_n()
Получает строку перевода единственного или множественного числа, ту которая соответствует указанному числу (1 комментарий, 2 комментария). Функция локализации.
В функцию указываются строки перевода и число, далее:
- Если передано единственное число (1), то функция вернет переведенное значение первого параметра: $single.
- Если передано множественное число (2 3 4), то функцию вернет переведенное значение второго параметра: $plural.
- Если не удастся получить перевод нужной строки из файла перевода, то функция вернет оригинальное значение строки.
Если указан ID перевода ($domain). Функция передаст параметры $single, $plural, и $number в метод Translations::translate_plural(). Затем результат и все параметры будут переданы в фильтр ngettext
.
Если нужно сделать такой перевод с учетом контекста, используйте _nx().
Хуки из функции
Возвращает
Строку
. Переведенную или оригинальную строку указанную в параметре $single или $plural, в зависимости от переданного числа $number.
Использование
_n( $single, $plural, $number, $domain )
- $single(строка) (обязательный)
- Строка перевода, которая будет использована при $number = 1.
- $plural(строка) (обязательный)
Строка перевода, которая будет использована при $number больше 1.
Для русского языка, где часто используется 3 формы (1 яблоко, 3 яблока, 5 яблок), эту функцию тоже можно использовать, но для этого нужно будет грамотно настроить "Формы множественного числа" для .mo файла в программе Poedit.
- $number(число) (обязательный)
- Число (множественное или единственное), которое будет определять какую строку перевода нужно использовать $single или $plural.
- $domain(строка)
- Домен (идентификатор файла перевода), который определяет какой файл использовать для перевода.
По умолчанию: 'default'
Примеры
#1 Простое использование, для наглядности
echo _n( '%s star', '%s stars', 1 ); // Выведет: %s star echo _n( '%s star', '%s stars', 3 ); // Выведет: %s stars
#2 C файлом перевода
Далее, предполагается, что есть файл перевода, он зарегистрирован с помощью
load_plugin_textdomain() и его идентификатор 'my_textdomain'.
Также в этом файле перевода указаны переводы для множественных чисел, тогда:
echo _n( '%s star', '%s stars', 1, 'textdomain' ); // Вернет: %s звезда echo _n( '%s star', '%s stars', 4, 'textdomain' ); // Вернет: %s звезды echo _n( '%s star', '%s stars', 6, 'textdomain' ); // Вернет: %s звезд
#3 Заменяем %s
на нужное число.
Для этого используем PHP функцию sprintf(). Так делается во всех темах:
$rating = 1; echo sprintf( _n( '%s star', '%s stars', $rating, 'your_textdomain' ), $rating ); // Вернет: 1 звезда $rating = 4; echo sprintf( _n( '%s star', '%s stars', $rating, 'your_textdomain' ), $rating ); // Вернет: 4 звезды $rating = 6; echo sprintf( _n( '%s star', '%s stars', $rating, 'your_textdomain' ), $rating ); // Вернет: 6 звезд
#4 Пример из файла /wp-admin/edit-comments.php
if ( $approved > 0 ) $messages[] = sprintf( _n( '%s comment approved', '%s comments approved', $approved ), $approved );
#5 Переводим фразу о количестве товаров в WooCommerce
// Получаем количество товаров в корзине, пусть их 5 $count = WC()->cart->get_cart_contents_count(); // Переводим, получим "%s, %d товаров" $translation = _n( '%s, has %d product', '%s, has %d products', $count, 'woocommerce' ); // Вырезаем запятую, если не нужна, получим "%s %d товаров" $translation = str_replace( ',', '', $translation ); // Подставляем вместо плейсхолдеров данные, получим "Всего 5 товаров" $translation = sprintf( $translation, 'Всего', $count ) // Очищаем и выводим на экран echo wp_kses_data( $translation );
#6 Никогда не выполняйте вычисления внутри функции sprintf()!
Следующее не будет работать:
$text = sprintf( _n( '%s star', '%s stars', $rating, 'your-text-domain' ), 2 <= $rating ? $rating -1 : $rating );
Правильно:
$rating = 2 <= $rating ? $rating - 1 : $rating; $text = sprintf( _n( '%s star', '%s stars', $rating, 'your-text-domain' ), $rating );
Список изменений
С версии 2.8.0 | Введена. |
С версии 5.5.0 | Introduced ngettext-{$domain} filter. |