What is "Theme and plugin translation for Polylang"?
Extension for Polylang plugin (Polylang is an extension to make multilingual WordPress websites.).
Plugin is needed to translate the WordPress themes and plugins by Polylang.
How to configure it?
Select themes and plugins to find texts for translation by Polylang.
In admin dashboard:
Languages -> TTfP Settings
How it is work?
"Theme and plugin translation for Polylang" automatically searches all files of WordPress themes and plugins. It chooses from this file only those files with extensions:
In addition, is implemented the integration with Timber library (read more:
http://timber.upstatement.com) – which allows to translate twig's skins in simple way.
Plugin in searched skins or plugins chooses texts from Polylang functions, such as:
- _e(string $text, string $domain = 'default');
- __(string $text, string $domain = 'default');
- _x(string $text, string $context, string $domain = 'default');
- pll_e(string $text);
- pll__(string $text);
- esc_html(string $text);
- esc_html_e(string $text, string $domain = 'default');
- esc_html__(string $text, string $domain = 'default');
- _n(string $single, string $plural, int $number, string $domain = 'default');
- esc_attr_e(string $text, string $domain = 'default');
- esc_attr__(string $text, string $domain = 'default');
In your function.php, themes or plugins.
For example:
<p><?php pll_e('My text'); ?></p>
<p><?php _e('My another text', 'my_theme'); ?></p>
On the timber context declare this functions like:
$context['pll_e'] = TimberHelper::function_wrapper('pll_e');
$context['pll_'] = TimberHelper::function_wrapper('pll_');
See more on:
https://polylang.wordpress.com/documentation/documentation-for-developers/functions-reference/
These functions are defined by Polylang plugin for printing translations.
Thanks "Theme and plugin translation for Polylang" you can find these strings to translate and add to Polylang register on very simple way.
And then you can translate these texts from the admin dashboard.
The scan result can be seen on the tab with translations:
Settings -> Languages -> String translation
or
Languages -> String translation
You don't need programs like poedit – you don't change files with extensions like:
.pot
,
.po
,
.mo
.
"Theme and plugin translation for Polylang" is highly efficient because the scanner is worked only on admin dashboard in tab:
In dashboard:
Settings -> Languages -> String translation
or
Languages -> String translation
Export and import string translation
In dashboard:
Languages -> TTfP Settings
Filter reference
ttfp_domains
Allows plugins and themes (in functions.php) to modify list of text domains (unique identifier for retrieving translated strings).
List of text domains is displayed on "TTfP Settings" page to select them for translation by polylang engine.
Example:
add_filter('ttfp_domains', 'custom_ttfp_domains', 10, 1); function custom_ttfp_domains(array $domains):array { $domains[] = "my-custom-domain"; return $domains; }
Filter reference
ttfp_translation_access
Returns whether the user has capability to view and edit translations provided by TTfP.
Example:
add_filter('ttfp_translation_access', 'custom_ttfp_translation_access', 10, 1); function custom_ttfp_translation_access(bool $hasAccess):bool { return current_user_can('edit_posts'); }
This plugin requires to be installed and activated the Polylang plugin,
This plugin requires PHP 5.0
- Upload the "Theme and plugin translation for Polylang" folder to the
/wp-content/plugins/
directory on your web server.
- Activate the plugin through the Plugins menu in WordPress.
- In Dashboard go to the
Settings -> Languages -> String translation
or Languages -> String translation
and find your texts.
Use
<?php pll_e('My string'); // similar to _e(); // or: $var = pll_('My string'); // similar to __(); // or: _e('My string', 'my_theme'); // or: $var = __('My string', 'my_theme');
How to enable Twig extension with "Theme and plugin translation for Polylang"? [Timber plugin]
In functions.php add:
`if (!class_exists('Timber')) {
add_action('admin_notices', function () {
echo '
Timber not activated. Make sure you activate the plugin in
' . esc_url(admin_url('plugins.php')) . '';
});
return;
}
function timber_context()
{
$context = Timber::get_context();
$post = Timber::query_post();
$context['post'] = $post;
$context['pll_e'] = TimberHelper::function_wrapper('pll_e');
$context['pll__'] = TimberHelper::function_wrapper('pll__');
return $context;
}
Timber::$dirname = array('templates', 'views'); // directory names with twig templates
timber_context();`
Next, for example in index.php add:
<?php $context = timber_context(); $templates = array('home.twig', 'index.twig'); // twig files for render Timber::render($templates, $context);
Then you can use in twig templates polylang functions like this (in templates/home.twig):
{% extends "base.twig" %} {% block content %} <p> {{ pll_e("Test text on TWIG template 1.") }} </p> <p> {{ pll__("Test text on TWIG template 2.") }} </p> {% endblock %}