<!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>[52039] trunk: General: Introduce polyfill for `str_contains()` added in PHP 8.0.</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/52039">52039</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/52039","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-11-08 14:02:54 +0000 (Mon, 08 Nov 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'>General: Introduce polyfill for `str_contains()` added in PHP 8.0.
PHP 8.0 introduced a new function: `str_contains()`. It performs a case-sensitive check indicating if given substring (needle) is contained in the string to search in (haystack).
This polyfill makes this function available for use in Core.
Ref:
* PHP RFC https://wiki.php.net/rfc/str_contains
* PHP manual https://www.php.net/manual/en/function.str-contains.php
Props ayeshrajans, costdev, desrosj, hellofromTonya, knutsp, pbearne.
Fixes <a href="https://core.trac.wordpress.org/ticket/49652">#49652</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescompatphp">trunk/src/wp-includes/compat.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestscompatstrContainsphp">trunk/tests/phpunit/tests/compat/strContains.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescompatphp"></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/compat.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/compat.php 2021-11-08 13:50:35 UTC (rev 52038)
+++ trunk/src/wp-includes/compat.php 2021-11-08 14:02:54 UTC (rev 52039)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -417,6 +417,24 @@
</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">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+if ( ! function_exists( 'str_contains' ) ) {
+ /**
+ * Polyfill for `str_contains()` function added in PHP 8.0.
+ *
+ * Performs a case-sensitive check indicating if needle is
+ * contained in haystack.
+ *
+ * @since 5.9.0
+ *
+ * @param string $haystack The string to search in.
+ * @param string $needle The substring to search for in the haystack.
+ * @return bool True if `$needle` is in `$haystack`, otherwise false.
+ */
+ function str_contains( $haystack, $needle ) {
+ return ( '' === $needle || false !== strpos( $haystack, $needle ) );
+ }
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // IMAGETYPE_WEBP constant is only defined in PHP 7.1 or later.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! defined( 'IMAGETYPE_WEBP' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> define( 'IMAGETYPE_WEBP', 18 );
</span></span></pre></div>
<a id="trunktestsphpunittestscompatstrContainsphp"></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/compat/strContains.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/compat/strContains.php (rev 0)
+++ trunk/tests/phpunit/tests/compat/strContains.php 2021-11-08 14:02:54 UTC (rev 52039)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,104 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group compat
+ *
+ * @covers ::str_contains
+ */
+class Tests_Compat_strContains extends WP_UnitTestCase {
+
+ /**
+ * Test that str_contains() is always available (either from PHP or WP).
+ *
+ * @ticket 49652
+ */
+ public function test_is_str_contains_availability() {
+ $this->assertTrue( function_exists( 'str_contains' ) );
+ }
+
+ /**
+ * @dataProvider data_str_contains
+ *
+ * @ticket 49652
+ *
+ * @param bool $expected Whether or not `$haystack` is expected to contain `$needle`.
+ * @param string $haystack The string to search in.
+ * @param string $needle The substring to search for in `$haystack`.
+ */
+ public function test_str_contains( $expected, $haystack, $needle ) {
+ if ( ! function_exists( 'str_contains' ) ) {
+ $this->markTestSkipped( 'str_contains() is not available.' );
+ } else {
+ $this->assertSame(
+ $expected,
+ str_contains( $haystack, $needle )
+ );
+ }
+
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_str_contains() {
+ return array(
+ 'empty needle' => array(
+ 'expected' => true,
+ 'haystack' => 'This is a Test',
+ 'needle' => '',
+ ),
+ 'empty haystack and needle' => array(
+ 'expected' => true,
+ 'haystack' => '',
+ 'needle' => '',
+ ),
+ 'empty haystack' => array(
+ 'expected' => false,
+ 'haystack' => '',
+ 'needle' => 'test',
+ ),
+ 'start of string' => array(
+ 'expected' => true,
+ 'haystack' => 'This is a Test',
+ 'needle' => 'This',
+ ),
+ 'middle of string' => array(
+ 'expected' => true,
+ 'haystack' => 'The needle in middle of string.',
+ 'needle' => 'middle',
+ ),
+ 'end of string' => array(
+ 'expected' => true,
+ 'string' => 'The needle is at end.',
+ 'needle' => 'end',
+ ),
+ 'lowercase' => array(
+ 'expected' => true,
+ 'string' => 'This is a test',
+ 'needle' => 'test',
+ ),
+ 'uppercase' => array(
+ 'expected' => true,
+ 'string' => 'This is a TEST',
+ 'needle' => 'TEST',
+ ),
+ 'camelCase' => array(
+ 'expected' => true,
+ 'string' => 'String contains camelCase.',
+ 'needle' => 'camelCase',
+ ),
+ 'with hyphen' => array(
+ 'expected' => true,
+ 'string' => 'String contains foo-bar needle.',
+ 'needle' => 'foo-bar',
+ ),
+ 'missing' => array(
+ 'expected' => false,
+ 'haystack' => 'This is a camelcase',
+ 'needle' => 'camelCase',
+ ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/compat/strContains.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>