Pagefile::hasTag() method

Does this file have the given tag(s)?

Example

$file = $page->files->first();

if($file->hasTag('foobar')) {
  // file has the "foobar" tag
}

if($file->hasTag("foo|baz")) {
  // file has either the foo OR baz tag
}

if($file->hasTag("foo,baz")) {
 // file has both the foo AND baz tags (since 3.0.17)
}

Usage

$bool = $pagefile->hasTag(string $tag);

Arguments

NameType(s)Description
tagstring

Specify one of the following:

  • Single tag without whitespace.
  • Multiple tags separated by a "|" to determine if Pagefile has at least one of the tags.
  • Multiple tags separated by a comma to determine if Pagefile has all of the tags. (since 3.0.17)

Return value

bool string

True if it has the given tag(s), false if not.

  • If multiple tags were specified separated by a "|", then if at least one was present, this method returns the found tag.
  • If multiple tags were specified separated by a space or comma, and all tags are present, it returns true. (since 3.0.17)

Changelog

  • 3.0.17 Added support for AND mode, where multiple tags can be specified and all must be present to return true.
  • 3.0.17 OR mode now returns found tag rather than boolean true.

See Also


Pagefile methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #523
    In the 523rd issue of ProcessWire Weekly we'll check out what's new in the core this week, share some new module related news, and more. Read on!
    Weekly.pw / 18 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer