gettext

Filters text with its translation.

Description

apply_filters( 'gettext', (string) $translations, (string) $text, (string) $domain ); 

Parameters (3)

0. $translations (string)
The translations.
1. $text (string)
Text to translate.
2. $domain (string)
Text domain. Unique identifier for retrieving translated strings.

Usage

To run the hook, copy the example below.
  1. $translations = apply_filters( 'gettext', $translations, $text, $domain ); 
  2.  
  3. if ( !empty( $translations ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the gettext callback 
  2. function filter_gettext( $translations, $text, $domain ) { 
  3. // make filter magic happen here... 
  4. return $translations
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'gettext', 'filter_gettext', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'gettext', 'filter_gettext', 10, 3 ); 

Defined (1)

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

/wp-includes/l10n.php  
  1. return apply_filters( 'gettext', $translations, $text, $domain );