wp_download_language_pack( string $download ): string|false
- Since
- 4.0.0
- Source
wp-admin/includes/translation-install.php:254
Compatibility
- WordPress
- since 4.0.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
$downloadstring- Language code to download.
Return value
string|false- Returns the language code if successfully downloaded (or already installed), or false on failure.
Performance profile
How much work a call to wp_download_language_pack() 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
- Heavy
- Scaling
- Scales with input
- Instructions
- 7–49
- Plugin surface
- None
- Called by
- 1
Reads stored settings via get_site_transient(), cached per request but not free on a cold cache.
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 54.
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_download_language_pack() - transienttransient
get_site_transient()one call below wp_download_language_pack()
Further down the call graph this can also reach cache, option, http, serialize and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_download_language_pack() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$download | 7 | get_available_languages() |
!$download && !wp_is_file_mod_allowed() | 11 | get_available_languages(), wp_is_file_mod_allowed() |
!$download && wp_is_file_mod_allowed() | 15–24 | get_available_languages(), wp_is_file_mod_allowed(), wp_get_available_translations() |
!$download && wp_is_file_mod_allowed() && !empty($translation_to_load) | 39–44 | get_available_languages(), wp_is_file_mod_allowed(), wp_get_available_translations(), ->upgrade() |
!$download && wp_is_file_mod_allowed() && !empty($translation_to_load) | 43–49 | get_available_languages(), wp_is_file_mod_allowed(), wp_get_available_translations(), ->upgrade(), is_wp_error() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 54 | 7–49 | 9 | |
| 8.5 | 54 | 7–49 | 9 | |
| 8.4 | 54 | 7–49 | 9 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 57 | 10–52 | 9 | |
| 8.2 | 57 | 10–52 | 9 | |
| 8.1 | 57 | 10–52 | 9 | |
| 7.4 | 57 | 10–52 | 9 |
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 · 6
- get_available_languages()Gets all available languages based on the presence of *.mo and *.l10n.php files in a given directory.
- wp_is_file_mod_allowed()Determines whether file modifications are allowed.
- wp_get_available_translations()Get available translations from the WordPress.org API.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- Automatic_Upgrader_Skin::__construct()
- Language_Pack_Upgrader::__construct()
Used by · 1
- edit_user()Edit user settings based on contents of $_POST
Source code
function wp_download_language_pack( $download ) { // Check if the translation is already installed. if ( in_array( $download, get_available_languages(), true ) ) { return $download; } if ( ! wp_is_file_mod_allowed( 'download_language_pack' ) ) { return false; } // Confirm the translation is one we can download. $translations = wp_get_available_translations(); if ( ! $translations ) { return false; } foreach ( $translations as $translation ) { if ( $translation['language'] === $download ) { $translation_to_load = true; break; } } if ( empty( $translation_to_load ) ) { return false; } $translation = (object) $translation; require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; $skin = new Automatic_Upgrader_Skin(); $upgrader = new Language_Pack_Upgrader( $skin ); $translation->type = 'core'; $result = $upgrader->upgrade( $translation, array( 'clear_update_cache' => false ) ); if ( ! $result || is_wp_error( $result ) ) { return false; } return $translation->language;}Changelog
Introduced in 4.0.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 6.8.8 tag, from
src/wp-admin/includes/translation-install.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.