<!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>[53891] trunk: Query: Be better at forcing data types for query vars.</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/53891">53891</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/53891","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-08-13 22:29:19 +0000 (Sat, 13 Aug 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'>Query: Be better at forcing data types for query vars.
Several query vars only accept a scalar value and pass the value through functions that assume a scalar value. Adding extra guard conditions to the types of query vars doesn't affect their functionality but does remove PHP notices and warnings that can otherwise be generated when a non-scalar value such as an array is present in a query var.
Props juliobox, xknown, SergeyBiryukov, dave1010, nacin, tellyworth, dd32, audrasjb, johnregan3
Fixes <a href="https://core.trac.wordpress.org/ticket/17737">#17737</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpqueryphp">trunk/src/wp-includes/class-wp-query.php</a></li>
<li><a href="#trunktestsphpunittestsqueryparseQueryphp">trunk/tests/phpunit/tests/query/parseQuery.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpqueryphp"></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/class-wp-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-query.php 2022-08-13 12:09:41 UTC (rev 53890)
+++ trunk/src/wp-includes/class-wp-query.php 2022-08-13 22:29:19 UTC (rev 53891)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -792,29 +792,41 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $qv['p'] = (int) $qv['p'];
</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">- $qv['page_id'] = absint( $qv['page_id'] );
- $qv['year'] = absint( $qv['year'] );
- $qv['monthnum'] = absint( $qv['monthnum'] );
- $qv['day'] = absint( $qv['day'] );
- $qv['w'] = absint( $qv['w'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $qv['page_id'] = is_scalar( $qv['page_id'] ) ? absint( $qv['page_id'] ) : 0;
+ $qv['year'] = is_scalar( $qv['year'] ) ? absint( $qv['year'] ) : 0;
+ $qv['monthnum'] = is_scalar( $qv['monthnum'] ) ? absint( $qv['monthnum'] ) : 0;
+ $qv['day'] = is_scalar( $qv['day'] ) ? absint( $qv['day'] ) : 0;
+ $qv['w'] = is_scalar( $qv['w'] ) ? absint( $qv['w'] ) : 0;
</ins><span class="cx" style="display: block; padding: 0 10px"> $qv['m'] = is_scalar( $qv['m'] ) ? preg_replace( '|[^0-9]|', '', $qv['m'] ) : '';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $qv['paged'] = absint( $qv['paged'] );
- $qv['cat'] = preg_replace( '|[^0-9,-]|', '', $qv['cat'] ); // Comma-separated list of positive or negative integers.
- $qv['author'] = preg_replace( '|[^0-9,-]|', '', $qv['author'] ); // Comma-separated list of positive or negative integers.
- $qv['pagename'] = trim( $qv['pagename'] );
- $qv['name'] = trim( $qv['name'] );
- $qv['title'] = trim( $qv['title'] );
- if ( '' !== $qv['hour'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $qv['paged'] = is_scalar( $qv['paged'] ) ? absint( $qv['paged'] ) : 0;
+ $qv['cat'] = preg_replace( '|[^0-9,-]|', '', $qv['cat'] ); // Array or comma-separated list of positive or negative integers.
+ $qv['author'] = is_scalar( $qv['author'] ) ? preg_replace( '|[^0-9,-]|', '', $qv['author'] ) : ''; // Comma-separated list of positive or negative integers.
+ $qv['pagename'] = is_scalar( $qv['pagename'] ) ? trim( $qv['pagename'] ) : '';
+ $qv['name'] = is_scalar( $qv['name'] ) ? trim( $qv['name'] ) : '';
+ $qv['title'] = is_scalar( $qv['title'] ) ? trim( $qv['title'] ) : '';
+
+ if ( is_scalar( $qv['hour'] ) && '' !== $qv['hour'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $qv['hour'] = absint( $qv['hour'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ $qv['hour'] = '';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( '' !== $qv['minute'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( is_scalar( $qv['minute'] ) && '' !== $qv['minute'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $qv['minute'] = absint( $qv['minute'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ $qv['minute'] = '';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( '' !== $qv['second'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( is_scalar( $qv['second'] ) && '' !== $qv['second'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $qv['second'] = absint( $qv['second'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ $qv['second'] = '';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( '' !== $qv['menu_order'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( is_scalar( $qv['menu_order'] ) && '' !== $qv['menu_order'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $qv['menu_order'] = absint( $qv['menu_order'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ $qv['menu_order'] = '';
</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"> // Fairly large, potentially too large, upper bound for search string lengths.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -823,14 +835,14 @@
</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"> // Compat. Map subpost to attachment.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( '' != $qv['subpost'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_scalar( $qv['subpost'] ) && '' != $qv['subpost'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $qv['attachment'] = $qv['subpost'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( '' != $qv['subpost_id'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_scalar( $qv['subpost_id'] ) && '' != $qv['subpost_id'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $qv['attachment_id'] = $qv['subpost_id'];
</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">- $qv['attachment_id'] = absint( $qv['attachment_id'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $qv['attachment_id'] = is_scalar( $qv['attachment_id'] ) ? absint( $qv['attachment_id'] ) : 0;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ( '' !== $qv['attachment'] ) || ! empty( $qv['attachment_id'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->is_single = true;
</span></span></pre></div>
<a id="trunktestsphpunittestsqueryparseQueryphp"></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/query/parseQuery.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/parseQuery.php 2022-08-13 12:09:41 UTC (rev 53890)
+++ trunk/tests/phpunit/tests/query/parseQuery.php 2022-08-13 22:29:19 UTC (rev 53891)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -104,4 +104,133 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( '404', $q->query_vars['error'] );
</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">+ /**
+ * Ensure an array of authors is rejected.
+ *
+ * @ticket 17737
+ */
+ public function test_parse_query_author_array() {
+ $q = new WP_Query();
+ $q->parse_query(
+ array(
+ 'author' => array( 1, 2, 3 ),
+ )
+ );
+
+ $this->assertEmpty( $q->query_vars['author'] );
+ }
+
+ /**
+ * Ensure a non-scalar (non-numeric) author value is rejected.
+ *
+ * @ticket 17737
+ */
+ public function test_parse_query_author_string() {
+ $q = new WP_Query();
+ $q->parse_query(
+ array(
+ 'author' => 'admin',
+ )
+ );
+
+ $this->assertEmpty( $q->query_vars['author'] );
+ }
+
+ /**
+ * Ensure nonscalar 'cat' array values are rejected.
+ *
+ * Note the returned 'cat' query_var value is a string.
+ *
+ * @ticket 17737
+ */
+ public function test_parse_query_cat_array_mixed() {
+ $q = new WP_Query();
+ $q->parse_query(
+ array(
+ 'cat' => array( 1, 'uncategorized', '-1' ),
+ )
+ );
+
+ $this->assertSame( '1,-1', $q->query_vars['cat'] );
+ }
+
+ /**
+ * Ensure a nonscalar menu_order value is rejected.
+ *
+ * @ticket 17737
+ */
+ public function test_parse_query_menu_order_nonscalar() {
+ $q = new WP_Query();
+ $q->parse_query(
+ array(
+ 'menu_order' => array( 1 ),
+ )
+ );
+
+ $this->assertEmpty( $q->query_vars['menu_order'] );
+ }
+
+ /**
+ * Ensure numeric 'subpost' gets assigned to 'attachment'.
+ *
+ * @ticket 17737
+ */
+ public function test_parse_query_subpost_scalar() {
+ $q = new WP_Query();
+ $q->parse_query(
+ array(
+ 'subpost' => 1,
+ )
+ );
+
+ $this->assertSame( 1, $q->query_vars['attachment'] );
+ }
+
+ /**
+ * Ensure non-scalar 'subpost' does not get assigned to 'attachment'.
+ *
+ * @ticket 17737
+ */
+ public function test_parse_query_subpost_nonscalar() {
+ $q = new WP_Query();
+ $q->parse_query(
+ array(
+ 'subpost' => array( 1 ),
+ )
+ );
+
+ $this->assertEmpty( $q->query_vars['attachment'] );
+ }
+
+ /**
+ * Ensure numeric 'attachment_id' value is assigned.
+ *
+ * @ticket 17737
+ */
+ public function test_parse_query_attachment_id() {
+ $q = new WP_Query();
+ $q->parse_query(
+ array(
+ 'attachment_id' => 1,
+ )
+ );
+
+ $this->assertSame( 1, $q->query_vars['attachment_id'] );
+ }
+
+ /**
+ * Ensure non-scalar 'attachment_id' value is rejected.
+ *
+ * @ticket 17737
+ */
+ public function test_parse_query_attachment_id_nonscalar() {
+ $q = new WP_Query();
+ $q->parse_query(
+ array(
+ 'attachment_id' => array( 1 ),
+ )
+ );
+
+ $this->assertEmpty( $q->query_vars['attachment_id'] );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>