esc_html_x( string $text, string $context, string $domain = 'default' ): string

User Contributed Notes

1. Skip to note 2 content

   Abdul Hadi 5 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

   The _x functions (like esc_html_x) are essentially the same as their _e counterparts, with an added “context” argument to explain the context a word or phrase is used in. Useful for words with multiple meanings:

   <!-- Here, we're asking the user to comment (verb): -->
   <a href="#comment">
     <?php 
       echo esc_html_x( 
         'Comment', 
         'Verb: To leave a comment', // Here's the contextual help
         'wpdocs_my_theme' 
       ); 
     ?>
   </a>
   <!-- Here, we're simply adding a heading with the text "Comment" (noun) -->
   <h3>
     <?php 
       echo esc_html_x( 
         'Comment', 
         'Noun: An individual comment', // Here's the contextual help
         'wpdocs_my_theme' 
       ); 
     ?>
   </h3>

   • There’s another key difference, he `_e` counterparts will output where `_x` will not. No need to echo before _e.

     admcfajn 4 years ago
   • I think it’s more accurate to say that “_x functions are essentially the same as their __ counterparts”, since _e functions include echo while _x and __ do not.

     Santiago Becerra 4 years ago