enmi-conf.org: comparison wp/wp-includes/l10n.php

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
 	$locale = $user->locale;
 	return $locale ? $locale : get_locale();
 }
 /**
+* Determine the current locale desired for the request.
+*
+* @since 5.0.0
+*
+* @global string $pagenow
+*
+* @return string The determined locale.
+*/
+function determine_locale() {
+	/**
+	 * Filters the locale for the current request prior to the default determination process.
+	 *
+	 * Using this filter allows to override the default logic, effectively short-circuiting the function.
+	 *
+	 * @since 5.0.0
+	 *
+	 * @param string|null The locale to return and short-circuit, or null as default.
+	 */
+	$determined_locale = apply_filters( 'pre_determine_locale', null );
+	if ( ! empty( $determined_locale ) && is_string( $determined_locale ) ) {
+		return $determined_locale;
+	}
+	$determined_locale = get_locale();
+	if ( is_admin() ) {
+		$determined_locale = get_user_locale();
+	}
+	if ( isset( $_GET['_locale'] ) && 'user' === $_GET['_locale'] && wp_is_json_request() ) {
+		$determined_locale = get_user_locale();
+	}
+	if ( ! empty( $_GET['wp_lang'] ) && ! empty( $GLOBALS['pagenow'] ) && 'wp-login.php' === $GLOBALS['pagenow'] ) {
+		$determined_locale = sanitize_text_field( $_GET['wp_lang'] );
+	}
+	/**
+	 * Filters the locale for the current request.
+	 *
+	 * @since 5.0.0
+	 *
+	 * @param string $locale The locale.
+	 */
+	return apply_filters( 'determine_locale', $determined_locale );
+}
+/**
 * Retrieve the translation of $text.
 *
 * If there is no translation, or the text domain isn't loaded, the original text is returned.
 *
 * *Note:* Don't use translate() directly, use __() or related functions.
 /**
 * Retrieve the translation of $text and escapes it for safe use in HTML output.
 *
 * If there is no translation, or the text domain isn't loaded, the original text
-* is escaped and returned..
+* is escaped and returned.
 *
 * @since 2.8.0
 *
 * @param string $text   Text to translate.
 * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
 * @param string $context Context information for the translators.
 * @param string $domain  Optional. Text domain. Unique identifier for retrieving translated strings.
 *                        Default 'default'.
 * @return string The translated singular or plural form.
 */
