WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
08/18/2023 05:27:16 PM (3 years ago)
Author:
johnbillion
Message:

Docs: Miscellaneous docblock corrections and improvements.

See #58833

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/cron.php

    r56394 r56414  
    5858
    5959        /**
    60          * Filter to preflight or hijack scheduling an event.
     60         * Filter to override scheduling an event.
    6161         *
    6262         * Returning a non-null value will short-circuit adding the event to the
    … …  
    377377
    378378        /**
    379          * Filter to preflight or hijack rescheduling of a recurring event.
     379         * Filter to override rescheduling of a recurring event.
    380380         *
    381381         * Returning a non-null value will short-circuit the normal rescheduling
    … …  
    474474
    475475        /**
    476          * Filter to preflight or hijack unscheduling of events.
     476         * Filter to override unscheduling of events.
    477477         *
    478478         * Returning a non-null value will short-circuit the normal unscheduling
    … …  
    527527 * Unschedules all events attached to the hook with the specified arguments.
    528528 *
    529  * Warning: This function may return Boolean FALSE, but may also return a non-Boolean
    530  * value which evaluates to FALSE. For information about casting to booleans see the
     529 * Warning: This function may return boolean false, but may also return a non-boolean
     530 * value which evaluates to false. For information about casting to booleans see the
    531531 * {@link https://www.php.net/manual/en/language.types.boolean.php PHP documentation}. Use
    532532 * the `===` operator for testing the return value of this function.
    … …  
    564564
    565565        /**
    566          * Filter to preflight or hijack clearing a scheduled hook.
     566         * Filter to override clearing a scheduled hook.
    567567         *
    568568         * Returning a non-null value will short-circuit the normal unscheduling
    … …  
    638638 * Can be useful for plugins when deactivating to clean up the cron queue.
    639639 *
    640  * Warning: This function may return Boolean FALSE, but may also return a non-Boolean
    641  * value which evaluates to FALSE. For information about casting to booleans see the
     640 * Warning: This function may return boolean false, but may also return a non-boolean
     641 * value which evaluates to false. For information about casting to booleans see the
    642642 * {@link https://www.php.net/manual/en/language.types.boolean.php PHP documentation}. Use
    643643 * the `===` operator for testing the return value of this function.
    … …  
    654654function wp_unschedule_hook( $hook, $wp_error = false ) {
    655655        /**
    656          * Filter to preflight or hijack clearing all events attached to the hook.
     656         * Filter to override clearing all events attached to the hook.
    657657         *
    658658         * Returning a non-null value will short-circuit the normal unscheduling
    … …  
    750750function wp_get_scheduled_event( $hook, $args = array(), $timestamp = null ) {
    751751        /**
    752          * Filter to preflight or hijack retrieving a scheduled event.
     752         * Filter to override retrieving a scheduled event.
    753753         *
    754754         * Returning a non-null value will short-circuit the normal process,
    … …  
    966966 * @since 5.7.0 Functionality moved to _wp_cron() to which this becomes a wrapper.
    967967 *
    968  * @return bool|int|void On success an integer indicating number of events spawned (0 indicates no
    969  *                       events needed to be spawned), false if spawning fails for one or more events or
    970  *                       void if the function registered _wp_cron() to run on the action.
     968 * @return false|int|void On success an integer indicating number of events spawned (0 indicates no
     969 *                        events needed to be spawned), false if spawning fails for one or more events or
     970 *                        void if the function registered _wp_cron() to run on the action.
    971971 */
    972972function wp_cron() {
    … …  
    11611161function wp_get_ready_cron_jobs() {
    11621162        /**
    1163          * Filter to preflight or hijack retrieving ready cron jobs.
     1163         * Filter to override retrieving ready cron jobs.
    11641164         *
    11651165         * Returning an array will short-circuit the normal retrieval of ready
Note: See TracChangeset for help on using the changeset viewer.