Make WordPress Core


Ignore:
Timestamp:
05/02/2024 01:17:45 PM (9 months ago)
Author:
johnbillion
Message:

Docs: Various docblock improvements.

See #60699

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/cron.php

    r57239 r58075  
    660660     *
    661661     * For plugins replacing wp-cron, return the number of events successfully
    662      * unscheduled (zero if no events were registered with the hook) or false
    663      * if unscheduling one or more events fails.
     662     * unscheduled (zero if no events were registered with the hook). If unscheduling
     663     * one or more events fails then return either a WP_Error object or false depending
     664     * on the value of the `$wp_error` parameter.
    664665     *
    665666     * @since 5.1.0
     
    10481049 *
    10491050 * The 'interval' is a number in seconds of when the cron job should run.
    1050  * So for 'hourly' the time is `HOUR_IN_SECONDS` (60 * 60 or 3600). For 'monthly',
    1051  * the value would be `MONTH_IN_SECONDS` (30 * 24 * 60 * 60 or 2592000).
     1051 * So for 'hourly' the time is `HOUR_IN_SECONDS` (`60 * 60` or `3600`). For 'monthly',
     1052 * the value would be `MONTH_IN_SECONDS` (`30 * 24 * 60 * 60` or `2592000`).
    10521053 *
    10531054 * The 'display' is the description. For the 'monthly' key, the 'display'
    10541055 * would be `__( 'Once Monthly' )`.
    10551056 *
    1056  * For your plugin, you will be passed an array. You can easily add your
    1057  * schedule by doing the following.
     1057 * For your plugin, you will be passed an array. You can add your
     1058 * schedule by doing the following:
    10581059 *
    10591060 *     // Filter parameter variable name is 'array'.
Note: See TracChangeset for help on using the changeset viewer.