X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/8f374b7233bc2815ccc387e448d208c5434eb961..refs/tags/wordpress-4.5.1:/wp-includes/class-wp-ajax-response.php
diff --git a/wp-includes/class-wp-ajax-response.php b/wp-includes/class-wp-ajax-response.php
index 2bf974a2..ee2901f9 100644
--- a/wp-includes/class-wp-ajax-response.php
+++ b/wp-includes/class-wp-ajax-response.php
@@ -11,9 +11,8 @@ class WP_Ajax_Response {
*
* @since 2.1.0
* @var array
- * @access private
*/
- var $responses = array();
+ public $responses = array();
/**
* Constructor - Passes args to {@link WP_Ajax_Response::add()}.
@@ -22,37 +21,48 @@ class WP_Ajax_Response {
* @see WP_Ajax_Response::add()
*
* @param string|array $args Optional. Will be passed to add() method.
- * @return WP_Ajax_Response
*/
- function __construct( $args = '' ) {
+ public function __construct( $args = '' ) {
if ( !empty($args) )
$this->add($args);
}
/**
- * Append to XML response based on given arguments.
+ * Appends data to an XML response based on given arguments.
*
- * The arguments that can be passed in the $args parameter are below. It is
- * also possible to pass a WP_Error object in either the 'id' or 'data'
- * argument. The parameter isn't actually optional, content should be given
- * in order to send the correct response.
+ * With `$args` defaults, extra data output would be:
*
- * 'what' argument is a string that is the XMLRPC response type.
- * 'action' argument is a boolean or string that acts like a nonce.
- * 'id' argument can be WP_Error or an integer.
- * 'old_id' argument is false by default or an integer of the previous ID.
- * 'position' argument is an integer or a string with -1 = top, 1 = bottom,
- * html ID = after, -html ID = before.
- * 'data' argument is a string with the content or message.
- * 'supplemental' argument is an array of strings that will be children of
- * the supplemental element.
+ *
+ * <$what id='$id' position='$position'>
+ *
+ * $what>
+ *
*
* @since 2.1.0
+ * @access public
*
- * @param string|array $args Override defaults.
+ * @param string|array $args {
+ * Optional. An array or string of XML response arguments.
+ *
+ * @type string $what XML-RPC response type. Used as a child element of ``.
+ * Default 'object' (`