<!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>[47060] trunk/src: Docs: In various `@return` tags, list the expected type first, instead of `false`.</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/47060">47060</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/47060","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>2020-01-11 18:30:58 +0000 (Sat, 11 Jan 2020)</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: In various `@return` tags, list the expected type first, instead of `false`.

Follow-up to <a href="https://core.trac.wordpress.org/changeset/46696">[46696]</a>.

See <a href="https://core.trac.wordpress.org/ticket/48303">#48303</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpadminincludesclasscoreupgraderphp">trunk/src/wp-admin/includes/class-core-upgrader.php</a></li>

<li><a href="#trunksrcwpadminincludesclasswpcommunityeventsphp">trunk/src/wp-admin/includes/class-wp-community-events.php</a></li>

<li><a href="#trunksrcwpadminincludesclasswpupgraderskinphp">trunk/src/wp-admin/includes/class-wp-upgrader-skin.php</a></li>

<li><a href="#trunksrcwpadminincludesfilephp">trunk/src/wp-admin/includes/file.php</a></li>

<li><a href="#trunksrcwpadminincludespluginphp">trunk/src/wp-admin/includes/plugin.php</a></li>

<li><a href="#trunksrcwpadminincludestemplatephp">trunk/src/wp-admin/includes/template.php</a></li>

<li><a href="#trunksrcwpadminincludesthemephp">trunk/src/wp-admin/includes/theme.php</a></li>

<li><a href="#trunksrcwpadminincludesupdatecorephp">trunk/src/wp-admin/includes/update-core.php</a></li>

<li><a href="#trunksrcwpadminincludesupdatephp">trunk/src/wp-admin/includes/update.php</a></li>

<li><a href="#trunksrcwpadminincludesupgradephp">trunk/src/wp-admin/includes/upgrade.php</a></li>

<li><a href="#trunksrcwpadmininstallhelperphp">trunk/src/wp-admin/install-helper.php</a></li>

<li><a href="#trunksrcwpincludesauthortemplatephp">trunk/src/wp-includes/author-template.php</a></li>

<li><a href="#trunksrcwpincludesbookmarktemplatephp">trunk/src/wp-includes/bookmark-template.php</a></li>

<li><a href="#trunksrcwpincludescachephp">trunk/src/wp-includes/cache.php</a></li>

<li><a href="#trunksrcwpincludescanonicalphp">trunk/src/wp-includes/canonical.php</a></li>

<li><a href="#trunksrcwpincludescategorytemplatephp">trunk/src/wp-includes/category-template.php</a></li>

<li><a href="#trunksrcwpincludesclasshttpphp">trunk/src/wp-includes/class-http.php</a></li>

<li><a href="#trunksrcwpincludesclasswpcustomizesettingphp">trunk/src/wp-includes/class-wp-customize-setting.php</a></li>

<li><a href="#trunksrcwpincludesclasswpcustomizewidgetsphp">trunk/src/wp-includes/class-wp-customize-widgets.php</a></li>

<li><a href="#trunksrcwpincludesclasswpeditorphp">trunk/src/wp-includes/class-wp-editor.php</a></li>

<li><a href="#trunksrcwpincludesclasswpembedphp">trunk/src/wp-includes/class-wp-embed.php</a></li>

<li><a href="#trunksrcwpincludesclasswpimageeditorphp">trunk/src/wp-includes/class-wp-image-editor.php</a></li>

<li><a href="#trunksrcwpincludesclasswpmetaqueryphp">trunk/src/wp-includes/class-wp-meta-query.php</a></li>

<li><a href="#trunksrcwpincludesclasswpoembedphp">trunk/src/wp-includes/class-wp-oembed.php</a></li>

<li><a href="#trunksrcwpincludesclasswprewritephp">trunk/src/wp-includes/class-wp-rewrite.php</a></li>

<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>

<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>

<li><a href="#trunksrcwpincludescronphp">trunk/src/wp-includes/cron.php</a></li>

<li><a href="#trunksrcwpincludesdeprecatedphp">trunk/src/wp-includes/deprecated.php</a></li>

<li><a href="#trunksrcwpincludesembedphp">trunk/src/wp-includes/embed.php</a></li>

<li><a href="#trunksrcwpincludesfeedphp">trunk/src/wp-includes/feed.php</a></li>

<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>

<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>

<li><a href="#trunksrcwpincludeshttpphp">trunk/src/wp-includes/http.php</a></li>

