| [ Index ] |
PHP Cross Reference of BuddyPress |
[Source view] [Print] [Project Stats]
bbPress Translation API
| File Size: | 490 lines (14 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| bb_get_locale() X-Ref |
| Gets 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 not set already, then the BB_LANG 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. The process to get the locale should only be done once but the locale will always be filtered using the 'locale' hook. return: string The locale of the blog or from the 'locale' hook. since: 0.7.2 |
| get_locale() X-Ref |
| No description |
| translate( $text, $domain = 'default' ) X-Ref |
| Retrieves the translation of $text. If there is no translation, or the domain isn't loaded the original text is returned. param: string $text Text to translate. param: string $domain Domain to retrieve the translated text. return: string Translated text since: 1.0 |
| before_last_bar( $string ) X-Ref |
since: 1.0 |
| translate_with_context( $text, $domain = 'default' ) X-Ref |
| Translate $text like translate(), but assumes that the text contains a context after its last vertical bar. param: string $text Text to translate param: string $domain Domain to retrieve the translated text return: string Translated text since: 1.0 |
| translate_with_gettext_context( $text, $context, $domain = 'default' ) X-Ref |
since: 1.0 |
| __( $text, $domain = 'default' ) X-Ref |
| Retrieves the translation of $text. If there is no translation, or the domain isn't loaded the original text is returned. param: string $text Text to translate param: string $domain Optional. Domain to retrieve the translated text return: string Translated text since: 0.7.2 |
| esc_attr__( $text, $domain = 'default' ) X-Ref |
| Retrieves the translation of $text and escapes it for safe use in an attribute. If there is no translation, or the domain isn't loaded the original text is returned. param: string $text Text to translate param: string $domain Optional. Domain to retrieve the translated text return: string Translated text since: 1.0 |
| esc_html__( $text, $domain = 'default' ) X-Ref |
| Retrieves the translation of $text and escapes it for safe use in HTML output. If there is no translation, or the domain isn't loaded the original text is returned. param: string $text Text to translate param: string $domain Optional. Domain to retrieve the translated text return: string Translated text since: 1.0 |
| _e( $text, $domain = 'default' ) X-Ref |
| Displays the returned translated text from translate(). param: string $text Text to translate param: string $domain Optional. Domain to retrieve the translated text since: 0.7.2 |
| esc_attr_e( $text, $domain = 'default' ) X-Ref |
| Displays translated text that has been escaped for safe use in an attribute. param: string $text Text to translate param: string $domain Optional. Domain to retrieve the translated text since: 1.0 |
| esc_html_e( $text, $domain = 'default' ) X-Ref |
| Displays translated text that has been escaped for safe use in HTML output. param: string $text Text to translate param: string $domain Optional. Domain to retrieve the translated text since: 1.0 |
| _c($text, $domain = 'default') X-Ref |
| Retrieve translated string with vertical bar context Quite a few times, there will be collisions with similar translatable text found in more than two places but with different translated context. In order to use the separate contexts, the _c() function is used and the translatable string uses a pipe ('|') which has the context the string is in. When the translated string is returned, it is everything before the pipe, not including the pipe character. If there is no pipe in the translated text then everything is returned. param: string $text Text to translate param: string $domain Optional. Domain to retrieve the translated text return: string Translated context string without pipe since: 1.0 |
| _x( $single, $context, $domain = 'default' ) X-Ref |
since: 1.0 |
| esc_attr_x( $single, $context, $domain = 'default' ) X-Ref |
| No description |
| __ngettext() X-Ref |
| _n($single, $plural, $number, $domain = 'default') X-Ref |
| Retrieve the plural or single form based on the amount. If the domain is not set in the $l10n list, then a comparsion will be made and either $plural or $single parameters returned. If the domain does exist, then the parameters $single, $plural, and $number will first be passed to the 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. 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 $domain Optional. The domain identifier the text should be retrieved in return: string Either $single or $plural translated text since: 1.0 |
| _nc( $single, $plural, $number, $domain = 'default' ) X-Ref |
since: 1.0 |
| _nx($single, $plural, $number, $context, $domain = 'default') X-Ref |
since: 1.0 |
| __ngettext_noop() X-Ref |
| _n_noop( $single, $plural ) X-Ref |
| Register plural strings in POT file, but don't translate them. Used when you want do keep structures with translatable plural strings and use them later. Example: $messages = array( 'post' => _n_noop('%s post', '%s posts'), 'page' => _n_noop('%s pages', '%s pages') ); ... $message = $messages[$type]; $usable_text = sprintf(_n($message[0], $message[1], $count), $count); param: $single Single form to be i18ned param: $plural Plural form to be i18ned return: array array($single, $plural) since: 1.0 |
| _nx_noop( $single, $plural, $context ) X-Ref |
| Register plural strings with context in POT file, but don't translate them. |
| load_textdomain($domain, $mofile) X-Ref |
| Loads MO file into the list of domains. If the domain already exists, the inclusion will fail. If the MO file is not readable, the inclusion will fail. On success, the mofile will be placed in the $l10n global by $domain and will be an gettext_reader object. param: string $domain Unique identifier for retrieving translated strings param: string $mofile Path to the .mo file return: null On failure returns null and also on success returns nothing. since: 0.7.2 |
| bb_load_default_textdomain() X-Ref |
| Loads default translated strings based on locale. Loads the .mo file in WP_LANG_DIR constant path from WordPress root. The translated (.mo) file is named based off of the locale. since: 1.5.0 |
| load_default_textdomain() X-Ref |
| No description |
| bb_load_plugin_textdomain($domain, $path = false) X-Ref |
| Loads the plugin's translated strings. If the path is not given then it will be the root of the plugin directory. The .mo file should be named based on the domain with a dash followed by a dash, and then the locale exactly. param: string $domain Unique identifier for retrieving translated strings param: string $path Optional. Absolute path to folder where the .mo file resides since: 0.7.2 |
| load_plugin_textdomain( $domain, $path = false ) X-Ref |
| No description |
| bb_load_theme_textdomain($domain, $path = false) X-Ref |
| Loads the theme's translated strings. If the current locale exists as a .mo file in the theme's root directory, it will be included in the translated strings by the $domain. The .mo files must be named based on the locale exactly. param: string $domain Unique identifier for retrieving translated strings since: 0.7.2 |
| load_theme_textdomain( $domain, $path = false ) X-Ref |
| No description |
| get_translations_for_domain( $domain ) X-Ref |
| Returns the Translations instance for a domain. If there isn't one, returns empty Translations instance. param: string $domain return: object A Translation instance |
| Generated: Thu Dec 7 01:01:35 2017 | Cross-referenced by PHPXref 0.7.1 |