wp_remove_object_terms

Remove term(s) associated with a given object.

Description

(bool|WP_Error) wp_remove_object_terms( (int) $object_id, (array|int|string) $terms, (array|string) $taxonomy ); 

Returns (bool|WP_Error)

True on success, false or WP_Error on failure.

Parameters (3)

0. $object_id (int)
The ID of the object from which the terms will be removed.
1. $terms (array|int|string)
The slug(s) or ID(s) of the term(s) to remove.
2. $taxonomy (array|string)
Taxonomy name.

Usage

  1. if ( !function_exists( 'wp_remove_object_terms' ) ) { 
  2.     require_once ABSPATH . WPINC . '/taxonomy.php'; 
  3. } 
  4.   
  5. // The ID of the object from which the terms will be removed. 
  6. $object_id = -1; 
  7.   
  8. // The slug(s) or ID(s) of the term(s) to remove. 
  9. $terms = null; 
  10.   
  11. // Taxonomy name. 
  12. $taxonomy = null; 
  13.   
  14. // NOTICE! Understand what this does before running. 
  15. $result = wp_remove_object_terms($object_id, $terms, $taxonomy); 
  16.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/taxonomy.php  
  1. function wp_remove_object_terms( $object_id, $terms, $taxonomy ) { 
  2.     global $wpdb; 
  3.  
  4.     $object_id = (int) $object_id; 
  5.  
  6.     if ( ! taxonomy_exists( $taxonomy ) ) { 
  7.         return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 
  8.     } 
  9.  
  10.     if ( ! is_array( $terms ) ) { 
  11.         $terms = array( $terms ); 
  12.     } 
  13.  
  14.     $tt_ids = array(); 
  15.  
  16.     foreach ( (array) $terms as $term ) { 
  17.         if ( ! strlen( trim( $term ) ) ) { 
  18.             continue; 
  19.         } 
  20.  
  21.         if ( ! $term_info = term_exists( $term, $taxonomy ) ) { 
  22.             // Skip if a non-existent term ID is passed. 
  23.             if ( is_int( $term ) ) { 
  24.                 continue; 
  25.             } 
  26.         } 
  27.  
  28.         if ( is_wp_error( $term_info ) ) { 
  29.             return $term_info; 
  30.         } 
  31.  
  32.         $tt_ids[] = $term_info['term_taxonomy_id']; 
  33.     } 
  34.  
  35.     if ( $tt_ids ) { 
  36.         $in_tt_ids = "'" . implode( "', '", $tt_ids ) . "'"; 
  37.  
  38.         /** 
  39.          * Fires immediately before an object-term relationship is deleted. 
  40.          * 
  41.          * @since 2.9.0 
  42.          * @since 4.7.0 Added the `$taxonomy` parameter. 
  43.          * 
  44.          * @param int   $object_id Object ID. 
  45.          * @param array $tt_ids    An array of term taxonomy IDs. 
  46.          * @param string $taxonomy  Taxonomy slug. 
  47.          */ 
  48.         do_action( 'delete_term_relationships', $object_id, $tt_ids, $taxonomy ); 
  49.         $deleted = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id IN ($in_tt_ids)", $object_id ) ); 
  50.  
  51.         wp_cache_delete( $object_id, $taxonomy . '_relationships' ); 
  52.  
  53.         /** 
  54.          * Fires immediately after an object-term relationship is deleted. 
  55.          * 
  56.          * @since 2.9.0 
  57.          * @since 4.7.0 Added the `$taxonomy` parameter. 
  58.          * 
  59.          * @param int    $object_id Object ID. 
  60.          * @param array  $tt_ids    An array of term taxonomy IDs. 
  61.          * @param string $taxonomy  Taxonomy slug. 
  62.          */ 
  63.         do_action( 'deleted_term_relationships', $object_id, $tt_ids, $taxonomy ); 
  64.  
  65.         wp_update_term_count( $tt_ids, $taxonomy ); 
  66.  
  67.         return (bool) $deleted; 
  68.     } 
  69.  
  70.     return false; 
  71. }