IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Various improvements to inline docblocks.

Browse Source 
See #55646

Built from https://develop.svn.wordpress.org/trunk@54470


git-svn-id: http://core.svn.wordpress.org/trunk@54029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn
2022-10-11 09:02:14 +00:00
parent 287a3c3120
commit f9db66d504
7 changed files with 15 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
wp-includes/cron.php
View File

@@ -8,7 +8,7 @@
/**
* Schedules an event to run only once.
*
* Schedules a hook which will be triggered by WordPress at the specified time.
* Schedules a hook which will be triggered by WordPress at the specified UTC time.
* The action will trigger when someone visits your WordPress site if the scheduled
* time has passed.
*
@@ -207,10 +207,6 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array(), $wp_error
* Valid values for the recurrence are 'hourly', 'daily', and 'twicedaily'. These can
* be extended using the {@see 'cron_schedules'} filter in wp_get_schedules().
*
* 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.
*
* Use wp_next_scheduled() to prevent duplicate events.
*
* Use wp_schedule_single_event() to schedule a non-recurring event.
@@ -317,7 +313,7 @@ function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array(), $wp
/**
* Reschedules a recurring event.
*
* Mainly for internal use, this takes the time stamp of a previously run
* Mainly for internal use, this takes the UTC timestamp of a previously run
* recurring event and reschedules it for its next run.
*
* To change upcoming scheduled events, use wp_schedule_event() to
@@ -383,7 +379,7 @@ function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array(), $
* process, causing the function to return the filtered value instead.
*
* For plugins replacing wp-cron, return true if the event was successfully
* rescheduled, false if not.
* rescheduled, false or a WP_Error if not.
*
* @since 5.1.0
* @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
@@ -480,7 +476,7 @@ function wp_unschedule_event( $timestamp, $hook, $args = array(), $wp_error = fa
* process, causing the function to return the filtered value instead.
*
* For plugins replacing wp-cron, return true if the event was successfully
* unscheduled, false if not.
* unscheduled, false or a WP_Error if not.
*
* @since 5.1.0
* @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
@@ -561,7 +557,7 @@ function wp_clear_scheduled_hook( $hook, $args = array(), $wp_error = false ) {
*
* 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.
* or a WP_Error if unscheduling one or more events fails.
*
* @since 5.1.0
* @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.