sites_site_options_format

The WordPress Core sites site options format hook.

Description

apply_filters( 'sites_site_options_format', (string) $self_site_options_format ); 

Parameters (1)

0. $self_site_options_format (string) => self::$site_options_format
The self site options format.

Usage

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

Defined (1)

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

/json-endpoints/class.wpcom-json-api-get-site-endpoint.php  
  1. $all_options = apply_filters( 'sites_site_options_format', self::$site_options_format );