<!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>[56638] trunk: General: Account for `Sec-CH-UA-Mobile` client hint request header in `wp_is_mobile()`.</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/56638">56638</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/56638","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-20 20:49:12 +0000 (Wed, 20 Sep 2023)</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'>General: Account for `Sec-CH-UA-Mobile` client hint request header in `wp_is_mobile()`.
Add missing test coverage for `wp_is_mobile()`.
Fixes <a href="https://core.trac.wordpress.org/ticket/59370">#59370</a>.
Props westonruter, flixos90.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesvarsphp">trunk/src/wp-includes/vars.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsvarsphp">trunk/tests/phpunit/tests/vars.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesvarsphp"></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/vars.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/vars.php 2023-09-20 19:29:30 UTC (rev 56637)
+++ trunk/src/wp-includes/vars.php 2023-09-20 20:49:12 UTC (rev 56638)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -144,11 +144,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Test if the current browser runs on a mobile device (smart phone, tablet, etc.)
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.4.0 Added checking for the Sec-CH-UA-Mobile request header.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_is_mobile() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $_SERVER['HTTP_USER_AGENT'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $_SERVER['HTTP_SEC_CH_UA_MOBILE'] ) ) {
+ // This is the `Sec-CH-UA-Mobile` user agent client hint HTTP request header.
+ // See <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-CH-UA-Mobile>.
+ $is_mobile = ( '?1' === $_SERVER['HTTP_SEC_CH_UA_MOBILE'] );
+ } elseif ( empty( $_SERVER['HTTP_USER_AGENT'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $is_mobile = false;
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( str_contains( $_SERVER['HTTP_USER_AGENT'], 'Mobile' ) // Many mobile devices (all iPhone, iPad, etc.)
</span><span class="cx" style="display: block; padding: 0 10px"> || str_contains( $_SERVER['HTTP_USER_AGENT'], 'Android' )
</span></span></pre></div>
<a id="trunktestsphpunittestsvarsphp"></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/vars.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/vars.php (rev 0)
+++ trunk/tests/phpunit/tests/vars.php 2023-09-20 20:49:12 UTC (rev 56638)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,147 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test functions in wp-includes/vars.php
+ *
+ * @group vars.php
+ */
+class Tests_Vars extends WP_UnitTestCase {
+
+ /**
+ * Backup of $_SERVER.
+ *
+ * @var array
+ */
+ protected $server_vars = array();
+
+ /**
+ * Set up.
+ */
+ public function set_up() {
+ $this->server_vars = $_SERVER;
+ parent::set_up();
+ }
+
+ /**
+ * Tear down.
+ */
+ public function tear_down() {
+ $_SERVER = $this->server_vars;
+ parent::tear_down();
+ }
+
+ /**
+ * Data provider to test wp_is_mobile().
+ *
+ * @return array
+ */
+ function get_data_to_test_wp_is_mobile(): array {
+ return array(
+ 'mobile client hint' => array(
+ 'headers' => array(
+ 'HTTP_SEC_CH_UA_MOBILE' => '?1',
+ ),
+ 'expected' => true,
+ ),
+ 'desktop client hint' => array(
+ 'headers' => array(
+ 'HTTP_SEC_CH_UA_MOBILE' => '?0',
+ ),
+ 'expected' => false,
+ ),
+ 'no user agent' => array(
+ 'headers' => array(),
+ 'expected' => false,
+ ),
+ 'desktop safari' => array(
+ 'headers' => array(
+ 'HTTP_USER_AGENT' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 13_5_2) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Safari/605.1.15',
+ ),
+ 'expected' => false,
+ ),
+ 'mobile safari' => array(
+ 'headers' => array(
+ 'HTTP_USER_AGENT' => 'Mozilla/5.0 (iPhone; CPU iPhone OS 16_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1',
+ ),
+ 'expected' => true,
+ ),
+ 'mobile android' => array(
+ 'headers' => array(
+ 'HTTP_USER_AGENT' => 'Mozilla/5.0 (Linux; Android 10) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.5938.60 Mobile Safari/537.36',
+ ),
+ 'expected' => true,
+ ),
+ 'silk' => array(
+ 'headers' => array(
+ 'HTTP_USER_AGENT' => 'Mozilla/5.0 (Linux; U; Android 4.4.3; KFTHWI Build/KTU84M) AppleWebKit/537.36 (KHTML, like Gecko) Silk/44.1.54 like Chrome/44.0.2403.63 Mobile Safari/537.36',
+ ),
+ 'expected' => true,
+ ),
+ 'kindle' => array(
+ 'headers' => array(
+ 'HTTP_USER_AGENT' => 'Mozilla/4.0 (compatible; Linux 2.6.10) NetFront/3.3 Kindle/1.0 (screen 600x800)',
+ ),
+ 'expected' => true,
+ ),
+ 'blackberry' => array(
+ 'headers' => array(
+ 'HTTP_USER_AGENT' => 'Mozilla/5.0 (Linux; Android 8.1.0; BlackBerry BBB100-4 Build/OPM1.171019.026) IPTV Pro/7.0.6',
+ ),
+ 'expected' => true,
+ ),
+ 'opera mini' => array(
+ 'headers' => array(
+ 'HTTP_USER_AGENT' => 'Opera/9.80 (Android; Opera Mini/69.0.2254/191.303; U; en) Presto/2.12.423 Version/12.16',
+ ),
+ 'expected' => true,
+ ),
+ 'opera mobi' => array(
+ 'headers' => array(
+ 'HTTP_USER_AGENT' => 'Opera/9.80 (Linux i686; Opera Mobi/1038; U; en) Presto/2.5.24 Version/10.00',
+ ),
+ 'expected' => true,
+ ),
+ );
+ }
+
+ /**
+ * Tests that wp_is_mobile() .
+ *
+ * @ticket 59370
+ *
+ * @covers ::wp_is_mobile
+ *
+ * @dataProvider get_data_to_test_wp_is_mobile
+ *
+ * @param array $headers Headers in $_SERVER.
+ * @param bool $expected Whether expected.
+ */
+ function test_wp_is_mobile( array $headers, bool $expected ) {
+ foreach ( $headers as $key => $value ) {
+ $_SERVER[ $key ] = $value;
+ }
+ $this->assertSame( $expected, wp_is_mobile() );
+ }
+
+ /**
+ * Tests that filter can override output of wp_is_mobile() to be true.
+ *
+ * @covers ::wp_is_mobile
+ */
+ function test_wp_is_mobile_is_true_with_filter() {
+ $this->assertFalse( wp_is_mobile() );
+ add_filter( 'wp_is_mobile', '__return_true' );
+ $this->assertTrue( wp_is_mobile() );
+ }
+
+ /**
+ * Tests that filter can override output of wp_is_mobile() to be false.
+ *
+ * @covers ::wp_is_mobile
+ */
+ function test_wp_is_mobile_is_false_with_filter() {
+ $_SERVER['HTTP_USER_AGENT'] = 'Mozilla/5.0 (Linux; Android 10) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.5938.60 Mobile Safari/537.36';
+ $this->assertTrue( wp_is_mobile() );
+ add_filter( 'wp_is_mobile', '__return_false' );
+ $this->assertFalse( wp_is_mobile() );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/vars.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></div>
</body>
</html>