WP_Scripts::set_translations() WordPress Method
The WP_Scripts::set_translations() method allows you to set the translations for a script. This is useful if you need to override the default translation for a script.
WP_Scripts::set_translations( string $handle, string $domain = 'default', string $path = null ) #
Sets a translation textdomain.
Parameters
- $handle
(string)(Required)Name of the script to register a translation domain to.
- $domain
(string)(Optional) Text domain.
Default value: 'default'
- $path
(string)(Optional) The full file path to the directory containing translation files.
Default value: null
Return
(bool) True if the text domain was registered, false if not.
Source
File: wp-includes/class.wp-scripts.php
public function set_translations( $handle, $domain = 'default', $path = null ) {
if ( ! isset( $this->registered[ $handle ] ) ) {
return false;
}
/** @var \_WP_Dependency $obj */
$obj = $this->registered[ $handle ];
if ( ! in_array( 'wp-i18n', $obj->deps, true ) ) {
$obj->deps[] = 'wp-i18n';
}
return $obj->set_translations( $domain, $path );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.1.0 | The $domain parameter was made optional. |
| 5.0.0 | Introduced. |