<!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>[54866] trunk/src: Docs: Revise comments using {U+201C}we{U+201D} in WordPress root directory files.</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/54866">54866</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/54866","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>2022-11-23 15:41:39 +0000 (Wed, 23 Nov 2022)</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: Revise comments using {U+201C}we{U+201D} in WordPress root directory files.
This updates some inline comments to better match the guidelines and recommendations set forth in the make/core and make/docs handbooks:
> In general, use second person in your documentation. Second person depicts a friendly tone, with a perfect focus on the reader. In addition to this, directly addressing the reader helps avoid passive voice; thereby preventing unwanted confusion.
> ...
> the word {U+201C}we{U+201D} should be avoided (...) unless its made very clear which group is speaking.
Includes:
* Replacing first-person usage of "we" with second person point of view.
* Making small clarification adjustments where the voice is much too casual or lacks clear context, especially for non-native English speakers.
References:
* [https://make.wordpress.org/docs/style-guide/language-grammar/grammatical-person/ Style Guide: Grammatical person]
* [https://make.wordpress.org/docs/handbook/documentation-team-handbook/handbooks-style-and-formatting-guide/ Handbooks & HelpHub Style and Formatting Guide]
* [https://make.wordpress.org/core/handbook/best-practices/post-comment-guidelines/#style-and-substance Post & Comment Guidelines: Style and Substance]
Follow-up to <a href="https://core.trac.wordpress.org/changeset/2176">[2176]</a>, <a href="https://core.trac.wordpress.org/changeset/3430">[3430]</a>, <a href="https://core.trac.wordpress.org/changeset/4676">[4676]</a>, <a href="https://core.trac.wordpress.org/changeset/6009">[6009]</a>, <a href="https://core.trac.wordpress.org/changeset/7991">[7991]</a>, <a href="https://core.trac.wordpress.org/changeset/12688">[12688]</a>, <a href="https://core.trac.wordpress.org/changeset/12762">[12762]</a>, <a href="https://core.trac.wordpress.org/changeset/26008">[26008]</a>, <a href="https://core.trac.wordpress.org/changeset/28978">[28978]</a>, <a href="https://core.trac.wordpress.org/changeset/44488">[44488]</a>, <a href="https://core.trac.wordpress.org/changeset/44962">[44962]</a>, <a href="https://core.trac.wordpress.org/changeset/51979">[51979]</a>, <a href="https://core.trac.wordpress.org/changeset/53131">[53131]</a>, <a href="https://core.trac.wordpress.org/changeset/53132">[53132]</a>, <
a href="https://core.trac.wordpress.org/changeset/53156">[53156]</a>, <a href="https://core.trac.wordpress.org/changeset/53131">[53131]</a>, <a href="https://core.trac.wordpress.org/changeset/54200">[54200]</a>.
Props ironprogrammer, costdev, jorbin, SergeyBiryukov.
See <a href="https://core.trac.wordpress.org/ticket/57052">#57052</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpcronphp">trunk/src/wp-cron.php</a></li>
<li><a href="#trunksrcwploadphp">trunk/src/wp-load.php</a></li>
<li><a href="#trunksrcwploginphp">trunk/src/wp-login.php</a></li>
<li><a href="#trunksrcwpmailphp">trunk/src/wp-mail.php</a></li>
<li><a href="#trunksrcwpsettingsphp">trunk/src/wp-settings.php</a></li>
<li><a href="#trunksrcwptrackbackphp">trunk/src/wp-trackback.php</a></li>
<li><a href="#trunksrcxmlrpcphp">trunk/src/xmlrpc.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpcronphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-cron.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-cron.php 2022-11-22 21:25:27 UTC (rev 54865)
+++ trunk/src/wp-cron.php 2022-11-23 15:41:39 UTC (rev 54866)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,7 +23,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> header( 'Cache-Control: no-cache, must-revalidate, max-age=0' );
</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">-/* Don't make the request block till we finish, if possible. */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Don't run cron until the request finishes, if possible.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( PHP_VERSION_ID >= 70016 && function_exists( 'fastcgi_finish_request' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> fastcgi_finish_request();
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( function_exists( 'litespeed_finish_request' ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,7 +35,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">- * Tell WordPress we are doing the cron task.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Tell WordPress the cron task is running.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @var bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwploadphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-load.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-load.php 2022-11-22 21:25:27 UTC (rev 54865)
+++ trunk/src/wp-load.php 2022-11-23 15:41:39 UTC (rev 54866)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -68,11 +68,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $path = wp_guess_url() . '/wp-admin/setup-config.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * We're going to redirect to setup-config.php. While this shouldn't result
- * in an infinite loop, that's a silly thing to assume, don't you think? If
- * we're traveling in circles, our last-ditch effort is "Need more help?"
- */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Redirect to setup-config.php.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( false === strpos( $_SERVER['REQUEST_URI'], 'setup-config' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> header( 'Location: ' . $path );
</span><span class="cx" style="display: block; padding: 0 10px"> exit;
</span></span></pre></div>
<a id="trunksrcwploginphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-login.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-login.php 2022-11-22 21:25:27 UTC (rev 54865)
+++ trunk/src/wp-login.php 2022-11-23 15:41:39 UTC (rev 54866)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1244,7 +1244,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"> } elseif ( isset( $_POST['testcookie'] ) && empty( $_COOKIE[ TEST_COOKIE ] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If cookies are disabled, we can't log in even with a valid user and password.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If cookies are disabled, the user can't log in even with a valid username and password.
</ins><span class="cx" style="display: block; padding: 0 10px"> $user = new WP_Error(
</span><span class="cx" style="display: block; padding: 0 10px"> 'test_cookie',
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span></span></pre></div>
<a id="trunksrcwpmailphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-mail.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-mail.php 2022-11-22 21:25:27 UTC (rev 54865)
+++ trunk/src/wp-mail.php 2022-11-23 15:41:39 UTC (rev 54866)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -231,7 +231,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> echo "\n" . $post_ID->get_error_message();
</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">- // We couldn't post, for whatever reason. Better move forward to the next email.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // The post wasn't inserted or updated, for whatever reason. Better move forward to the next email.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $post_ID ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpsettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-settings.php 2022-11-22 21:25:27 UTC (rev 54865)
+++ trunk/src/wp-settings.php 2022-11-23 15:41:39 UTC (rev 54866)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,8 +19,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Version information for the current WordPress release.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * These can't be directly globalized in version.php. When updating,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * we're including version.php from another installation and don't want
- * these values to be overridden if already set.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * include version.php from another installation and don't override
+ * these values if already set.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $wp_version The WordPress version string.
</span><span class="cx" style="display: block; padding: 0 10px"> * @global int $wp_db_version WordPress database version.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,7 +60,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Set initial default constants including WP_MEMORY_LIMIT, WP_MAX_MEMORY_LIMIT, WP_DEBUG, SCRIPT_DEBUG, WP_CONTENT_DIR and WP_CACHE.
</span><span class="cx" style="display: block; padding: 0 10px"> wp_initial_constants();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Make sure we register the shutdown handler for fatal errors as soon as possible.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Register the shutdown handler for fatal errors as soon as possible.
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_register_fatal_error_handler();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // WordPress calculates offsets from UTC.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -70,13 +70,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Standardize $_SERVER variables across setups.
</span><span class="cx" style="display: block; padding: 0 10px"> wp_fix_server_vars();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Check if we're in maintenance mode.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Check if the site is in maintenance mode.
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_maintenance();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Start loading timer.
</span><span class="cx" style="display: block; padding: 0 10px"> timer_start();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Check if we're in WP_DEBUG mode.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Check if WP_DEBUG mode is enabled.
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_debug_mode();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,7 +145,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> register_shutdown_function( 'shutdown_action_hook' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Stop most of WordPress from being loaded if we just want the basics.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Stop most of WordPress from being loaded if SHORTINIT is enabled.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( SHORTINIT ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwptrackbackphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-trackback.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-trackback.php 2022-11-22 21:25:27 UTC (rev 54865)
+++ trunk/src/wp-trackback.php 2022-11-23 15:41:39 UTC (rev 54866)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,7 +76,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_name = mb_convert_encoding( $blog_name, get_option( 'blog_charset' ), $charset );
</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">-// Now that mb_convert_encoding() has been given a swing, we need to escape these three.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Escape values to use in the trackback.
</ins><span class="cx" style="display: block; padding: 0 10px"> $title = wp_slash( $title );
</span><span class="cx" style="display: block; padding: 0 10px"> $excerpt = wp_slash( $excerpt );
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_name = wp_slash( $blog_name );
</span></span></pre></div>
<a id="trunksrcxmlrpcphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/xmlrpc.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/xmlrpc.php 2022-11-22 21:25:27 UTC (rev 54865)
+++ trunk/src/xmlrpc.php 2022-11-23 15:41:39 UTC (rev 54866)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,7 +12,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> define( 'XMLRPC_REQUEST', true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Some browser-embedded clients send cookies. We don't want them.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Discard unneeded cookies sent by some browser-embedded clients.
</ins><span class="cx" style="display: block; padding: 0 10px"> $_COOKIE = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // $HTTP_RAW_POST_DATA was deprecated in PHP 5.6 and removed in PHP 7.0.
</span></span></pre>
</div>
</div>
</body>
</html>