<?php

/**

 * Core Translation API

 *

 * @package WordPress

 * @subpackage i18n

 * @since 1.2.0

 */

/**

 * Retrieves the current locale.

 *

 * 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 {@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 {@see 'locale'} hook.

 *

 * @since 1.5.0

 *

 * @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 ( isset( $locale ) ) {

		/**

		 * Filters the locale ID of the WordPress installation.

		 *

		 * @since 1.5.0

		 *

		 * @param string $locale The locale ID.

		 */

		return apply_filters( 'locale', $locale );

	}

	if ( isset( $wp_local_package ) ) {

		$locale = $wp_local_package;

	}

	// WPLANG was defined in wp-config.

	if ( defined( 'WPLANG' ) ) {

		$locale = WPLANG;

	}

	// If multisite, check options.

	if ( is_multisite() ) {

		// Don't check blog option when installing.

		if ( wp_installing() || ( false === $ms_locale = get_option( 'WPLANG' ) ) ) {

			$ms_locale = get_site_option( 'WPLANG' );

		}

		if ( $ms_locale !== false ) {

			$locale = $ms_locale;

		}

	} else {

		$db_locale = get_option( 'WPLANG' );

		if ( $db_locale !== false ) {

			$locale = $db_locale;

		}

	}

	if ( empty( $locale ) ) {

		$locale = 'en_US';

	}

	/** This filter is documented in wp-includes/l10n.php */

	return apply_filters( 'locale', $locale );

}

/**

 * Retrieves the locale of a user.

 *

 * If the user has a locale set to a non-empty string then it will be

 * returned. Otherwise it returns the locale of get_locale().

 *

 * @since 4.7.0

 *

 * @param int|WP_User $user_id User's ID or a WP_User object. Defaults to current user.

 * @return string The locale of the user.

 */

function get_user_locale( $user_id = 0 ) {

	$user = false;

	if ( 0 === $user_id && function_exists( 'wp_get_current_user' ) ) {

		$user = wp_get_current_user();

	} elseif ( $user_id instanceof WP_User ) {

		$user = $user_id;

	} elseif ( $user_id && is_numeric( $user_id ) ) {

		$user = get_user_by( 'id', $user_id );

	}

	if ( ! $user ) {

		return get_locale();

	}

	$locale = $user->locale;

	return $locale ? $locale : get_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.

 *

 * @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' ) {

	$translations = get_translations_for_domain( $domain );

	$translation  = $translations->translate( $text );

	/**

	 * Filters text with its translation.

	 *

	 * @since 2.0.11

	 *

	 * @param string $translation  Translated text.

	 * @param string $text         Text to translate.

	 * @param string $domain       Text domain. Unique identifier for retrieving translated strings.

	 */

	return apply_filters( 'gettext', $translation, $text, $domain );

}

/**

 * Remove last item on a pipe-delimited string.

 *

 * Meant for removing the last item in a string, such as 'Role name|User role'. The original

 * string will be returned if no pipe '|' characters are found in the string.

 *

 * @since 2.8.0

 *

 * @param string $string A pipe-delimited string.

 * @return string Either $string or everything before the last pipe.

 */

function before_last_bar( $string ) {

	$last_bar = strrpos( $string, '|' );

	if ( false === $last_bar ) {

		return $string;

	} else {

		return substr( $string, 0, $last_bar );

	}

}

/**

 * Retrieve the translation of $text in the context defined in $context.

 *

 * 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' ) {

	$translations = get_translations_for_domain( $domain );

	$translation  = $translations->translate( $text, $context );

	/**

	 * Filters text with its translation based on context information.

	 *

	 * @since 2.8.0

	 *

	 * @param string $translation  Translated text.

	 * @param string $text         Text to translate.

	 * @param string $context      Context information for the translators.

	 * @param string $domain       Text domain. Unique identifier for retrieving translated strings.

	 */

	return apply_filters( 'gettext_with_context', $translation, $text, $context, $domain );

}

/**

 * 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' ) {

	return translate( $text, $domain );

}

/**

 * Retrieve the translation of $text and escapes it for safe use in an attribute.

 *

 * If there is no translation, or the text domain isn't loaded, the original text is returned.

 *

 * @since 2.8.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 on success, original text on failure.

 */

function esc_attr__( $text, $domain = 'default' ) {

	return esc_attr( translate( $text, $domain ) );

}

/**

 * 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

 *

 * @since 2.8.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 esc_html__( $text, $domain = 'default' ) {

	return esc_html( translate( $text, $domain ) );

}

/**

 * Display translated text.

 *

 * @since 1.2.0

 *

 * @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 );

}

/**

 * Display translated text that has been escaped for safe use in an attribute.

 *

 * @since 2.8.0

 *

 * @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 ) );

}

/**

 * Display translated text that has been escaped for safe use in HTML output.

 *

 * @since 2.8.0

 *

 * @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 ) );

}

/**

 * Retrieve translated string with gettext context.

 *

 * Quite a few times, there will be collisions with similar translatable text

 * found in more than two places, but with different translated context.

 *

 * By including the context in the pot file, translators can translate the two

 * strings differently.

 *

 * @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 context string without pipe.

 */

function _x( $text, $context, $domain = 'default' ) {

	return translate_with_gettext_context( $text, $context, $domain );

}

/**

 * Display translated string with gettext context.

 *

 * @since 3.0.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 context string without pipe.

 */

function _ex( $text, $context, $domain = 'default' ) {

	echo _x( $text, $context, $domain );

}

/**

 * Translate string with gettext context, and escapes it for safe use in an attribute.

 *

 * @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

 */

function esc_attr_x( $text, $context, $domain = 'default' ) {

	return esc_attr( translate_with_gettext_context( $text, $context, $domain ) );

}

/**

 * Translate string with gettext context, and escapes it for safe use in HTML output.

 *

 * @since 2.9.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.

 */

function esc_html_x( $text, $context, $domain = 'default' ) {

	return esc_html( translate_with_gettext_context( $text, $context, $domain ) );

}

/**

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

 *

 * Example:

 *

 *     printf( _n( '%s person', '%s people', $count, 'text-domain' ), number_format_i18n( $count ) );

 *

 * @since 2.8.0

 *

 * @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.

 *                       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 );

	/**

	 * Filters the singular or plural form of a string.

	 *

	 * @since 2.2.0

	 *

	 * @param string $translation Translated text.

	 * @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 );

}

/**

 * 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 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 of a generic phrase which is disambiguated via the context parameter:

 *

 *     printf( _nx( '%s group', '%s groups', $people, 'group of people', 'text-domain' ), number_format_i18n( $people ) );

 *     printf( _nx( '%s group', '%s groups', $animals, 'group of animals', 'text-domain' ), number_format_i18n( $animals ) );

 *

 * @since 2.8.0

 *