Changeset 53207

Timestamp:

04/18/2022 03:20:16 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-admin/includes/nav-menu.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 $echo parameter to $display in wp_nav_menu_disabled_check().
• Renames the $object parameter to $item_object in:
  • wp_nav_menu_item_post_type_meta_box()
  • wp_nav_menu_item_taxonomy_meta_box()
  • _wp_nav_menu_meta_box_object()

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203].

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

File:

• trunk/src/wp-admin/includes/nav-menu.php (modified) (10 diffs)

trunk/src/wp-admin/includes/nav-menu.php

@@ -263 +263 @@
  *
  * @since 3.6.0
- * @since 5.3.1 The `$echo` parameter was added.
+ * @since 5.3.1 The `$display` parameter was added.
  *
  * @global bool $one_theme_location_no_menus to determine if no menus exist
  *
  * @param int|string $nav_menu_selected_id ID, name, or slug of the currently selected menu.
- * @param bool       $echo                 Whether to echo or just return the string.
+ * @param bool       $display              Whether to display or just return the string.
  * @return string|false Disabled attribute if at least one menu exists, false if not.
  */
-function wp_nav_menu_disabled_check( $nav_menu_selected_id, $echo = true ) {
+function wp_nav_menu_disabled_check( $nav_menu_selected_id, $display = true ) {
     global $one_theme_location_no_menus;
 
@@ -278 +278 @@
     }
 
-    return disabled( $nav_menu_selected_id, 0, $echo );
+    return disabled( $nav_menu_selected_id, 0, $display );
 }
 
@@ -326 +326 @@
  * @global int|string $nav_menu_selected_id
  *
- * @param string $object Not used.
+ * @param string $item_object Not used.
  * @param array  $box {
  *     Post type menu item meta box arguments.
@@ -336 +336 @@
  * }
  */
-function wp_nav_menu_item_post_type_meta_box( $object, $box ) {
+function wp_nav_menu_item_post_type_meta_box( $item_object, $box ) {
     global $_nav_menu_placeholder, $nav_menu_selected_id;
 
@@ -690 +690 @@
  * @global int|string $nav_menu_selected_id
  *
- * @param string $object Not used.
+ * @param string $item_object Not used.
  * @param array  $box {
  *     Taxonomy menu item meta box arguments.
@@ -700 +700 @@
  * }
  */
-function wp_nav_menu_item_taxonomy_meta_box( $object, $box ) {
+function wp_nav_menu_item_taxonomy_meta_box( $item_object, $box ) {
     global $nav_menu_selected_id;
 
@@ -990 +990 @@
  * @access private
  *
- * @param object $object The post type or taxonomy meta-object.
+ * @param object $item_object The post type or taxonomy meta-object.
  * @return object The post type or taxonomy object.
  */
-function _wp_nav_menu_meta_box_object( $object = null ) {
-    if ( isset( $object->name ) ) {
-
-        if ( 'page' === $object->name ) {
-            $object->_default_query = array(
+function _wp_nav_menu_meta_box_object( $item_object = null ) {
+    if ( isset( $item_object->name ) ) {
+
+        if ( 'page' === $item_object->name ) {
+            $item_object->_default_query = array(
                 'orderby'     => 'menu_order title',
                 'post_status' => 'publish',
@@ -1003 +1003 @@
 
             // Posts should show only published items.
-        } elseif ( 'post' === $object->name ) {
-            $object->_default_query = array(
+        } elseif ( 'post' === $item_object->name ) {
+            $item_object->_default_query = array(
                 'post_status' => 'publish',
             );
 
             // Categories should be in reverse chronological order.
-        } elseif ( 'category' === $object->name ) {
-            $object->_default_query = array(
+        } elseif ( 'category' === $item_object->name ) {
+            $item_object->_default_query = array(
                 'orderby' => 'id',
                 'order'   => 'DESC',
@@ -1017 +1017 @@
             // Custom post types should show only published items.
         } else {
-            $object->_default_query = array(
+            $item_object->_default_query = array(
                 'post_status' => 'publish',
             );
@@ -1023 +1023 @@
     }
 
-    return $object;
+    return $item_object;
 }