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

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

string|false

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

Uses · 3

• wp_scripts()Initializes $wp_scripts if it has not been set.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• _load_script_textdomain_from_src()Resolves and loads the translation JSON file for a given script or script module source URL.

Used by · 1

• WP_Scripts::print_translations()Prints translations set for a specific handle.

Source

View on Trac ↗View on GitHub ↗

1143function load_script_textdomain( $handle, $domain = 'default', $path = '' ) {1144	$wp_scripts = wp_scripts();1145 1146	if ( ! isset( $wp_scripts->registered[ $handle ] ) ) {1147		return false;1148	}1149 1150	$src = $wp_scripts->registered[ $handle ]->src;1151 1152	if ( ! preg_match( '|^(https?:)?//|', $src ) && ! ( $wp_scripts->content_url && str_starts_with( $src, $wp_scripts->content_url ) ) ) {1153		$src = $wp_scripts->base_url . $src;1154	}1155 1156	return _load_script_textdomain_from_src( $handle, $src, $domain, $path, false );1157}

History

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.

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.