ngettext WordPress Filter Hook

The ngettext hook allows you to change the text of a string based on the number of objects it refers to. For example, if you have three objects, the string "There are three objects" would become "There are three objects (with ngettext)."

apply_filters( 'ngettext', string $translation, string $single, string $plural, string $number, string $domain ) #

Filters the singular or plural form of a string.


Parameters

$translation

(string)Translated text.

$single

(string)The text to be used if the number is singular.

$plural

(string)The text to be used if the number is plural.

$number

(string)The number to compare against to use either the singular or plural form.

$domain

(string)Text domain. Unique identifier for retrieving translated strings.


Top ↑

More Information

This filter hook is applied to the translated text by the internationalization function that handle plurals (_n()).

IMPORTANT: This filter is always applied even if internationalization is not in effect, and if the text domain has not been loaded. If there are functions hooked to this filter, they will always run. This could lead to a performance problem.

For regular translation functions such as _e(), and for examples on usage, see gettext().

For context-specific translation functions such as _x(), see filter hook gettext_with_context() and ngettext_with_context().


Top ↑

Source

File: wp-includes/l10n.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
2.2.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.