wppaste
WordPress

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

Since
5.0.0, 5.0.2, 5.1.0
Source
wp-includes/l10n.php:1143
Loads the script translated strings.

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

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

Performance profile

How much work a call to load_script_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

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
10–30

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

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 it touches

  • hookthird-party callbacksapply_filters()one call below load_script_textdomain()

Further down the call graph this can also reach query, option, cache, serialize 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 · 2 distinct outcomes

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

WhenInstructionsCalls it makes
!isset($handle)10wp_scripts()
isset($handle)22–30wp_scripts(), _load_script_textdomain_from_src()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev3110–304
8.53110–304
8.43110–3046 fewer instructions than PHP 8.3
8.33710–364
8.23710–364
8.13710–3641 fewer instruction than PHP 7.4
7.43810–374

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

Used by · 1

Source code

View on Trac View on GitHub 

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 );}

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.2
Uses load_script_translations() to load translation data.from the docblock
5.0.0
Introduced.from the docblock

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.