format()source public

format( string $locale , string|array $message , array $vars )

Returns a string with all passed variables interpolated into the original message. Variables are interpolated using the sprintf format.

If an array is passed in $message, it will trigger the plural selection routine. Plural forms are selected depending on the locale and the _count key passed in $vars.

Parameters

string $locale

The locale in which the message is presented.

string|array $message

The message to be translated

array $vars

The list of values to interpolate in the message

Returns

string
The formatted message