wp_remove_object_terms() │ WP 3.6.0

Remove term(s) associated with a given object.

Uses: term_exists()
Used By: wp_delete_object_term_relationships()
Hooks from the function

Return

true|false|WP_Error. True on success, false or WP_Error on failure.

Usage

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

Examples

0

#1 Removing tags from a post

An example showing how to remove a post from a post_tag taxonomy term:

$post_id  = 5;
$terms    = 'sweet';
$taxonomy = 'post_tag';

$done = wp_remove_object_terms( $post_id, $terms, $taxonomy );

if( $done ){
	echo "Tag posts deleted.";
}
else {
	echo "Failed to delete the tag.";
}

Notes

  • Global. wpdb. $wpdb WordPress database abstraction object.

Changelog

Since 3.6.0 Introduced.

wp_remove_object_terms() code WP 6.1.1

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 ( '' === trim( $term ) ) {
			continue;
		}

		$term_info = term_exists( $term, $taxonomy );
		if ( ! $term_info ) {
			// 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 2.9.0
		 * @since 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 2.9.0
		 * @since 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;
}

For posts