<!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>[51916] trunk: Cron: Fix malformed cron array in `wp_schedule_single_event()` when `_get_cron_array()` returns `false`.</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/51916">51916</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/51916","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-10-18 12:51:00 +0000 (Mon, 18 Oct 2021)</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: Fix malformed cron array in `wp_schedule_single_event()` when `_get_cron_array()` returns `false`.
In `wp_schedule_single_event()`, the cron info array is retrieved via a call to `_get_cron_array()` and straight away cast to an array. But as the documentation for that function (correctly) states, the return type of that function is `array|false`, where `false` is returned for a site where no cron jobs have been scheduled (yet).
In the case that `_get_cron_array()` would return `false`, this would now unintentionally create an array with a single entry with key `0` and as the value `false`.
This is a bug. Fixed now by adding validation to the output of `_get_cron_array()` and initializing `$crons` to an empty array if `false` was returned.
Tests added first to prove the bug (a) was introduced in <a href="https://core.trac.wordpress.org/ticket/44818">#44818</a> <a href="https://core.trac.wordpress.org/changeset/44917">[44917]</a> and (b) is now fixed.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/44917">[44917]</a>.
Props jrf, peterwilsoncc.
Fixes <a href="https://core.trac.wordpress.org/ticket/53950">#53950</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescronphp">trunk/src/wp-includes/cron.php</a></li>
<li><a href="#trunktestsphpunittestscronphp">trunk/tests/phpunit/tests/cron.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 2021-10-18 11:13:32 UTC (rev 51915)
+++ trunk/src/wp-includes/cron.php 2021-10-18 12:51:00 UTC (rev 51916)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -118,7 +118,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * current time) all events scheduled within the next ten minutes
</span><span class="cx" style="display: block; padding: 0 10px"> * are considered duplicates.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $crons = (array) _get_cron_array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $crons = _get_cron_array();
+ if ( ! is_array( $crons ) ) {
+ $crons = array();
+ }
+
</ins><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="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<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 2021-10-18 11:13:32 UTC (rev 51915)
+++ trunk/tests/phpunit/tests/cron.php 2021-10-18 12:51:00 UTC (rev 51916)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,7 +100,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $recur, wp_get_schedule( $hook, $args ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Tests that a call to wp_schedule_event() on a site without any scheduled events
</span><span class="cx" style="display: block; padding: 0 10px"> * does not result in a PHP deprecation warning on PHP 8.1 or higher.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,6 +124,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( wp_schedule_event( $timestamp, 'daily', $hook ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Tests that a call to wp_schedule_single_event() on a site without any scheduled events
+ * does not result in the value "false" being added into the cron array.
+ *
+ * @ticket 53950
+ *
+ * @covers ::wp_schedule_single_event
+ */
+ function test_wp_schedule_single_event_without_cron_option() {
+ delete_option( 'cron' );
+
+ // Verify that the cause of the error is in place.
+ $this->assertFalse( _get_cron_array(), '_get_cron_array() does not return false' );
+
+ $hook = __FUNCTION__;
+ $timestamp = strtotime( '+10 minutes' );
+
+ // Add an event.
+ $this->assertTrue( wp_schedule_single_event( $timestamp, $hook ), 'Scheduling single event failed' );
+
+ // Verify that "false" is not a value in the final cron array.
+ $this->assertNotContains( false, get_option( 'cron' ), 'Resulting cron array contains the value "false"' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_unschedule_event() {
</span><span class="cx" style="display: block; padding: 0 10px"> // Schedule an event and make sure it's returned by wp_next_scheduled().
</span><span class="cx" style="display: block; padding: 0 10px"> $hook = __FUNCTION__;
</span></span></pre>
</div>
</div>
</body>
</html>