the_sites

Filters the site query results.

Description

apply_filters( 'the_sites', (array) $array ); 

Parameters (1)

0. $array (array) => array( $_sites, &$this )
The array.

Usage

To run the hook, copy the example below.
  1. $array = apply_filters( 'the_sites', $array ); 
  2.  
  3. if ( !empty( $array ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the the_sites callback 
  2. function filter_the_sites( $array ) { 
  3. // make filter magic happen here... 
  4. return $array
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'the_sites', 'filter_the_sites', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'the_sites', 'filter_the_sites', 10, 1 ); 

Defined (1)

The filter is defined in the following location(s).

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