Changeset 45630 for trunk/src/wp-includes/wp-db.php

Timestamp:

07/12/2019 12:16:34 AM (5 years ago)

Author:

pento

Message:

Code Modernisation: Introduce the spread operator in wpdb::prepare().

Rather than relying func_get_args() to retrieve arbitrary function arguments, we can now use the spread operator to assign them directly to a variable.

Props jrf.
See #47678.

File:

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

trunk/src/wp-includes/wp-db.php

@@ -1268 +1268 @@
      *   %s (string)
      *
-     * All placeholders MUST be left unquoted in the query string. A corresponding argument MUST be passed for each placeholder.
-     *
-     * For compatibility with old behavior, numbered or formatted string placeholders (eg, %1$s, %5s) will not have quotes
-     * added by this function, so should be passed with appropriate quotes around them for your usage.
+     * All placeholders MUST be left unquoted in the query string. A corresponding argument
+     * MUST be passed for each placeholder.
+     *
+     * For compatibility with old behavior, numbered or formatted string placeholders (eg, %1$s, %5s)
+     * will not have quotes added by this function, so should be passed with appropriate quotes around
+     * them for your usage.
      *
      * Literal percentage signs (%) in the query string must be written as %%. Percentage wildcards (for example,
@@ -1277 +1279 @@
      * cannot be inserted directly in the query string. Also see wpdb::esc_like().
      *
-     * Arguments may be passed as individual arguments to the method, or as a single array containing all arguments. A combination
-     * of the two is not supported.
+     * Arguments may be passed as individual arguments to the method, or as a single array containing
+     * all arguments. A combination of the two is not supported.
      *
      * Examples:
@@ -1288 +1290 @@
      *
      * @param string      $query   Query statement with sprintf()-like placeholders
-     * @param array|mixed $args    The array of variables to substitute into the query's placeholders if being called with an array of arguments,
-     *                             or the first variable to substitute into the query's placeholders if being called with individual arguments.
-     * @param mixed       ...$args further variables to substitute into the query's placeholders if being called wih individual arguments.
+     * @param array|mixed $args    The array of variables to substitute into the query's placeholders
+     *                             if being called with an array of arguments, or the first variable
+     *                             to substitute into the query's placeholders if being called with
+     *                             individual arguments.
+     * @param mixed       ...$args Further variables to substitute into the query's placeholders
+     *                             if being called with individual arguments.
      * @return string|void Sanitized query string, if there is a query to prepare.
      */
-    public function prepare( $query, $args ) {
+    public function prepare( $query, ...$args ) {
         if ( is_null( $query ) ) {
             return;
@@ -1303 +1308 @@
             _doing_it_wrong( 'wpdb::prepare', sprintf( __( 'The query argument of %s must have a placeholder.' ), 'wpdb::prepare()' ), '3.9.0' );
         }
-
-        $args = func_get_args();
-        array_shift( $args );
 
         // If args were passed as an array (as in vsprintf), move them up.