load_script_textdomain( string $handle, string $domain = 'default', string $path = '' ): string|false

Loads the script translated strings.

Description

Parameters

$handlestringrequired: Name of the script to register a translation domain to.
$domainstringoptional: Text domain. Default 'default'.
Default:'default'
$pathstringoptional: The full file path to the directory containing translation files.
Default:''

Return

string|false The translated strings in JSON encoding on success, false if the script textdomain could not be loaded.

Source

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

	if ( ! isset( $wp_scripts->registered[ $handle ] ) ) {
		return false;
	}

	$src = $wp_scripts->registered[ $handle ]->src;

	if ( ! preg_match( '|^(https?:)?//|', $src ) && ! ( $wp_scripts->content_url && str_starts_with( $src, $wp_scripts->content_url ) ) ) {
		$src = $wp_scripts->base_url . $src;
	}

	return _load_script_textdomain_from_src( $handle, $src, $domain, $path, false );
}

View all references View on Trac View on GitHub

Uses	Description
_load_script_textdomain_from_src()`wp-includes/l10n.php`	Resolves and loads the translation JSON file for a given script or script module source URL.
wp_scripts()`wp-includes/functions.wp-scripts.php`	Initializes $wp_scripts if it has not been set.

Used by	Description
WP_Scripts::print_translations()`wp-includes/class-wp-scripts.php`	Prints translations set for a specific handle.

Changelog

Version	Description
5.1.0	The `$domain` parameter was made optional.
5.0.2	Uses load_script_translations() to load translation data.
5.0.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.