X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/8f374b7233bc2815ccc387e448d208c5434eb961..refs/tags/wordpress-4.5:/wp-includes/class-wp-ajax-response.php?ds=sidebyside

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.
+	 *     <response action='{$action}_$id'>
+	 *      <$what id='$id' position='$position'>
+	 *          <response_data><![CDATA[$data]]></response_data>
+	 *      </$what>
+	 *     </response>
 	 *
 	 * @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 `<response>`.
+	 *                                         Default 'object' (`<object>`).
+	 *     @type string|false    $action       Value to use for the `action` attribute in `<response>`. Will be
+	 *                                         appended with `_$id` on output. If false, `$action` will default to
+	 *                                         the value of `$_POST['action']`. Default false.
+	 *     @type int|WP_Error    $id           The response ID, used as the response type `id` attribute. Also
+	 *                                         accepts a `WP_Error` object if the ID does not exist. Default 0.
+	 *     @type int|false       $old_id       The previous response ID. Used as the value for the response type
+	 *                                         `old_id` attribute. False hides the attribute. Default false.
+	 *     @type string          $position     Value of the response type `position` attribute. Accepts 1 (bottom),
+	 *                                         -1 (top), html ID (after), or -html ID (before). Default 1 (bottom).
+	 *     @type string|WP_Error $data         The response content/message. Also accepts a WP_Error object if the
+	 *                                         ID does not exist. Default empty.
+	 *     @type array           $supplemental An array of extra strings that will be output within a `<supplemental>`
+	 *                                         element as CDATA. Default empty array.
+	 * }
 	 * @return string XML response.
 	 */
-	function add( $args = '' ) {
+	public function add( $args = '' ) {
 		$defaults = array(
 			'what' => 'object', 'action' => false,
 			'id' => '0', 'old_id' => false,
@@ -61,33 +71,40 @@ class WP_Ajax_Response {
 		);
 
 		$r = wp_parse_args( $args, $defaults );
-		extract( $r, EXTR_SKIP );
-		$position = preg_replace( '/[^a-z0-9:_-]/i', '', $position );
 
-		if ( is_wp_error($id) ) {
+		$position = preg_replace( '/[^a-z0-9:_-]/i', '', $r['position'] );
+		$id = $r['id'];
+		$what = $r['what'];
+		$action = $r['action'];
+		$old_id = $r['old_id'];
+		$data = $r['data'];
+
+		if ( is_wp_error( $id ) ) {
 			$data = $id;
 			$id = 0;
 		}
 
 		$response = '';
-		if ( is_wp_error($data) ) {
+		if ( is_wp_error( $data ) ) {
 			foreach ( (array) $data->get_error_codes() as $code ) {
-				$response .= "<wp_error code='$code'><![CDATA[" . $data->get_error_message($code) . "]]></wp_error>";
-				if ( !$error_data = $data->get_error_data($code) )
+				$response .= "<wp_error code='$code'><![CDATA[" . $data->get_error_message( $code ) . "]]></wp_error>";
+				if ( ! $error_data = $data->get_error_data( $code ) ) {
 					continue;
+				}
 				$class = '';
-				if ( is_object($error_data) ) {
-					$class = ' class="' . get_class($error_data) . '"';
-					$error_data = get_object_vars($error_data);
+				if ( is_object( $error_data ) ) {
+					$class = ' class="' . get_class( $error_data ) . '"';
+					$error_data = get_object_vars( $error_data );
 				}
 
 				$response .= "<wp_error_data code='$code'$class>";
 
-				if ( is_scalar($error_data) ) {
+				if ( is_scalar( $error_data ) ) {
 					$response .= "<![CDATA[$error_data]]>";
-				} elseif ( is_array($error_data) ) {
-					foreach ( $error_data as $k => $v )
+				} elseif ( is_array( $error_data ) ) {
+					foreach ( $error_data as $k => $v ) {
 						$response .= "<$k><![CDATA[$v]]></$k>";
+					}
 				}
 
 				$response .= "</wp_error_data>";
@@ -97,15 +114,16 @@ class WP_Ajax_Response {
 		}
 
 		$s = '';
-		if ( is_array($supplemental) ) {
-			foreach ( $supplemental as $k => $v )
+		if ( is_array( $r['supplemental'] ) ) {
+			foreach ( $r['supplemental'] as $k => $v ) {
 				$s .= "<$k><![CDATA[$v]]></$k>";
+			}
 			$s = "<supplemental>$s</supplemental>";
 		}
 
-		if ( false === $action )
+		if ( false === $action ) {
 			$action = $_POST['action'];
-
+		}
 		$x = '';
 		$x .= "<response action='{$action}_$id'>"; // The action attribute in the xml output is formatted like a nonce action
 		$x .=	"<$what id='$id' " . ( false === $old_id ? '' : "old_id='$old_id' " ) . "position='$position'>";
@@ -125,9 +143,9 @@ class WP_Ajax_Response {
 	 *
 	 * @since 2.1.0
 	 */
-	function send() {
-		header('Content-Type: text/xml');
-		echo "<?xml version='1.0' standalone='yes'?><wp_ajax>";
+	public function send() {
+		header( 'Content-Type: text/xml; charset=' . get_option( 'blog_charset' ) );
+		echo "<?xml version='1.0' encoding='" . get_option( 'blog_charset' ) . "' standalone='yes'?><wp_ajax>";
 		foreach ( (array) $this->responses as $response )
 			echo $response;
 		echo '</wp_ajax>';