<!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>[54470] trunk/src/wp-includes: Docs: Various improvements to inline docblocks.</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/54470">54470</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/54470","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>2022-10-11 09:00:33 +0000 (Tue, 11 Oct 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: Various improvements to inline docblocks.
See <a href="https://core.trac.wordpress.org/ticket/55646">#55646</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocktemplateutilsphp">trunk/src/wp-includes/block-template-utils.php</a></li>
<li><a href="#trunksrcwpincludesclasswpdependenciesphp">trunk/src/wp-includes/class-wp-dependencies.php</a></li>
<li><a href="#trunksrcwpincludescronphp">trunk/src/wp-includes/cron.php</a></li>
<li><a href="#trunksrcwpincludesfunctionswpscriptsphp">trunk/src/wp-includes/functions.wp-scripts.php</a></li>
<li><a href="#trunksrcwpincludesfunctionswpstylesphp">trunk/src/wp-includes/functions.wp-styles.php</a></li>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocktemplateutilsphp"></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/block-template-utils.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-template-utils.php 2022-10-11 08:46:00 UTC (rev 54469)
+++ trunk/src/wp-includes/block-template-utils.php 2022-10-11 09:00:33 UTC (rev 54470)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1138,11 +1138,11 @@
</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">- * Prints a template-part.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prints a block template part.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.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 $part The template-part to print. Use "header" or "footer".
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $part The block template part to print. Use "header" or "footer".
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function block_template_part( $part ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $template_part = get_block_template( get_stylesheet() . '//' . $part, 'wp_template_part' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1153,7 +1153,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">- * Prints the header template-part.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prints the header block template part.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1162,7 +1162,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">- * Prints the footer template-part.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prints the footer block template part.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpdependenciesphp"></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-dependencies.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-dependencies.php 2022-10-11 08:46:00 UTC (rev 54469)
+++ trunk/src/wp-includes/class-wp-dependencies.php 2022-10-11 09:00:33 UTC (rev 54470)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -239,7 +239,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0 Moved from `WP_Scripts`.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $handle Name of the item. Should be unique.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|bool $src Full URL of the item, or path of the item relative
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|false $src Full URL of the item, or path of the item relative
</ins><span class="cx" style="display: block; padding: 0 10px"> * to the WordPress root directory. If source is set to false,
</span><span class="cx" style="display: block; padding: 0 10px"> * item is an alias of other items it depends on.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $deps Optional. An array of registered item handles this item depends on.
</span></span></pre></div>
<a id="trunksrcwpincludescronphp"></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/cron.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/cron.php 2022-10-11 08:46:00 UTC (rev 54469)
+++ trunk/src/wp-includes/cron.php 2022-10-11 09:00:33 UTC (rev 54470)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,7 +8,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Schedules an event to run only once.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Schedules a hook which will be triggered by WordPress at the specified time.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Schedules a hook which will be triggered by WordPress at the specified UTC time.
</ins><span class="cx" style="display: block; padding: 0 10px"> * The action will trigger when someone visits your WordPress site if the scheduled
</span><span class="cx" style="display: block; padding: 0 10px"> * time has passed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -207,10 +207,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Valid values for the recurrence are 'hourly', 'daily', and 'twicedaily'. These can
</span><span class="cx" style="display: block; padding: 0 10px"> * be extended using the {@see 'cron_schedules'} filter in wp_get_schedules().
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Note that scheduling an event to occur within 10 minutes of an existing event
- * with the same action hook will be ignored unless you pass unique `$args` values
- * for each scheduled event.
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * Use wp_next_scheduled() to prevent duplicate events.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Use wp_schedule_single_event() to schedule a non-recurring event.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -317,7 +313,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Reschedules a recurring event.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Mainly for internal use, this takes the time stamp of a previously run
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Mainly for internal use, this takes the UTC timestamp of a previously run
</ins><span class="cx" style="display: block; padding: 0 10px"> * recurring event and reschedules it for its next run.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * To change upcoming scheduled events, use wp_schedule_event() to
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -383,7 +379,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * process, causing the function to return the filtered value instead.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * For plugins replacing wp-cron, return true if the event was successfully
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * rescheduled, false if not.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * rescheduled, false or a WP_Error if not.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -480,7 +476,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * process, causing the function to return the filtered value instead.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * For plugins replacing wp-cron, return true if the event was successfully
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * unscheduled, false if not.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * unscheduled, false or a WP_Error if not.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -561,7 +557,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * For plugins replacing wp-cron, return the number of events successfully
</span><span class="cx" style="display: block; padding: 0 10px"> * unscheduled (zero if no events were registered with the hook) or false
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * if unscheduling one or more events fails.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * or a WP_Error if unscheduling one or more events fails.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionswpscriptsphp"></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.wp-scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.wp-scripts.php 2022-10-11 08:46:00 UTC (rev 54469)
+++ trunk/src/wp-includes/functions.wp-scripts.php 2022-10-11 09:00:33 UTC (rev 54470)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -159,7 +159,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.3.0 A return value was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $handle Name of the script. Should be unique.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|bool $src Full URL of the script, or path of the script relative to the WordPress root directory.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|false $src Full URL of the script, or path of the script relative to the WordPress root directory.
</ins><span class="cx" style="display: block; padding: 0 10px"> * If source is set to false, script is an alias of other scripts it depends on.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $deps Optional. An array of registered script handles this script depends on. Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|bool|null $ver Optional. String specifying script version number, if it has one, which is added to the URL
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionswpstylesphp"></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.wp-styles.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.wp-styles.php 2022-10-11 08:46:00 UTC (rev 54469)
+++ trunk/src/wp-includes/functions.wp-styles.php 2022-10-11 09:00:33 UTC (rev 54470)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -114,7 +114,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.3.0 A return value was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $handle Name of the stylesheet. Should be unique.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|bool $src Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|false $src Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
</ins><span class="cx" style="display: block; padding: 0 10px"> * If source is set to false, stylesheet is an alias of other stylesheets it depends on.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $deps Optional. An array of registered stylesheet handles this stylesheet depends on. Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|bool|null $ver Optional. String specifying stylesheet version number, if it has one, which is added to the URL
</span></span></pre></div>
<a id="trunksrcwpincludesgeneraltemplatephp"></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/general-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/general-template.php 2022-10-11 08:46:00 UTC (rev 54469)
+++ trunk/src/wp-includes/general-template.php 2022-10-11 09:00:33 UTC (rev 54470)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4463,8 +4463,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $before_page_number A string to appear before the page number. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $after_page_number A string to append after the page number. Default empty.
</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 string|array|void String of page links or array of page links, depending on 'type' argument.
- * Void if total number of pages is less than 2.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string|string[]|void String of page links or array of page links, depending on 'type' argument.
+ * Void if total number of pages is less than 2.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function paginate_links( $args = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_query, $wp_rewrite;
</span></span></pre>
</div>
</div>
</body>
</html>