.. _f (double underscore):

##################################################
``__ (double underscore)`` — Translate a string.
##################################################

:doc:`Locale-related functions </Reference/packages/Function/Locale/index>`

*******
Summary
*******

.. include:: /Reference/libraries/globals/summary/__.rst

.. php:function:: __($msgid)

    Translate a string.
    
    :type $msgid: string|array
    :param $msgid: The string to be translated, or Array for plural translations.
    :returns: string The translated string.

*****
Usage
*****

.. include:: /Reference/libraries/globals/usage/__.rst

********
Examples
********

.. include:: /Reference/libraries/globals/examples/__.rst

********
See Also
********

.. include:: /Reference/libraries/globals/see_also/__.rst