wppaste
WordPress

wp_set_script_module_translations( string $id, string $domain = 'default', string $path = '' ): bool

Since
7.0.0
Source
wp-includes/script-modules.php:158
Overrides the text domain and path used to load translations for a script module.

Description

Translations for script modules are loaded automatically from the default text domain and language directory. Use this function only when a module's text domain differs from 'default' or when translation files live outside the standard location, for example plugin modules using their own text domain.

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 identifier of the script module.
$domainstringoptional
Text domain. Default 'default'.Default: 'default'
$pathstringoptional
The full file path to the directory containing translation files.Default: ''

Return value

bool
True if the text domain was registered, false if the module is not registered.

Performance profile

How much work a call to wp_set_script_module_translations() 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

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
12

Executed per call on PHP 8.5. The body compiles to 12.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_set_script_module_translations() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always12wp_script_modules(), ->set_translations()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 12 instructions, 12 executed per call, 0 branches. The work does not change between versions.

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 · 2

  • wp_script_modules()Retrieves the main WP_Script_Modules instance.
  • wp_script_modules()::set_translations()

Source code

View on Trac View on GitHub 

function wp_set_script_module_translations( string $id, string $domain = 'default', string $path = '' ): bool {	return wp_script_modules()->set_translations( $id, $domain, $path );}

Changelog

Introduced in 7.0.0. Unchanged from 7.0.4 through 7.1.0.

  1. 7.0.4
  2. 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/script-modules.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.