<!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>[55539] trunk/src/wp-includes/class-wp-xmlrpc-server.php: Docs: Improve some DocBlock formatting in `wp-includes/class-wp-xmlrpc-server.php`.</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 { white-space: pre-line; 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/55539">55539</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/55539","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-03-12 14:48:03 +0000 (Sun, 12 Mar 2023)</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: Improve some DocBlock formatting in `wp-includes/class-wp-xmlrpc-server.php`.
Includes clarifying the list of fields passed to the `xmlrpc_default_*_fields` filters by default.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/16046">[16046]</a>, <a href="https://core.trac.wordpress.org/changeset/17647">[17647]</a>, <a href="https://core.trac.wordpress.org/changeset/27730">[27730]</a>, <a href="https://core.trac.wordpress.org/changeset/32550">[32550]</a>, <a href="https://core.trac.wordpress.org/changeset/37492">[37492]</a>, <a href="https://core.trac.wordpress.org/changeset/55316">[55316]</a>.
See <a href="https://core.trac.wordpress.org/ticket/57840">#57840</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpxmlrpcserverphp">trunk/src/wp-includes/class-wp-xmlrpc-server.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpxmlrpcserverphp"></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-xmlrpc-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-xmlrpc-server.php 2023-03-11 11:32:54 UTC (rev 55538)
+++ trunk/src/wp-includes/class-wp-xmlrpc-server.php 2023-03-12 14:48:03 UTC (rev 55539)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -198,8 +198,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters whether XML-RPC methods requiring authentication are enabled.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Contrary to the way it's named, this filter does not control whether XML-RPC is *fully*
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * enabled, rather, it only controls whether XML-RPC methods requiring authentication - such
- * as for publishing purposes - are enabled.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * enabled, rather, it only controls whether XML-RPC methods requiring authentication -
+ * such as for publishing purposes - are enabled.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Further, the filter does not control whether pingbacks or other custom endpoints that don't
</span><span class="cx" style="display: block; padding: 0 10px"> * require authentication are enabled. This behavior is expected, and due to how parity was matched
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1909,11 +1909,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = $args[4];
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters the list of post query fields used by the given XML-RPC method.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the default post query fields used by the given XML-RPC method.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $fields Array of post fields. Default array contains 'post', 'terms', and 'custom_fields'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $fields An array of post fields to retrieve. By default,
+ * contains 'post', 'terms', and 'custom_fields'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $method Method name.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = apply_filters( 'xmlrpc_default_post_fields', array( 'post', 'terms', 'custom_fields' ), 'wp.getPost' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1960,7 +1961,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $4 Optional. The subset of post type fields to return in the response array.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|IXR_Error Array contains a collection of posts.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array|IXR_Error Array containing a collection of posts.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function wp_getPosts( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $this->minimum_args( $args, 3 ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2540,11 +2541,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = $args[4];
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters the taxonomy query fields used by the given XML-RPC method.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the default taxonomy query fields used by the given XML-RPC method.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $fields An array of taxonomy fields to retrieve.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $fields An array of taxonomy fields to retrieve. By default,
+ * contains 'labels', 'cap', and 'object_type'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $method The method name.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = apply_filters( 'xmlrpc_default_taxonomy_fields', array( 'labels', 'cap', 'object_type' ), 'wp.getTaxonomy' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2688,7 +2690,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $fields User query fields for given method. Default 'all'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $fields An array of user fields to retrieve. By default, contains 'all'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $method The method name.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getUser' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3605,16 +3607,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves comments.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Besides the common blog_id (unused), username, and password arguments, it takes a filter
- * array as last argument.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Besides the common blog_id (unused), username, and password arguments,
+ * it takes a filter array as the last argument.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Accepted 'filter' keys are 'status', 'post_id', 'offset', and 'number'.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The defaults are as follows:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * - 'status' - Default is ''. Filter by status (e.g., 'approve', 'hold')
- * - 'post_id' - Default is ''. The post where the comment is posted. Empty string shows all comments.
- * - 'number' - Default is 10. Total number of media items to retrieve.
- * - 'offset' - Default is 0. See WP_Query::query() for more.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - 'status' - Default is ''. Filter by status (e.g., 'approve', 'hold')
+ * - 'post_id' - Default is ''. The post where the comment is posted.
+ * Empty string shows all comments.
+ * - 'number' - Default is 10. Total number of media items to retrieve.
+ * - 'offset' - Default is 0. See WP_Query::query() for more.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3626,8 +3629,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $2 Password.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $3 Optional. Query arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|IXR_Error Contains a collection of comments. See wp_xmlrpc_server::wp_getComment()
- * for a description of each item contents.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array|IXR_Error Array containing a collection of comments.
+ * See wp_xmlrpc_server::wp_getComment() for a description
+ * of each item contents.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function wp_getComments( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->escape( $args );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3759,8 +3763,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Edits a comment.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Besides the common blog_id (unused), username, and password arguments, it takes a
- * comment_id integer and a content_struct array as last argument.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Besides the common blog_id (unused), username, and password arguments,
+ * it takes a comment_id integer and a content_struct array as the last argument.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The allowed keys in the content_struct array are:
</span><span class="cx" style="display: block; padding: 0 10px"> * - 'author'
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4377,15 +4381,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves a collection of media library items (or attachments).
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Besides the common blog_id (unused), username, and password arguments, it takes a filter
- * array as last argument.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Besides the common blog_id (unused), username, and password arguments,
+ * it takes a filter array as the last argument.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Accepted 'filter' keys are 'parent_id', 'mime_type', 'offset', and 'number'.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The defaults are as follows:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * - 'number' - Default is 5. Total number of media items to retrieve.
- * - 'offset' - Default is 0. See WP_Query::query() for more.
- * - 'parent_id' - Default is ''. The post where the media item is attached. Empty string shows all media items. 0 shows unattached media items.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - 'number' - Default is 5. Total number of media items to retrieve.
+ * - 'offset' - Default is 0. See WP_Query::query() for more.
+ * - 'parent_id' - Default is ''. The post where the media item is attached.
+ * Empty string shows all media items. 0 shows unattached media items.
</ins><span class="cx" style="display: block; padding: 0 10px"> * - 'mime_type' - Default is ''. Filter by mime type (e.g., 'image/jpeg', 'application/pdf')
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4396,11 +4401,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $0 Blog ID (unused).
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $1 Username.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $2 Password.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type array $3 Query arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $3 Optional. Query 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">- * @return array|IXR_Error Contains a collection of media items.
- * See wp_xmlrpc_server::wp_getMediaItem() for
- * a description of each item contents.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array|IXR_Error Array containing a collection of media items.
+ * See wp_xmlrpc_server::wp_getMediaItem() for a description
+ * of each item contents.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function wp_getMediaLibrary( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->escape( $args );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4539,11 +4544,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = $args[4];
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters the default query fields used by the given XML-RPC method.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the default post type query fields used by the given XML-RPC method.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $fields An array of post type query fields for the given method.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $fields An array of post type fields to retrieve. By default,
+ * contains 'labels', 'cap', and 'taxonomies'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $method The method name.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = apply_filters( 'xmlrpc_default_posttype_fields', array( 'labels', 'cap', 'taxonomies' ), 'wp.getPostType' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4649,7 +4655,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $3 Post ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $4 Optional. Fields to fetch.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|IXR_Error contains a collection of posts.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array|IXR_Error Array containing a collection of posts.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function wp_getRevisions( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $this->minimum_args( $args, 4 ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4670,7 +4676,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $field An array of revision query fields.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $field An array of revision fields to retrieve. By default,
+ * contains 'post_date' and 'post_date_gmt'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $method The method name.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = apply_filters( 'xmlrpc_default_revision_fields', array( 'post_date', 'post_date_gmt' ), 'wp.getRevisions' );
</span></span></pre>
</div>
</div>
</body>
</html>