wireLangEntityEncode() function

Set entity encoding state for language translation function calls

The function affects behavior of future __(), _x() and _n() calls.

The following can be used for the $value argument:

  • true (bool): Entity encoding ON
  • false (bool): Entity encoding OFF
  • 1 (int): Entity encode only if not already
  • null (null): Entity encoding undefined

To get current entity encoding state, call this function with no arguments.

Please note this method is and thus not intended to be called directly.

Available since version 3.0.154. Versions 3.0.125 to 3.0.153 can use __(true, 'entityEncode', $value);

Internal usage

// basic internal usage
$bool = wireLangEntityEncode();

// internal usage with all arguments
$bool = wireLangEntityEncode($value = '');

Arguments

NameType(s)Description
$value (optional)bool int string null

Return value

bool int string null


Functions methods and properties

API reference based on ProcessWire core version 3.0.251