Skip to content

Commit f41d9d9

Browse files
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. git-svn-id: https://develop.svn.wordpress.org/trunk@54965 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 608bbf5 commit f41d9d9

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

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

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -797,26 +797,26 @@ public function envelope_response( $response, $embed ) {
797797
*
798798
* @since 4.4.0
799799
*
800-
* @param string $namespace Namespace.
801-
* @param string $route The REST route.
802-
* @param array $route_args Route arguments.
803-
* @param bool $override Optional. Whether the route should be overridden if it already exists.
804-
* Default false.
800+
* @param string $route_namespace Namespace.
801+
* @param string $route The REST route.
802+
* @param array $route_args Route arguments.
803+
* @param bool $override Optional. Whether the route should be overridden if it already exists.
804+
* Default false.
805805
*/
806-
public function register_route( $namespace, $route, $route_args, $override = false ) {
807-
if ( ! isset( $this->namespaces[ $namespace ] ) ) {
808-
$this->namespaces[ $namespace ] = array();
806+
public function register_route( $route_namespace, $route, $route_args, $override = false ) {
807+
if ( ! isset( $this->namespaces[ $route_namespace ] ) ) {
808+
$this->namespaces[ $route_namespace ] = array();
809809

810810
$this->register_route(
811-
$namespace,
812-
'/' . $namespace,
811+
$route_namespace,
812+
'/' . $route_namespace,
813813
array(
814814
array(
815815
'methods' => self::READABLE,
816816
'callback' => array( $this, 'get_namespace_index' ),
817817
'args' => array(
818818
'namespace' => array(
819-
'default' => $namespace,
819+
'default' => $route_namespace,
820820
),
821821
'context' => array(
822822
'default' => 'view',
@@ -828,8 +828,9 @@ public function register_route( $namespace, $route, $route_args, $override = fal
828828
}
829829

830830
// Associative to avoid double-registration.
831-
$this->namespaces[ $namespace ][ $route ] = true;
832-
$route_args['namespace'] = $namespace;
831+
$this->namespaces[ $route_namespace ][ $route ] = true;
832+
833+
$route_args['namespace'] = $route_namespace;
833834

834835
if ( $override || empty( $this->endpoints[ $route ] ) ) {
835836
$this->endpoints[ $route ] = $route_args;
@@ -854,17 +855,17 @@ public function register_route( $namespace, $route, $route_args, $override = fal
854855
* used as the delimiter with preg_match()
855856
*
856857
* @since 4.4.0
857-
* @since 5.4.0 Add $namespace parameter.
858+
* @since 5.4.0 Added `$route_namespace` parameter.
858859
*
859-
* @param string $namespace Optionally, only return routes in the given namespace.
860+
* @param string $route_namespace Optionally, only return routes in the given namespace.
860861
* @return array `'/path/regex' => array( $callback, $bitmask )` or
861862
* `'/path/regex' => array( array( $callback, $bitmask ), ...)`.
862863
*/
863-
public function get_routes( $namespace = '' ) {
864+
public function get_routes( $route_namespace = '' ) {
864865
$endpoints = $this->endpoints;
865866

866-
if ( $namespace ) {
867-
$endpoints = wp_list_filter( $endpoints, array( 'namespace' => $namespace ) );
867+
if ( $route_namespace ) {
868+
$endpoints = wp_list_filter( $endpoints, array( 'namespace' => $route_namespace ) );
868869
}
869870

870871
/**

0 commit comments

Comments
 (0)