_load_script_textdomain_from_src( string $handle, string $src, string $domain, string $path, bool $is_module ): string|false

Description

Parameters

$handlestring

Name of the script or script module identifier to register a translation domain to.

$srcstring

Absolute source URL of the script or script module.

$domainstring

Text domain.

$pathstring

The full file path to the directory containing translation files, or an empty string to use the default path from the text domain registry.

$is_modulebool

Whether the source belongs to a script module (true) or a classic script (false).

Return

string|false

The JSON-encoded translated strings on success, false otherwise.

Hooks fired · 1

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

1. 1
   apply_filters( load_script_textdomain_relative_path )filterline 1316 (+108 into the body)

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

Uses · 12

• determine_locale()Determines the current locale desired for the request.
• untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
• load_script_translations()Loads the translation data for the given script handle and text domain.
• 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.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• trailingslashit()Appends a trailing slash.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.

Used by · 2

• load_script_module_textdomain()Loads the translation data for a given script module ID and text domain.
• load_script_textdomain()Loads the script translated strings.

Source

View on Trac ↗View on GitHub ↗

1208function _load_script_textdomain_from_src( string $handle, string $src, string $domain, string $path, bool $is_module ) {1209	/** @var WP_Textdomain_Registry $wp_textdomain_registry */1210	global $wp_textdomain_registry;1211 1212	$locale = determine_locale();1213 1214	if ( ! $path ) {1215		$path = $wp_textdomain_registry->get( $domain, $locale );1216	}1217 1218	if ( $path ) {1219		$path = untrailingslashit( $path );1220	}1221 1222	// If a path was given and the handle file exists simply return it.1223	$file_base       = 'default' === $domain ? $locale : $domain . '-' . $locale;1224	$handle_filename = $file_base . '-' . $handle . '.json';1225 1226	if ( $path ) {1227		$translations = load_script_translations( $path . '/' . $handle_filename, $handle, $domain );1228 1229		if ( $translations ) {1230			return $translations;1231		}1232	}1233 1234	$relative       = false;1235	$languages_path = WP_LANG_DIR;1236 1237	$src_url = wp_parse_url( $src );1238	if ( ! $src_url ) {1239		return load_script_translations( false, $handle, $domain );1240	}1241	$src_url['path'] ??= '';1242 1243	$content_url = wp_parse_url( content_url() );1244	if ( ! $content_url ) {1245		return load_script_translations( false, $handle, $domain );1246	}1247 1248	$plugins_url = wp_parse_url( plugins_url() );1249	$site_url    = wp_parse_url( site_url() );1250	$theme_root  = get_theme_root();1251 1252	// If the host is the same or it's a relative URL.1253	if (1254		( ! isset( $content_url['path'] ) || str_starts_with( $src_url['path'], $content_url['path'] ) ) &&1255		( ! isset( $src_url['host'] ) || ! isset( $content_url['host'] ) || $src_url['host'] === $content_url['host'] )1256	) {1257		// Make the src relative the specific plugin or theme.1258		if ( isset( $content_url['path'] ) ) {1259			$relative = substr( $src_url['path'], strlen( $content_url['path'] ) );1260		} else {1261			$relative = $src_url['path'];1262		}1263		$relative = trim( $relative, '/' );1264		$relative = explode( '/', $relative );1265 1266		/*1267		 * Ensure correct languages path when using a custom `WP_PLUGIN_DIR` / `WP_PLUGIN_URL` configuration,1268		 * a custom theme root, and/or using Multisite with subdirectories.1269		 * See https://core.trac.wordpress.org/ticket/60891 and https://core.trac.wordpress.org/ticket/62016.1270		 */1271 1272		$theme_dir = array_slice( explode( '/', $theme_root ), -1 );1273		$dirname   = $theme_dir[0] === $relative[0] ? 'themes' : 'plugins';1274 1275		$languages_path = WP_LANG_DIR . '/' . $dirname;1276 1277		$relative = array_slice( $relative, 2 ); // Remove plugins/<plugin name> or themes/<theme name>.1278		$relative = implode( '/', $relative );1279	} elseif (1280		( ! isset( $plugins_url['path'] ) || str_starts_with( $src_url['path'], $plugins_url['path'] ) ) &&1281		( ! isset( $src_url['host'] ) || ! isset( $plugins_url['host'] ) || $src_url['host'] === $plugins_url['host'] )1282	) {1283		// Make the src relative the specific plugin.1284		if ( isset( $plugins_url['path'] ) ) {1285			$relative = substr( $src_url['path'], strlen( $plugins_url['path'] ) );1286		} else {1287			$relative = $src_url['path'];

History

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/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.