esc_html

Escaping for HTML blocks.

Description

(string) esc_html__( (string) $text, (string) $domain = 'default' ); 

If there is no translation, or the text domain isn't loaded, the original text is returned.

Returns (string)

Translated text

Parameters (2)

0. $text (string)
Text to translate.
1. $domain — Optional. (string) => 'default'
Text domain. Unique identifier for retrieving translated strings. Default default..

Usage

  1. if ( !function_exists( 'esc_html__' ) ) { 
  2.     require_once ABSPATH . WPINC . '/l10n.php'; 
  3. } 
  4.   
  5. // Text to translate. 
  6. $text = ''; 
  7.   
  8. // Optional. Text domain. Unique identifier for retrieving translated strings. 
  9. // Default 'default'. 
  10. $domain = 'default'; 
  11.   
  12. // NOTICE! Understand what this does before running. 
  13. $result = esc_html__($text, $domain); 
  14.     

Defined (2)

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

/wp-includes/l10n.php  
  1. function esc_html__( $text, $domain = 'default' ) { 
  2.     return esc_html( translate( $text, $domain ) ); 
  3. } 
/wp-includes/formatting.php  
  1. function esc_html( $text ) { 
  2.     $safe_text = wp_check_invalid_utf8( $text ); 
  3.     $safe_text = _wp_specialchars( $safe_text, ENT_QUOTES ); 
  4.     /** 
  5.      * Filters a string cleaned and escaped for output in HTML. 
  6.      * 
  7.      * Text passed to esc_html() is stripped of invalid or special characters 
  8.      * before output. 
  9.      * 
  10.      * @since 2.8.0 
  11.      * 
  12.      * @param string $safe_text The text after it has been escaped. 
  13.       * @param string $text      The text prior to being escaped. 
  14.      */ 
  15.     return apply_filters( 'esc_html', $safe_text, $text ); 
  16. }