<!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>[52040] trunk: General: Introduce polyfills for `str_ends_with()` and `str_starts_with()` 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/52040">52040</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/52040","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:21:44 +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 polyfills for `str_ends_with()` and `str_starts_with()` added in PHP 8.0.
PHP 8.0 introduced two new functions: `str_ends_with()` and `str_starts_with()`. These perform a case-sensitive check indicating if the string to search in (haystack) ends or begins with the given substring (needle).
These polyfills make these functios available for use in Core.
Ref:
* PHP RFC https://wiki.php.net/rfc/add_str_starts_with_and_ends_with_functions
* PHP manual `str_ends_with()` https://www.php.net/manual/en/function.str-ends-with.php
* PHP manual `str_starts_with()` https://www.php.net/manual/en/function.str-starts-with.php
Props costdev, hellofromTonya, pbearne, pbiron.
Fixes <a href="https://core.trac.wordpress.org/ticket/54377">#54377</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="#trunktestsphpunittestscompatstrEndsWithphp">trunk/tests/phpunit/tests/compat/strEndsWith.php</a></li>
<li><a href="#trunktestsphpunittestscompatstrStartsWithphp">trunk/tests/phpunit/tests/compat/strStartsWith.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 14:02:54 UTC (rev 52039)
+++ trunk/src/wp-includes/compat.php 2021-11-08 14:21:44 UTC (rev 52040)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -435,6 +435,49 @@
</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_starts_with' ) ) {
+ /**
+ * Polyfill for `str_starts_with()` function added in PHP 8.0.
+ *
+ * Performs a case-sensitive check indicating if
+ * the haystack begins with needle.
+ *
+ * @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 `$haystack` starts with `$needle`, otherwise false.
+ */
+ function str_starts_with( $haystack, $needle ) {
+ if ( '' === $needle ) {
+ return true;
+ }
+ return 0 === strpos( $haystack, $needle );
+ }
+}
+
+if ( ! function_exists( 'str_ends_with' ) ) {
+ /**
+ * Polyfill for `str_ends_with()` function added in PHP 8.0.
+ *
+ * Performs a case-sensitive check indicating if
+ * the haystack ends with needle.
+ *
+ * @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 `$haystack` ends with `$needle`, otherwise false.
+ */
+ function str_ends_with( $haystack, $needle ) {
+ if ( '' === $haystack && '' !== $needle ) {
+ return false;
+ }
+ $len = strlen( $needle );
+ return 0 === substr_compare( $haystack, $needle, -$len, $len );
+ }
+}
+
</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="trunktestsphpunittestscompatstrEndsWithphp"></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/strEndsWith.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/compat/strEndsWith.php (rev 0)
+++ trunk/tests/phpunit/tests/compat/strEndsWith.php 2021-11-08 14:21:44 UTC (rev 52040)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,115 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group compat
+ *
+ * @covers ::str_ends_with
+ */
+class Tests_Compat_StrEndsWith extends WP_UnitTestCase {
+
+ /**
+ * Test that str_ends_with() is always available (either from PHP or WP).
+ *
+ * @ticket 54377
+ */
+ public function test_str_ends_with_availability() {
+ $this->assertTrue( function_exists( 'str_ends_with' ) );
+ }
+
+ /**
+ * @dataProvider data_str_ends_with
+ *
+ * @ticket 54377
+ *
+ * @param bool $expected Whether or not `$haystack` is expected to end with `$needle`.
+ * @param string $haystack The string to search in.
+ * @param string $needle The substring to search for at the end of `$haystack`.
+ */
+ public function test_str_ends_with( $expected, $haystack, $needle ) {
+ if ( ! function_exists( 'str_ends_with' ) ) {
+ $this->markTestSkipped( 'str_ends_with() is not available.' );
+ } else {
+ $this->assertSame(
+ $expected,
+ str_ends_with( $haystack, $needle )
+ );
+ }
+
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_str_ends_with() {
+ 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',
+ ),
+ 'lowercase' => array(
+ 'expected' => true,
+ 'haystack' => 'This is a test',
+ 'needle' => 'test',
+ ),
+ 'uppercase' => array(
+ 'expected' => true,
+ 'haystack' => 'This is a TEST',
+ 'needle' => 'TEST',
+ ),
+ 'first letter uppercase' => array(
+ 'expected' => true,
+ 'haystack' => 'This is a Test',
+ 'needle' => 'Test',
+ ),
+ 'camelCase' => array(
+ 'expected' => true,
+ 'haystack' => 'This is a camelCase',
+ 'needle' => 'camelCase',
+ ),
+ 'null' => array(
+ 'expected' => true,
+ 'haystack' => 'This is a null \x00test',
+ 'needle' => '\x00test',
+ ),
+ 'trademark' => array(
+ 'expected' => true,
+ 'haystack' => 'This is a trademark\x2122',
+ 'needle' => 'trademark\x2122',
+ ),
+ 'not camelCase' => array(
+ 'expected' => false,
+ 'haystack' => 'This is a cammelcase',
+ 'needle' => 'cammelCase',
+ ),
+ 'missing' => array(
+ 'expected' => false,
+ 'haystack' => 'This is a cammelcase',
+ 'needle' => 'cammelCase',
+ ),
+ 'not end' => array(
+ 'expected' => false,
+ 'haystack' => 'This is a test extra',
+ 'needle' => 'test',
+ ),
+ 'extra space' => array(
+ 'expected' => false,
+ 'haystack' => 'This is a test ',
+ 'needle' => 'test',
+ ),
+
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/compat/strEndsWith.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="trunktestsphpunittestscompatstrStartsWithphp"></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/strStartsWith.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/compat/strStartsWith.php (rev 0)
+++ trunk/tests/phpunit/tests/compat/strStartsWith.php 2021-11-08 14:21:44 UTC (rev 52040)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,119 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group compat
+ *
+ * @covers ::str_starts_with
+ */
+class Tests_Compat_StrStartsWith extends WP_UnitTestCase {
+
+ /**
+ * Test that str_starts_with() is always available (either from PHP or WP).
+ *
+ * @ticket 54377
+ */
+ public function test_str_starts_with_availability() {
+ $this->assertTrue( function_exists( 'str_starts_with' ) );
+ }
+
+ /**
+ * @dataProvider data_str_starts_with
+ *
+ * @ticket 54377
+ *
+ * @param bool $expected Whether or not `$haystack` is expected to start with `$needle`.
+ * @param string $haystack The string to search in.
+ * @param string $needle The substring to search for at the start of `$haystack`.
+ */
+ public function test_str_starts_with( $expected, $haystack, $needle ) {
+ if ( ! function_exists( 'str_starts_with' ) ) {
+ $this->markTestSkipped( 'str_starts_with() is not available.' );
+ } else {
+ $this->assertSame(
+ $expected,
+ str_starts_with( $haystack, $needle )
+ );
+ }
+
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_str_starts_with() {
+ 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',
+ ),
+ 'lowercase' => array(
+ 'expected' => true,
+ 'haystack' => 'this is a test',
+ 'needle' => 'this',
+ ),
+ 'uppercase' => array(
+ 'expected' => true,
+ 'haystack' => 'THIS is a TEST',
+ 'needle' => 'THIS',
+ ),
+ 'first letter uppercase' => array(
+ 'expected' => true,
+ 'haystack' => 'This is a Test',
+ 'needle' => 'This',
+ ),
+ 'case mismatch' => array(
+ 'expected' => false,
+ 'haystack' => 'This is a test',
+ 'needle' => 'this',
+ ),
+ 'camelCase' => array(
+ 'expected' => true,
+ 'haystack' => 'camelCase is the start',
+ 'needle' => 'camelCase',
+ ),
+ 'null' => array(
+ 'expected' => true,
+ 'haystack' => 'This\x00is a null test ',
+ 'needle' => 'This\x00is',
+ ),
+ 'trademark' => array(
+ 'expected' => true,
+ 'haystack' => 'trademark\x2122 is a null test ',
+ 'needle' => 'trademark\x2122',
+ ),
+ 'not camelCase' => array(
+ 'expected' => false,
+ 'haystack' => ' cammelcase is the start',
+ 'needle' => 'cammelCase',
+ ),
+ 'missing' => array(
+ 'expected' => false,
+ 'haystack' => 'This is a test',
+ 'needle' => 'camelCase',
+ ),
+ 'not start' => array(
+ 'expected' => false,
+ 'haystack' => 'This is a test extra',
+ 'needle' => 'test',
+ ),
+ 'extra_space' => array(
+ 'expected' => false,
+ 'haystack' => ' This is a test',
+ 'needle' => 'This',
+ ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/compat/strStartsWith.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>