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.133

Twitter updates

  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019
  • New post: This week we’ll take a look at 3 different WEBP image strategies that you can use in ProcessWire 3.0.132+. Then we’ll dive into a major update for the Google Client API module, and finish up by outlining some useful new updates in FormBuilder— More
    31 May 2019
  • New post: This week we've added WEBP support in ProcessWire thanks to a GitHub pull request from Horst Nogajski. This enables you to have highly optimized image output in PW and I think you’ll really like the difference it makes— More
    24 May 2019

Latest news

  • ProcessWire Weekly #266
    In the 266th issue of ProcessWire Weekly we're going to take a closer look at ProcessWire 3.0.133 (dev), introduce a third party module called Repeater Images, and highlight a recently released site belonging to the Australian Antarctic Division. Read on!
    Weekly.pw / 15 June 2019
  • ProcessWire 3.0.133 core updates
    ProcessWire 3.0.133 adds a useful new $page->meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type. Read on for all the details, examples and screenshots.
    Blog / 14 June 2019
  • 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