1. Escribir con la localización en mente
No use echo
o print()
para producir salida de texto, en su lugar use las funciones de WordPress __()
y _e()
:
/** Not localization friendly */
echo "Welcome to my plugin";
// OR
print("Welcome to my plugin");
/** Localization friendly */
_e('Welcome to my plugin', 'my-plugin');
// OR
$my_text = __('Welcome to my plugin', 'my-plugin');
echo $my_text;
_e()
y __()
proporcionará la traducción, en el idioma actual, del texto proporcionado como primer parámetro. _e()
generará el texto mientras que __()
lo devolverá.
El segundo parámetro es el dominio de texto , lo usará para decirle a WordPress que el texto proporcionado como primer parámetro pertenece a este complemento, puede usar el nombre que desee, pero prefiero usar el mismo nombre que usé para el complemento archivo de directorio, lo encuentro más intuitivo.
¿Cómo generar texto dinámico como: "Hola <nombre de usuario>"?
Con __()
y sprintf()
:
/** Get the username */
$username = 'Magictrick';
/** Not localization friendly */
echo "Hello $username";
/** Localization friendly */
printf(__('Hello %s', 'my-plugin'), $username);
// OR
$my_text = sprintf(__('Hello %s', 'my-plugin'), $username);
echo $my_text;
2. Prepare los archivos .pot / .po / .mo
Definiciones
- El archivo .pot : está a su disposición por el desarrollador del complemento y se usa como punto de partida para crear nuevas traducciones, WordPress no lo usa.
- Un archivo .po : es un archivo de traducción que usted u otra persona comenzaron, y tal vez completado, WordPress no lo usa.
- Archivo A.mo : Poedit crea automáticamente cada vez que guarda un archivo .po, todo lo que puede hacer con estos archivos es cargarlos o volver a cargarlos cada vez que cree o actualice un archivo .po. WordPress obtiene traducciones de archivos .mo .
Abra Poedit y cree un nuevo catálogo (Archivo ›Nuevo catálogo ...) con esta configuración:
- Información del proyecto: use su información (o la de su equipo), el idioma y el país deben coincidir con el idioma predeterminado de su complemento
- Rutas:
- Camino base:
.
- Rutas: elimine todo y agregue
..
, (almacenaremos el archivo de idioma en un subdirectorio de plugin llamado idiomas)
- Palabras clave: eliminar todo y agregar
__
y_e
Guarde el catálogo como y escanee sus archivos de complemento en busca de texto traducible presionando el botón de actualización. Cuando finalice la actualización, cierre ese catálogo, no necesitará actualizar ese archivo a menos que agregue nuevas cadenas traducibles (es decir, incluidas en o ) a su complemento./my_wordpress_blog/wp-content/plugins/my-plugin/languages/my-plugin.pot
__()
_e()
Ahora creemos la primera traducción (usaré fr_FR):
Con Podeit , cree un catálogo desde un archivo POT
(Archivo ›Nuevo catálogo desde un archivo POT ...) :
- Información del proyecto: use su información (o la de su equipo), cambie el idioma y el país , usaré francés y Francia
- Caminos: no cambies
- Palabras clave: no cambies
Guarde el catálogo como . Traduzca algunas o todas las cadenas, guarde el archivo .po nuevamente, cargue los archivos .po y .mo./my_wordpress_blog/wp-content/plugins/my-plugin/languages/my-plugin-fr_FR.po
Tenga en cuenta que cada vez que guarda un archivo .po, se genera un archivo .mo con el mismo nombre, el nombre de archivo del archivo .po es crucial , se compone de la concatenación del dominio de texto del complemento (my-plugin) y el idioma local ( fr_FR), siempre nombra tus archivos .po para complementos como este: [textdomain] - [locale] .po , aquí hay algunos ejemplos:
- Italiano / Italia:
wpcf7-it_IT.po
- Portugués / Brasil:
wpcf7-pt_BR.po
- Árabe:
wpcf7-ar.po
... ¡Sí!
Siempre que el complemento se actualice con texto nuevo, actualice el archivo po, traduzca nuevas cadenas y vuelva a cargar los archivos .po y .mo
3. Indique al complemento que cargue el texto traducido para el idioma actual
En algún lugar de su complemento, debe decirle a WordPress que use su archivo .mo, puede hacerlo usando este código al comienzo de su archivo de complemento:
function my_plugin_init() {
load_plugin_textdomain( 'my-plugin', false, 'my-plugin/languages' );
}
add_action('init', 'my_plugin_init');
Reemplace my-plugin
con el nombre de su complemento en el primer y tercer parámetro de la load_plugin_textdomain
función.
4. Prueba y solución de problemas
Algunas razones pueden no funcionar:
- Las cadenas no se importan al archivo .pot o .po
- → Configuración de catálogo incorrecta (ruta o palabras clave o ambas)
- El texto no está traducido en el sitio de WordPress
- → Falta el archivo .mo para ese idioma o tiene un nombre de archivo incorrecto
- → Dominio de texto no utilizado (reemplazar
_e('my text')
con _e('my text', 'my-plugin')
)
- → El dominio de texto no está cargado (use el ejemplo anterior con los parámetros correctos, WP no le advertirá sobre los errores)