Skip to content

Code Quality: Add PHPStan types for wp_insert_term(), wp_update_term(), and wp_delete_term() #12465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
westonruter wants to merge 13 commits into from
Closed

Code Quality: Add PHPStan types for wp_insert_term(), wp_update_term(), and wp_delete_term() #12465

Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
3abe2a6
Code Quality: Add PHPStan types for `wp_insert_term()` and `wp_update…
westonruter Jul 9, 2026
ae064fc
Document that wp_delete_term() must take a non-empty taxonomy
westonruter Jul 9, 2026
01d340c
Document type of $tt_id
westonruter Jul 9, 2026
8921090
Remove erroneous string type from $args
westonruter Jul 9, 2026
dedb5c4
Unseal args arrays
westonruter Jul 9, 2026
b31069e
Document that description can be null and parent may ne numeric-strin…
westonruter Jul 9, 2026
99148cf
Allow passing null as slug
westonruter Jul 9, 2026
8a4c3ab
Make parent consistent
westonruter Jul 9, 2026
876bf39
Allow null being passed to slug
westonruter Jul 9, 2026
421aed9
Remove unaccepted string from $args for wp_update_term()
westonruter Jul 9, 2026
5b7654d
Use non-negative-int for parent
westonruter Jul 9, 2026
a2a3e02
Add type definition for $args on wp_delete_term()
westonruter Jul 9, 2026
1f34314
Tighten parent and default to reject non-positive term IDs
westonruter Jul 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions src/wp-includes/taxonomy.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2047,6 +2047,12 @@ function wp_delete_object_term_relationships( $object_id, $taxonomies ) {
* }
* @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() ) {
global $wpdb;
Expand Down Expand Up @@ -2437,6 +2443,17 @@ function wp_get_object_terms( $object_ids, $taxonomies, $args = array() ) {
* @type int $term_id The new term ID.
* @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() ) {
global $wpdb;
Expand Down Expand Up @@ -2622,6 +2639,7 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
do_action( 'edited_terms', $term_id, $taxonomy );
}

/** @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 ) );

if ( ! empty( $tt_id ) ) {
Expand Down Expand Up @@ -3229,6 +3247,17 @@ function wp_unique_term_slug( $slug, $term ) {
* }
* @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() ) {
global $wpdb;
Expand Down
Loading