<!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>[48695] trunk/src: Docs: Various fixes and improvements to inline documentation.</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/48695">48695</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/48695","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-07-30 19:12:02 +0000 (Thu, 30 Jul 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: Various fixes and improvements to inline documentation.
See <a href="https://core.trac.wordpress.org/ticket/49572">#49572</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpcronphp">trunk/src/wp-cron.php</a></li>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.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="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunksrcwpincludesrewritephp">trunk/src/wp-includes/rewrite.php</a></li>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.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 2020-07-30 14:00:59 UTC (rev 48694)
+++ trunk/src/wp-cron.php 2020-07-30 19:12:02 UTC (rev 48695)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,17 +1,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?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">- * A pseudo-CRON daemon for scheduling WordPress tasks
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * A pseudo-cron daemon for scheduling WordPress tasks.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * WP Cron is triggered when the site receives a visit. In the scenario
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * WP-Cron is triggered when the site receives a visit. In the scenario
</ins><span class="cx" style="display: block; padding: 0 10px"> * where a site may not receive enough visits to execute scheduled tasks
</span><span class="cx" style="display: block; padding: 0 10px"> * in a timely manner, this file can be called directly or via a server
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * CRON daemon for X number of times.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * cron daemon for X number of times.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Defining DISABLE_WP_CRON as true and calling this file directly are
</span><span class="cx" style="display: block; padding: 0 10px"> * mutually exclusive and the latter does not rely on the former to work.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The HTTP request to this file will not slow down the visitor who happens to
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * visit when the cron job is needed to run.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * visit when a scheduled cron event runs.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @package WordPress
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,7 +33,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 we are doing the cron task.
</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="trunksrcwpincludescommenttemplatephp"></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/comment-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment-template.php 2020-07-30 14:00:59 UTC (rev 48694)
+++ trunk/src/wp-includes/comment-template.php 2020-07-30 19:12:02 UTC (rev 48695)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2240,11 +2240,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Outputs a complete commenting form for use within a template.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Most strings and form fields may be controlled through the $args array passed
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Most strings and form fields may be controlled through the `$args` array passed
</ins><span class="cx" style="display: block; padding: 0 10px"> * into the function, while you may also choose to use the {@see 'comment_form_default_fields'}
</span><span class="cx" style="display: block; padding: 0 10px"> * filter to modify the array of default fields if you'd just like to add a new
</span><span class="cx" style="display: block; padding: 0 10px"> * one or remove a single field. All fields are also individually passed through
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * a filter of the {@see 'comment_form_field_$name'} where $name is the key used
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * a filter of the {@see 'comment_form_field_$name'} where `$name` is the key used
</ins><span class="cx" style="display: block; padding: 0 10px"> * in the array of fields.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span></span></pre></div>
<a id="trunksrcwpincludesdeprecatedphp"></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/deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/deprecated.php 2020-07-30 14:00:59 UTC (rev 48694)
+++ trunk/src/wp-includes/deprecated.php 2020-07-30 19:12:02 UTC (rev 48695)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3564,7 +3564,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Formats text for the rich text editor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The {@see 'richedit_pre'} filter is applied here. If $text is empty the filter will
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The {@see 'richedit_pre'} filter is applied here. If `$text` is empty the filter will
</ins><span class="cx" style="display: block; padding: 0 10px"> * be applied to an empty string.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span></span></pre></div>
<a id="trunksrcwpincludesembedphp"></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/embed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/embed.php 2020-07-30 14:00:59 UTC (rev 48694)
+++ trunk/src/wp-includes/embed.php 2020-07-30 19:12:02 UTC (rev 48695)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -993,7 +993,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">- * Enqueue embed iframe default CSS and JS & fire do_action('enqueue_embed_scripts')
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Enqueues embed iframe default CSS and JS.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Enqueue PNG fallback CSS for embed iframe for legacy versions of IE.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionsphp"></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/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2020-07-30 14:00:59 UTC (rev 48694)
+++ trunk/src/wp-includes/functions.php 2020-07-30 19:12:02 UTC (rev 48695)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6821,7 +6821,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Optional. Context in which the function is called. Accepts either 'admin',
</span><span class="cx" style="display: block; padding: 0 10px"> * 'image', or an arbitrary other context. If an arbitrary context is passed,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * the similarly arbitrary {@see '{$context}_memory_limit'} filter will be
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * the similarly arbitrary {@see '$context_memory_limit'} filter will be
</ins><span class="cx" style="display: block; padding: 0 10px"> * invoked. Default 'admin'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool|int|string The limit that was set or false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwpincludesrewritephp"></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/rewrite.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rewrite.php 2020-07-30 14:00:59 UTC (rev 48694)
+++ trunk/src/wp-includes/rewrite.php 2020-07-30 19:12:02 UTC (rev 48695)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -143,9 +143,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Add a new rewrite tag (like %postname%).
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The $query parameter is optional. If it is omitted you must ensure that
- * you call this on, or before, the {@see 'init'} hook. This is because $query defaults
- * to "$tag=", and for this to work a new query var has to be added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The `$query` parameter is optional. If it is omitted you must ensure that you call
+ * this on, or before, the {@see 'init'} hook. This is because `$query` defaults to
+ * `$tag=`, and for this to work a new query var has to be added.
</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><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunksrcwpincludestaxonomyphp"></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/taxonomy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy.php 2020-07-30 14:00:59 UTC (rev 48694)
+++ trunk/src/wp-includes/taxonomy.php 2020-07-30 19:12:02 UTC (rev 48695)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2407,6 +2407,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires immediately after a new term is created, before the term cache is cleaned.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The {@see 'create_$taxonomy'} hook is also available for targeting a specific
+ * taxonomy.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $term_id Term ID.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2443,6 +2446,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires after a new term is created, and after the term cache has been cleaned.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The {@see 'created_$taxonomy'} hook is also available for targeting a specific
+ * taxonomy.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $term_id Term ID.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2467,6 +2473,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires after a term has been saved, and the term cache has been cleared.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The {@see 'saved_$taxonomy'} hook is also available for targeting a specific
+ * taxonomy.
+ *
</ins><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="cx" style="display: block; padding: 0 10px"> * @param int $term_id Term ID.
</span></span></pre>
</div>
</div>
</body>
</html>