<!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>[48184] trunk/src: Docs: Miscellaneous docblock improvements.</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/48184">48184</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/48184","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-26 18:38:51 +0000 (Fri, 26 Jun 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: Miscellaneous docblock improvements.
See <a href="https://core.trac.wordpress.org/ticket/49572">#49572</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswppluginslisttablephp">trunk/src/wp-admin/includes/class-wp-plugins-list-table.php</a></li>
<li><a href="#trunksrcwpadminincludesfilephp">trunk/src/wp-admin/includes/file.php</a></li>
<li><a href="#trunksrcwpincludescanonicalphp">trunk/src/wp-includes/canonical.php</a></li>
<li><a href="#trunksrcwpincludesclasswphttpproxyphp">trunk/src/wp-includes/class-wp-http-proxy.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswppluginslisttablephp"></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-plugins-list-table.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-plugins-list-table.php 2020-06-26 18:32:44 UTC (rev 48183)
+++ trunk/src/wp-admin/includes/class-wp-plugins-list-table.php 2020-06-26 18:38:51 UTC (rev 48184)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1011,9 +1011,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * the version, author, author URI, and plugin URI.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $plugin_file Path to the plugin file relative to the plugins directory.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $plugin_data An array of plugin data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $status Status of the plugin. Defaults are 'All', 'Active',
- * 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
- * 'Drop-ins', 'Search', 'Paused'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $status Status filter currently applied to the plugin list. Possible
+ * values are: 'all', 'active', 'inactive', 'recently_activated',
+ * 'upgrade', 'mustuse', 'dropins', 'search', 'paused',
+ * 'auto-update-enabled', 'auto-update-disabled'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_meta = apply_filters( 'plugin_row_meta', $plugin_meta, $plugin_file, $plugin_data, $status );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1131,10 +1132,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $plugin_file Path to the plugin file relative to the plugins directory.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $plugin_data An array of plugin data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $status Status of the plugin. Defaults are 'All', 'Active',
- * 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
- * 'Drop-ins', 'Search', 'Paused', 'Auto-updates Enabled',
- * 'Auto-updates Disabled'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $status Status filter currently applied to the plugin list. Possible
+ * values are: 'all', 'active', 'inactive', 'recently_activated',
+ * 'upgrade', 'mustuse', 'dropins', 'search', 'paused',
+ * 'auto-update-enabled', 'auto-update-disabled'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'after_plugin_row', $plugin_file, $plugin_data, $status );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1149,10 +1150,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $plugin_file Path to the plugin file relative to the plugins directory.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $plugin_data An array of plugin data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $status Status of the plugin. Defaults are 'All', 'Active',
- * 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
- * 'Drop-ins', 'Search', 'Paused', 'Auto-updates Enabled',
- * 'Auto-updates Disabled'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $status Status filter currently applied to the plugin list. Possible
+ * values are: 'all', 'active', 'inactive', 'recently_activated',
+ * 'upgrade', 'mustuse', 'dropins', 'search', 'paused',
+ * 'auto-update-enabled', 'auto-update-disabled'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( "after_plugin_row_{$plugin_file}", $plugin_file, $plugin_data, $status );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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-06-26 18:32:44 UTC (rev 48183)
+++ trunk/src/wp-admin/includes/file.php 2020-06-26 18:38:51 UTC (rev 48184)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -888,7 +888,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $move_new_file If null (default) move the file after the upload.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $file An array of data for a single file.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $new_file Filename of the newly-uploaded file.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $type File type.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $type Mime type of the newly-uploaded file.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $move_new_file = apply_filters( 'pre_move_uploaded_file', null, $file, $new_file, $type );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -940,8 +940,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of upload data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $file Filename of the newly-uploaded file.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $url URL of the uploaded file.
- * @type string $type File type.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $url URL of the newly-uploaded file.
+ * @type string $type Mime type of the newly-uploaded file.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $context The type of upload action. Values include 'upload' or 'sideload'.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwpincludescanonicalphp"></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/canonical.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/canonical.php 2020-06-26 18:32:44 UTC (rev 48183)
+++ trunk/src/wp-includes/canonical.php 2020-06-26 18:38:51 UTC (rev 48184)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -850,7 +850,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters whether to attempt to guess a redirect URL for a 404 request.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Passing a false value to the filter will disable the URL guessing
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * and return early.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * and return early without performing a redirect.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -862,7 +862,7 @@
</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">- * Filters whether to short-circuit redirect URL guessing for 404 requests.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Short-circuits the redirect URL guessing for 404 requests.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Passing a non-null value to the filter will effectively short-circuit
</span><span class="cx" style="display: block; padding: 0 10px"> * the URL guessing, returning the passed value instead.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -869,8 +869,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.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 null|string $pre Whether to short-circuit redirect guess 404 permalink.
- * Default null to continue with the URL guessing.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param null|string|false $pre Whether to short-circuit guessing the redirect for a 404.
+ * Default null to continue with the URL guessing.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $pre = apply_filters( 'pre_redirect_guess_404_permalink', null );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( null !== $pre ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -879,13 +879,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( get_query_var( 'name' ) ) {
</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 whether to perform a strict or loose guess.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters whether to perform a strict guess for a 404 redirect.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Passing a truthy value to the filter will redirect only exact post_name matches.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.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 bool $strict_guess Whether to perform a strict/exact guess. Default false (loose guess).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $strict_guess Whether to perform a strict guess. Default false (loose guess).
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $strict_guess = apply_filters( 'strict_redirect_guess_404_permalink', false );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesclasswphttpproxyphp"></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-http-proxy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-http-proxy.php 2020-06-26 18:32:44 UTC (rev 48183)
+++ trunk/src/wp-includes/class-wp-http-proxy.php 2020-06-26 18:38:51 UTC (rev 48184)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -160,8 +160,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.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">- * @param string $uri URI to check.
- * @return bool True, to send through the proxy and false if, the proxy should not be used.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $uri URL of the request.
+ * @return bool Whether to send the request through the proxy.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function send_through_proxy( $uri ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $check = parse_url( $uri );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -181,10 +181,10 @@
</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 bool|null $override Whether to override the request result. Default null.
- * @param string $uri URL to check.
- * @param array $check Associative array result of parsing the request URI.
- * @param array $home Associative array result of parsing the site URL.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool|null $override Whether to send the request through the proxy. Default null.
+ * @param string $uri URL of the request.
+ * @param array $check Associative array result of parsing the request URL with `parse_url()`.
+ * @param array $home Associative array result of parsing the site URL with `parse_url()`.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $result = apply_filters( 'pre_http_send_through_proxy', null, $uri, $check, $home );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_null( $result ) ) {
</span></span></pre>
</div>
</div>
</body>
</html>