Changeset 54965

Timestamp:

12/13/2022 06:32:33 PM (22 months ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/rest-api/class-wp-rest-server.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 $namespace parameter to $route_namespace in:

• WP_REST_Server::register_route()
• WP_REST_Server::get_routes()

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], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964].

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

File:

• trunk/src/wp-includes/rest-api/class-wp-rest-server.php (modified) (4 diffs)

trunk/src/wp-includes/rest-api/class-wp-rest-server.php

@@ -798 +798 @@
      * @since 4.4.0
      *
-     * @param string $namespace  Namespace.
-     * @param string $route      The REST route.
-     * @param array  $route_args Route arguments.
-     * @param bool   $override   Optional. Whether the route should be overridden if it already exists.
-     *                           Default false.
-     */
-    public function register_route( $namespace, $route, $route_args, $override = false ) {
-        if ( ! isset( $this->namespaces[ $namespace ] ) ) {
-            $this->namespaces[ $namespace ] = array();
+     * @param string $route_namespace Namespace.
+     * @param string $route           The REST route.
+     * @param array  $route_args      Route arguments.
+     * @param bool   $override        Optional. Whether the route should be overridden if it already exists.
+     *                                Default false.
+     */
+    public function register_route( $route_namespace, $route, $route_args, $override = false ) {
+        if ( ! isset( $this->namespaces[ $route_namespace ] ) ) {
+            $this->namespaces[ $route_namespace ] = array();
 
             $this->register_route(
-                $namespace,
-                '/' . $namespace,
+                $route_namespace,
+                '/' . $route_namespace,
                 array(
                     array(
@@ -817 +817 @@
                         'args'     => array(
                             'namespace' => array(
-                                'default' => $namespace,
+                                'default' => $route_namespace,
                             ),
                             'context'   => array(
@@ -829 +829 @@
 
         // Associative to avoid double-registration.
-        $this->namespaces[ $namespace ][ $route ] = true;
-        $route_args['namespace']                  = $namespace;
+        $this->namespaces[ $route_namespace ][ $route ] = true;
+
+        $route_args['namespace'] = $route_namespace;
 
         if ( $override || empty( $this->endpoints[ $route ] ) ) {
@@ -855 +856 @@
      *
      * @since 4.4.0
-     * @since 5.4.0 Add $namespace parameter.
-     *
-     * @param string $namespace Optionally, only return routes in the given namespace.
+     * @since 5.4.0 Added `$route_namespace` parameter.
+     *
+     * @param string $route_namespace Optionally, only return routes in the given namespace.
      * @return array `'/path/regex' => array( $callback, $bitmask )` or
      *               `'/path/regex' => array( array( $callback, $bitmask ), ...)`.
      */
-    public function get_routes( $namespace = '' ) {
+    public function get_routes( $route_namespace = '' ) {
         $endpoints = $this->endpoints;
 
-        if ( $namespace ) {
-            $endpoints = wp_list_filter( $endpoints, array( 'namespace' => $namespace ) );
+        if ( $route_namespace ) {
+            $endpoints = wp_list_filter( $endpoints, array( 'namespace' => $route_namespace ) );
         }