Changeset 61298

Timestamp:

11/25/2025 01:32:39 AM (8 weeks ago)

Author:

westonruter

Message:

Docs: Update typing for wp_create_category().

• Ensure that wp_create_category() returns int as opposed to numeric-string.
• Rename $cat_name to $category_name to avoid abbreviating variables.
• Update docblock to remove erroneous int for $category_name param when only string is intended.
• Add missing tests for wp_create_category().

Developed in ​https://github.com/WordPress/wordpress-develop/pull/8861

Props justlevine, westonruter.
See #64238, #64226.

Location:

trunk

Files:

• src/wp-admin/includes/taxonomy.php (modified) (1 diff)
• tests/phpunit/tests/term/wpCreateCategory.php (added)

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

@@ -49 +49 @@
  * @since 2.0.0
  *
- * @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, $category_parent = 0 ) {
-    $id = category_exists( $cat_name, $category_parent );
+ * @param string $category_name   Category name.
+ * @param int    $category_parent Optional. ID of parent category.
+ * @return int The ID of category term on success, or zero on failure.
+ */
+function wp_create_category( $category_name, $category_parent = 0 ) {
+    $id = category_exists( $category_name, $category_parent );
     if ( $id ) {
-        return $id;
+        return (int) $id;
     }
 
     return wp_insert_category(
         array(
-            'cat_name'        => $cat_name,
+            'cat_name'        => $category_name,
             'category_parent' => $category_parent,
         )