wp_remove_object_terms() | Fonctions Wordpress

Paramètres

$object_id: (int) (Requis) Id de l'objet dont on veut supprimer les termes associés.
$terms: (string | int | array) (Requis) Les slugs ou ids des termes à supprimer.
$taxonomy: (array | string) (Requis) Nom de la ou des taxonomies auxquelles appartiennent les termes à supprimer.

Retourne

(bool | WP_Error) True si succès, false ou WP_Error si échec.

Structure de la fonction `wp_remove_object_terms()`

Définie dans le fichier wp-includes/taxonomy.php à la ligne 2709 :

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

Fonctions et Hooks utilisés par `wp_remove_object_terms()`

wp_cache_delete(): Supprime les contenus du cache correspondant à la clé et au groupe.
__(): Retourne la traduction d'un texte.
wp_update_term_count(): Met à jour la quantité de termes dans une taxonomie.
delete_term_relationships: Se lance juste avant que la relation objet - terme soit supprimée.
deleted_term_relationships: Se lance juste après que la relation objet - terme soit supprimée.
term_exists(): Détermine si le terme d'une taxonomie existe.
taxonomy_exists(): Détermine si un nom de taxonomie existe.
do_action(): Exécute des fonctions attachées à un hook spécifique.
is_wp_error(): Vérifie si la variable est une erreur WordPress.

Où trouver la fonction `wp_remove_object_terms()` dans le CMS Wordpress

Exemple

Supprimer une étiquette d'un poste :

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

Sources

Codex Wordpress : wp_remove_object_terms()

Autres fonctions dans le même fichier : wp-includes/taxonomy.php

Retour