-function _nx($single, $plural, $number, $context, $domain = 'default') {
+function _nx( $single, $plural, $number, $context, $domain = 'default' ) {
 	$translations = get_translations_for_domain( $domain );
 	$translation  = $translations->translate_plural( $single, $plural, $number, $context );
 	/**
 	 * Filters the singular or plural form of a string with gettext context.
 *     @type null   $context  Context information for the translators.
 *     @type string $domain   Text domain.
 * }
 */
 function _n_noop( $singular, $plural, $domain = null ) {
-	return array( 0 => $singular, 1 => $plural, 'singular' => $singular, 'plural' => $plural, 'context' => null, 'domain' => $domain );
+	return array(
+		0          => $singular,
+		1          => $plural,
+		'singular' => $singular,
+		'plural'   => $plural,
+		'context'  => null,
+		'domain'   => $domain,
+	);
 }
 /**
 * Registers plural strings with gettext context in POT file, but does not translate them.
 *
 * strings and use them later when the number is known.
 *
 * Example of a generic phrase which is disambiguated via the context parameter:
 *
 *     $messages = array(
-*      	'people'  => _nx_noop( '%s group', '%s groups', 'people', 'text-domain' ),
+*          'people'  => _nx_noop( '%s group', '%s groups', 'people', 'text-domain' ),
-*      	'animals' => _nx_noop( '%s group', '%s groups', 'animals', 'text-domain' ),
+*          'animals' => _nx_noop( '%s group', '%s groups', 'animals', 'text-domain' ),
 *     );
 *     ...
 *     $message = $messages[ $type ];
 *     printf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
 *
 *     @type string $context  Context information for the translators.
 *     @type string $domain   Text domain.
 * }
 */
 function _nx_noop( $singular, $plural, $context, $domain = null ) {
-	return array( 0 => $singular, 1 => $plural, 2 => $context, 'singular' => $singular, 'plural' => $plural, 'context' => $context, 'domain' => $domain );
+	return array(
+		0          => $singular,
+		1          => $plural,
+		2          => $context,
+		'singular' => $singular,
+		'plural'   => $plural,
+		'context'  => $context,
+		'domain'   => $domain,
+	);
 }
 /**
 * Translates and retrieves the singular or plural form of a string that's been registered
 * with _n_noop() or _nx_noop().
 * @param string $domain        Optional. Text domain. Unique identifier for retrieving translated strings. If $nooped_plural contains
 *                              a text domain passed to _n_noop() or _nx_noop(), it will override this value. Default 'default'.
 * @return string Either $single or $plural translated text.
 */
 function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' ) {
-	if ( $nooped_plural['domain'] )
+	if ( $nooped_plural['domain'] ) {
 		$domain = $nooped_plural['domain'];
+	}
-	if ( $nooped_plural['context'] )
+	if ( $nooped_plural['context'] ) {
 		return _nx( $nooped_plural['singular'], $nooped_plural['plural'], $count, $nooped_plural['context'], $domain );
-	else
+	} else {
 		return _n( $nooped_plural['singular'], $nooped_plural['plural'], $count, $domain );
+	}
 }
 /**
 * Load a .mo file into the text domain $domain.
 *
 * On success, the .mo file will be placed in the $l10n global by $domain
 * and will be a MO object.
 *
 * @since 1.5.0
 *
-* @global array $l10n          An array of all currently loaded text domains.
+* @global MO[] $l10n          An array of all currently loaded text domains.
-* @global array $l10n_unloaded An array of all text domains that have been unloaded again.
+* @global MO[] $l10n_unloaded An array of all text domains that have been unloaded again.
 *
 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 * @param string $mofile Path to the .mo file.
 * @return bool True on success, false on failure.
 */
 	 * @param string $mofile Path to the MO file.
 	 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 	 */
 	$mofile = apply_filters( 'load_textdomain_mofile', $mofile, $domain );
-	if ( !is_readable( $mofile ) ) return false;
+	if ( ! is_readable( $mofile ) ) {
+		return false;
+	}
 	$mo = new MO();
-	if ( !$mo->import_from_file( $mofile ) ) return false;
+	if ( ! $mo->import_from_file( $mofile ) ) {
+		return false;
-	if ( isset( $l10n[$domain] ) )
+	}
-		$mo->merge_with( $l10n[$domain] );
+	if ( isset( $l10n[ $domain ] ) ) {
+		$mo->merge_with( $l10n[ $domain ] );
+	}
 	unset( $l10n_unloaded[ $domain ] );
-	$l10n[$domain] = &$mo;
+	$l10n[ $domain ] = &$mo;
 	return true;
 }
 /**
 * Unload translations for a text domain.
 *
 * @since 3.0.0
 *
-* @global array $l10n          An array of all currently loaded text domains.
+* @global MO[] $l10n          An array of all currently loaded text domains.
-* @global array $l10n_unloaded An array of all text domains that have been unloaded again.
+* @global MO[] $l10n_unloaded An array of all text domains that have been unloaded again.
 *
 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 * @return bool Whether textdomain was unloaded.
 */
 function unload_textdomain( $domain ) {
 	 *
 	 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 	 */
 	do_action( 'unload_textdomain', $domain );
-	if ( isset( $l10n[$domain] ) ) {
+	if ( isset( $l10n[ $domain ] ) ) {
-		unset( $l10n[$domain] );
+		unset( $l10n[ $domain ] );
 		$l10n_unloaded[ $domain ] = true;
 		return true;
 	}
 * @param string $locale Optional. Locale to load. Default is the value of get_locale().
 * @return bool Whether the textdomain was loaded.
 */
 function load_default_textdomain( $locale = null ) {
 	if ( null === $locale ) {
-		$locale = is_admin() ? get_user_locale() : get_locale();
+		$locale = determine_locale();
 	}
 	// Unload previously loaded strings so we can switch translations.
 	unload_textdomain( 'default' );
 	$return = load_textdomain( 'default', WP_LANG_DIR . "/$locale.mo" );
-	if ( ( is_multisite() || ( defined( 'WP_INSTALLING_NETWORK' ) && WP_INSTALLING_NETWORK ) ) && ! file_exists(  WP_LANG_DIR . "/admin-$locale.mo" ) ) {
+	if ( ( is_multisite() || ( defined( 'WP_INSTALLING_NETWORK' ) && WP_INSTALLING_NETWORK ) ) && ! file_exists( WP_LANG_DIR . "/admin-$locale.mo" ) ) {
 		load_textdomain( 'default', WP_LANG_DIR . "/ms-$locale.mo" );
 		return $return;
 	}
 	if ( is_admin() || wp_installing() || ( defined( 'WP_REPAIRING' ) && WP_REPAIRING ) ) {
 		load_textdomain( 'default', WP_LANG_DIR . "/admin-$locale.mo" );
 	}
-	if ( is_network_admin() || ( defined( 'WP_INSTALLING_NETWORK' ) && WP_INSTALLING_NETWORK ) )
+	if ( is_network_admin() || ( defined( 'WP_INSTALLING_NETWORK' ) && WP_INSTALLING_NETWORK ) ) {
 		load_textdomain( 'default', WP_LANG_DIR . "/admin-network-$locale.mo" );
+	}
 	return $return;
 }
 /**
 * The .mo file should be named based on the text domain with a dash, and then the locale exactly.
 *
 * @since 1.5.0
 * @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
 *
-* @param string $domain          Unique identifier for retrieving translated strings
+* @param string       $domain          Unique identifier for retrieving translated strings
-* @param string $deprecated      Optional. Use the $plugin_rel_path parameter instead. Default false.
+* @param string|false $deprecated      Optional. Deprecated. Use the $plugin_rel_path parameter instead.
-* @param string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR where the .mo file resides.
+*                                      Default false.
-*                                Default false.
+* @param string|false $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR where the .mo file resides.
+*                                      Default false.
 * @return bool True when textdomain is successfully loaded, false otherwise.
 */
 function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
 	/**
 	 * Filters a plugin's locale.
 	 * @since 3.0.0
 	 *
 	 * @param string $locale The plugin's current locale.
 	 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 	 */
-	$locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
+	$locale = apply_filters( 'plugin_locale', determine_locale(), $domain );
 	$mofile = $domain . '-' . $locale . '.mo';
 	// Try to load from the languages directory first.
 	if ( load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile ) ) {
 *                                   file resides. Default empty string.
 * @return bool True when textdomain is successfully loaded, false otherwise.
 */
 function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
 	/** This filter is documented in wp-includes/l10n.php */
-	$locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
+	$locale = apply_filters( 'plugin_locale', determine_locale(), $domain );
 	$mofile = $domain . '-' . $locale . '.mo';
 	// Try to load from the languages directory first.
 	if ( load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile ) ) {
 	 * @since 3.0.0
 	 *
 	 * @param string $locale The theme's current locale.
 	 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 	 */
-	$locale = apply_filters( 'theme_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
+	$locale = apply_filters( 'theme_locale', determine_locale(), $domain );
 	$mofile = $domain . '-' . $locale . '.mo';
 	// Try to load from the languages directory first.
 	if ( load_textdomain( $domain, WP_LANG_DIR . '/themes/' . $mofile ) ) {
 * @param string $path   Optional. Path to the directory containing the .mo file.
 *                       Default false.
 * @return bool True when the theme textdomain is successfully loaded, false otherwise.
 */
 function load_child_theme_textdomain( $domain, $path = false ) {
-	if ( ! $path )
+	if ( ! $path ) {
 		$path = get_stylesheet_directory();
+	}
 	return load_theme_textdomain( $domain, $path );
+}
+/**
+* Loads the script translated strings.
+*
+* @since 5.0.0
+* @since 5.0.2 Uses load_script_translations() to load translation data.
+* @since 5.1.0 The `$domain` parameter was made optional.
+*
+* @see WP_Scripts::set_translations()
+*
+* @param string $handle Name of the script to register a translation domain to.
+* @param string $domain Optional. Text domain. Default 'default'.
+* @param string $path   Optional. The full file path to the directory containing translation files.
+*
+* @return false|string False if the script textdomain could not be loaded, the translated strings
+*                      in JSON encoding otherwise.
+*/
+function load_script_textdomain( $handle, $domain = 'default', $path = null ) {
+	$wp_scripts = wp_scripts();
+	if ( ! isset( $wp_scripts->registered[ $handle ] ) ) {
+		return false;
+	}
+	$path   = untrailingslashit( $path );
+	$locale = determine_locale();
+	// If a path was given and the handle file exists simply return it.
+	$file_base       = $domain === 'default' ? $locale : $domain . '-' . $locale;
+	$handle_filename = $file_base . '-' . $handle . '.json';
+	if ( $path ) {
+		$translations = load_script_translations( $path . '/' . $handle_filename, $handle, $domain );
+		if ( $translations ) {
+			return $translations;
+		}
+	}
+	$src = $wp_scripts->registered[ $handle ]->src;
+	if ( ! preg_match( '|^(https?:)?//|', $src ) && ! ( $wp_scripts->content_url && 0 === strpos( $src, $wp_scripts->content_url ) ) ) {
+		$src = $wp_scripts->base_url . $src;
+	}
+	$relative       = false;
+	$languages_path = WP_LANG_DIR;
+	$src_url     = wp_parse_url( $src );
+	$content_url = wp_parse_url( content_url() );
+	$site_url    = wp_parse_url( site_url() );
+	// If the host is the same or it's a relative URL.
+	if (
+		strpos( $src_url['path'], $content_url['path'] ) === 0 &&
+		( ! isset( $src_url['host'] ) || $src_url['host'] === $content_url['host'] )
+	) {
+		// Make the src relative the specific plugin or theme.
+		$relative = trim( substr( $src_url['path'], strlen( $content_url['path'] ) ), '/' );
+		$relative = explode( '/', $relative );
+		$languages_path = WP_LANG_DIR . '/' . $relative[0];
+		$relative = array_slice( $relative, 2 );
+		$relative = implode( '/', $relative );
+	} elseif ( ! isset( $src_url['host'] ) || $src_url['host'] === $site_url['host'] ) {
+		if ( ! isset( $site_url['path'] ) ) {
+			$relative = trim( $src_url['path'], '/' );
+		} elseif ( ( strpos( $src_url['path'], trailingslashit( $site_url['path'] ) ) === 0 ) ) {
+			// Make the src relative to the WP root.
+			$relative = substr( $src_url['path'], strlen( $site_url['path'] ) );
+			$relative = trim( $relative, '/' );
+		}
+	}
+	/**
+	 * Filters the relative path of scripts used for finding translation files.
+	 *
+	 * @since 5.0.2
+	 *
+	 * @param string $relative The relative path of the script. False if it could not be determined.
+	 * @param string $src      The full source url of the script.
+	 */
+	$relative = apply_filters( 'load_script_textdomain_relative_path', $relative, $src );
+	// If the source is not from WP.
+	if ( false === $relative ) {
+		return load_script_translations( false, $handle, $domain );
+	}
+	// Translations are always based on the unminified filename.
+	if ( substr( $relative, -7 ) === '.min.js' ) {
+		$relative = substr( $relative, 0, -7 ) . '.js';
+	}
+	$md5_filename = $file_base . '-' . md5( $relative ) . '.json';
+	if ( $path ) {
+		$translations = load_script_translations( $path . '/' . $md5_filename, $handle, $domain );
+		if ( $translations ) {
+			return $translations;
+		}
+	}
+	$translations = load_script_translations( $languages_path . '/' . $md5_filename, $handle, $domain );
+	if ( $translations ) {
+		return $translations;
+	}
+	return load_script_translations( false, $handle, $domain );
+}
+/**
+* Loads the translation data for the given script handle and text domain.
+*
+* @since 5.0.2
+*
+* @param string|false $file   Path to the translation file to load. False if there isn't one.
+* @param string       $handle Name of the script to register a translation domain to.
+* @param string       $domain The text domain.
+* @return string|false The JSON-encoded translated strings for the given script handle and text domain. False if there are none.
+*/
+function load_script_translations( $file, $handle, $domain ) {
+	/**
+	 * Pre-filters script translations for the given file, script handle and text domain.
+	 *
+	 * Returning a non-null value allows to override the default logic, effectively short-circuiting the function.
+	 *
+	 * @since 5.0.2
+	 *
+	 * @param string|false $translations JSON-encoded translation data. Default null.
+	 * @param string|false $file         Path to the translation file to load. False if there isn't one.
+	 * @param string       $handle       Name of the script to register a translation domain to.
+	 * @param string       $domain       The text domain.
+	 */
+	$translations = apply_filters( 'pre_load_script_translations', null, $file, $handle, $domain );
+	if ( null !== $translations ) {
+		return $translations;
+	}
+	/**
+	 * Filters the file path for loading script translations for the given script handle and text domain.
+	 *
+	 * @since 5.0.2
+	 *
+	 * @param string|false $file   Path to the translation file to load. False if there isn't one.
+	 * @param string       $handle Name of the script to register a translation domain to.
+	 * @param string       $domain The text domain.
+	 */
+	$file = apply_filters( 'load_script_translation_file', $file, $handle, $domain );
+	if ( ! $file || ! is_readable( $file ) ) {
+		return false;
+	}
+	$translations = file_get_contents( $file );
+	/**
+	 * Filters script translations for the given file, script handle and text domain.
+	 *
+	 * @since 5.0.2
+	 *
+	 * @param string $translations JSON-encoded translation data.
+	 * @param string $file         Path to the translation file that was loaded.
+	 * @param string $handle       Name of the script to register a translation domain to.
+	 * @param string $domain       The text domain.
+	 */
+	return apply_filters( 'load_script_translations', $translations, $file, $handle, $domain );
 }
 /**
 * Loads plugin and theme textdomains just-in-time.
 *
 *
 * @since 4.6.0
 * @access private
 *
 * @see get_translations_for_domain()
-* @global array $l10n_unloaded An array of all text domains that have been unloaded again.
+* @global MO[] $l10n_unloaded An array of all text domains that have been unloaded again.
 *
 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 * @return bool True when the textdomain is successfully loaded, false otherwise.
 */
 function _load_textdomain_just_in_time( $domain ) {
 *
 * @since 4.7.0
 * @access private
 *
 * @see _load_textdomain_just_in_time()
+* @staticvar array $available_translations
 *
 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 * @param bool   $reset  Whether to reset the internal cache. Used by the switch to locale functionality.
 * @return string|false The path to the translation file or false if no translation file was found.
 */
 *
 * @since 4.7.0
 * @access private
 *
 * @see _get_path_to_translation()
+* @staticvar array $cached_mofiles
 *
 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 * @return string|false The path to the translation file or false if no translation file was found.
 */
 function _get_path_to_translation_from_lang_dir( $domain ) {
 				$cached_mofiles = array_merge( $cached_mofiles, $mofiles );
 			}
 		}
 	}
-	$locale = is_admin() ? get_user_locale() : get_locale();
+	$locale = determine_locale();
 	$mofile = "{$domain}-{$locale}.mo";
 	$path = WP_LANG_DIR . '/plugins/' . $mofile;
 	if ( in_array( $path, $cached_mofiles ) ) {
 		return $path;
 *
 * If there isn't one, returns empty Translations instance.
 *
 * @since 2.8.0
 *
-* @global array $l10n
+* @global MO[] $l10n
+* @staticvar NOOP_Translations $noop_translations
 *
 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 * @return Translations|NOOP_Translations A Translations instance.
 */
 function get_translations_for_domain( $domain ) {
 /**
 * Whether there are translations for the text domain.
 *
 * @since 3.0.0
 *
-* @global array $l10n
+* @global MO[] $l10n
 *
 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 * @return bool Whether there are translations.
 */
 function is_textdomain_loaded( $domain ) {
 * using the old context format: 'Role name|User role' and just skipping the
 * content after the last bar is easier than fixing them in the DB. New installations
 * won't suffer from that problem.
 *
 * @since 2.8.0
-*
+* @since 5.2.0 Added the `$domain` parameter.
-* @param string $name The role name.
+*
+* @param string $name   The role name.
+* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+*                       Default 'default'.
 * @return string Translated role name on success, original name on failure.
 */
-function translate_user_role( $name ) {
+function translate_user_role( $name, $domain = 'default' ) {
-	return translate_with_gettext_context( before_last_bar($name), 'User role' );
+	return translate_with_gettext_context( before_last_bar( $name ), 'User role', $domain );
 }
 /**
 * Get all available languages based on the presence of *.mo files in a given directory.
 *
 *
 * @param string $type What to search for. Accepts 'plugins', 'themes', 'core'.
 * @return array Array of language data.
 */
 function wp_get_installed_translations( $type ) {
-	if ( $type !== 'themes' && $type !== 'plugins' && $type !== 'core' )
+	if ( $type !== 'themes' && $type !== 'plugins' && $type !== 'core' ) {
 		return array();
+	}
 	$dir = 'core' === $type ? '' : "/$type";
-	if ( ! is_dir( WP_LANG_DIR ) )
+	if ( ! is_dir( WP_LANG_DIR ) ) {
 		return array();
+	}
-	if ( $dir && ! is_dir( WP_LANG_DIR . $dir ) )
+	if ( $dir && ! is_dir( WP_LANG_DIR . $dir ) ) {
 		return array();
+	}
 	$files = scandir( WP_LANG_DIR . $dir );
-	if ( ! $files )
+	if ( ! $files ) {
 		return array();
+	}
 	$language_data = array();
 	foreach ( $files as $file ) {
 		if ( '.' === $file[0] || is_dir( WP_LANG_DIR . "$dir/$file" ) ) {
 			continue;
 		}
 		if ( ! preg_match( '/(?:(.+)-)?([a-z]{2,3}(?:_[A-Z]{2})?(?:_[a-z0-9]+)?).po/', $file, $match ) ) {
 			continue;
 		}
-		if ( ! in_array( substr( $file, 0, -3 ) . '.mo', $files ) )  {
+		if ( ! in_array( substr( $file, 0, -3 ) . '.mo', $files ) ) {
 			continue;
 		}
 		list( , $textdomain, $language ) = $match;
 		if ( '' === $textdomain ) {
 *
 * @param string $po_file Path to PO file.
 * @return array PO file headers.
 */
 function wp_get_pomo_file_data( $po_file ) {
-	$headers = get_file_data( $po_file, array(
+	$headers = get_file_data(
-		'POT-Creation-Date'  => '"POT-Creation-Date',
+		$po_file,
-		'PO-Revision-Date'   => '"PO-Revision-Date',
+		array(
-		'Project-Id-Version' => '"Project-Id-Version',
+			'POT-Creation-Date'  => '"POT-Creation-Date',
-		'X-Generator'        => '"X-Generator',
+			'PO-Revision-Date'   => '"PO-Revision-Date',
-	) );
+			'Project-Id-Version' => '"Project-Id-Version',
+			'X-Generator'        => '"X-Generator',
+		)
+	);
 	foreach ( $headers as $header => $value ) {
 		// Remove possible contextual '\n' and closing double quote.
 		$headers[ $header ] = preg_replace( '~(\\\n)?"$~', '', $value );
 	}
 	return $headers;
 * Language selector.
 *
 * @since 4.0.0
 * @since 4.3.0 Introduced the `echo` argument.
 * @since 4.7.0 Introduced the `show_option_site_default` argument.
+* @since 5.1.0 Introduced the `show_option_en_us` argument.
 *
 * @see get_available_languages()
 * @see wp_get_available_translations()
 *
 * @param string|array $args {
 *     @type string   $selected                     Language which should be selected. Default empty.
 *     @type bool|int $echo                         Whether to echo the generated markup. Accepts 0, 1, or their
 *                                                  boolean equivalents. Default 1.
 *     @type bool     $show_available_translations  Whether to show available translations. Default true.
 *     @type bool     $show_option_site_default     Whether to show an option to fall back to the site's locale. Default false.
+*     @type bool     $show_option_en_us            Whether to show an option for English (United States). Default true.
 * }
 * @return string HTML content
 */
 function wp_dropdown_languages( $args = array() ) {
-	$parsed_args = wp_parse_args( $args, array(
+	$parsed_args = wp_parse_args(
-		'id'           => 'locale',
+		$args,
-		'name'         => 'locale',
+		array(
-		'languages'    => array(),
+			'id'                          => 'locale',
-		'translations' => array(),
+			'name'                        => 'locale',
-		'selected'     => '',
+			'languages'                   => array(),
-		'echo'         => 1,
+			'translations'                => array(),
-		'show_available_translations' => true,
+			'selected'                    => '',
-		'show_option_site_default'    => false,
+			'echo'                        => 1,
-	) );
+			'show_available_translations' => true,
+			'show_option_site_default'    => false,
+			'show_option_en_us'           => true,
+		)
+	);
 	// Bail if no ID or no name.
 	if ( ! $parsed_args['id'] || ! $parsed_args['name'] ) {
 		return;
 	}
 			selected( 'site-default', $parsed_args['selected'], false ),
 			_x( 'Site Default', 'default site language' )
 		);
 	}
-	// Always show English.
+	if ( $parsed_args['show_option_en_us'] ) {
-	$structure[] = sprintf(
+		$structure[] = sprintf(
-		'<option value="" lang="en" data-installed="1"%s>English (United States)</option>',
+			'<option value="" lang="en" data-installed="1"%s>English (United States)</option>',
-		selected( '', $parsed_args['selected'], false )
+			selected( '', $parsed_args['selected'], false )
-	);
+		);
+	}
-	// List installed languages.
+	// List installed languages.
 	foreach ( $languages as $language ) {
 		$structure[] = sprintf(
 			'<option value="%s" lang="%s"%s data-installed="1">%s</option>',
 			esc_attr( $language['language'] ),
 			esc_attr( $language['lang'] ),
 	return $output;
 }
 /**
-* Checks if current locale is RTL.
+* Determines whether the current locale is right-to-left (RTL).
+*
+* For more information on this and similar theme functions, check out
+* the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
+* Conditional Tags} article in the Theme Developer Handbook.
 *
 * @since 3.0.0
 *
 * @global WP_Locale $wp_locale
 *

changeset 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4