Ticket #32246: class-wp-ajax-response.php.2.patch

wp-includes/class-wp-ajax-response.php

@@ -30 +30 @@
         /**
          * Append to 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.
+         * @since 2.1.0
          *
-         * '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.
+         * @param string|array $args {
+         *     Optional. An array or string of XML response arguments.
          *
-         * @since 2.1.0
-         *
-         * @param string|array $args Override defaults.
+         *     @type string          $what         XMLRPC response type. Used as a child element of
+         *                                         `<response>`. Default is 'object' (`<object>`).
+         *     @type bool            $action       Whether to use a nonce action in the responce
+         *                                         action attribute `<response action="">`.
+         *                                         Default is false, not to use nonces.
+         *     @type int|WP_Error    $id           The response ID, used as the response type `id`
+         *                                         attribute. Or `WP_Error` object if the ID does
+         *                                         not exist. Default is '0'.
+         *     @type int|false       $old_id       The previous response ID, used as the response
+         *                                         type `old_id` attribute. Or false, to hide this
+         *                                         attribute. Default is false.
+         *     @type string          $position     The response position, used as the response type
+         *                                         `position` attribute. Available positions:
+         *                                         bottom = 1 ; top = -1 ;
+         *                                         after = html ID ; before = -html ID ;
+         *                                         Default is 1 (bottom).
+         *     @type string|WP_Error $data         The response content/message. Or `WP_Error` object
+         *                                         if the ID does not exist. Default is empty response.
+         *     @type array           $supplemental An array of strings that will be children of the
+         *                                         `<supplemental>` element. Default is empty array.
+         * }
          * @return string XML response.
          */
         public function add( $args = '' ) {
                 $defaults = array(
-                        'what' => 'object', 'action' => false,
-                        'id' => '0', 'old_id' => false,
-                        'position' => 1,
-                        'data' => '', 'supplemental' => array()
+                        'what'         => 'object',
+                        'action'       => false,
+                        'id'           => '0',
+                        'old_id'       => false,
+                        'position'     => 1,
+                        'data'         => '',
+                        'supplemental' => array()
                 );
 
                 $r = wp_parse_args( $args, $defaults );
 
                 $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'];
+                $id       = $r['id'];
+                $what     = $r['what'];
+                $action   = $r['action'];
+                $old_id   = $r['old_id'];
+                $data     = $r['data'];
 
                 if ( is_wp_error( $id ) ) {
                         $data = $id;
@@ -101 +112 @@
                         $response = "<response_data><![CDATA[$data]]></response_data>";
                 }
 
-                $s = '';
+                $supplemental = '';
                 if ( is_array( $r['supplemental'] ) ) {
                         foreach ( $r['supplemental'] as $k => $v ) {
-                                $s .= "<$k><![CDATA[$v]]></$k>";
+                                $supplemental .= "<$k><![CDATA[$v]]></$k>";
                         }
-                        $s = "<supplemental>$s</supplemental>";
+                        $supplemental = "<supplemental>$supplemental</supplemental>";
                 }
 
                 if ( false === $action ) {
@@ -113 +124 @@
                         $action = $_POST['action'];
                 }
                 $x = '';
-                $x .= "<response action='{$action}_$id'>"; // The action attribute in the xml output is formatted like a nonce action
+                $x .= "<response action='{$action}_$id'>";
                 $x .=   "<$what id='$id' " . ( false === $old_id ? '' : "old_id='$old_id' " ) . "position='$position'>";
                 $x .=           $response;
-                $x .=           $s;
+                $x .=           $supplemental;
                 $x .=   "</$what>";
                 $x .= "</response>";