Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Intro to I18N in code

Intro to I18N in code

Short introduction to writing code that can be easily translated in WordPress

B17c1f19d80bf8f61c3f14962153f959?s=128

Matthew Haines-Young

May 13, 2015
Tweet

Transcript

  1. I18N Making your code translatable.

  2. How translation it works. • Uses the gettext libraries. •

    Wrap translatable strings in special gettext functions • Automated process - scans your code • Creates POT (Portable Objects Template) file with all translatable strings.
  3. Note: Code is not executed when scanning for translatable strings.

  4. Setup • Add the Text Domain to the theme/plugin header.

    • This is a unique identifier. • Use dashes not underscores
  5. __( 'string', 'text-domain' ) Basic translation function

  6. _e( 'string', 'text-domain' ) Same, but outputs result.

  7. Translate strings, not HTML

  8. You cannot use variables in translatable strings. Translate placeholders and

    use sprintf/printf
  9. Don’t use variable for text domain.

  10. Plurals • _n( $singular, $plural, $count, ‘text- domain’ ) •

    1st param: the singular form of the string • 2nd param: the plural form of the string • 3rd param: the count.
  11. _x( ‘string', 'context', 'text- domain' ); Disambiguation by context. Also

    _ex. Same but outputs.
  12. JavaScript • Use wp_localize_script to pass strings.

  13. Resources • VIDEO: Rules for WordPress i18n - http://wordpress.tv/2014/02/26/ samuel-otto-wood-on-internationalization-plugins-and-themes-for-the-

    whole-world/ • Otto on i18n - http://ottopress.com/2012/internationalization-youre- probably-doing-it-wrong/ • Plugin i18n - https://developer.wordpress.org/plugins/ internationalization/ • Theme i18n - https://developer.wordpress.org/themes/functionality/ internationalization/ • i18n quiz for developers: https://developer.wordpress.com/2015/04/23/ wordpress-developers-test-your-i18n-internationalization-knowledge/