locale

Initializes the locale switcher.

Description

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

Hooks into the filter to change the locale on the fly.

Parameters (1)

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

Usage

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

Defined (3)

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

/wp-includes/class-wp-locale-switcher.php  
  1. add_filter( 'locale', array( $this, 'filter_locale' ) ); 
/wp-includes/l10n.php  
  1. return apply_filters( 'locale', $locale ); 
  1. return apply_filters( 'locale', $locale );