W3cubDocs

/WordPress

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

Sets translated strings for a script.

Description

Works only if the script has already been registered.

See also

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 );
}

Changelog

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

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_set_script_translations