<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[53791] trunk: Cron API: Modify `_get_cron_array()` to always return an array.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/53791">53791</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/53791","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-07-29 03:32:58 +0000 (Fri, 29 Jul 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/53940">#53940</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescronphp">trunk/src/wp-includes/cron.php</a></li>
<li><a href="#trunktestsphpunittestsadminwpMediaListTablephp">trunk/tests/phpunit/tests/admin/wpMediaListTable.php</a></li>
<li><a href="#trunktestsphpunittestscronphp">trunk/tests/phpunit/tests/cron.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestscrongetCronArrayphp">trunk/tests/phpunit/tests/cron/getCronArray.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescronphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/cron.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/cron.php 2022-07-28 22:37:00 UTC (rev 53790)
+++ trunk/src/wp-includes/cron.php 2022-07-29 03:32:58 UTC (rev 53791)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,9 +119,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * are considered duplicates.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $crons = _get_cron_array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! is_array( $crons ) ) {
- $crons = array();
- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $key = md5( serialize( $event->args ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $duplicate = false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -306,9 +303,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $key = md5( serialize( $event->args ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $crons = _get_cron_array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! is_array( $crons ) ) {
- $crons = array();
- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $crons[ $event->timestamp ][ $event->hook ][ $key ] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'schedule' => $event->schedule,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1133,9 +1127,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $crons = _get_cron_array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! is_array( $crons ) ) {
- return array();
- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $gmt_time = microtime( true );
</span><span class="cx" style="display: block; padding: 0 10px"> $keys = array_keys( $crons );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1162,14 +1153,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieve cron info array option.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.1.0 Return type modified to consistenty return an array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array[]|false Array of cron info arrays on success, false on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array[] Array of cron events.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _get_cron_array() {
</span><span class="cx" style="display: block; padding: 0 10px"> $cron = get_option( 'cron' );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $cron ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return array();
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $cron['version'] ) ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsadminwpMediaListTablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/admin/wpMediaListTable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/wpMediaListTable.php 2022-07-28 22:37:00 UTC (rev 53790)
+++ trunk/tests/phpunit/tests/admin/wpMediaListTable.php 2022-07-29 03:32:58 UTC (rev 53791)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24,6 +24,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 53949
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers WP_Media_List_Table::prepare_items
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group cron
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_prepare_items_without_cron_option_does_not_throw_warning() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_query;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -42,7 +43,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> delete_option( 'cron' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Verify that the cause of the error is in place.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertFalse( _get_cron_array(), '_get_cron_array() does not return false' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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.' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If this test does not error out due to the PHP warning, we're good.
</span><span class="cx" style="display: block; padding: 0 10px"> $mock->prepare_items();
</span></span></pre></div>
<a id="trunktestsphpunittestscrongetCronArrayphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/cron/getCronArray.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/cron/getCronArray.php (rev 0)
+++ trunk/tests/phpunit/tests/cron/getCronArray.php 2022-07-29 03:32:58 UTC (rev 53791)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,120 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Test the `_get_cron_array()` function.
+ *
+ * @group cron
+ * @covers ::_get_cron_array
+ */
+class Tests_Cron_getCronArray extends WP_UnitTestCase {
+
+ public function set_up() {
+ parent::set_up();
+ // Make sure the schedule is clear.
+ _set_cron_array( array() );
+ }
+
+ public function tear_down() {
+ // Make sure the schedule is clear.
+ _set_cron_array( array() );
+ parent::tear_down();
+ }
+
+ /**
+ * Tests the output validation for the `_get_cron_array()` function when the option is unset.
+ *
+ * @ticket 53940
+ */
+ public function test_get_cron_array_output_validation_with_no_option() {
+ delete_option( 'cron' );
+
+ $crons = _get_cron_array();
+ $this->assertIsArray( $crons, 'Cron jobs is not an array.' );
+ $this->assertCount( 0, $crons, 'Cron job does not contain the expected number of entries.' );
+ }
+
+ /**
+ * Tests the output validation for the `_get_cron_array()` function.
+ *
+ * @ticket 53940
+ *
+ * @dataProvider data_get_cron_array_output_validation
+ *
+ * @param mixed $input Cron "array".
+ * @param int $expected Expected array entry count of the cron option after update.
+ */
+ public function test_get_cron_array_output_validation( $input, $expected ) {
+ update_option( 'cron', $input );
+
+ $crons = _get_cron_array();
+ $this->assertIsArray( $crons, 'Cron jobs is not an array.' );
+ $this->assertCount( $expected, $crons, 'Cron job does not contain the expected number of entries.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_get_cron_array_output_validation() {
+ return array(
+ 'stdClass' => array(
+ 'input' => new stdClass(),
+ 'expected' => 0,
+ ),
+ 'null' => array(
+ 'input' => null,
+ 'expected' => 0,
+ ),
+ 'false' => array(
+ 'input' => false,
+ 'expected' => 0,
+ ),
+ 'true' => array(
+ 'input' => true,
+ 'expected' => 0,
+ ),
+ 'integer' => array(
+ 'input' => 53940,
+ 'expected' => 0,
+ ),
+ 'float' => array(
+ 'input' => 539.40,
+ 'expected' => 0,
+ ),
+ 'string' => array(
+ 'input' => 'ticket 53940',
+ 'expected' => 0,
+ ),
+ 'empty array' => array(
+ 'input' => array(),
+ 'expected' => 0,
+ ),
+ 'cron array' => array(
+ 'input' => array(
+ 'version' => 2,
+ time() => array(
+ 'hookname' => array(
+ 'event key' => array(
+ 'schedule' => 'schedule',
+ 'args' => 'args',
+ 'interval' => 'interval',
+ ),
+ ),
+ ),
+ ),
+ 'expected' => 1,
+ ),
+ 'cron v1' => array(
+ 'input' => array(
+ time() => array(
+ 'hookname' => array(
+ 'args' => 'args',
+ ),
+ ),
+ ),
+ 'expected' => 1,
+ ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/cron/getCronArray.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestscronphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/cron.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/cron.php 2022-07-28 22:37:00 UTC (rev 53790)
+++ trunk/tests/phpunit/tests/cron.php 2022-07-29 03:32:58 UTC (rev 53791)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -130,7 +130,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> delete_option( 'cron' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Verify that the cause of the error is in place.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertFalse( _get_cron_array(), '_get_cron_array() does not return false' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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.' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $hook = __FUNCTION__;
</span><span class="cx" style="display: block; padding: 0 10px"> $timestamp = strtotime( '+10 minutes' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -151,7 +152,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> delete_option( 'cron' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Verify that the cause of the error is in place.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertFalse( _get_cron_array(), '_get_cron_array() does not return false' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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.' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $hook = __FUNCTION__;
</span><span class="cx" style="display: block; padding: 0 10px"> $timestamp = strtotime( '+10 minutes' );
</span></span></pre>
</div>
</div>
</body>
</html>