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 wireTranslateValues() 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.155

Twitter updates

  • This post covers a few of the bigger updates in ProcessWire 3.0.154+3.0.155. This includes new live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our input->urlSegment() method! More
    24 April 2020
  • A brief look at what's new in ProcessWire 3.0.154 in this forum post: More
    17 April 2020
  • This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks… More
    3 April 2020

Latest news

  • ProcessWire Weekly #311
    In the 311th issue of ProcessWire Weekly we're going to talk a bit about the latest dev versions of ProcessWire, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 25 April 2020
  • ProcessWire 3.0.154 and 3.0.155 core updates
    This post covers a few of the bigger updates in ProcessWire 3.0.154 and 3.0.155 on the dev branch. This includes a new function for live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our $input->urlSegment() method that I think you’ll like!
    Blog / 24 April 2020
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer