<!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>[38357] trunk/src/wp-includes/cron.php: Cron: clarify descriptions for Cron API 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 { 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/38357">38357</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/38357","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-08-26 09:21:33 +0000 (Fri, 26 Aug 2016)</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: clarify descriptions for Cron API functions.
Props johnbillion.
Fixes <a href="https://core.trac.wordpress.org/ticket/37769">#37769</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 2016-08-25 19:41:42 UTC (rev 38356)
+++ trunk/src/wp-includes/cron.php 2016-08-26 09:21:33 UTC (rev 38357)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,28 +1,28 @@
</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">- * WordPress CRON API
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * WordPress Cron API
</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="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">- * Schedules a hook to run only once.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Schedules an event to run only once.
</ins><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 executed once by the WordPress actions core at
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Schedules an event which will execute once by the WordPress actions core at
</ins><span class="cx" style="display: block; padding: 0 10px"> * a time which you specify. The action will fire off when someone visits your
</span><span class="cx" style="display: block; padding: 0 10px"> * WordPress site, if the schedule time has passed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Note that scheduling an event to occur within 10 minutes of an existing event
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * with the same action hook will be ignored, unless you pass unique `$args` values
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * with the same action hook will be ignored unless you pass unique `$args` values
</ins><span class="cx" style="display: block; padding: 0 10px"> * for each scheduled event.
</span><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"> * @link https://codex.wordpress.org/Function_Reference/wp_schedule_single_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">- * @param int $timestamp Timestamp for when to run the event.
- * @param string $hook Action hook to execute when cron is run.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $timestamp Unix timestamp (UTC) for when to run the event.
+ * @param string $hook Action hook to execute when event is run.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. Arguments to pass to the hook's callback function.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return false|void False when an event is not scheduled.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return false|void False if the event does not get scheduled.
</ins><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="cx" style="display: block; padding: 0 10px"> // Make sure timestamp is a positive integer
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -43,7 +43,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.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 object $event An object containing an event's data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param stdClass $event {
+ * An object containing an event's data.
+ *
+ * @type string $hook Action hook to execute when event is run.
+ * @type int $timestamp Unix timestamp (UTC) for when to run the event.
+ * @type string|false $schedule How often the event should recur. See `wp_get_schedules()`.
+ * @type array $args Arguments to pass to the hook's callback function.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $event = apply_filters( 'schedule_event', $event );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -59,24 +66,24 @@
</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">- * Schedule a periodic event.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Schedule a recurring event.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Schedules a hook which will be executed by the WordPress actions core on a
</span><span class="cx" style="display: block; padding: 0 10px"> * specific interval, specified by you. The action will trigger when someone
</span><span class="cx" style="display: block; padding: 0 10px"> * visits your WordPress site, if the scheduled time has passed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Valid values for the recurrence are hourly, daily and twicedaily. These can
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Valid values for the recurrence are hourly, daily, and twicedaily. These can
</ins><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><span class="cx" style="display: block; padding: 0 10px"> * Use wp_next_scheduled() to prevent duplicates
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $timestamp Timestamp for when to run the event.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $timestamp Unix timestamp (UTC) for when to run the event.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $recurrence How often the event should recur.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $hook Action hook to execute when cron is run.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $hook Action hook to execute when event is run.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. Arguments to pass to the hook's callback function.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return false|void False when an event is not scheduled.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return false|void False if the event does not get scheduled.
</ins><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="cx" style="display: block; padding: 0 10px"> // Make sure timestamp is a positive integer
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -110,11 +117,11 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $timestamp Timestamp for when to run the event.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $timestamp Unix timestamp (UTC) for when to run the event.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $recurrence How often the event should recur.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $hook Action hook to execute when cron is run.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $hook Action hook to execute when event is run.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. Arguments to pass to the hook's callback function.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return false|void False when an event is not scheduled.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return false|void False if the event does not get rescheduled.
</ins><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="cx" style="display: block; padding: 0 10px"> // Make sure timestamp is a positive integer
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -152,20 +159,20 @@
</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">- * Unschedule a previously scheduled cron job.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Unschedule a previously scheduled event.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The $timestamp and $hook parameters are required, so that the event can be
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The $timestamp and $hook parameters are required so that the event can be
</ins><span class="cx" style="display: block; padding: 0 10px"> * identified.
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $timestamp Timestamp for when to run the event.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $timestamp Unix timestamp (UTC) for when to run the event.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $hook Action hook, the execution of which will be unscheduled.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Arguments to pass to the hook's callback function.
</span><span class="cx" style="display: block; padding: 0 10px"> * Although not passed to a callback function, these arguments are used
</span><span class="cx" style="display: block; padding: 0 10px"> * to uniquely identify the scheduled event, so they should be the same
</span><span class="cx" style="display: block; padding: 0 10px"> * as those used when originally scheduling the event.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return false|void False when an event is not unscheduled.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return false|void False if the event does not get unscheduled.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_unschedule_event( $timestamp, $hook, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Make sure timestamp is a positive integer
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -184,12 +191,12 @@
</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">- * Unschedule all cron jobs attached to a specific hook.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Unschedule all events attached to the specified hook.
</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 class="cx" style="display: block; padding: 0 10px"> * @param string $hook Action hook, the execution of which will be unscheduled.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Optional. Arguments that were to be 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. Arguments that were to be passed to the hook's callback function.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_clear_scheduled_hook( $hook, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Backward compatibility
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -215,13 +222,13 @@
</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">- * Retrieve the next timestamp for a cron event.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieve the next timestamp for an event.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $hook Action hook to execute when cron is run.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $hook Action hook to execute when event is run.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. Arguments to pass to the hook's callback function.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return false|int The UNIX timestamp of the next time the scheduled event will occur.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return false|int The Unix timestamp of the next time the scheduled event will occur.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_next_scheduled( $hook, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $crons = _get_cron_array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -240,7 +247,7 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $gmt_time Optional. Unix timestamp. Default 0 (current time is used).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $gmt_time Optional. Unix timestamp (UTC). Default 0 (current time is used).
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function spawn_cron( $gmt_time = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $gmt_time )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -250,7 +257,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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">- * Get the cron lock, which is a unix timestamp of when the last cron was spawned
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get the cron lock, which is a Unix timestamp of when the last cron was spawned
</ins><span class="cx" style="display: block; padding: 0 10px"> * and has not finished running.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Multiple processes on multiple web servers can run this code concurrently,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -364,11 +371,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">- * Retrieve supported and filtered Cron recurrences.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieve supported event recurrence schedules.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The supported recurrences are 'hourly' and 'daily'. A plugin may add more by
- * hooking into the {@see 'cron_schedules'} filter. The filter accepts an array of
- * arrays. The outer array has a key that is the name of the schedule or for
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The default supported recurrences are 'hourly', 'twicedaily', and 'daily'. A plugin may
+ * add more by hooking into the {@see 'cron_schedules'} filter. The filter accepts an array
+ * of arrays. The outer array has a key that is the name of the schedule or for
</ins><span class="cx" style="display: block; padding: 0 10px"> * example 'weekly'. The value is an array with two keys, one is 'interval' and
</span><span class="cx" style="display: block; padding: 0 10px"> * the other is 'display'.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -410,13 +417,15 @@
</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">- * Retrieve Cron schedule for hook with arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieve the recurrence schedule for an event.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see wp_get_schedules() for available schedules.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.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 $hook Action hook to execute when cron is run.
- * @param array $args Optional. Arguments to pass to the hook's callback function.
- * @return string|false False, if no schedule. Schedule on success.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $hook Action hook to identify the event.
+ * @param array $args Optional. Arguments passed to the event's callback function.
+ * @return string|false False, if no schedule. Schedule name on success.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_schedule($hook, $args = array()) {
</span><span class="cx" style="display: block; padding: 0 10px"> $crons = _get_cron_array();
</span></span></pre>
</div>
</div>
</body>
</html>