Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-22 17:18:32 +01:00
Code Issues Projects Releases Wiki Activity

Docs: Correct @see syntax for Cron API changes.

Browse Source 
Fixes documentation errors introduced in  [43540], [43050] and [43608].

Props coffee2code.
Fixes #45445.


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


git-svn-id: http://core.svn.wordpress.org/trunk@44204 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Peter Wilson 2018-12-30 04:51:51 +00:00
parent 9b0c0c7201
commit 4ae9b553c5
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
wp-includes/cron.php
View File

@ -22,7 +22,7 @@
*
* @since 2.1.0
* @since 5.1.0 Return value modified to boolean indicating success or failure,
* {@see pre_schedule_event} filter added to short-circuit the function.
* {@see 'pre_schedule_event'} filter added to short-circuit the function.
*
* @link https://codex.wordpress.org/Function_Reference/wp_schedule_single_event
*
@ -52,11 +52,11 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array() ) {
*
* Both single events and recurring events are passed through this filter;
* single events have `$event->schedule` as false, whereas recurring events
* have this set to a recurrence from {@see wp_get_schedules}. Recurring
* have this set to a recurrence from wp_get_schedules(). Recurring
* events also have the integer recurrence interval set as `$event->interval`.
*
* For plugins replacing wp-cron, it is recommended you check for an
* identical event within ten minutes and apply the {@see schedule_event}
* identical event within ten minutes and apply the {@see 'schedule_event'}
* filter to check if another plugin has disallowed the event before scheduling.
*
* Return true if the event was scheduled, false if not.
@ -138,7 +138,7 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array() ) {
*
* @since 2.1.0
* @since 5.1.0 Return value modified to boolean indicating success or failure,
* {@see pre_schedule_event} filter added to short-circuit the function.
* {@see 'pre_schedule_event'} filter added to short-circuit the function.
*
* @link https://codex.wordpress.org/Function_Reference/wp_schedule_event
*
@ -200,12 +200,12 @@ function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array() ) {
* Mainly for internal use, this takes the time stamp of a previously run
* recurring event and reschedules it for its next run.
*
* To change upcoming scheduled events, use {@see wp_schedule_event} to
* To change upcoming scheduled events, use wp_schedule_event() to
* change the recurrence frequency.
*
* @since 2.1.0
* @since 5.1.0 Return value modified to boolean indicating success or failure,
* {@see pre_reschedule_event} filter added to short-circuit the function.
* {@see 'pre_reschedule_event'} filter added to short-circuit the function.
*
* @param int $timestamp Unix timestamp (UTC) for when the event was scheduled.
* @param string $recurrence How often the event should subsequently recur. See wp_get_schedules() for accepted values.
@ -294,7 +294,7 @@ function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() )
*
* @since 2.1.0
* @since 5.1.0 Return value modified to boolean indicating success or failure,
* {@see pre_unschedule_event} filter added to short-circuit the function.
* {@see 'pre_unschedule_event'} filter added to short-circuit the function.
*
* @param int $timestamp Unix timestamp (UTC) of the event.
* @param string $hook Action hook of the event.
@ -352,7 +352,7 @@ function wp_unschedule_event( $timestamp, $hook, $args = array() ) {
*
* @since 2.1.0
* @since 5.1.0 Return value modified to indicate success or failure,
* {@see pre_clear_scheduled_hook} filter added to short-circuit the function.
* {@see 'pre_clear_scheduled_hook'} filter added to short-circuit the function.
*
* @param string $hook Action hook, the execution of which will be unscheduled.
* @param array $args Optional. Arguments that were to be passed to the hook's callback function.
@ -551,7 +551,7 @@ function wp_get_scheduled_event( $hook, $args = array(), $timestamp = null ) {
* Retrieve the next timestamp for an event.
*
* @since 2.1.0
* @since 5.0.0 {@see pre_next_scheduled} and {@see next_scheduled} filters added.
* @since 5.0.0 {@see 'pre_next_scheduled'} and {@see 'next_scheduled'} filters added.
*
* @param string $hook Action hook of the event.
* @param array $args Optional. Array containing each separate argument to pass to the hook's callback function.
@ -828,7 +828,7 @@ function wp_get_schedules() {
* @see wp_get_schedules() for available schedules.
*
* @since 2.1.0
* @since 5.0.0 {@see get_schedule} filter added.
* @since 5.0.0 {@see 'get_schedule'} filter added.
*
* @param string $hook Action hook to identify the event.
* @param array $args Optional. Arguments passed to the event's callback function.
@ -885,7 +885,7 @@ function _get_cron_array() {
* Updates the CRON option with the new CRON array.
*
* @since 2.1.0
* @since 5.1.0 Return value modified to outcome of {@see update_option}.
* @since 5.1.0 Return value modified to outcome of update_option().
*
* @access private
*

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.1-alpha-44373';
$wp_version = '5.1-alpha-44374';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.