Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-22 17:18:32 +01:00
Code Issues Projects Releases Wiki Activity

Docs: Document default WP_Ajax_Response::add() arguments as a hash notation.

Browse Source 
Adds example output to the DocBlock description based on default argument values.

Props ramiy for the initial patch.
See #32246.

Built from https://develop.svn.wordpress.org/trunk@37032


git-svn-id: http://core.svn.wordpress.org/trunk@36999 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-03-18 11:59:27 +00:00
parent 6edbcc88ff
commit 7be6a1c317
2 changed files with 28 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
wp-includes/class-wp-ajax-response.php
View File

@ -28,26 +28,38 @@ class WP_Ajax_Response {
}
/**
* 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.
*/
public function add( $args = '' ) {

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.5-beta4-37031';
$wp_version = '4.5-beta4-37032';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.