wp_set_script_translations() – Function

Sets translated strings for a script.

Description

Works only if the script has already been registered.

Parameters

$handlestringrequired: Script handle the textdomain will be attached to.
$domainstringoptional: Text domain. Default 'default'.
Default:'default'
$pathstringoptional: The full file path to the directory containing translation files.
Default:''

Return

bool True if the text domain was successfully localized, false otherwise.

Source

function wp_set_script_translations( $handle, $domain = 'default', $path = '' ) {
	global $wp_scripts;

	if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
		_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
		return false;
	}

	return $wp_scripts->set_translations( $handle, $domain, $path );
}

View all references View on Trac View on GitHub

Uses	Description
WP_Scripts::set_translations()`wp-includes/class-wp-scripts.php`	Sets a translation textdomain.

Used by	Description
register_block_script_handle()`wp-includes/blocks.php`	Finds a script handle for the selected block metadata field. It detects when a path to file was provided and optionally finds a corresponding asset file with details necessary to register the script under automatically generated handle name. It returns unprocessed script handle otherwise.

Changelog

Version	Description
5.1.0	The `$domain` parameter was made optional.
5.0.0	Introduced.

User Contributed Notes

Skip to note 5 content

Ronald Huereca 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
If you have to generate your own JSON language pack files, use WP CLI to generate your JSON file for you. Just navigate to your plugin folder and run the following command.

wp i18n make-json languages

Then set the language folder in wp_set_script_translations
```
wp_set_script_translations( 'wp-presenter-pro-js', 'wp-presenter-pro', plugin_dir_path( __FILE__ ) . 'languages' );
```
Warning: If someone translates your plugin with the same locale on the WordPress Plugin Directory, the language will not show up if using the third argument.
Log in to add feedback
Skip to note 6 content

Kris Kelvin 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Remember to check the path in the third argument. I wasted 3 days investigating what’s wrong and it turned out I gave
```
plugin_basename( __DIR__ ) . '/languages/'
```
instead of
```
plugin_dir_path( __FILE__ ) . '/languages/'
```
—

With plugin_dir_path() works fine.
- plugin_dir_path() returns the path with trailing slash
  
  Manzoor Wani 4 years ago
Log in to add feedback
Skip to note 7 content

shewa12 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
wp_set_script_translations() should not be called before register or wp_enqueue_scripts or with init hook. To make wordpress able to load handled scripts this function should be called after text domain handled script load. Here is an example:
```
add_action( 'wp_enqueue_scripts', array( $this, 'wpdocs_load_scripts' ) );

add_action( 'wp_enqueue_scripts', array( $this, 'wpdocs_load_text_domain' ), 100 );

function wpdocs_load_text_domain() {
    wp_set_script_translations( 
         'wpdocs-js',
         'wpdocs-text-domain',
         plugin_dir_path( __FILE__ ) . 'languages' 
    );
}
```
Log in to add feedback
Skip to note 8 content

Lovro Hrust 10 months ago

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

If you do not register script yourself, but rely on automatic script registration, the appropriate handle is in the format [plugin name]-editor-script (as of WP 6.6.1).

If naming rules change or you want to translate some other automatically registered script, you can find registered scripts in array wp_scripts->registered.

Naming of the translation files still applies like described in Block editor internationalization.

Log in to add feedback

wp_set_script_translations( string $handle, string $domain = 'default', string $path = '' ): bool

In this article

Description

See also

Parameters

Return

Source

Changelog

User Contributed Notes