Changeset 53184

Timestamp:

04/14/2022 03:24:09 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-admin/includes/deprecated.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 $default and $parent parameters to $default_category and $parent_category in dropdown_categories().
• Renames the $default parameter to $default_link_category in dropdown_link_categories().
• Renames the $parent parameter to $parent_cat and some other parameters for consistency in wp_dropdown_cats().
• Renames the $function to $callback in add_object_page() and add_utility_page().

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174].

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

File:

• trunk/src/wp-admin/includes/deprecated.php (modified) (8 diffs)

trunk/src/wp-admin/includes/deprecated.php

@@ -78 +78 @@
  * @global int $post_ID
  *
- * @param int $default       Unused.
- * @param int $parent        Unused.
- * @param array $popular_ids Unused.
- */
-function dropdown_categories( $default = 0, $parent = 0, $popular_ids = array() ) {
+ * @param int   $default_category Unused.
+ * @param int   $parent_category  Unused.
+ * @param array $popular_ids      Unused.
+ */
+function dropdown_categories( $default_category = 0, $parent_category = 0, $popular_ids = array() ) {
     _deprecated_function( __FUNCTION__, '2.6.0', 'wp_category_checklist()' );
     global $post_ID;
@@ -97 +97 @@
  * @global int $link_id
  *
- * @param int $default Unused.
- */
-function dropdown_link_categories( $default = 0 ) {
+ * @param int $default_link_category Unused.
+ */
+function dropdown_link_categories( $default_link_category = 0 ) {
     _deprecated_function( __FUNCTION__, '2.6.0', 'wp_link_category_checklist()' );
     global $link_id;
@@ -128 +128 @@
  * @see wp_dropdown_categories()
  *
- * @param int $currentcat    Optional. ID of the current category. Default 0.
- * @param int $currentparent Optional. Current parent category ID. Default 0.
- * @param int $parent        Optional. Parent ID to retrieve categories for. Default 0.
- * @param int $level         Optional. Number of levels deep to display. Default 0.
- * @param array $categories  Optional. Categories to include in the control. Default 0.
+ * @param int $current_cat    Optional. ID of the current category. Default 0.
+ * @param int $current_parent Optional. Current parent category ID. Default 0.
+ * @param int $parent_cat     Optional. Parent ID to retrieve categories for. Default 0.
+ * @param int $level          Optional. Number of levels deep to display. Default 0.
+ * @param array $categories   Optional. Categories to include in the control. Default 0.
  * @return void|false Void on success, false if no categories were found.
  */
-function wp_dropdown_cats( $currentcat = 0, $currentparent = 0, $parent = 0, $level = 0, $categories = 0 ) {
+function wp_dropdown_cats( $current_cat = 0, $current_parent = 0, $parent_cat = 0, $level = 0, $categories = 0 ) {
     _deprecated_function( __FUNCTION__, '3.0.0', 'wp_dropdown_categories()' );
     if (!$categories )
@@ -142 +142 @@
     if ( $categories ) {
         foreach ( $categories as $category ) {
-            if ( $currentcat != $category->term_id && $parent == $category->parent) {
+            if ( $current_cat != $category->term_id && $parent_cat == $category->parent) {
                 $pad = str_repeat( '– ', $level );
                 $category->name = esc_html( $category->name );
                 echo "\n\t<option value='$category->term_id'";
-                if ( $currentparent == $category->term_id )
+                if ( $current_parent == $category->term_id )
                     echo " selected='selected'";
                 echo ">$pad$category->name</option>";
-                wp_dropdown_cats( $currentcat, $currentparent, $category->term_id, $level +1, $categories );
+                wp_dropdown_cats( $current_cat, $current_parent, $category->term_id, $level +1, $categories );
             }
         }
@@ -1427 +1427 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function   Optional. The function to be called to output the content for this page.
+ * @param callable $callback   Optional. The function to be called to output the content for this page.
  * @param string   $icon_url   Optional. The URL to the icon to be used for this menu.
  * @return string The resulting page's hook_suffix.
  */
-function add_object_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
+function add_object_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $icon_url = '') {
     _deprecated_function( __FUNCTION__, '4.5.0', 'add_menu_page()' );
 
@@ -1438 +1438 @@
     $_wp_last_object_menu++;
 
-    return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_object_menu);
+    return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $callback, $icon_url, $_wp_last_object_menu);
 }
 
@@ -1460 +1460 @@
  * @param string   $capability The capability required for this menu to be displayed to the user.
  * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function   Optional. The function to be called to output the content for this page.
+ * @param callable $callback   Optional. The function to be called to output the content for this page.
  * @param string   $icon_url   Optional. The URL to the icon to be used for this menu.
  * @return string The resulting page's hook_suffix.
  */
-function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
+function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $icon_url = '') {
     _deprecated_function( __FUNCTION__, '4.5.0', 'add_menu_page()' );
 
@@ -1471 +1471 @@
     $_wp_last_utility_menu++;
 
-    return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_utility_menu);
+    return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $callback, $icon_url, $_wp_last_utility_menu);
 }