<li><a href="#trunksrcwpincludesl10nphp">trunk/src/wp-includes/l10n.php</a></li>

<li><a href="#trunksrcwpincludeslinktemplatephp">trunk/src/wp-includes/link-template.php</a></li>

<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>

<li><a href="#trunksrcwpincludesnavmenuphp">trunk/src/wp-includes/nav-menu.php</a></li>

<li><a href="#trunksrcwpincludespluggabledeprecatedphp">trunk/src/wp-includes/pluggable-deprecated.php</a></li>

<li><a href="#trunksrcwpincludespluggablephp">trunk/src/wp-includes/pluggable.php</a></li>

<li><a href="#trunksrcwpincludespomopophp">trunk/src/wp-includes/pomo/po.php</a></li>

<li><a href="#trunksrcwpincludesposttemplatephp">trunk/src/wp-includes/post-template.php</a></li>

<li><a href="#trunksrcwpincludesrestapiclasswprestserverphp">trunk/src/wp-includes/rest-api/class-wp-rest-server.php</a></li>

<li><a href="#trunksrcwpincludesrevisionphp">trunk/src/wp-includes/revision.php</a></li>

<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>

<li><a href="#trunksrcwpincludeswpdbphp">trunk/src/wp-includes/wp-db.php</a></li>

<li><a href="#trunksrcwpsignupphp">trunk/src/wp-signup.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpadminincludesclasscoreupgraderphp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-core-upgrader.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-core-upgrader.php       2020-01-11 17:56:15 UTC (rev 47059)

+++ trunk/src/wp-admin/includes/class-core-upgrader.php 2020-01-11 18:30:58 UTC (rev 47060)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -57,7 +57,7 @@

<span class="cx" style="display: block; padding: 0 10px">         *        @type bool $do_rollback      Whether to perform this "upgrade" as a rollback.

<span class="cx" style="display: block; padding: 0 10px">         *                                     Default false.

