wp_delete_term( int $term, string $taxonomy, array|string $args = array() ): bool|int|WP_Error

Description

Parameters

$termint

Term ID.

$taxonomystring

Taxonomy name.

$argsarray|stringoptional

Array of arguments to override the default term ID. Default empty array.Default: array()

• $defaultint

  The term ID to make the default term. This will only override the terms found if there is only one term found. Any other and the found terms are used.

• $force_defaultbooldefault: false

  Optional. Whether to force the supplied term as default to be assigned even if the object was not going to be term-less.

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.

Hooks fired · 7

7 hooks fire while wp_delete_term() runs, in this order:

1. 1
   do_action( pre_delete_term )actionline 2088 (+54 into the body)

   Fires when deleting a term, before any modifications are made to posts or terms.

2. 2
   do_action( edit_term_taxonomies )actionline 2108 (+74 into the body)

   Fires immediately before a term to delete's children are reassigned a parent.

3. 3
   do_action( edited_term_taxonomies )actionline 2123 (+89 into the body)

   Fires immediately after a term to delete's children are reassigned a parent.

4. 4
   do_action( delete_term_taxonomy )actionline 2177 (+143 into the body)

   Fires immediately before a term taxonomy ID is deleted.

5. 5
   do_action( deleted_term_taxonomy )actionline 2188 (+154 into the body)

   Fires immediately after a term taxonomy ID is deleted.

6. 6
   do_action( delete_term )actionline 2212 (+178 into the body)

   Fires after a term is deleted from the database and the cache is cleaned.

7. 7
   do_action( delete_{$taxonomy} )actionline 2233 (+199 into the body)

   Fires after a term in a specific taxonomy is deleted.

Uses · 15

• term_exists()Determines whether a taxonomy term exists.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_option()Retrieves an option value based on an option name.
• get_taxonomy()Retrieves the taxonomy object of $taxonomy.
• wp_parse_args()Merges user defined arguments into defaults array.
• do_action()Calls the callback functions that have been added to an action hook.
• is_taxonomy_hierarchical()Determines whether the taxonomy object is hierarchical.
• get_term()Gets all term data from database by term ID.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• clean_term_cache()Removes all of the term IDs from the cache.
• wp_remove_object_terms()Removes term(s) associated with a given object.
• wp_get_object_terms()Retrieves the terms associated with the given object(s), in the supplied taxonomies.

Used by · 7

• WP_REST_Terms_Controller::delete_item()Deletes a single term from a taxonomy.
• upgrade_350()Execute changes made in WordPress 3.5.
• wp_ajax_delete_tag()Handles deleting a tag via AJAX.
• wp_delete_category()Deletes one existing category.
• wp_delete_nav_menu()Deletes a navigation menu.
• wp_xmlrpc_server::wp_deleteCategory()Deletes a category.
• wp_xmlrpc_server::wp_deleteTerm()Deletes a term.

Source

View on Trac ↗View on GitHub ↗

2034function wp_delete_term( $term, $taxonomy, $args = array() ) {2035	global $wpdb;2036 2037	$term = (int) $term;2038 2039	$ids = term_exists( $term, $taxonomy );2040	if ( ! $ids ) {2041		return false;2042	}2043	if ( is_wp_error( $ids ) ) {2044		return $ids;2045	}2046 2047	$tt_id = $ids['term_taxonomy_id'];2048 2049	$defaults = array();2050 2051	if ( 'category' === $taxonomy ) {2052		$defaults['default'] = (int) get_option( 'default_category' );2053		if ( $defaults['default'] === $term ) {2054			return 0; // Don't delete the default category.2055		}2056	}2057 2058	// Don't delete the default custom taxonomy term.2059	$taxonomy_object = get_taxonomy( $taxonomy );2060	if ( ! empty( $taxonomy_object->default_term ) ) {2061		$defaults['default'] = (int) get_option( 'default_term_' . $taxonomy );2062		if ( $defaults['default'] === $term ) {2063			return 0;2064		}2065	}2066 2067	$args = wp_parse_args( $args, $defaults );2068 2069	if ( isset( $args['default'] ) ) {2070		$default = (int) $args['default'];2071		if ( ! term_exists( $default, $taxonomy ) ) {2072			unset( $default );2073		}2074	}2075 2076	if ( isset( $args['force_default'] ) ) {2077		$force_default = $args['force_default'];2078	}2079 2080	/**2081	 * Fires when deleting a term, before any modifications are made to posts or terms.2082	 *2083	 * @since 4.1.02084	 *2085	 * @param int    $term     Term ID.2086	 * @param string $taxonomy Taxonomy name.2087	 */2088	do_action( 'pre_delete_term', $term, $taxonomy );2089 2090	// Update children to point to new parent.2091	if ( is_taxonomy_hierarchical( $taxonomy ) ) {2092		$term_obj = get_term( $term, $taxonomy );2093		if ( is_wp_error( $term_obj ) ) {2094			return $term_obj;2095		}2096		$parent = $term_obj->parent;2097 2098		$edit_ids    = $wpdb->get_results( "SELECT term_id, term_taxonomy_id FROM $wpdb->term_taxonomy WHERE `parent` = " . (int) $term_obj->term_id );2099		$edit_tt_ids = wp_list_pluck( $edit_ids, 'term_taxonomy_id' );2100 2101		/**2102		 * Fires immediately before a term to delete's children are reassigned a parent.2103		 *2104		 * @since 2.9.02105		 *2106		 * @param array $edit_tt_ids An array of term taxonomy IDs for the given term.2107		 */2108		do_action( 'edit_term_taxonomies', $edit_tt_ids );2109 2110		$wpdb->update( $wpdb->term_taxonomy, compact( 'parent' ), array( 'parent' => $term_obj->term_id ) + compact( 'taxonomy' ) );2111 2112		// Clean the cache for all child terms.2113		$edit_term_ids = wp_list_pluck( $edit_ids, 'term_id' );

History

Introduced in 2.3.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/taxonomy.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.