wp_remove_object_terms( int $object_id, string|int|array $terms, array|string $taxonomy )
Remove term(s) associated with a given object.
Parameters
- $object_id
-
(Required) The ID of the object from which the terms will be removed.
- $terms
-
(Required) The slug(s) or ID(s) of the term(s) to remove.
- $taxonomy
-
(Required) Taxonomy name.
Return
(bool|WP_Error) True on success, false or WP_Error on failure.
Source
File: wp-includes/taxonomy.php
function wp_remove_object_terms( $object_id, $terms, $taxonomy ) {
global $wpdb;
$object_id = (int) $object_id;
if ( ! taxonomy_exists( $taxonomy ) ) {
return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
}
if ( ! is_array( $terms ) ) {
$terms = array( $terms );
}
$tt_ids = array();
foreach ( (array) $terms as $term ) {
if ( ! strlen( trim( $term ) ) ) {
continue;
}
if ( ! $term_info = term_exists( $term, $taxonomy ) ) {
// Skip if a non-existent term ID is passed.
if ( is_int( $term ) ) {
continue;
}
}
if ( is_wp_error( $term_info ) ) {
return $term_info;
}
$tt_ids[] = $term_info['term_taxonomy_id'];
}
if ( $tt_ids ) {
$in_tt_ids = "'" . implode( "', '", $tt_ids ) . "'";
/**
* Fires immediately before an object-term relationship is deleted.
*
* @since WP-2.9.0
* @since WP-4.7.0 Added the `$taxonomy` parameter.
*
* @param int $object_id Object ID.
* @param array $tt_ids An array of term taxonomy IDs.
* @param string $taxonomy Taxonomy slug.
*/
do_action( 'delete_term_relationships', $object_id, $tt_ids, $taxonomy );
$deleted = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id IN ($in_tt_ids)", $object_id ) );
wp_cache_delete( $object_id, $taxonomy . '_relationships' );
wp_cache_delete( 'last_changed', 'terms' );
/**
* Fires immediately after an object-term relationship is deleted.
*
* @since WP-2.9.0
* @since WP-4.7.0 Added the `$taxonomy` parameter.
*
* @param int $object_id Object ID.
* @param array $tt_ids An array of term taxonomy IDs.
* @param string $taxonomy Taxonomy slug.
*/
do_action( 'deleted_term_relationships', $object_id, $tt_ids, $taxonomy );
wp_update_term_count( $tt_ids, $taxonomy );
return (bool) $deleted;
}
return false;
}
Changelog
Version | Description |
---|---|
WP-3.6.0 | Introduced. |