</span><span class="cx" style="display: block; padding: 0 10px">         * }

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @return null|false|WP_Error False or WP_Error on failure, null on success.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @return null|false|WP_Error Null on success, false or WP_Error on failure.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><span class="cx" style="display: block; padding: 0 10px">        public function upgrade( $current, $args = array() ) {

</span><span class="cx" style="display: block; padding: 0 10px">                global $wp_filesystem;

</span></span></pre></div>

<a id="trunksrcwpadminincludesclasswpcommunityeventsphp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-community-events.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-community-events.php 2020-01-11 17:56:15 UTC (rev 47059)

+++ trunk/src/wp-admin/includes/class-wp-community-events.php   2020-01-11 18:30:58 UTC (rev 47060)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -229,7 +229,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 4.8.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">-         * @return false|string The anonymized address on success; the given address

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @return string|false The anonymized address on success; the given address

</ins><span class="cx" style="display: block; padding: 0 10px">          *                      or false on failure.

</span><span class="cx" style="display: block; padding: 0 10px">         */

</span><span class="cx" style="display: block; padding: 0 10px">        public static function get_unsafe_client_ip() {

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -341,8 +341,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">         *

</span><span class="cx" style="display: block; padding: 0 10px">         * @since 4.8.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">-         * @return false|array false on failure; an array containing `location`

-        *                     and `events` items on success.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @return array|false An array containing `location` and `events` items

+        *                     on success, false on failure.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><span class="cx" style="display: block; padding: 0 10px">        public function get_cached_events() {

</span><span class="cx" style="display: block; padding: 0 10px">                $cached_response = get_site_transient( $this->get_events_transient_key( $this->user_location ) );

</span></span></pre></div>

<a id="trunksrcwpadminincludesclasswpupgraderskinphp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-upgrader-skin.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-upgrader-skin.php    2020-01-11 17:56:15 UTC (rev 47059)

+++ trunk/src/wp-admin/includes/class-wp-upgrader-skin.php      2020-01-11 18:30:58 UTC (rev 47060)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,7 +81,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">         * @param string        $context                      Optional. Full path to the directory that is tested

<span class="cx" style="display: block; padding: 0 10px">         *                                                    for being writable. Default empty.

<span class="cx" style="display: block; padding: 0 10px">         * @param bool          $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @return bool False on failure, true on success.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @return bool True on success, false on failure.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><span class="cx" style="display: block; padding: 0 10px">        public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) {

</span><span class="cx" style="display: block; padding: 0 10px">                $url = $this->options['url'];

</span></span></pre></div>

<a id="trunksrcwpadminincludesfilephp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/file.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/file.php      2020-01-11 17:56:15 UTC (rev 47059)

+++ trunk/src/wp-admin/includes/file.php        2020-01-11 18:30:58 UTC (rev 47060)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1189,8 +1189,8 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param string       $filename            The file to validate.

<span class="cx" style="display: block; padding: 0 10px">  * @param string|array $signatures          A Signature provided for the file.

<span class="cx" style="display: block; padding: 0 10px">  * @param string       $filename_for_errors A friendly filename for errors. Optional.

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *

- * @return bool|WP_Error true on success, false if verification not attempted, or WP_Error describing an error condition.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|WP_Error True on success, false if verification not attempted,

+ *                       or WP_Error describing an error condition.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function verify_file_signature( $filename, $signatures, $filename_for_errors = false ) {

</span><span class="cx" style="display: block; padding: 0 10px">        if ( ! $filename_for_errors ) {

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1964,12 +1964,11 @@

<span class="cx" style="display: block; padding: 0 10px">         * @param mixed         $output                       Form output to return instead. Default empty.

<span class="cx" style="display: block; padding: 0 10px">         * @param string        $form_post                    The URL to post the form to.

<span class="cx" style="display: block; padding: 0 10px">         * @param string        $type                         Chosen type of filesystem.

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param bool|WP_Error $error                        Optional. Whether the current request has failed to connect,

-        *                                                    or an error object. Default false.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param bool|WP_Error $error                        Whether the current request has failed to connect,

+        *                                                    or an error object.

</ins><span class="cx" style="display: block; padding: 0 10px">          * @param string        $context                      Full path to the directory that is tested for

<span class="cx" style="display: block; padding: 0 10px">         *                                                    being writable.

<span class="cx" style="display: block; padding: 0 10px">         * @param bool          $allow_relaxed_file_ownership Whether to allow Group/World writable.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         *                                                    Default false.

</del><span class="cx" style="display: block; padding: 0 10px">          * @param array         $extra_fields                 Extra POST fields.

</span><span class="cx" style="display: block; padding: 0 10px">         */

</span><span class="cx" style="display: block; padding: 0 10px">        $req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2092,7 +2091,8 @@

<span class="cx" style="display: block; padding: 0 10px">         * @param string[]      $types       Types of connections.

<span class="cx" style="display: block; padding: 0 10px">         * @param array         $credentials Credentials to connect with.

<span class="cx" style="display: block; padding: 0 10px">         * @param string        $type        Chosen filesystem method.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param bool|WP_Error $error       Error object or status.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param bool|WP_Error $error       Whether the current request has failed to connect,

+        *                                   or an error object.

</ins><span class="cx" style="display: block; padding: 0 10px">          * @param string        $context     Full path to the directory that is tested for being writable.

</span><span class="cx" style="display: block; padding: 0 10px">         */

</span><span class="cx" style="display: block; padding: 0 10px">        $types = apply_filters( 'fs_ftp_connection_types', $types, $credentials, $type, $error, $context );

</span></span></pre></div>

<a id="trunksrcwpadminincludespluginphp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/plugin.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/plugin.php    2020-01-11 17:56:15 UTC (rev 47059)

+++ trunk/src/wp-admin/includes/plugin.php      2020-01-11 18:30:58 UTC (rev 47060)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -613,7 +613,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  * @param bool   $network_wide Optional. Whether to enable the plugin for all sites in the network

<span class="cx" style="display: block; padding: 0 10px">  *                             or just the current site. Multisite only. Default false.

<span class="cx" style="display: block; padding: 0 10px">  * @param bool   $silent       Optional. Whether to prevent calling activation hooks. Default false.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return null|WP_Error WP_Error on invalid file or null on success.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return null|WP_Error Null on success, WP_Error on invalid file.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) {

</span><span class="cx" style="display: block; padding: 0 10px">        $plugin = plugin_basename( trim( $plugin ) );

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1342,7 +1342,7 @@

<span class="cx" style="display: block; padding: 0 10px">  *                              to be compatible with sanitize_key().

<span class="cx" style="display: block; padding: 0 10px">  * @param callable $function    The function to be called to output the content for this page.

<span class="cx" style="display: block; padding: 0 10px">  * @param int      $position    The position in the menu order this item should appear.