Changeset 53791

Timestamp:

07/29/2022 03:32:58 AM (2 years ago)

Author:

peterwilsoncc

Message:

Cron API: Modify _get_cron_array() to always return an array.

Change the return type of _get_cron_array() to an empty array if the cron option is either missing or of an
unexpected type.

This change ensures the return value for no registered events is consistently an empty array. Previously the return
value could be either an empty array or false.

Props thakkarhardik, jrf, costdev.
Fixes #53940.

Location:

trunk

Files:

• src/wp-includes/cron.php (modified) (4 diffs)
• tests/phpunit/tests/admin/wpMediaListTable.php (modified) (2 diffs)
• tests/phpunit/tests/cron.php (modified) (2 diffs)
• tests/phpunit/tests/cron/getCronArray.php (added)

trunk/src/wp-includes/cron.php

@@ -120 +120 @@
      */
     $crons = _get_cron_array();
-    if ( ! is_array( $crons ) ) {
-        $crons = array();
-    }
 
     $key       = md5( serialize( $event->args ) );
@@ -307 +304 @@
 
     $crons = _get_cron_array();
-    if ( ! is_array( $crons ) ) {
-        $crons = array();
-    }
 
     $crons[ $event->timestamp ][ $event->hook ][ $key ] = array(
@@ -1134 +1128 @@
 
     $crons = _get_cron_array();
-    if ( ! is_array( $crons ) ) {
-        return array();
-    }
 
     $gmt_time = microtime( true );
@@ -1163 +1154 @@
  *
  * @since 2.1.0
+ * @since 6.1.0 Return type modified to consistenty return an array.
  * @access private
  *
- * @return array[]|false Array of cron info arrays on success, false on failure.
+ * @return array[] Array of cron events.
  */
 function _get_cron_array() {
     $cron = get_option( 'cron' );
     if ( ! is_array( $cron ) ) {
-        return false;
+        return array();
     }
 

trunk/tests/phpunit/tests/admin/wpMediaListTable.php

@@ -25 +25 @@
      * @ticket 53949
      * @covers WP_Media_List_Table::prepare_items
+     * @group cron
      */
     public function test_prepare_items_without_cron_option_does_not_throw_warning() {
@@ -43 +44 @@
 
         // Verify that the cause of the error is in place.
-        $this->assertFalse( _get_cron_array(), '_get_cron_array() does not return false' );
+        $this->assertIsArray( _get_cron_array(), '_get_cron_array() does not return an array.' );
+        $this->assertEmpty( _get_cron_array(), '_get_cron_array() does not return an empty array.' );
 
         // If this test does not error out due to the PHP warning, we're good.

trunk/tests/phpunit/tests/cron.php

@@ -131 +131 @@
 
         // Verify that the cause of the error is in place.
-        $this->assertFalse( _get_cron_array(), '_get_cron_array() does not return false' );
+        $this->assertIsArray( _get_cron_array(), '_get_cron_array() does not return an array.' );
+        $this->assertEmpty( _get_cron_array(), '_get_cron_array() does not return an empty array.' );
 
         $hook      = __FUNCTION__;
@@ -152 +153 @@
 
         // Verify that the cause of the error is in place.
-        $this->assertFalse( _get_cron_array(), '_get_cron_array() does not return false' );
+        $this->assertIsArray( _get_cron_array(), '_get_cron_array() does not return an array.' );
+        $this->assertEmpty( _get_cron_array(), '_get_cron_array() does not return an empty array.' );
 
         $hook      = __FUNCTION__;