function format_plural

You are here

7 common.inc format_plural($count, $singular, $plural, array $args = array(), array $options = array())
4.6 common.inc format_plural($count, $singular, $plural)
4.7 common.inc format_plural($count, $singular, $plural)
5 common.inc format_plural($count, $singular, $plural)
6 common.inc format_plural($count, $singular, $plural, $args = array(), $langcode = NULL)
8 common.inc format_plural($count, $singular, $plural, array $args = array(), array $options = array())

Formats a string containing a count of items.

This function ensures that the string is pluralized correctly. Since t() is called by this function, make sure not to pass already-localized strings to it.

For example:

  $output = format_plural($node->comment_count, '1 comment', '@count comments');

Example with additional replacements:

  $output = format_plural($update_count,
    'Changed the content type of 1 post from %old-type to %new-type.',
    'Changed the content type of @count posts from %old-type to %new-type.',
    array('%old-type' => $info->old_type, '%new-type' => $info->new_type));

Parameters

$count: The item count to display.

$singular: The string for the singular case. Make sure it is clear this is singular, to ease translation (e.g. use "1 new comment" instead of "1 new"). Do not use @count in the singular string.

$plural: The string for the plural case. Make sure it is clear this is plural, to ease translation. Use @count in place of the item count, as in "@count new comments".

$args: An associative array of replacements to make after translation. Instances of any key in this array are replaced with the corresponding value. Based on the first character of the key, the value is escaped and/or themed. See format_string(). Note that you do not need to include @count in this array; this replacement is done automatically for the plural case.

$options: An associative array of additional options. See t() for allowed keys.

Return value

A translated string.

See also

t()

format_string()

Related topics

51 calls to format_plural()
aggregator_view in modules/aggregator/aggregator.admin.inc
Displays the aggregator administration page.
CommentHelperCase::performCommentOperation in modules/comment/comment.test
Perform the specified operation on the specified comment.
comment_multiple_delete_confirm_submit in modules/comment/comment.admin.inc
Process comment_multiple_delete_confirm form submissions.
comment_node_search_result in modules/comment/comment.module
Implements hook_node_search_result().
comment_node_view in modules/comment/comment.module
Implements hook_node_view().

... See full list

File

includes/common.inc, line 1804
Common functions that many Drupal modules will need to reference.

Code

function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
  $args['@count'] = $count;
  if ($count == 1) {
    return t($singular, $args, $options);
  }

  // Get the plural index through the gettext formula.
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, isset($options['langcode']) ? $options['langcode'] : NULL) : -1;
  // If the index cannot be computed, use the plural as a fallback (which
  // allows for most flexiblity with the replaceable @count value).
  if ($index < 0) {
    return t($plural, $args, $options);
  }
  else {
    switch ($index) {
      case "0":
        return t($singular, $args, $options);
      case "1":
        return t($plural, $args, $options);
      default:
        unset($args['@count']);
        $args['@count[' . $index . ']'] = $count;
        return t(strtr($plural, array('@count' => '@count[' . $index . ']')), $args, $options);
    }
  }
}

Comments

All guides describe to use this function like that:

<?php
  format_plural
($nodes, '1 node', '@count nodes');
?>

This is wrong for languages which using singular method for numbers like 21, 31 and so on.

Let's take module CAPTCHA for example. In "Status report" this module show how many submissions were blocked. If we will translate CAPTCHA into Russian for example (my case), then whenever we will have 21, 51, 141 (and so on) blocked submissions, CAPTCHA would report that only 1 post submission was blocked. This is not right.

So i have a suggestion to write singular string with @count prefix instead of digit 1. The code would be following:

<?php
  format_plural
($nodes, '@count node', '@count nodes');
?>

Please share this information with everyone!

If you write your translation with @count it will be replaced in singural AND in plural

msgid "1 sheep"
msgid_plural "@count sheep"
msgstr[0] "@count (russian word)"
msgstr[1] "@count (russian words)"

Translators must be careful about this...

This is the expected usage:

<?php
  format_plural
($nodes, '1 node', '@count nodes');
?>

The plural formula of the destination language is going to take care of multiple plural forms. The best practice is to not have @count in the singular form.

In English (and, generally, Romance languages), 1 is singular, and singular always implies 1. 0, and n>=2 are plural.

This isn't necessarily the case for other languages.

In Russian, "If the number is 1, or the number ends in the word 'один' (example: 1, 21, 61) (but not 11), then you should use the case (singular)" - http://www.russianlessons.net/lessons/lesson11_main.php

This means that we cannot rely on the singular form having '1' of something: 21 could also select singular. This suggests to me that we should use @count in both the singular and plural versions:

format_plural($nodes, '@count node', '@count nodes');

Should we therefore change the documentation to reflect this practice, or have I misunderstood something about how the pluralisation and translation work together?

I needed to use this in field.tpl and also wanted to have an option for zero comments. With the help of some #drupal-support IRC buds, this works for me (the link is to an anchor tag down by the comments section of the page):

<?php
if ($element['#object']->comment_count == 0) {
   
$output = t('Add a comment'); }
    else {
   
$output = format_plural($element['#object']->comment_count, '1 Comment', '@count Comments');
     }
     print
'<a href="#comments">' . $output . '</a>';
?>

my working code... in .tpl with the right translation for "Add new comment" and a other way to create link to comment div anchors. Hope that can help someone.

<?php
if ($node->comment_count == 0) {
   
$comment_text_link = t('Add new comment'); }
else {
   
$comment_text_link = format_plural($node->comment_count, '1 ' . t('comment'), '@count ' . t('comments'));
}
print
l($comment_text_link, $_GET['q'], array('fragment' => 'comments'));
?>

This is wrong. You want:

<?php
$comment_text_link
= format_plural($node->comment_count, '1 comment', '@count comments');
?>

format_plural() takes care of both the pluralization and the translation.

Here is just some sample code that I figured out. Hopefully it will benefit someone someday.

<?php
print format_plural(count($content['field_price']['#items']), 'Price', 'Prices');
?>

This prints Price or Prices based on the number of items in a Field Collection. I had to include the PHP Count function because Drupal's format_plural wouldn't work without it.

the singular and plural arguments seem to only accept plain text - no HTML. In some cases it would be handy to have output like this:

5 comments

.. but the function won't accept HTML.