<!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>[55136] trunk/src/wp-includes/compat.php: Coding Standards: Allow some parameters with reserved keywords in `wp-includes/compat.php`.</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/55136">55136</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/55136","name":"Review Commit"}}</script></dd>

<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>

<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-01-25 01:38:59 +0000 (Wed, 25 Jan 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'>Coding Standards: Allow some parameters with reserved keywords in `wp-includes/compat.php`.

Parameter names for PHP polyfills in WordPress core need to 100% match the native PHP parameter names. Otherwise using named parameters with those functions could cause fatal errors for installations where the polyfills kick in.

This commit adds inline comments instructing PHPCS to ignore parameters with reserved keywords in the affected functions that should not be renamed:

* `$string` parameter in `mb_substr()` and `mb_strlen()`

* `$array` parameter in `array_key_first()` and `array_key_last()`

This resolves a few WPCS warnings along the lines of:

{{{

It is recommended not to use reserved keyword "string" as function parameter name. Found: $string

}}}

Follow-up to <a href="https://core.trac.wordpress.org/changeset/7140">[7140]</a>, <a href="https://core.trac.wordpress.org/changeset/10707">[10707]</a>, <a href="https://core.trac.wordpress.org/changeset/17603">[17603]</a>, <a href="https://core.trac.wordpress.org/changeset/17621">[17621]</a>, <a href="https://core.trac.wordpress.org/changeset/32114">[32114]</a>, <a href="https://core.trac.wordpress.org/changeset/52038">[52038]</a>, <a href="https://core.trac.wordpress.org/changeset/53365">[53365]</a>.

Props jrf.

See <a href="https://core.trac.wordpress.org/ticket/56788">#56788</a>, <a href="https://core.trac.wordpress.org/ticket/56791">#56791</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpincludescompatphp">trunk/src/wp-includes/compat.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  2023-01-24 21:30:42 UTC (rev 55135)

+++ trunk/src/wp-includes/compat.php    2023-01-25 01:38:59 UTC (rev 55136)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,7 +56,7 @@

<span class="cx" style="display: block; padding: 0 10px">         * @param string|null $encoding Optional. Character encoding to use. Default null.

<span class="cx" style="display: block; padding: 0 10px">         * @return string Extracted substring.

</span><span class="cx" style="display: block; padding: 0 10px">         */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        function mb_substr( $string, $start, $length = null, $encoding = null ) {

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function mb_substr( $string, $start, $length = null, $encoding = null ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound

</ins><span class="cx" style="display: block; padding: 0 10px">                 return _mb_substr( $string, $start, $length, $encoding );

</span><span class="cx" style="display: block; padding: 0 10px">        }

</span><span class="cx" style="display: block; padding: 0 10px"> endif;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -148,7 +148,7 @@

<span class="cx" style="display: block; padding: 0 10px">         * @param string|null $encoding Optional. Character encoding to use. Default null.

<span class="cx" style="display: block; padding: 0 10px">         * @return int String length of `$string`.

</span><span class="cx" style="display: block; padding: 0 10px">         */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        function mb_strlen( $string, $encoding = null ) {

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function mb_strlen( $string, $encoding = null ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound

</ins><span class="cx" style="display: block; padding: 0 10px">                 return _mb_strlen( $string, $encoding );

</span><span class="cx" style="display: block; padding: 0 10px">        }

</span><span class="cx" style="display: block; padding: 0 10px"> endif;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -393,7 +393,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">         * @return string|int|null The first key of array if the array

<span class="cx" style="display: block; padding: 0 10px">         *                         is not empty; `null` otherwise.

</span><span class="cx" style="display: block; padding: 0 10px">         */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        function array_key_first( array $array ) {

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function array_key_first( array $array ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound

</ins><span class="cx" style="display: block; padding: 0 10px">                 foreach ( $array as $key => $value ) {

</span><span class="cx" style="display: block; padding: 0 10px">                        return $key;

</span><span class="cx" style="display: block; padding: 0 10px">                }

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -413,7 +413,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">         * @return string|int|null The last key of array if the array

<span class="cx" style="display: block; padding: 0 10px">         *.                        is not empty; `null` otherwise.

</span><span class="cx" style="display: block; padding: 0 10px">         */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        function array_key_last( array $array ) {

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function array_key_last( array $array ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound

</ins><span class="cx" style="display: block; padding: 0 10px">                 if ( empty( $array ) ) {

</span><span class="cx" style="display: block; padding: 0 10px">                        return null;

</span><span class="cx" style="display: block; padding: 0 10px">                }

</span></span></pre>

</div>

</div>

</body>

</html>