sites_site_format
The WordPress Core sites site format hook.
Description
Parameters (1)
- 0. $array (callback) =>
array( $this, 'site_format' )
- The array.
Usage
- To run the hook, copy the example below.
- $array = apply_filters( 'sites_site_format', $array );
- if ( !empty( $array ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the sites_site_format callback
- function filter_sites_site_format( $array ) {
- // make filter magic happen here...
- return $array;
- };
- // add the filter
- add_filter( 'sites_site_format', 'filter_sites_site_format', 10, 1 );
- To remove a hook callback, use the example below.
- // remove the filter
- 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
- add_filter( 'sites_site_format', array( $this, 'site_format' ) );
- /json-endpoints/class.wpcom-json-api-get-site-endpoint.php
- $default_fields = array_keys( apply_filters( 'sites_site_format', self::$site_format ) );