wppaste
WordPress

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

Since
5.0.0, 5.1.0
Source
wp-includes/functions.wp-scripts.php:252
Sets translated strings for a script.

Description

Works only if the script has already been registered.

Compatibility

WordPress
since 5.1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$handlestring
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 value

bool
True if the text domain was successfully localized, false otherwise.

Performance profile

How much work a call to wp_set_script_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
11–12

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 17.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
!($wp_scripts instanceof)11_wp_scripts_maybe_doing_it_wrong()
$wp_scripts instanceof12->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: 17 instructions, 11–12 executed per call, 1 branch. 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 · 1

Used by · 1

  • register_block_script_handle()Finds a script handle for the selected block metadata field. It detects when a path to file was provided and optionally finds a corresponding asset file with details necessary to register the script under automatically generated handle name. It returns unprocessed script handle otherwise.

Source code

View on Trac View on GitHub 

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

Introduced in 5.0.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

5.1.0
The $domain parameter was made optional.from the docblock
5.0.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/functions.wp-scripts.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.