Changeset 52236 for trunk/src/wp-includes/cron.php

Timestamp:

11/23/2021 09:35:57 PM (3 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections and improvements.

See #53399

File:

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

trunk/src/wp-includes/cron.php

@@ -1114 +1114 @@
  * @since 5.1.0
  *
- * @return array Cron jobs ready to be run.
+ * @return array[] Array of cron job arrays ready to be run.
  */
 function wp_get_ready_cron_jobs() {
@@ -1125 +1125 @@
      * @since 5.1.0
      *
-     * @param null|array $pre Array of ready cron tasks to return instead. Default null
-     *                        to continue using results from _get_cron_array().
+     * @param null|array[] $pre Array of ready cron tasks to return instead. Default null
+     *                          to continue using results from _get_cron_array().
      */
     $pre = apply_filters( 'pre_get_ready_cron_jobs', null );
@@ -1165 +1165 @@
  * @access private
  *
- * @return array|false Cron info array on success, false on failure.
+ * @return array[]|false Array of cron info arrays on success, false on failure.
  */
 function _get_cron_array() {
@@ -1191 +1191 @@
  * @access private
  *
- * @param array $cron     Cron info array from _get_cron_array().
- * @param bool  $wp_error Optional. Whether to return a WP_Error on failure. Default false.
+ * @param array[] $cron     Array of cron info arrays from _get_cron_array().
+ * @param bool    $wp_error Optional. Whether to return a WP_Error on failure. Default false.
  * @return bool|WP_Error True if cron array updated. False or WP_Error on failure.
  */