WP_Locale_Switcher::load_translations( string $locale )
- Since
- 4.7.0
- Source
wp-includes/class-wp-locale-switcher.php:245
Description
When switching to a locale, translations for this locale must be loaded from scratch.
Compatibility
- WordPress
- since 4.7.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
$localestring- The locale to load translations for.
Performance profile
How much work a call to WP_Locale_Switcher::load_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
- Light
- Scaling
- Scales with input
- Instructions
- 11–16
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 27.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below WP_Locale_Switcher::load_translations()
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 WP_Locale_Switcher::load_translations() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 11–12 | load_default_textdomain() |
| always | 15–16 | array_keys(), load_default_textdomain() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 26 | 11–15 | 4 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 27 | 11–16 | 4 | |
| 8.4 | 27 | 11–16 | 4 | |
| 8.3 | 27 | 11–16 | 4 | |
| 8.2 | 27 | 11–16 | 4 | |
| 8.1 | 27 | 11–16 | 4 | |
| 7.4 | 27 | 11–16 | 4 |
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
- load_default_textdomain()Loads default translated strings based on locale.
- unload_textdomain()Unloads translations for a text domain.
- get_translations_for_domain()Returns the Translations instance for a text domain.
Used by · 1
- WP_Locale_Switcher::change_locale()Changes the site's locale to the given one.
Source code
private function load_translations( $locale ) { global $l10n; $domains = $l10n ? array_keys( $l10n ) : array(); load_default_textdomain( $locale ); foreach ( $domains as $domain ) { // The default text domain is handled by `load_default_textdomain()`. if ( 'default' === $domain ) { continue; } /* * Unload current text domain but allow them to be reloaded * after switching back or to another locale. */ unload_textdomain( $domain, true ); get_translations_for_domain( $domain ); } }Changelog
Introduced in 4.7.0. Unchanged from 6.7.7 through 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/class-wp-locale-switcher.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.