PHP Conference Nagoya 2025

    MessageFormatter::formatMessage

    msgfmt_format_message

    (PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)

    MessageFormatter::formatMessage -- msgfmt_format_message — Quick format message

    Description

    Object-oriented style

    public static MessageFormatter::formatMessage(string $locale, string $pattern, array $values): string|false

    Procedural style

    msgfmt_format_message(string $locale, string $pattern, array $values): string|false

    Quick formatting function that formats the string without having to explicitly create the formatter object. Use this function when the format operation is done only once and does not need any parameters or state to be kept or when wanting to customize the output by providing additional context to ICU directly.

    Parameters

    locale

    The locale to use for formatting locale-dependent parts

    pattern

    The pattern string to insert things into. The pattern uses an 'apostrophe-friendly' syntax; see » Quoting/Escaping for details.

    values

    The array of values to insert into the format string

    Return Values

    The formatted pattern string or false if an error occurred

    Examples

    Example #1 msgfmt_format_message() example

    <?php
    echo msgfmt_format_message("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree\n", array(4560, 123, 4560/123));
    echo     msgfmt_format_message("de", "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum\n", array(4560, 123, 4560/123));
    echo     msgfmt_format_message("en", 'You finished {place, selectordinal, one {#st} two {#nd} few {#rd} other {#th}}!', ['place' => 3]), "\n";
    echo     msgfmt_format_message("en",
    "There {apple, plural,
    =0 {are no apples}
    =1 {is one apple...}
    other {are # apples!}
    }"    ,
    [    'apple' => 0]
    ),     "\n";

    Example #2 OO example

    <?php
    echo MessageFormatter::formatMessage("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree\n", array(4560, 123, 4560/123));
    echo     MessageFormatter::formatMessage("de", "{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum\n", array(4560, 123, 4560/123));
    echo     MessageFormatter::formatMessage("en", 'You finished {place, selectordinal, one {#st} two {#nd} few {#rd} other {#th}}!', ['place' => 3]), "\n";
    echo     MessageFormatter::formatMessage("en",
    "There {apple, plural,
    =0 {are no apples}
    =1 {is one apple...}
    other {are # apples!}
    }"    ,
    [    'apple' => 0]
    ),     "\n";

    The above example will output:

    4,560 monkeys on 123 trees make 37.073 monkeys per tree
4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum
You finished 3rd!
There are no apples

    Example #3 Instructing ICU to format currency with common and with narrow currency symbol

    Requires ICU ≥ 67.

    <?php
    echo msgfmt_format_message("cs_CZ", "{0, number, :: currency/CAD}", array(123.45));
    echo     msgfmt_format_message("cs_CZ", "{0, number, :: currency/CAD unit-width-narrow}", array(123.45));

    The above example will output:

    123,45 CA$
123,45 $

    See Also

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 3 notes

    up
    7
    zlobnygrif at gmail dot com
    11 years ago
    <?php
    var_dump    (
    msgfmt_format_message('ru_RU', 'The value of {somekey} is {0, choice, 0 #less 12| 12 #between 12 and 32| 32 #more than 32}', ['SomeAnotherKey' => -1]),
    msgfmt_format_message('ru_RU', 'The value of {somekey} is {0, choice, 0 #less 12| 12 #between 12 and 32| 32 #more than 32}', [14]),
    msgfmt_format_message('ru_RU', 'The value of {somekey} is {0, choice, 0 #less 12| 12 #between 12 and 32| 32 #more than 32}', [133]),
    msgfmt_format_message('ru_RU', '{0, plural, =0{Zero}=1{One}other{Unknown #}}', [0]),
    msgfmt_format_message('ru_RU', '{0, plural, =0{Zero}=1{One}other{Unknown #}}', [1]),
    msgfmt_format_message('ru_RU', '{0, plural, =0{Zero}=1{One}other{Unknown #}}', [2]),
    msgfmt_format_message('ru_RU', '{0, select, somevalue{This is some value} other{Unknown value}}', ['somevalue']),
    msgfmt_format_message('ru_RU', '{0, select, somevalue{This is some value} other{Unknown value "{0}"}}', ['somevalue2'])
    );

    var_dump(
    msgfmt_format_message('en_GB', 'Peter has {0, plural, =0{no cat} =1{a cat} other{# cats}}', [0]),
    msgfmt_format_message('en_GB', 'Peter has {0, plural, =0{no cat} =1{a cat} other{# cats}}', [1]),
    msgfmt_format_message('en_GB', 'Peter has {0, plural, =0{no cat} =1{a cat} other{# cats}}', [2])
    );
    ?>

    Output (PHP 5.4.17RC1)
    ==========================
    string 'The value of -1 is less 12' (length=26)
    string 'The value of 14 is between 12 and 32' (length=36)
    string 'The value of 133 is more than 32' (length=32)
    string 'Zero' (length=4)
    string 'One' (length=3)
    string 'Unknown 2' (length=9)
    string 'This is some value' (length=18)
    string 'Unknown value "somevalue2"' (length=26)
    string 'Peter has no cat' (length=16)
    string 'Peter has a cat' (length=15)
    string 'Peter has 2 cats' (length=16)
    up
    1
    ricardoyubal at gmail dot com
    3 years ago
    Although not mentioned, single quotes (') are used internally as escaping characters. So if you want to have them in your output, you should escape them with another single quote. See examples below.

    <?php

    // The value {foo} should be enclosed in single quotes
    echo msgfmt_format_message('en_US', "The value '{foo}' should be enclosed in single quotes", ['foo' => 'bar']);

    // The value 'bar' should be enclosed in single quotes
    echo msgfmt_format_message('en_US', "The value ''{foo}'' should be enclosed in single quotes", ['foo' => 'bar']);

    ?>
    up
    0
    contact at sowapps dot com
    3 years ago
    For now, there is now way to define a default value.

    <?php
    echo msgfmt_format_message('fr_FR', '{distance, plural, =0{Here}other{# km}}', []);
    // Show {distance}
    ?>
    ＋add a note
    To Top