wireLangReplacements() function

Set global translation replacement values

This option enables you to replace text sent to translation calls like __('text') with your own replacement text. This is similar to the wireLangTranslations() function except that it applies regardless of whether or not a translation is available for the phrase. It overrides rather than serves as a fallback.

This function works whether ProcessWire multi-language support is installed or not, so it can also be useful for selectively replacing phrases in core or modules.

Note that this applies globally to all translations that match, regardless of language. As a result, you would typically surround this in an if() statement to make sure you are in the desired state before you apply the replacements.

The function affects behavior of future __(), _x() and _n() calls, as well as their object-oriented equivalents.

This function should ideally be called from a /site/init.php file (before PW has booted) to ensure that your replacements will be available to any translation calls. However, it can be called from anywhere you’d like, so long as it is before the translation calls that you are looking to replace.

Available since version 3.0.154.

Example

// The following example replaces the labels of all the Tabs in the 
// Page editor (and anywhere else labels used):

wireLangReplacements([
  'Content' => 'Data',
  'Children' => 'Family',
  'Settings' => 'Details',
  'Delete' => 'Trash',
  'View' => 'See',
]);

// If you wanted to be sure the above replacements applied only
// to the Page editor, then you would place it in /site/ready.php
// or /site/templates/admin.php and surround with an if() statement:

if($page->process == 'ProcessPageEdit') {
  wireLangReplacements([
    'Content' => 'Data', // and so on
  ]);
}

// To make the replacement apply only for a specific _x() context, specify the
// translated value in an array with text first and context second, like the
// following example that replaces 'URL' with 'Path' when the context call
// specifed 'relative-url' as context, i.e. _x('URL', 'relative-url');

wireLangReplacements([
  'URL' => [ 'Path', 'relative-url' ],
]);

Usage

$array = wireLangReplacements(array $values);

Arguments

NameType(s)Description
valuesarray

Return value

array string


Functions methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #519
    In the 519th issue of ProcessWire Weekly we'll check out a new third party module called RockForms, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 20 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer