Changeset 44374

Timestamp:

12/30/2018 04:50:08 AM (7 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:

• trunk/src/wp-includes/cron.php (modified) (9 diffs)

trunk/src/wp-includes/cron.php

@@ -23 +23 @@
  * @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
@@ -53 +53 @@
      * 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.
      *
@@ -139 +139 @@
  * @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
@@ -201 +201 @@
  * 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.
@@ -295 +295 @@
  * @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.
@@ -353 +353 @@
  * @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.
@@ -552 +552 @@
  *
  * @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.
@@ -829 +829 @@
  *
  * @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.
@@ -886 +886 @@
  *
  * @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