WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

_prime_site_caches()

_prime_site_caches( array $ids, bool $update_meta_cache = true )

In this article

Back to top

Adds any sites from the given IDs to the cache that do not already exist in cache.

Description

See also

Parameters

$idsarrayrequired
ID list.
$update_meta_cachebooloptional
Whether to update the meta cache.

Default:true

Source

function _prime_site_caches( $ids, $update_meta_cache = true ) {
	global $wpdb;

	$non_cached_ids = _get_non_cached_ids( $ids, 'sites' );
	if ( ! empty( $non_cached_ids ) ) {
		$fresh_sites = $wpdb->get_results( sprintf( "SELECT * FROM $wpdb->blogs WHERE blog_id IN (%s)", implode( ',', array_map( 'intval', $non_cached_ids ) ) ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

		update_site_cache( $fresh_sites, false );
	}

	if ( $update_meta_cache ) {
		wp_lazyload_site_meta( $ids );
	}
}

View all references View on Trac View on GitHub

UsesDescription
wp_lazyload_site_meta()wp-includes/ms-site.php

Queue site meta for lazy-loading.

update_site_cache()wp-includes/ms-site.php

Updates sites in cache.

_get_non_cached_ids()wp-includes/functions.php

Retrieves IDs that are not already present in the cache.

wpdb::get_results()wp-includes/class-wpdb.php

Retrieves an entire SQL result set from the database (i.e., many rows).

Show 1 moreShow less
Used byDescription
WP_Site_Query::get_sites()wp-includes/class-wp-site-query.php

Retrieves a list of sites matching the query vars.

Changelog

VersionDescription
6.3.0Use wp_lazyload_site_meta() for lazy-loading of site meta.
6.1.0This function is no longer marked as "private".
5.1.0Introduced the $update_meta_cache parameter.
4.6.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.