Pagefile::tags() method

Get or set the "tags" property, when in use.

Example

$file = $page->files->first();
$tags = $file->tags(); // Get tags string
$tags = $file->tags(true); // Get tags array
$file->tags("foo bar baz"); // Set tags to be these 3 tags
$tags->tags(["foo", "bar", "baz"]); // Same as above, using array

Usage

// basic usage
$string = $pagefile->tags();

// usage with all arguments
$string = $pagefile->tags($value = null);

Arguments

NameType(s)Description
value (optional)bool, string, array

Specify one of the following:

  • Omit to simply return the tags as a string.
  • Boolean true if you want to return tags as an array (rather than string).
  • Boolean false to return tags as an array, with lowercase enforced.
  • String or array if you are setting the tags.

Return value

string array

Returns the current tags as a string or an array. When an array is returned, it is an associative array where the key and value are both the tag (keys are always lowercase).

See Also

Pagefile methods and properties

API reference based on ProcessWire core version 3.0.244

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.