InputfieldTextTags::tagsArray() method

Static utility function to convert a tags string to an array of [ 'tag' => 'label' ]

There isn’t currently a dedicated FieldtypeTextTags module, so if you want to convert a string of tags (as would be returned from a $page “text” field value) you can use this static helper method to convert the string of tags to an array of labels indexed by tag.

Note: returned tags and labels are entity-encoded when current $page API var output formatting is ON.

Example

$field = $fields->get('tags'); // tags field using FieldtypeText
$tags = $page->get('tags'); // page value (string of tags, i.e. "foo bar baz")
$labels = InputfieldTextTags::tagsArray($field, $tags);
foreach($labels as $tag => $label) {
  echo "<li>$tag: $label</li>";
}

Usage

// basic usage
$array = InputfieldTextTags::tagsArray(Field $field);

// usage with all arguments
$array = InputfieldTextTags::tagsArray(Field $field, $tags = null);

Arguments

NameType(s)Description
fieldField
tags (optional)string, array, null

Return value

array


InputfieldTextTags methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #551
    In the 551st issue of ProcessWire Weekly we'll check out what's new in the core this week, share a new weekly poll, and more. Read on!
    Weekly.pw / 1 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK