Changeset 55136

Timestamp:

01/25/2023 01:38:59 AM (4 years ago)

Author:

SergeyBiryukov

Message:

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 [7140], [10707], [17603], [17621], [32114], [52038], [53365].

Props jrf.
See #56788, #56791.

File:

• trunk/src/wp-includes/compat.php (modified) (4 diffs)

trunk/src/wp-includes/compat.php

@@ -57 +57 @@
          * @return string Extracted substring.
          */
-        function mb_substr( $string, $start, $length = null, $encoding = null ) {
+        function mb_substr( $string, $start, $length = null, $encoding = null ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound
                 return _mb_substr( $string, $start, $length, $encoding );
         }
@@ -149 +149 @@
          * @return int String length of `$string`.
          */
-        function mb_strlen( $string, $encoding = null ) {
+        function mb_strlen( $string, $encoding = null ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound
                 return _mb_strlen( $string, $encoding );
         }
@@ -394 +394 @@
          *                         is not empty; `null` otherwise.
          */
-        function array_key_first( array $array ) {
+        function array_key_first( array $array ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound
                 foreach ( $array as $key => $value ) {
                         return $key;
@@ -414 +414 @@
          *.                        is not empty; `null` otherwise.
          */
-        function array_key_last( array $array ) {
+        function array_key_last( array $array ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound
                 if ( empty( $array ) ) {
                         return null;