<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[37032] trunk/src/wp-includes/class-wp-ajax-response.php: Docs: Document default `WP_Ajax_Response::add()` arguments as a hash notation.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/37032">37032</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/37032","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-03-18 11:58:08 +0000 (Fri, 18 Mar 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Document default `WP_Ajax_Response::add()` arguments as a hash notation.
Adds example output to the DocBlock description based on default argument values.
Props ramiy for the initial patch.
See <a href="https://core.trac.wordpress.org/ticket/32246">#32246</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpajaxresponsephp">trunk/src/wp-includes/class-wp-ajax-response.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpajaxresponsephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-ajax-response.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-ajax-response.php 2016-03-17 19:15:57 UTC (rev 37031)
+++ trunk/src/wp-includes/class-wp-ajax-response.php 2016-03-18 11:58:08 UTC (rev 37032)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,26 +28,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Append to XML response based on given arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Appends data to an XML response based on given arguments.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * With `$args` defaults, extra data output would be:
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * '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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * <response action='{$action}_$id'>
+ * <$what id='$id' position='$position'>
+ * <response_data><![CDATA[$data]]></response_data>
+ * </$what>
+ * </response>
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @access public
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|array $args Override defaults.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string XML response.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add( $args = '' ) {
</span></span></pre>
</div>
</div>
</body>
</html>