Changeset 53216

Timestamp:

04/19/2022 01:49:19 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-admin/includes/taxonomy.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 $parent parameter to $category_parent in category_exists() and wp_create_category(). This matches the category object property of the same name.
• Amends similar parameters in dropdown_categories() and wp_dropdown_cats() for consistency.

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

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

Location:

trunk/src/wp-admin/includes

Files:

• deprecated.php (modified) (3 diffs)
• taxonomy.php (modified) (3 diffs)

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

@@ -79 +79 @@
  *
  * @param int   $default_category Unused.
- * @param int   $parent_category  Unused.
+ * @param int   $category_parent  Unused.
  * @param array $popular_ids      Unused.
  */
-function dropdown_categories( $default_category = 0, $parent_category = 0, $popular_ids = array() ) {
+function dropdown_categories( $default_category = 0, $category_parent = 0, $popular_ids = array() ) {
     _deprecated_function( __FUNCTION__, '2.6.0', 'wp_category_checklist()' );
     global $post_ID;
@@ -128 +128 @@
  * @see wp_dropdown_categories()
  *
- * @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.
+ * @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 $category_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.
  * @return void|false Void on success, false if no categories were found.
  */
-function wp_dropdown_cats( $current_cat = 0, $current_parent = 0, $parent_cat = 0, $level = 0, $categories = 0 ) {
+function wp_dropdown_cats( $current_cat = 0, $current_parent = 0, $category_parent = 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 ( $current_cat != $category->term_id && $parent_cat == $category->parent) {
+            if ( $current_cat != $category->term_id && $category_parent == $category->parent) {
                 $pad = str_repeat( '– ', $level );
                 $category->name = esc_html( $category->name );

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

@@ -18 +18 @@
  * @see term_exists()
  *
- * @param int|string $cat_name Category name.
- * @param int        $parent   Optional. ID of parent term.
+ * @param int|string $cat_name        Category name.
+ * @param int        $category_parent Optional. ID of parent category.
  * @return string|null Returns the category ID as a numeric string if the pairing exists, null if not.
  */
-function category_exists( $cat_name, $parent = null ) {
-    $id = term_exists( $cat_name, 'category', $parent );
+function category_exists( $cat_name, $category_parent = null ) {
+    $id = term_exists( $cat_name, 'category', $category_parent );
     if ( is_array( $id ) ) {
         $id = $id['term_id'];
@@ -49 +49 @@
  * @since 2.0.0
  *
- * @param int|string $cat_name
- * @param int        $parent
+ * @param int|string $cat_name        Category name.
+ * @param int        $category_parent Optional. ID of parent category.
  * @return int|WP_Error
  */
-function wp_create_category( $cat_name, $parent = 0 ) {
-    $id = category_exists( $cat_name, $parent );
+function wp_create_category( $cat_name, $category_parent = 0 ) {
+    $id = category_exists( $cat_name, $category_parent );
     if ( $id ) {
         return $id;
@@ -62 +62 @@
         array(
             'cat_name'        => $cat_name,
-            'category_parent' => $parent,
+            'category_parent' => $category_parent,
         )
     );