InputfieldTextTags class

Enables input of user entered tags or selection of predefined tags.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the InputfieldTextTags class also inherits all the methods and properties of: Inputfield, WireData and Wire.

Common

Name	Return	Summary
InputfieldTextTags::addOptions() InputfieldTextTags::addOptions(array $options) InputfieldTextTags::addOptions(array $options)	`self`	Add multiple selectable options
InputfieldTextTags::allowUserTags	`int` `bool`	Allow user-entered tags?
InputfieldTextTags::arrayValue	`array`
InputfieldTextTags::closeAfterSelect	`int` `bool`	Close select dropdown box after user makes selection?
InputfieldTextTags::delimiter	`string`	One of 's' (for space ' '), 'p' (for pipe '\|') or 'c' (for comma).
InputfieldTextTags::getAttributes() InputfieldTextTags::getAttributes() InputfieldTextTags::getAttributes()	`array`	Get all attributes in an associative array
InputfieldTextTags::maxItems	`int`	Max selectable items, 0 for no limit, 1 for single-select mode, or 2+ to limit selection to that number.
InputfieldTextTags::maxSelectedItems	`int`	Alias of maxItems (as used by InputfieldPage)
InputfieldTextTags::pageSelector	`string` `null`
InputfieldTextTags::placeholder	`string`	Placeholder string to show when no options selected.
InputfieldTextTags::setPageSelector() InputfieldTextTags::setPageSelector(string $selector) InputfieldTextTags::setPageSelector(string $selector)	`bool`	Set page selector
InputfieldTextTags::tagsList	`array` `string`	Array of tags [ 'tag' => 'label' ], or newline separated string of "tag=label", or use addTag() to populate.
InputfieldTextTags::tagsUrl	`string`	Remote URL to find tags from, must have a '{q}' in it somewhere, which will be replaced with the query.
InputfieldTextTags::useAjax	`bool` `int`
InputfieldTextTags::value	`string`

Settings

Name	Return	Summary
InputfieldTextTags::addTag() InputfieldTextTags::addTag(string $tag) InputfieldTextTags::addTag(string $tag, string $label = '', $language = null)	`self`	Add a predefined tag
InputfieldTextTags::getTagLabel() InputfieldTextTags::getTagLabel(string $tag) InputfieldTextTags::getTagLabel(string $tag, $language = null)	`mixed`	Get label for given tag
InputfieldTextTags::getTagLabels() InputfieldTextTags::getTagLabels() InputfieldTextTags::getTagLabels($language = null)	`array`	Get labels for all tags
InputfieldTextTags::getTagsList() InputfieldTextTags::getTagsList() InputfieldTextTags::getTagsList($language = null, bool $getArray = true)	`array` `string`	Get all selectable tags and labels, optionally for specific language
InputfieldTextTags::removeTag() InputfieldTextTags::removeTag(string $tag) InputfieldTextTags::removeTag(string $tag)	`self`	Remove tag
InputfieldTextTags::setTagLabel() InputfieldTextTags::setTagLabel(string $tag, string $label) InputfieldTextTags::setTagLabel(string $tag, string $label, $language = null)	`self`	Set label for tag
InputfieldTextTags::setTagsList() InputfieldTextTags::setTagsList($tags) InputfieldTextTags::setTagsList($tags, $language = null)	`self`	Set all selectable tags and labels, optionally for specific language

Helpers

Name	Return	Summary
InputfieldTextTags::tagsArray() InputfieldTextTags::tagsArray(Field $field) InputfieldTextTags::tagsArray(Field $field, $tags = null)	`array`	Static utility function to convert a tags string to an array of [ 'tag' => 'label' ]

Additional methods and properties

In addition to the methods and properties above, InputfieldTextTags also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.244

Enables input of user entered tags or selection of predefined tags.

Common

Settings

Helpers

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news