Changeset 62682

Timestamp:

07/09/2026 08:55:02 PM (3 weeks ago)

Author:

westonruter

Message:

Code Quality: Add types for term insert/update/delete functions.

Add PHPStan array shapes for the $args parameter of wp_insert_term(), wp_update_term(), and wp_delete_term(), along with narrowed return types. The types describe the contract these functions are intended to be called with, rather than what unguarded callers happen to pass today.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/12465.
Follow-up to r62680.

See #64898.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (4 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -2048 +2048 @@
  * @return bool|int|WP_Error True on success, false if term does not exist. Zero on attempted
  *                           deletion of default Category. WP_Error if the taxonomy does not exist.
+ * @phpstan-param non-empty-string $taxonomy
+ * @phpstan-param string|array{
+ *     default?: positive-int,
+ *     force_default?: bool,
+ * } $args
+ * @phpstan-return bool|WP_Error|0
  */
 function wp_delete_term( $term, $taxonomy, $args = array() ) {
@@ -2438 +2444 @@
  *     @type int|string $term_taxonomy_id The new term taxonomy ID. Can be a numeric string.
  * }
+ * @phpstan-param string|array{
+ *     alias_of?: string,
+ *     description?: string|null,
+ *     parent?: non-negative-int,
+ *     slug?: string|null,
+ *     ...
+ * } $args
+ * @phpstan-return array{
+ *     term_id: int,
+ *     term_taxonomy_id: int|numeric-string,
+ * }|WP_Error
  */
 function wp_insert_term( $term, $taxonomy, $args = array() ) {
@@ -2623 +2640 @@
         }
 
+        /** @var numeric-string|null $tt_id */
         $tt_id = $wpdb->get_var( $wpdb->prepare( "SELECT tt.term_taxonomy_id FROM $wpdb->term_taxonomy AS tt INNER JOIN $wpdb->terms AS t ON tt.term_id = t.term_id WHERE tt.taxonomy = %s AND t.term_id = %d", $taxonomy, $term_id ) );
 
@@ -3230 +3248 @@
  * @return array|WP_Error An array containing the `term_id` and `term_taxonomy_id`,
  *                        WP_Error otherwise.
+ * @phpstan-param array{
+ *     alias_of?: string,
+ *     description?: string,
+ *     parent?: non-negative-int,
+ *     slug?: string|null,
+ *     ...
+ * } $args
+ * @phpstan-return array{
+ *     term_id: int,
+ *     term_taxonomy_id: int,
+ * }|WP_Error
  */
 function wp_update_term( $term_id, $taxonomy, $args = array() ) {