<?php
/**
- * WordPress Translation API
+ * Core Translation API
*
* @package WordPress
* @subpackage i18n
+ * @since 1.2.0
*/
/**
- * Get the current locale.
+ * Retrieves the current locale.
*
- * If the locale is set, then it will filter the locale in the 'locale' filter
- * hook and return the value.
+ * If the locale is set, then it will filter the locale in the {@see 'locale'}
+ * filter hook and return the value.
*
* If the locale is not set already, then the WPLANG constant is used if it is
- * defined. Then it is filtered through the 'locale' filter hook and the value
- * for the locale global set and the locale is returned.
+ * defined. Then it is filtered through the {@see 'locale'} filter hook and
+ * the value for the locale global set and the locale is returned.
*
* The process to get the locale should only be done once, but the locale will
- * always be filtered using the 'locale' hook.
+ * always be filtered using the {@see 'locale'} hook.
*
* @since 1.5.0
*
- * @return string The locale of the blog or from the 'locale' hook.
+ * @global string $locale
+ * @global string $wp_local_package
+ *
+ * @return string The locale of the blog or from the {@see 'locale'} hook.
*/
function get_locale() {
global $locale, $wp_local_package;
// If multisite, check options.
if ( is_multisite() ) {
// Don't check blog option when installing.
- if ( defined( 'WP_INSTALLING' ) || ( false === $ms_locale = get_option( 'WPLANG' ) ) ) {
+ if ( wp_installing() || ( false === $ms_locale = get_option( 'WPLANG' ) ) ) {
$ms_locale = get_site_option( 'WPLANG' );
}
*
* If there is no translation, or the text domain isn't loaded, the original text is returned.
*
- * *Note:* Don't use {@see translate()} directly, use `{@see __()} or related functions.
+ * *Note:* Don't use translate() directly, use __() or related functions.
*
* @since 2.2.0
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text
*/
function translate( $text, $domain = 'default' ) {
*/
function before_last_bar( $string ) {
$last_bar = strrpos( $string, '|' );
- if ( false == $last_bar )
+ if ( false === $last_bar ) {
return $string;
- else
+ } else {
return substr( $string, 0, $last_bar );
+ }
}
/**
* If there is no translation, or the text domain isn't loaded the original
* text is returned.
*
+ * *Note:* Don't use translate_with_gettext_context() directly, use _x() or related functions.
+ *
* @since 2.8.0
*
* @param string $text Text to translate.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text on success, original text on failure.
*/
function translate_with_gettext_context( $text, $context, $domain = 'default' ) {
}
/**
- * Retrieve the translation of $text. If there is no translation,
- * or the text domain isn't loaded, the original text is returned.
+ * Retrieve the translation of $text.
+ *
+ * If there is no translation, or the text domain isn't loaded, the original text is returned.
*
* @since 2.1.0
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text.
*/
function __( $text, $domain = 'default' ) {
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text on success, original text on failure.
*/
function esc_attr__( $text, $domain = 'default' ) {
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text
*/
function esc_html__( $text, $domain = 'default' ) {
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
*/
function _e( $text, $domain = 'default' ) {
echo translate( $text, $domain );
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
*/
function esc_attr_e( $text, $domain = 'default' ) {
echo esc_attr( translate( $text, $domain ) );
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
*/
function esc_html_e( $text, $domain = 'default' ) {
echo esc_html( translate( $text, $domain ) );
* @param string $text Text to translate.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated context string without pipe.
*/
function _x( $text, $context, $domain = 'default' ) {
* @param string $text Text to translate.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated context string without pipe.
*/
function _ex( $text, $context, $domain = 'default' ) {
* @param string $text Text to translate.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text
*/
function esc_attr_x( $text, $context, $domain = 'default' ) {
* @param string $text Text to translate.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text.
*/
function esc_html_x( $text, $context, $domain = 'default' ) {
}
/**
- * Retrieve the plural or single form based on the supplied amount.
+ * Translates and retrieves the singular or plural form based on the supplied number.
+ *
+ * Used when you want to use the appropriate form of a string based on whether a
+ * number is singular or plural.
*
- * If the text domain is not set in the $l10n list, then a comparison will be made
- * and either $plural or $single parameters returned.
+ * Example:
*
- * If the text domain does exist, then the parameters $single, $plural, and $number
- * will first be passed to the text domain's ngettext method. Then it will be passed
- * to the 'ngettext' filter hook along with the same parameters. The expected
- * type will be a string.
+ * $people = sprintf( _n( '%s person', '%s people', $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 2.8.0
*
- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param int $number The number to compare against to use either $single or $plural.
+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param int $number The number to compare against to use either the singular or plural form.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
- * @return string Either $single or $plural translated text.
+ * Default 'default'.
+ * @return string The translated singular or plural form.
*/
function _n( $single, $plural, $number, $domain = 'default' ) {
$translations = get_translations_for_domain( $domain );
$translation = $translations->translate_plural( $single, $plural, $number );
+
/**
- * Filter text with its translation when plural option is available.
+ * Filter the singular or plural form of a string.
*
* @since 2.2.0
*
* @param string $translation Translated text.
- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param string $number The number to compare against to use either $single or $plural.
+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param string $number The number to compare against to use either the singular or plural form.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
return apply_filters( 'ngettext', $translation, $single, $plural, $number, $domain );
}
/**
- * Retrieve the plural or single form based on the supplied amount with gettext context.
+ * Translates and retrieves the singular or plural form based on the supplied number, with gettext context.
*
- * This is a hybrid of _n() and _x(). It supports contexts and plurals.
+ * This is a hybrid of _n() and _x(). It supports context and plurals.
+ *
+ * Used when you want to use the appropriate form of a string with context based on whether a
+ * number is singular or plural.
+ *
+ * Example:
+ *
+ * $people = sprintf( _n( '%s person', '%s people', $count, 'context', 'text-domain' ), number_format_i18n( $count ) );
*
* @since 2.8.0
*
- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param int $number The number to compare against to use either $single or $plural.
+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param int $number The number to compare against to use either the singular or plural form.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
- * @return string Either $single or $plural translated text with context.
+ * Default 'default'.
+ * @return string The translated singular or plural form.
*/
function _nx($single, $plural, $number, $context, $domain = 'default') {
$translations = get_translations_for_domain( $domain );
$translation = $translations->translate_plural( $single, $plural, $number, $context );
+
/**
- * Filter text with its translation while plural option and context are available.
+ * Filter the singular or plural form of a string with gettext context.
*
* @since 2.8.0
*
* @param string $translation Translated text.
- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param string $number The number to compare against to use either $single or $plural.
+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param string $number The number to compare against to use either the singular or plural form.
* @param string $context Context information for the translators.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
}
/**
- * Register plural strings in POT file, but don't translate them.
+ * Registers plural strings in POT file, but does not translate them.
*
* Used when you want to keep structures with translatable plural
- * strings and use them later.
+ * strings and use them later when the number is known.
*
* Example:
*
* $messages = array(
- * 'post' => _n_noop( '%s post', '%s posts' ),
- * 'page' => _n_noop( '%s pages', '%s pages' ),
+ * 'post' => _n_noop( '%s post', '%s posts', 'text-domain' ),
+ * 'page' => _n_noop( '%s pages', '%s pages', 'text-domain' ),
* );
* ...
* $message = $messages[ $type ];
- * $usable_text = sprintf( translate_nooped_plural( $message, $count ), $count );
+ * $usable_text = sprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 2.5.0
*
- * @param string $singular Single form to be i18ned.
- * @param string $plural Plural form to be i18ned.
+ * @param string $singular Singular form to be localized.
+ * @param string $plural Plural form to be localized.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
- * @return array array($singular, $plural)
+ * Default null.
+ * @return array {
+ * Array of translation information for the strings.
+ *
+ * @type string $0 Singular form to be localized. No longer used.
+ * @type string $1 Plural form to be localized. No longer used.
+ * @type string $singular Singular form to be localized.
+ * @type string $plural Plural form to be localized.
+ * @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 );
}
/**
- * Register plural strings with context in POT file, but don't translate them.
+ * Registers plural strings with gettext context in POT file, but does not translate them.
+ *
+ * Used when you want to keep structures with translatable plural
+ * strings and use them later when the number is known.
+ *
+ * Example:
+ *
+ * $messages = array(
+ * 'post' => _n_noop( '%s post', '%s posts', 'context', 'text-domain' ),
+ * 'page' => _n_noop( '%s pages', '%s pages', 'context', 'text-domain' ),
+ * );
+ * ...
+ * $message = $messages[ $type ];
+ * $usable_text = sprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 2.8.0
- * @param string $singular
- * @param string $plural
- * @param string $context
- * @param string|null $domain
- * @return array
+ *
+ * @param string $singular Singular form to be localized.
+ * @param string $plural Plural form to be localized.
+ * @param string $context Context information for the translators.
+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default null.
+ * @return array {
+ * Array of translation information for the strings.
+ *
+ * @type string $0 Singular form to be localized. No longer used.
+ * @type string $1 Plural form to be localized. No longer used.
+ * @type string $2 Context information for the translators. No longer used.
+ * @type string $singular Singular form to be localized.
+ * @type string $plural Plural form to be localized.
+ * @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 );
}
/**
- * Translate the result of _n_noop() or _nx_noop().
+ * Translates and retrieves the singular or plural form of a string that's been registered
+ * with _n_noop() or _nx_noop().
+ *
+ * Used when you want to use a translatable plural string once the number is known.
+ *
+ * Example:
+ *
+ * $messages = array(
+ * 'post' => _n_noop( '%s post', '%s posts', 'text-domain' ),
+ * 'page' => _n_noop( '%s pages', '%s pages', 'text-domain' ),
+ * );
+ * ...
+ * $message = $messages[ $type ];
+ * $usable_text = sprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 3.1.0
*
- * @param array $nooped_plural Array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop()
- * @param int $count Number of objects
+ * @param array $nooped_plural Array with singular, plural, and context keys, usually the result of _n_noop() or _nx_noop().
+ * @param int $count Number of objects.
* @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.
+ * 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' ) {
*
* @since 1.5.0
*
+ * @global array $l10n
+ *
* @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.
*
* @since 3.0.0
*
+ * @global array $l10n
+ *
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @return bool Whether textdomain was unloaded.
*/
return $return;
}
- if ( is_admin() || defined( 'WP_INSTALLING' ) || ( defined( 'WP_REPAIRING' ) && WP_REPAIRING ) ) {
+ if ( is_admin() || wp_installing() || ( defined( 'WP_REPAIRING' ) && WP_REPAIRING ) ) {
load_textdomain( 'default', WP_LANG_DIR . "/admin-$locale.mo" );
}
*
* @since 2.8.0
*
+ * @global array $l10n
+ *
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @return NOOP_Translations A Translations instance.
*/
function get_translations_for_domain( $domain ) {
global $l10n;
- if ( !isset( $l10n[$domain] ) ) {
- $l10n[$domain] = new NOOP_Translations;
+ if ( isset( $l10n[ $domain ] ) ) {
+ return $l10n[ $domain ];
+ }
+
+ static $noop_translations = null;
+ if ( null === $noop_translations ) {
+ $noop_translations = new NOOP_Translations;
}
- return $l10n[$domain];
+
+ return $noop_translations;
}
/**
*
* @since 3.0.0
*
+ * @global array $l10n
+ *
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @return bool Whether there are translations.
*/
function is_textdomain_loaded( $domain ) {
global $l10n;
- return isset( $l10n[$domain] );
+ return isset( $l10n[ $domain ] );
}
/**
$lang_files = glob( ( is_null( $dir) ? WP_LANG_DIR : $dir ) . '/*.mo' );
if ( $lang_files ) {
- foreach( $lang_files as $lang_file ) {
+ foreach ( $lang_files as $lang_file ) {
$lang_file = basename( $lang_file, '.mo' );
if ( 0 !== strpos( $lang_file, 'continents-cities' ) && 0 !== strpos( $lang_file, 'ms-' ) &&
0 !== strpos( $lang_file, 'admin-' ) ) {
$language_data = array();
foreach ( $files as $file ) {
- if ( '.' === $file[0] || is_dir( $file ) ) {
+ if ( '.' === $file[0] || is_dir( WP_LANG_DIR . "$dir/$file" ) ) {
continue;
}
if ( substr( $file, -3 ) !== '.po' ) {
continue;
}
- if ( ! preg_match( '/(?:(.+)-)?([A-Za-z_]{2,6}).po/', $file, $match ) ) {
+ 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 ) ) {
* Language selector.
*
* @since 4.0.0
+ * @since 4.3.0 Introduced the `echo` argument.
*
* @see get_available_languages()
* @see wp_get_available_translations()
* @param string|array $args {
* Optional. Array or string of arguments for outputting the language selector.
*
- * @type string $id ID attribute of the select element. Default empty.
- * @type string $name Name attribute of the select element. Default empty.
- * @type array $languages List of installed languages, contain only the locales.
- * Default empty array.
- * @type array $translations List of available translations. Default result of
- * {@see wp_get_available_translations()}.
- * @type string $selected Language which should be selected. Default empty.
- * @type bool $show_available_translations Whether to show available translations. Default true.
+ * @type string $id ID attribute of the select element. Default empty.
+ * @type string $name Name attribute of the select element. Default empty.
+ * @type array $languages List of installed languages, contain only the locales.
+ * Default empty array.
+ * @type array $translations List of available translations. Default result of
+ * wp_get_available_translations().
+ * @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.
* }
+ * @return string HTML content
*/
function wp_dropdown_languages( $args = array() ) {
'languages' => array(),
'translations' => array(),
'selected' => '',
+ 'echo' => 1,
'show_available_translations' => true,
) );
$translations_available = ( ! empty( $translations ) && $args['show_available_translations'] );
- printf( '<select name="%s" id="%s">', esc_attr( $args['name'] ), esc_attr( $args['id'] ) );
+ $output = sprintf( '<select name="%s" id="%s">', esc_attr( $args['name'] ), esc_attr( $args['id'] ) );
// Holds the HTML markup.
$structure = array();
$structure[] = '</optgroup>';
}
- echo join( "\n", $structure );
+ $output .= join( "\n", $structure );
+
+ $output .= '</select>';
+
+ if ( $args['echo'] ) {
+ echo $output;
+ }
- echo '</select>';
+ return $output;
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff