wp_dropdown_languages( string|array $args = array() ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsstring|arrayoptional

Array or string of arguments for outputting the language selector.Default: array()

• $idstringdefault: 'locale'

  ID attribute of the select element.

• $namestringdefault: 'locale'

  Name attribute of the select element.

• $languagesstring[]default: empty array

  List of installed languages, contain only the locales.

• $translationsarraydefault: result of wp_get_available_translations()

  List of available translations.

• $selectedstringdefault: empty

  Language which should be selected.

• $echobool|intdefault: 1

  Whether to echo the generated markup. Accepts 0, 1, or their boolean equivalents.

• $show_available_translationsbooldefault: true

  Whether to show available translations.

• $show_option_site_defaultbooldefault: false

  Whether to show an option to fall back to the site's locale.

• $show_option_en_usbooldefault: true

  Whether to show an option for English (United States).

• $explicit_option_en_usbooldefault: false

  Whether the English (United States) option uses an explicit value of en_US instead of an empty value.

Return value

string

HTML dropdown list of languages.

Performance profile

How much work a call to wp_dropdown_languages() 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

Reads stored settings via get_site_transient(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

9–133

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• transienttransientget_site_transient()one call below wp_dropdown_languages()
• hookthird-party callbacksapply_filters()one call below wp_dropdown_languages()

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 · 31 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_dropdown_languages() 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.

Uses · 7

• wp_parse_args()Merges user defined arguments into defaults array.
• wp_get_available_translations()Get available translations from the WordPress.org API.
• esc_attr_x()Translates string with gettext context, and escapes it for safe use in an attribute.
• selected()Outputs the HTML selected attribute.
• _x()Retrieves translated string with gettext context.
• esc_attr()Escaping for HTML attributes.
• esc_html()Escaping for HTML blocks.

Used by · 2

• login_footer()Outputs the footer for the login page.
• show_blog_form()Generates and displays the Sign-up and Create Site forms.

Source code

View on Trac ↗View on GitHub ↗

1666function wp_dropdown_languages( $args = array() ) {1667 1668	$parsed_args = wp_parse_args(1669		$args,1670		array(1671			'id'                          => 'locale',1672			'name'                        => 'locale',1673			'languages'                   => array(),1674			'translations'                => array(),1675			'selected'                    => '',1676			'echo'                        => 1,1677			'show_available_translations' => true,1678			'show_option_site_default'    => false,1679			'show_option_en_us'           => true,1680			'explicit_option_en_us'       => false,1681		)1682	);1683 1684	// Bail if no ID or no name.1685	if ( ! $parsed_args['id'] || ! $parsed_args['name'] ) {1686		return;1687	}1688 1689	// English (United States) uses an empty string for the value attribute.1690	if ( 'en_US' === $parsed_args['selected'] && ! $parsed_args['explicit_option_en_us'] ) {1691		$parsed_args['selected'] = '';1692	}1693 1694	$translations = $parsed_args['translations'];1695	if ( empty( $translations ) ) {1696		require_once ABSPATH . 'wp-admin/includes/translation-install.php';1697		$translations = wp_get_available_translations();1698	}1699 1700	/*1701	 * $parsed_args['languages'] should only contain the locales. Find the locale in1702	 * $translations to get the native name. Fall back to locale.1703	 */1704	$languages = array();1705	foreach ( $parsed_args['languages'] as $locale ) {1706		if ( isset( $translations[ $locale ] ) ) {1707			$translation = $translations[ $locale ];1708			$languages[] = array(1709				'language'    => $translation['language'],1710				'native_name' => $translation['native_name'],1711				'lang'        => current( $translation['iso'] ),1712			);1713 1714			// Remove installed language from available translations.1715			unset( $translations[ $locale ] );1716		} else {1717			$languages[] = array(1718				'language'    => $locale,1719				'native_name' => $locale,1720				'lang'        => '',1721			);1722		}1723	}1724 1725	$translations_available = ( ! empty( $translations ) && $parsed_args['show_available_translations'] );1726 1727	// Holds the HTML markup.1728	$structure = array();1729 1730	// List installed languages.1731	if ( $translations_available ) {1732		$structure[] = '<optgroup label="' . esc_attr_x( 'Installed', 'translations' ) . '">';1733	}1734 1735	// Site default.1736	if ( $parsed_args['show_option_site_default'] ) {1737		$structure[] = sprintf(1738			'<option value="site-default" data-installed="1"%s>%s</option>',1739			selected( 'site-default', $parsed_args['selected'], false ),1740			_x( 'Site Default', 'default site language' )1741		);1742	}1743 1744	if ( $parsed_args['show_option_en_us'] ) {1745		$value       = ( $parsed_args['explicit_option_en_us'] ) ? 'en_US' : '';

Changelog

Introduced in 5.9.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.