the_sites filter-hookWP 4.6.0

Filters the site query results.

Usage

add_filter( 'the_sites', 'wp_kama_the_sites_filter', 10, 2 );

/**
 * Function for `the_sites` filter-hook.
 * 
 * @param WP_Site[]     $_sites An array of WP_Site objects.
 * @param WP_Site_Query $query  Current instance of WP_Site_Query (passed by reference).
 *
 * @return WP_Site[]
 */
function wp_kama_the_sites_filter( $_sites, $query ){

	// filter...
	return $_sites;
}
$_sites(WP_Site[])
An array of WP_Site objects.
$query(WP_Site_Query)
Current instance of WP_Site_Query (passed by reference).

Changelog

Since 4.6.0 Introduced.

Where the hook is called

WP_Site_Query::get_sites()
the_sites
wp-includes/class-wp-site-query.php 418
$_sites = apply_filters_ref_array( 'the_sites', array( $_sites, &$this ) );

Where the hook is used in WordPress

Usage not found.