wp_get_object_terms() | Fonctions Wordpress

Description

On peut noter que les résultats de wp_get_object_terms() ne sont pas mis en cache. Pour une question de performance on peut utiliser get_the_terms() dont les résultats sont mis en cache.

Paramètres

$object_ids

(int | int[]) (Requis) Ids des objets (ex : ids de postes)

$taxonomies

(string | string[]) (Requis) Noms des taxonomies auxquelles les objets sont associés.

$args

(array | string) (Optionnel) Arguments acceptés. Voir la fonction get_terms().

Valeur par défaut : array()

Retourne

(WP_Term[] | WP_Error) Tableau de termes ou tableau vide si aucuns termes n'est trouvés. WP_Error si les taxonomies n'existent pas.

Structure de la fonction `wp_get_object_terms()`

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

function wp_get_object_terms( $object_ids, $taxonomies, $args = array() ) {
    if ( empty( $object_ids ) || empty( $taxonomies ) ) {
        return array();
    }

    if ( ! is_array( $taxonomies ) ) {
        $taxonomies = array( $taxonomies );
    }

    foreach ( $taxonomies as $taxonomy ) {
        if ( ! taxonomy_exists( $taxonomy ) ) {
            return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
        }
    }

    if ( ! is_array( $object_ids ) ) {
        $object_ids = array( $object_ids );
    }
    $object_ids = array_map( 'intval', $object_ids );

    $args = wp_parse_args( $args );

    /**
     * Filter arguments for retrieving object terms.
     *
     * @since 4.9.0
     *
     * @param array    $args       An array of arguments for retrieving terms for the given object(s).
     *                             See {@see wp_get_object_terms()} for details.
     * @param int[]    $object_ids Array of object IDs.
     * @param string[] $taxonomies Array of taxonomy names to retrieve terms from.
     */
    $args = apply_filters( 'wp_get_object_terms_args', $args, $object_ids, $taxonomies );

    /*
     * When one or more queried taxonomies is registered with an 'args' array,
     * those params override the `$args` passed to this function.
     */
    $terms = array();
    if ( count( $taxonomies ) > 1 ) {
        foreach ( $taxonomies as $index => $taxonomy ) {
            $t = get_taxonomy( $taxonomy );
            if ( isset( $t->args ) && is_array( $t->args ) && array_merge( $args, $t->args ) != $args ) {
                unset( $taxonomies[ $index ] );
                $terms = array_merge( $terms, wp_get_object_terms( $object_ids, $taxonomy, array_merge( $args, $t->args ) ) );
            }
        }
    } else {
        $t = get_taxonomy( $taxonomies[0] );
        if ( isset( $t->args ) && is_array( $t->args ) ) {
            $args = array_merge( $args, $t->args );
        }
    }

    $args['taxonomy']   = $taxonomies;
    $args['object_ids'] = $object_ids;

    // Taxonomies registered without an 'args' param are handled here.
    if ( ! empty( $taxonomies ) ) {
        $terms_from_remaining_taxonomies = get_terms( $args );

        // Array keys should be preserved for values of $fields that use term_id for keys.
        if ( ! empty( $args['fields'] ) && 0 === strpos( $args['fields'], 'id=>' ) ) {
            $terms = $terms + $terms_from_remaining_taxonomies;
        } else {
            $terms = array_merge( $terms, $terms_from_remaining_taxonomies );
        }
    }

    /**
     * Filters the terms for a given object or objects.
     *
     * @since 4.2.0
     *
     * @param array    $terms      Array of terms for the given object or objects.
     * @param int[]    $object_ids Array of object IDs for which terms were retrieved.
     * @param string[] $taxonomies Array of taxonomy names from which terms were retrieved.
     * @param array    $args       Array of arguments for retrieving terms for the given
     *                             object(s). See wp_get_object_terms() for details.
     */
    $terms = apply_filters( 'get_object_terms', $terms, $object_ids, $taxonomies, $args );

    $object_ids = implode( ',', $object_ids );
    $taxonomies = "'" . implode( "', '", array_map( 'esc_sql', $taxonomies ) ) . "'";

    /**
     * Filters the terms for a given object or objects.
     *
     * The `$taxonomies` parameter passed to this filter is formatted as a SQL fragment. The
     * {@see 'get_object_terms'} filter is recommended as an alternative.
     *
     * @since 2.8.0
     *
     * @param array    $terms      Array of terms for the given object or objects.
     * @param int[]    $object_ids Array of object IDs for which terms were retrieved.
     * @param string[] $taxonomies Array of taxonomy names from which terms were retrieved.
     * @param array    $args       Array of arguments for retrieving terms for the given
     *                             object(s). See wp_get_object_terms() for details.
     */
    return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args );
}

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

wp_get_object_terms_args: Filtre les arguments pour recevoir les objets de termes.
get_object_terms: Filtre les termes pour des objets donnés.
__(): Retourne la traduction d'un texte.
wp_parse_args(): Fusionne des arguments définis par l'utilisateur dans un tableau par défaut.
wp_get_object_terms(): Retourne les termes associés aux ids d'objets donnés, en fournissant les taxonomies correspondantes.
wp_get_object_terms: Filtre les termes pour des objets donnés.
get_terms(): Retourne les termes pour une taxonomie donnée ou une liste de taxonomies.
taxonomy_exists(): Détermine si un nom de taxonomie existe.
get_taxonomy(): Retourne l'objet d'une taxonomie en donnant son nom.
apply_filters(): Appel les fonctions qui ont été attaché à un filtre (hook).

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

Exemple

Retourne une liste de tous les termes de la taxonomie 'produit' :

$product_terms = wp_get_object_terms( $post->ID,  'produit' );
 
if ( ! empty( $product_terms ) ) {
    if ( ! is_wp_error( $product_terms ) ) {
        echo '<ul>';
            foreach( $product_terms as $term ) {
                echo '<li><a href="' . esc_url( get_term_link( $term->slug, 'produit' ) ) . '">' . esc_html( $term->name ) . '</a></li>'; 
            }
        echo '</ul>';
    }
}

Sources

Codex Wordpress : wp_get_object_terms()

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

Retour