WireTextTools::populatePlaceholders() method

Given a string ($str) and values ($vars), populate placeholder “{tags}” in the string with the values

  • The $vars should be an associative array of [ 'tag' => 'value' ].
  • The $vars may also be an object, in which case values will be pulled as properties of the object.

By default, tags are specified in the format: {first_name} where first_name is the name of the variable to pull from $vars, { is the opening tag character, and } is the closing tag char.

The tag parser can also handle subfields and OR tags, if $vars is an object that supports that. For instance {products.title} is a subfield, and {first_name|title|name} is an OR tag.

Available since version 3.0.126. Use wirePopulateStringTags() function for older versions

Example

$vars = [ 'foo' => 'FOO!', 'bar' => 'BAR!' ];
$str = 'This is a test: {foo}, and this is another test: {bar}';
echo $sanitizer->getTextTools()->populatePlaceholders($str, $vars);
// outputs: This is a test: FOO!, and this is another test: BAR!

Usage

// basic usage
$string = $wireTextTools->populatePlaceholders(string $str, $vars);

// usage with all arguments
$string = $wireTextTools->populatePlaceholders(string $str, $vars, array $options = []);

Arguments

NameType(s)Description
strstring

The string to operate on (where the {tags} might be found)

varsWireData, object, array

Object or associative array to pull replacement values from.

options (optional)array

Array of optional changes to default behavior, including:

  • tagOpen (string): The required opening tag character(s), default is '{'
  • tagClose (string): The optional closing tag character(s), default is '}'
  • recursive (bool): If replacement value contains tags, populate those too? (default=false)
  • removeNullTags (bool): If a tag resolves to a NULL, remove it? If false, tag will remain. (default=true)
  • entityEncode (bool): Entity encode the values pulled from $vars? (default=false)
  • entityDecode (bool): Entity decode the values pulled from $vars? (default=false)
  • allowMarkup (bool): Allow markup to appear in populated variables? (default=true)

Return value

string

String with tags populated.


WireTextTools methods and properties

API reference based on ProcessWire core version 3.0.234

Latest news

  • ProcessWire Weekly #511
    In the 511th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new third party module called Auto AVIF, and more. Read on!
    Weekly.pw / 25 February 2024
  • Using date range fields in ProcessWire
    This week we'll take a detailed look at the newest addition to the ProFields set of modules: the Date Range Fieldtype and Inputfield.
    Blog / 24 November 2023
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer