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

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

string

HTML dropdown list of languages.

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

View on Trac ↗View on GitHub ↗

1740function wp_dropdown_languages( $args = array() ) {1741 1742	$parsed_args = wp_parse_args(1743		$args,1744		array(1745			'id'                          => 'locale',1746			'name'                        => 'locale',1747			'languages'                   => array(),1748			'translations'                => array(),1749			'selected'                    => '',1750			'echo'                        => 1,1751			'show_available_translations' => true,1752			'show_option_site_default'    => false,1753			'show_option_en_us'           => true,1754			'explicit_option_en_us'       => false,1755		)1756	);1757 1758	// Bail if no ID or no name.1759	if ( ! $parsed_args['id'] || ! $parsed_args['name'] ) {1760		return;1761	}1762 1763	// English (United States) uses an empty string for the value attribute.1764	if ( 'en_US' === $parsed_args['selected'] && ! $parsed_args['explicit_option_en_us'] ) {1765		$parsed_args['selected'] = '';1766	}1767 1768	$translations = $parsed_args['translations'];1769	if ( empty( $translations ) ) {1770		require_once ABSPATH . 'wp-admin/includes/translation-install.php';1771		$translations = wp_get_available_translations();1772	}1773 1774	/*1775	 * $parsed_args['languages'] should only contain the locales. Find the locale in1776	 * $translations to get the native name. Fall back to locale.1777	 */1778	$languages = array();1779	foreach ( $parsed_args['languages'] as $locale ) {1780		if ( isset( $translations[ $locale ] ) ) {1781			$translation = $translations[ $locale ];1782			$languages[] = array(1783				'language'    => $translation['language'],1784				'native_name' => $translation['native_name'],1785				'lang'        => current( $translation['iso'] ),1786			);1787 1788			// Remove installed language from available translations.1789			unset( $translations[ $locale ] );1790		} else {1791			$languages[] = array(1792				'language'    => $locale,1793				'native_name' => $locale,1794				'lang'        => '',1795			);1796		}1797	}1798 1799	$translations_available = ( ! empty( $translations ) && $parsed_args['show_available_translations'] );1800 1801	// Holds the HTML markup.1802	$structure = array();1803 1804	// List installed languages.1805	if ( $translations_available ) {1806		$structure[] = '<optgroup label="' . esc_attr_x( 'Installed', 'translations' ) . '">';1807	}1808 1809	// Site default.1810	if ( $parsed_args['show_option_site_default'] ) {1811		$structure[] = sprintf(1812			'<option value="site-default" data-installed="1"%s>%s</option>',1813			selected( 'site-default', $parsed_args['selected'], false ),1814			_x( 'Site Default', 'default site language' )1815		);1816	}1817 1818	if ( $parsed_args['show_option_en_us'] ) {1819		$value       = ( $parsed_args['explicit_option_en_us'] ) ? 'en_US' : '';

History

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