<!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>[49357] trunk/src/wp-includes/cron.php: Cron API: Improve the inline documentation for the args passed to the cron event scheduling functions.</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/49357">49357</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/49357","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-10-28 18:35:14 +0000 (Wed, 28 Oct 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'>Cron API: Improve the inline documentation for the args passed to the cron event scheduling functions.

Props chadreitsma, peterwilsoncc

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

<h3>Modified Paths</h3>

<ul>

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

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<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    2020-10-28 17:07:18 UTC (rev 49356)

+++ trunk/src/wp-includes/cron.php      2020-10-28 18:35:14 UTC (rev 49357)

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $timestamp  Unix timestamp (UTC) for when to next run the event.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $hook       Action hook to execute when the event is run.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array  $args       Optional. Array containing each separate argument to pass to the hook's callback function.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array  $args       Optional. Array containing arguments to pass to the

+ *                           hook's callback function. Each value in the array is passed

+ *                           to the callback as an individual parameter. The array keys

+ *                           are ignored. Default: empty array.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return bool True if event successfully scheduled. False for failure.

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

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

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

</span><span class="cx" style="display: block; padding: 0 10px">  * @link https://developer.wordpress.org/reference/functions/wp_schedule_event/

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

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $timestamp  Unix timestamp (UTC) for when to next run the event.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $recurrence How often the event should subsequently recur. See wp_get_schedules() for accepted values.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $recurrence How often the event should subsequently recur.

+ *                           See wp_get_schedules() for accepted values.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param string $hook       Action hook to execute when the event is run.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array  $args       Optional. Array containing each separate argument to pass to the hook's callback function.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array  $args       Optional. Array containing arguments to pass to the

+ *                           hook's callback function. Each value in the array is passed

+ *                           to the callback as an individual parameter. The array keys

+ *                           are ignored. Default: empty array.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return bool True if event successfully scheduled. False for failure.

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

</span><span class="cx" style="display: block; padding: 0 10px"> function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array() ) {

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

<span class="cx" style="display: block; padding: 0 10px">  *              {@see 'pre_reschedule_event'} filter added to short-circuit the function.

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

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $timestamp  Unix timestamp (UTC) for when the event was scheduled.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $recurrence How often the event should subsequently recur. See wp_get_schedules() for accepted values.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $recurrence How often the event should subsequently recur.

+ *                           See wp_get_schedules() for accepted values.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param string $hook       Action hook to execute when the event is run.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array  $args       Optional. Array containing each separate argument to pass to the hook's callback function.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array  $args       Optional. Array containing arguments to pass to the

+ *                           hook's callback function. Each value in the array is passed

+ *                           to the callback as an individual parameter. The array keys

+ *                           are ignored. Default: empty array.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return bool True if event successfully rescheduled. False for failure.

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

</span><span class="cx" style="display: block; padding: 0 10px"> function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() ) {

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

<span class="cx" style="display: block; padding: 0 10px">  *              {@see 'pre_clear_scheduled_hook'} filter added to short-circuit the function.

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

<span class="cx" style="display: block; padding: 0 10px">  * @param string $hook Action hook, the execution of which will be unscheduled.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array  $args Optional. Arguments that were to be passed to the hook's callback function.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array  $args Optional. Array containing each separate argument to pass to the hook's callback function.

+ *                     Although not passed to a callback, these arguments are used to uniquely identify the

+ *                     event, so they should be the same as those used when originally scheduling the event.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return int|false On success an integer indicating number of events unscheduled (0 indicates no

</span><span class="cx" style="display: block; padding: 0 10px">  *                   events were registered with the hook and arguments combination), false if

<span class="cx" style="display: block; padding: 0 10px">  *                   unscheduling one or more events fail.

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

</div>

</div>

</body>

</html>