load_script_module_textdomain( string $id, string $domain = 'default', string $path = '' ): string|false

Loads the translation data for a given script module ID and text domain.

Description

Works like load_script_textdomain() but for script modules registered via wp_register_script_module().

Parameters

$idstringrequired: The script module identifier.
$domainstringoptional: Text domain. Default 'default'.
Default:'default'
$pathstringoptional: The full file path to the directory containing translation files.
Default:''

Return

string|false The JSON-encoded translated strings for the given script module and text domain.
False if there are none.

Source

function load_script_module_textdomain( string $id, string $domain = 'default', string $path = '' ) {
	$module = wp_script_modules()->get_registered( $id );
	if ( null === $module ) {
		return false;
	}
	$src = $module['src'];

	// Ensure src is an absolute URL for path resolution.
	if ( ! preg_match( '|^(https?:)?//|', $src ) ) {
		$src = site_url( $src );
	}

	return _load_script_textdomain_from_src( $id, $src, $domain, $path, true );
}

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_Script_Modules::get_registered()`wp-includes/class-wp-script-modules.php`	Gets the data for a registered script module.
wp_script_modules()`wp-includes/script-modules.php`	Retrieves the main WP_Script_Modules instance.
site_url()`wp-includes/link-template.php`	Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.

Used by	Description
WP_Script_Modules::print_script_module_translations()`wp-includes/class-wp-script-modules.php`	Prints translations for all enqueued script modules.

Changelog

Version	Description
7.0.0	Introduced.

User Contributed Notes

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