wirePopulateStringTags() function

Given a string ($str) and values ($vars), replace “{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.

Example

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

Usage

// basic usage
$string = wirePopulateStringTags(string $str, $vars);

// usage with all arguments
$string = wirePopulateStringTags(string $str, $vars, array $options = array);

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)

Return value

string

String with tags populated.


Functions methods and properties

API reference based on ProcessWire core version 3.0.130

Twitter updates

  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019
  • New post: This week we look at the latest version of ProcessWire, 3.0.127 with nearly 30 new commits resolving dozens of older issue reports and a couple useful new features— More
    1 March 2019

Latest news

  • ProcessWire Weekly #257
    In the 257th issue of ProcessWire Weekly we'll walk you through the new features in ProcessWire 3.0.130, introduce two new third party modules, and showcase the elegant new website of the QFMA. Read on!
    Weekly.pw / 13 April 2019
  • ProcessWire 3.0.130 core updates
    This week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each.
    Blog / 12 April 2019
  • 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