Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-11-12 13:44:21 +01:00
Code Issues Projects Releases Wiki Activity

Docs: Correct inline documentation versions.

Browse Source 
[43050] updated the Cron API to return values indicating success or failure when called.

At the time, these changes were slated for 5.0, but have since been moved to the 5.1 release. This updates the inline documentation to reflect that.

Fixes #21072.
Built from https://develop.svn.wordpress.org/trunk@44324


git-svn-id: http://core.svn.wordpress.org/trunk@44154 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
desrosj 2018-12-19 03:41:49 +00:00
parent fc094984ea
commit eef048a3e8
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
wp-includes/cron.php
View File

@ -21,7 +21,7 @@
* Use wp_schedule_event() to schedule a recurring event.
*
* @since 2.1.0
* @since 5.0.0 Return value modified to boolean indicating success or failure,
* @since 5.1.0 Return value modified to boolean indicating success or failure,
* {@see pre_schedule_event} filter added to short-circuit the function.
*
* @link https://codex.wordpress.org/Function_Reference/wp_schedule_single_event
@ -137,7 +137,7 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array() ) {
* Use wp_schedule_single_event() to schedule a non-recurring event.
*
* @since 2.1.0
* @since 5.0.0 Return value modified to boolean indicating success or failure,
* @since 5.1.0 Return value modified to boolean indicating success or failure,
* {@see pre_schedule_event} filter added to short-circuit the function.
*
* @link https://codex.wordpress.org/Function_Reference/wp_schedule_event
@ -204,7 +204,7 @@ function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array() ) {
* change the recurrence frequency.
*
* @since 2.1.0
* @since 5.0.0 Return value modified to boolean indicating success or failure,
* @since 5.1.0 Return value modified to boolean indicating success or failure,
* {@see pre_reschedule_event} filter added to short-circuit the function.
*
* @param int $timestamp Unix timestamp (UTC) for when the event was scheduled.
@ -293,7 +293,7 @@ function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() )
* identified.
*
* @since 2.1.0
* @since 5.0.0 Return value modified to boolean indicating success or failure,
* @since 5.1.0 Return value modified to boolean indicating success or failure,
* {@see pre_unschedule_event} filter added to short-circuit the function.
*
* @param int $timestamp Unix timestamp (UTC) of the event.
@ -351,7 +351,7 @@ function wp_unschedule_event( $timestamp, $hook, $args = array() ) {
* the `===` operator for testing the return value of this function.
*
* @since 2.1.0
* @since 5.0.0 Return value modified to indicate success or failure,
* @since 5.1.0 Return value modified to indicate success or failure,
* {@see pre_clear_scheduled_hook} filter added to short-circuit the function.
*
* @param string $hook Action hook, the execution of which will be unscheduled.
@ -421,7 +421,7 @@ function wp_clear_scheduled_hook( $hook, $args = array() ) {
* the `===` operator for testing the return value of this function.
*
* @since 4.9.0
* @since 5.0.0 Return value added to indicate success or failure.
* @since 5.1.0 Return value added to indicate success or failure.
*
* @param string $hook Action hook, the execution of which will be unscheduled.
* @return bool|int On success an integer indicating number of events unscheduled (0 indicates no
@ -608,7 +608,7 @@ function wp_next_scheduled( $hook, $args = array() ) {
* Sends a request to run cron through HTTP request that doesn't halt page loading.
*
* @since 2.1.0
* @since 5.0.0 Return values added.
* @since 5.1.0 Return values added.
*
* @param int $gmt_time Optional. Unix timestamp (UTC). Default 0 (current time is used).
* @return bool True if spawned, false if no events spawned.
@ -725,7 +725,7 @@ function spawn_cron( $gmt_time = 0 ) {
* the `===` operator for testing the return value of this function.
*
* @since 2.1.0
* @since 5.0.0 Return value added to indicate success or failure.
* @since 5.1.0 Return value added to indicate success or failure.
*
* @return bool|int On success an integer indicating number of events spawned (0 indicates no
* events needed to be spawned), false if spawning fails for one or more events.
@ -885,7 +885,7 @@ function _get_cron_array() {
* Updates the CRON option with the new CRON array.
*
* @since 2.1.0
* @since 5.0.0 Return value modified to outcome of {@see update_option}.
* @since 5.1.0 Return value modified to outcome of {@see update_option}.
*
* @access private
*

2
wp-includes/version.php
View File

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