switch_locale

Fires when the locale is switched.

Description

do_action( 'switch_locale', (string) $locale ); 

Parameters (1)

0. $locale (string)
The new locale.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'switch_locale', $locale ); 
The following example is for adding a hook callback.
  1. // define the switch_locale callback 
  2. function action_switch_locale( $locale ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'switch_locale', 'action_switch_locale', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'switch_locale', 'action_switch_locale', 10, 1 ); 

Defined (1)

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

/wp-includes/class-wp-locale-switcher.php  
  1. do_action( 'switch_locale', $locale );