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

Compatibility

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

90–166

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

Plugin surface

1 hook

Third-party callbacks on 'load_script_textdomain_relative_path' run inside this call, and their cost is not bounded by anything here.

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()called directly

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 · 16 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.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

One hook fires while load_script_textdomain() runs, in this order:

1. 1
   apply_filters( load_script_textdomain_relative_path )filterline 1242 (+99 into the body)

   Filters the relative path of scripts used for finding translation files.

Uses · 13

• wp_scripts()Initializes $wp_scripts if it has not been set.
• untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
• determine_locale()Determines the current locale desired for the request.
• load_script_translations()Loads the translation data for the given script handle and text domain.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• wp_parse_url()A wrapper for PHP's parse_url() function that handles consistency in the return values across PHP versions.
• content_url()Retrieves the URL to the content directory.
• plugins_url()Retrieves a URL within the plugins or mu-plugins directory.
• 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.
• get_theme_root()Retrieves path to themes directory.
• trailingslashit()Appends a trailing slash.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

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

Source code

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	$path   = untrailingslashit( $path );1151	$locale = determine_locale();1152 1153	// If a path was given and the handle file exists simply return it.1154	$file_base       = 'default' === $domain ? $locale : $domain . '-' . $locale;1155	$handle_filename = $file_base . '-' . $handle . '.json';1156 1157	if ( $path ) {1158		$translations = load_script_translations( $path . '/' . $handle_filename, $handle, $domain );1159 1160		if ( $translations ) {1161			return $translations;1162		}1163	}1164 1165	$src = $wp_scripts->registered[ $handle ]->src;1166 1167	if ( ! preg_match( '|^(https?:)?//|', $src ) && ! ( $wp_scripts->content_url && str_starts_with( $src, $wp_scripts->content_url ) ) ) {1168		$src = $wp_scripts->base_url . $src;1169	}1170 1171	$relative       = false;1172	$languages_path = WP_LANG_DIR;1173 1174	$src_url     = wp_parse_url( $src );1175	$content_url = wp_parse_url( content_url() );1176	$plugins_url = wp_parse_url( plugins_url() );1177	$site_url    = wp_parse_url( site_url() );1178	$theme_root  = get_theme_root();1179 1180	// If the host is the same or it's a relative URL.1181	if (1182		( ! isset( $content_url['path'] ) || str_starts_with( $src_url['path'], $content_url['path'] ) ) &&1183		( ! isset( $src_url['host'] ) || ! isset( $content_url['host'] ) || $src_url['host'] === $content_url['host'] )1184	) {1185		// Make the src relative the specific plugin or theme.1186		if ( isset( $content_url['path'] ) ) {1187			$relative = substr( $src_url['path'], strlen( $content_url['path'] ) );1188		} else {1189			$relative = $src_url['path'];1190		}1191		$relative = trim( $relative, '/' );1192		$relative = explode( '/', $relative );1193 1194		/*1195		 * Ensure correct languages path when using a custom `WP_PLUGIN_DIR` / `WP_PLUGIN_URL` configuration,1196		 * a custom theme root, and/or using Multisite with subdirectories.1197		 * See https://core.trac.wordpress.org/ticket/60891 and https://core.trac.wordpress.org/ticket/62016.1198		 */1199 1200		$theme_dir = array_slice( explode( '/', $theme_root ), -1 );1201		$dirname   = $theme_dir[0] === $relative[0] ? 'themes' : 'plugins';1202 1203		$languages_path = WP_LANG_DIR . '/' . $dirname;1204 1205		$relative = array_slice( $relative, 2 ); // Remove plugins/<plugin name> or themes/<theme name>.1206		$relative = implode( '/', $relative );1207	} elseif (1208		( ! isset( $plugins_url['path'] ) || str_starts_with( $src_url['path'], $plugins_url['path'] ) ) &&1209		( ! isset( $src_url['host'] ) || ! isset( $plugins_url['host'] ) || $src_url['host'] === $plugins_url['host'] )1210	) {1211		// Make the src relative the specific plugin.1212		if ( isset( $plugins_url['path'] ) ) {1213			$relative = substr( $src_url['path'], strlen( $plugins_url['path'] ) );1214		} else {1215			$relative = $src_url['path'];1216		}1217		$relative = trim( $relative, '/' );1218		$relative = explode( '/', $relative );1219 1220		$languages_path = WP_LANG_DIR . '/plugins';1221 1222		$relative = array_slice( $relative, 1 ); // Remove <plugin name>.

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.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 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.