load_script_module_textdomain( string $id, string $domain = 'default', string $path = '' ): string|false
- Since
- 7.0.0
- Source
wp-includes/l10n.php:1173
Description
Works like load_script_textdomain() but for script modules registered via wp_register_script_module().
Compatibility
- WordPress
- since 7.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 2 of the 5 tracked releases, added in 7.0.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$idstring- The script module identifier.
$domainstringoptional- Text domain. Default 'default'.Default:
'default' $pathstringoptional- The full file path to the directory containing translation files.Default:
''
Return value
string|false- The JSON-encoded translated strings for the given script module and text domain.
False if there are none.
Performance profile
How much work a call to load_script_module_textdomain() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 12–26
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 27.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below load_script_module_textdomain()
Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost load_script_module_textdomain() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$module === null | 12 | wp_script_modules(), ->get_registered() |
$module !== null && $src | 22 | wp_script_modules(), ->get_registered(), _load_script_textdomain_from_src() |
$module !== null && !$src | 26 | wp_script_modules(), ->get_registered(), site_url(), _load_script_textdomain_from_src() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 27 | 12–26 | 2 | |
| 8.5 | 27 | 12–26 | 2 | |
| 8.4 | 27 | 12–26 | 2 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 30 | 12–29 | 2 | |
| 8.2 | 30 | 12–29 | 2 | |
| 8.1 | 30 | 12–29 | 2 | |
| 7.4 | 30 | 12–29 | 2 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 4
- wp_script_modules()Retrieves the main WP_Script_Modules instance.
- site_url()Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
- _load_script_textdomain_from_src()Resolves and loads the translation JSON file for a given script or script module source URL.
- wp_script_modules()::get_registered()
Used by · 1
- WP_Script_Modules::print_script_module_translations()Prints translations for all enqueued script modules.
Source code
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 );}Changelog
Introduced in 7.0.0. Unchanged from 7.0.4 through 7.1.0.
Signature, return type and hooks compared across 2 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/l10n.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.