summaryrefslogtreecommitdiffstats
path: root/wp-includes/cron.php
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-09-19 04:51:18 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-09-19 04:51:18 +0000
commit0e41b5d52fdc6af6442816b5f465c9db9f84e126 (patch)
treee139a90049b158d4eed892d1662ee7f5c358fa31 /wp-includes/cron.php
parentAdding upstream version 6.5.5+dfsg1. (diff)
downloadwordpress-upstream/6.6.1+dfsg1.tar.xz
wordpress-upstream/6.6.1+dfsg1.zip
Adding upstream version 6.6.1+dfsg1.upstream/6.6.1+dfsg1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--wp-includes/cron.php13
1 files changed, 7 insertions, 6 deletions
diff --git a/wp-includes/cron.php b/wp-includes/cron.php
index aadc22b..9371515 100644
--- a/wp-includes/cron.php
+++ b/wp-includes/cron.php
@@ -659,8 +659,9 @@ function wp_unschedule_hook( $hook, $wp_error = false ) {
* process, causing the function to return the filtered value instead.
*
* For plugins replacing wp-cron, return the number of events successfully
- * unscheduled (zero if no events were registered with the hook) or false
- * if unscheduling one or more events fails.
+ * unscheduled (zero if no events were registered with the hook). If unscheduling
+ * one or more events fails then return either a WP_Error object or false depending
+ * on the value of the `$wp_error` parameter.
*
* @since 5.1.0
* @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
@@ -1047,14 +1048,14 @@ function _wp_cron() {
* one is 'interval' and the other is 'display'.
*
* The 'interval' is a number in seconds of when the cron job should run.
- * So for 'hourly' the time is `HOUR_IN_SECONDS` (60 * 60 or 3600). For 'monthly',
- * the value would be `MONTH_IN_SECONDS` (30 * 24 * 60 * 60 or 2592000).
+ * So for 'hourly' the time is `HOUR_IN_SECONDS` (`60 * 60` or `3600`). For 'monthly',
+ * the value would be `MONTH_IN_SECONDS` (`30 * 24 * 60 * 60` or `2592000`).
*
* The 'display' is the description. For the 'monthly' key, the 'display'
* would be `__( 'Once Monthly' )`.
*
- * For your plugin, you will be passed an array. You can easily add your
- * schedule by doing the following.
+ * For your plugin, you will be passed an array. You can add your
+ * schedule by doing the following:
*
* // Filter parameter variable name is 'array'.
* $array['monthly'] = array(