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

Removes term(s) associated with a given object.

Parameters

$object_idintrequired

The ID of the object from which the terms will be removed.

$termsstring|int|arrayrequired

The slug(s) or ID(s) of the term(s) to remove.

$taxonomystringrequired

Taxonomy name.

Return

Source

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_set_terms_last_changed();

		/**
		 * 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;
}

View all references View on Trac View on GitHub

Hooks

do_action( ‘deleted_term_relationships’, int $object_id, array $tt_ids, string $taxonomy )

Fires immediately after an object-term relationship is deleted.

do_action( ‘delete_term_relationships’, int $object_id, array $tt_ids, string $taxonomy )

Fires immediately before an object-term relationship is deleted.

Related

Changelog

User Contributed Notes

1. Skip to note 3 content
   Codex 11 years ago
   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   Example

   Remove tag from post.

   wp_remove_object_terms( $post_id, 'sweet', 'post_tag' );

   Log in to add feedback
2. Skip to note 4 content
   Tunn 4 years ago
   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   Even though it’s not specified, I found that $terms can also be the names of terms.

   $post_tags = array(
      'Tag name',
      'Another tag name',
   );
   
   wp_remove_object_terms( $post_id, $post_tags, 'post_tag' );

   Log in to add feedback