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

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 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

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer