WordPress.org

Make WordPress Core


Ignore:
Timestamp:
12/30/2018 04:50:08 AM (10 months ago)
Author:
peterwilsoncc
Message:

Docs: Correct @see syntax for Cron API changes.

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

Props coffee2code.
Fixes #45445.

File:
1 edited

Legend:

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

    r44324 r44374  
    2323 * @since 2.1.0
    2424 * @since 5.1.0 Return value modified to boolean indicating success or failure,
    25  *              {@see pre_schedule_event} filter added to short-circuit the function.
     25 *              {@see 'pre_schedule_event'} filter added to short-circuit the function.
    2626 *
    2727 * @link https://codex.wordpress.org/Function_Reference/wp_schedule_single_event
     
    5353     * Both single events and recurring events are passed through this filter;
    5454     * single events have `$event->schedule` as false, whereas recurring events
    55      * have this set to a recurrence from {@see wp_get_schedules}. Recurring
     55     * have this set to a recurrence from wp_get_schedules(). Recurring
    5656     * events also have the integer recurrence interval set as `$event->interval`.
    5757     *
    5858     * For plugins replacing wp-cron, it is recommended you check for an
    59      * identical event within ten minutes and apply the {@see schedule_event}
     59     * identical event within ten minutes and apply the {@see 'schedule_event'}
    6060     * filter to check if another plugin has disallowed the event before scheduling.
    6161     *
     
    139139 * @since 2.1.0
    140140 * @since 5.1.0 Return value modified to boolean indicating success or failure,
    141  *              {@see pre_schedule_event} filter added to short-circuit the function.
     141 *              {@see 'pre_schedule_event'} filter added to short-circuit the function.
    142142 *
    143143 * @link https://codex.wordpress.org/Function_Reference/wp_schedule_event
     
    201201 * recurring event and reschedules it for its next run.
    202202 *
    203  * To change upcoming scheduled events, use {@see wp_schedule_event} to
     203 * To change upcoming scheduled events, use wp_schedule_event() to
    204204 * change the recurrence frequency.
    205205 *
    206206 * @since 2.1.0
    207207 * @since 5.1.0 Return value modified to boolean indicating success or failure,
    208  *              {@see pre_reschedule_event} filter added to short-circuit the function.
     208 *              {@see 'pre_reschedule_event'} filter added to short-circuit the function.
    209209 *
    210210 * @param int    $timestamp  Unix timestamp (UTC) for when the event was scheduled.
     
    295295 * @since 2.1.0
    296296 * @since 5.1.0 Return value modified to boolean indicating success or failure,
    297  *              {@see pre_unschedule_event} filter added to short-circuit the function.
     297 *              {@see 'pre_unschedule_event'} filter added to short-circuit the function.
    298298 *
    299299 * @param int    $timestamp Unix timestamp (UTC) of the event.
     
    353353 * @since 2.1.0
    354354 * @since 5.1.0 Return value modified to indicate success or failure,
    355  *              {@see pre_clear_scheduled_hook} filter added to short-circuit the function.
     355 *              {@see 'pre_clear_scheduled_hook'} filter added to short-circuit the function.
    356356 *
    357357 * @param string $hook Action hook, the execution of which will be unscheduled.
     
    552552 *
    553553 * @since 2.1.0
    554  * @since 5.0.0 {@see pre_next_scheduled} and {@see next_scheduled} filters added.
     554 * @since 5.0.0 {@see 'pre_next_scheduled'} and {@see 'next_scheduled'} filters added.
    555555 *
    556556 * @param string $hook Action hook of the event.
     
    829829 *
    830830 * @since 2.1.0
    831  * @since 5.0.0 {@see get_schedule} filter added.
     831 * @since 5.0.0 {@see 'get_schedule'} filter added.
    832832 *
    833833 * @param string $hook Action hook to identify the event.
     
    886886 *
    887887 * @since 2.1.0
    888  * @since 5.1.0 Return value modified to outcome of {@see update_option}.
     888 * @since 5.1.0 Return value modified to outcome of update_option().
    889889 *
    890890 * @access private
Note: See TracChangeset for help on using the changeset viewer.