sites_site_format

The WordPress Core sites site format hook.

Description

add_filter( 'sites_site_format', (callback) $array ); 

Parameters (1)

0. $array (callback) => array( $this, 'site_format' )
The array.

Usage

To run the hook, copy the example below.
  1. $array = apply_filters( 'sites_site_format', $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 sites_site_format callback 
  2. function filter_sites_site_format( $array ) { 
  3. // make filter magic happen here... 
  4. return $array
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'sites_site_format', 'filter_sites_site_format', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'sites_site_format', 'filter_sites_site_format', 10, 1 ); 

Defined (2)

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

/json-endpoints/class.wpcom-json-api-get-site-v1-2-endpoint.php  
  1. add_filter( 'sites_site_format', array( $this, 'site_format' ) ); 
/json-endpoints/class.wpcom-json-api-get-site-endpoint.php  
  1. $default_fields = array_keys( apply_filters( 'sites_site_format', self::$site_format ) );