$fields->getTags() method

Get list of all tags used by fields

By default it returns an array of tag names where both keys and values are the tag names.
If you specify true for the $getFields argument, it returns an array where the keys are tag names and the values are arrays of field names in the tag.
If you specify "reset" for the $getFields argument it returns a blank array and resets internal tags cache.

Available since version 3.0.106. + made hookable in 3.0.179

Usage

// basic usage
$array = $fields->getTags();

// usage with all arguments
$array = $fields->getTags($getFieldNames = false);

Arguments

Name	Type(s)	Description
`getFieldNames` (optional)	bool, string	Specify true to return associative array where keys are tags and values are field names …or specify the string "reset" to force getTags() to reset its cache, forcing it to reload on the next call.

Return value

array

Both keys and values are tags in return value

Hooking $fields->getTags(…)

You can add your own hook events that are executed either before or after the $fields->getTags(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $fields->getTags(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Fields::getTags', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $fields = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $getFieldNames = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $getFieldNames);
});

Hooking after

The 'after' hooks are called immediately after each $fields->getTags(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Fields::getTags', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $fields = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $getFieldNames = $event->arguments(0);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$fields methods and properties

API reference based on ProcessWire core version 3.0.244