update_object_term_cache() WordPress Function

The update_object_term_cache() function is used to update the cache for an object with the given terms.

update_object_term_cache( string|int[] $object_ids, string|string[] $object_type ) #

Updates the cache for the given term object ID(s).

Description
Parameters
Return
Source
Related
- Uses
- Used By
Changelog

Description

Note: Due to performance concerns, great care should be taken to only update term caches when necessary. Processing time can increase exponentially depending on both the number of passed term IDs and the number of taxonomies those terms belong to.

Caches will only be updated for terms not already cached.

Top ↑

Parameters

$object_ids: (string|int[])(Required)Comma-separated list or array of term object IDs.
$object_type: (string|string[])(Required)The taxonomy object type or array of the same.

Top ↑

Return

(void|false) Void on success or if the $object_ids parameter is empty, false if all of the terms in $object_ids are already cached.

Top ↑

Source

File: wp-includes/taxonomy.php

function update_object_term_cache( $object_ids, $object_type ) {
    if ( empty( $object_ids ) ) {
        return;
    }
 
    if ( ! is_array( $object_ids ) ) {
        $object_ids = explode( ',', $object_ids );
    }
 
    $object_ids     = array_map( 'intval', $object_ids );
    $non_cached_ids = array();
 
    $taxonomies = get_object_taxonomies( $object_type );
 
    foreach ( $taxonomies as $taxonomy ) {
        $cache_values = wp_cache_get_multiple( (array) $object_ids, "{$taxonomy}_relationships" );
 
        foreach ( $cache_values as $id => $value ) {
            if ( false === $value ) {
                $non_cached_ids[] = $id;
            }
        }
    }
 
    if ( empty( $non_cached_ids ) ) {
        return false;
    }
 
    $non_cached_ids = array_unique( $non_cached_ids );
 
    $terms = wp_get_object_terms(
        $non_cached_ids,
        $taxonomies,
        array(
            'fields'                 => 'all_with_object_id',
            'orderby'                => 'name',
            'update_term_meta_cache' => false,
        )
    );
 
    $object_terms = array();
    foreach ( (array) $terms as $term ) {
        $object_terms[ $term->object_id ][ $term->taxonomy ][] = $term->term_id;
    }
 
    foreach ( $non_cached_ids as $id ) {
        foreach ( $taxonomies as $taxonomy ) {
            if ( ! isset( $object_terms[ $id ][ $taxonomy ] ) ) {
                if ( ! isset( $object_terms[ $id ] ) ) {
                    $object_terms[ $id ] = array();
                }
                $object_terms[ $id ][ $taxonomy ] = array();
            }
        }
    }
 
    $cache_values = array();
    foreach ( $object_terms as $id => $value ) {
        foreach ( $value as $taxonomy => $terms ) {
            $cache_values[ $taxonomy ][ $id ] = $terms;
        }
    }
    foreach ( $cache_values as $taxonomy => $data ) {
        wp_cache_add_multiple( $data, "{$taxonomy}_relationships" );
    }
}

Expand full source code Collapse full source codeView on TracView on GitHub

Top ↑

Uses

Uses
Uses	Description
wp-includes/cache.php:wp_cache_add_multiple()	Adds multiple values to the cache in one call.
wp-includes/cache.php:wp_cache_get_multiple()	Retrieves multiple values from the cache in one call.
wp-includes/taxonomy.php:wp_get_object_terms()	Retrieves the terms associated with the given object(s), in the supplied taxonomies.
wp-includes/taxonomy.php:get_object_taxonomies()	Returns the names or objects of the taxonomies which are registered for the requested object or object type, such as a post object or post type name.