Get the pattern used by the formatter

- « MessageFormatter::getLocale

- MessageFormatter::parseMessage »

- PHP Manual
- MessageFormatter
- Get the pattern used by the formatter

# MessageFormatter::getPattern

# msgfmt_get_pattern

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

MessageFormatter::getPattern -- msgfmt_get_pattern — Get the pattern used by the formatter

### Description

Object-oriented style

public MessageFormatter::getPattern(): string|false

Procedural style

msgfmt_get_pattern(MessageFormatter `$formatter`): string|false

Get the pattern used by the formatter

### Parameters

`formatter`

  The message formatter

### Return Values

The pattern string for this message formatter, or `false` on failure.

### Examples

Example #1 msgfmt_get_pattern() example

    <?php$fmt = msgfmt_create( "en_US", "{0, number} monkeys on {1, number} trees" );echo "Default pattern: '" . msgfmt_get_pattern( $fmt ) . "'\n";echo "Formatting result: " . msgfmt_format( $fmt, array(123, 456) ) . "\n";msgfmt_set_pattern( $fmt, "{0, number} trees hosting {1, number} monkeys" );echo "New pattern: '" . msgfmt_get_pattern( $fmt ) . "'\n";echo "Formatted number: " . msgfmt_format( $fmt, array(123, 456) ) . "\n";?>

Example #2 OO example

    <?php$fmt = new MessageFormatter( "en_US", "{0, number} monkeys on {1, number} trees" );echo "Default pattern: '" . $fmt->getPattern() . "'\n";echo "Formatting result: " . $fmt->format(array(123, 456)) . "\n";$fmt->setPattern("{0, number} trees hosting {1, number} monkeys" );echo "New pattern: '" . $fmt->getPattern() . "'\n";echo "Formatted number: " . $fmt->format(array(123, 456)) . "\n";?>

The above example will output:

    Default pattern: '{0,number} monkeys on {1,number} trees'
    Formatting result: 123 monkeys on 456 trees
    New pattern: '{0,number} trees hosting {1,number} monkeys'
    Formatted number: 123 trees hosting 456 monkeys

### See Also

- msgfmt_create() - Constructs a new Message Formatter
- msgfmt_set_pattern() - Set the pattern used by the formatter