In a global world, making sure that WordPress themes or plugins are prepared for easy translation is of the highest importance. By doing that, you’re making sure that your plugin or theme can be translated and used by people who don’t necessarily speak English. And that could sometimes mean millions and millions of users. Therefore, WordPress developers prepared several functions and here are some of them:
|
1 2 3 4 5 |
__ ( $text, $domain = 'default' ) _x ( $text, $context, $domain = 'default' ) _n ( $single, $plural, $number, $domain = 'default' ) _ex ( $text, $context, $domain = 'default' ... |
__ function
Consider the following example:
|
1 |
<?php printf( __( 'I am ready to be translated', 'theme-domain' ))?> |
In this one, ‘theme-domain’ is your theme text domain and should be the same all across the theme (or plugin). The first string (I am ready to be translated) is what outputs by default (default language).
Note that you can’t add variables where $text variable goes – if you want to do it, you will need placeholders. Here’s an example:
|
1 |
<?php printf( __( 'View all posts by %s', 'twentyfifteen' ), get_the_author() ); ?> |
Placeholder is %s and variable is whatever the value get_the_author() returns.
In other words, this will not work:
|
1 |
<?php printf (__( 'His name is $author ', 'twentyfifteen' ));?> |
And the reason is simple – gettext will read text only, and not variables.
_x function
There’s a great example for _x function (and even more for placeholders) in Twenty Fifteen theme – if you check the earlier syntax, the only difference is that it adds context in which translation appears. This is very useful if you have an exact string (such as Posted on) which appears in different templates.
|
1 2 3 4 5 6 7 |
$tags_list = get_the_tag_list( '', _x( ', ', 'Used between list items, there is a space after the comma.', 'twentyfifteen' ) ); if ( $tags_list ) { printf( '<span class="tags-links"><span class="screen-reader-text">%1$s </span>%2$s</span>', _x( 'Tags', 'Used before tag names.', 'twentyfifteen' ), $tags_list, __('my added parameter','text-under') ); } |
Consider the placeholders first; these are %1$s and %2$s, which means it will accept next two variables (“s” goes for string) in that order. In this case, variables are whatever _x and $tags_list return. In this example, _x returns ‘Tags‘ by default, twentyfifteens is the themes’ textdomain, while ‘Used before tag names’ is description (context) providing information on where this string appears and is very useful for anyone who will translate the theme into their language.
_nx function
Consider the following example:
|
1 2 3 4 5 6 7 8 9 10 |
if ( have_comments() ) : ?> <h2 class="comments-title"> <?php printf( // WPCS: XSS OK. esc_html( _nx( 'One thought on “%2$s”', '%1$s thoughts on “%2$s”', get_comments_number(), 'comments title', 'bbird-prius' ) ), number_format_i18n( get_comments_number() ), '<span>' . get_the_title() . '</span>' ); ?> </h2> |
Whenever you need different wording for cases where you count something (such as 1 comment, 2 comments…) and where you’ll have singular and plural, you will have a great use of _nx function (or _n, given that it is actually _nx, but without the context parameter). In the example above (note that we are also using escapes), _nx will accept two options, depending on number of comments. You can also see that this function accepts variables (comment counter).
There are also some other WordPress functions with similar combinations which you can use depending on what you need. For further reading, I definitely suggest post by Otto in which he covers the topic in more detail.