Changeset 54950 for trunk/src/wp-includes/class-wpdb.php

Timestamp:

12/08/2022 05:26:17 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/class-wpdb.php.

While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.

This commit:

• Renames the $string parameter to $data in:
  • wpdb::_weak_escape()
  • wpdb::_real_escape()
  • wpdb::escape_by_ref()
• Renames the $string parameter to $input_string in wpdb::check_ascii().

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.

File:

• trunk/src/wp-includes/class-wpdb.php (modified) (6 diffs)

trunk/src/wp-includes/class-wpdb.php

@@ -1245 +1245 @@
      * @see esc_sql()
      *
-     * @param string $string
+     * @param string $data
      * @return string
      */
-    public function _weak_escape( $string ) {
+    public function _weak_escape( $data ) {
         if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) ) {
             _deprecated_function( __METHOD__, '3.6.0', 'wpdb::prepare() or esc_sql()' );
         }
-        return addslashes( $string );
+        return addslashes( $data );
     }
 
@@ -1263 +1263 @@
      * @see mysql_real_escape_string()
      *
-     * @param string $string String to escape.
+     * @param string $data String to escape.
      * @return string Escaped string.
      */
-    public function _real_escape( $string ) {
-        if ( ! is_scalar( $string ) ) {
+    public function _real_escape( $data ) {
+        if ( ! is_scalar( $data ) ) {
             return '';
         }
@@ -1273 +1273 @@
         if ( $this->dbh ) {
             if ( $this->use_mysqli ) {
-                $escaped = mysqli_real_escape_string( $this->dbh, $string );
+                $escaped = mysqli_real_escape_string( $this->dbh, $data );
             } else {
-                $escaped = mysql_real_escape_string( $string, $this->dbh );
+                $escaped = mysql_real_escape_string( $data, $this->dbh );
             }
         } else {
@@ -1284 +1284 @@
             _doing_it_wrong( $class, sprintf( __( '%s must set a database connection for use with escaping.' ), $class ), '3.6.0' );
 
-            $escaped = addslashes( $string );
+            $escaped = addslashes( $data );
         }
 
@@ -1355 +1355 @@
      * @since 2.3.0
      *
-     * @param string $string String to escape.
-     */
-    public function escape_by_ref( &$string ) {
-        if ( ! is_float( $string ) ) {
-            $string = $this->_real_escape( $string );
+     * @param string $data String to escape.
+     */
+    public function escape_by_ref( &$data ) {
+        if ( ! is_float( $data ) ) {
+            $data = $this->_real_escape( $data );
         }
     }
@@ -3162 +3162 @@
      * @since 4.2.0
      *
-     * @param string $string String to check.
+     * @param string $input_string String to check.
      * @return bool True if ASCII, false if not.
      */
-    protected function check_ascii( $string ) {
+    protected function check_ascii( $input_string ) {
         if ( function_exists( 'mb_check_encoding' ) ) {
-            if ( mb_check_encoding( $string, 'ASCII' ) ) {
+            if ( mb_check_encoding( $input_string, 'ASCII' ) ) {
                 return true;
             }
-        } elseif ( ! preg_match( '/[^\x00-\x7F]/', $string ) ) {
+        } elseif ( ! preg_match( '/[^\x00-\x7F]/', $input_string ) ) {
             return true;
         }