PageValues class

Located in file /wire/core/PageValues.php

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

Show class?             Show args?        

Common

NameReturnSummary 
PageValues::formatFieldValue(Page $page, Field $field, mixed $value)
mixedReturn a value consistent with the page’s output formatting state 
PageValues::getBracketValue(Page $page, string $key)
mixedGet value that ends with square brackets to get iterable value, filtered value or property value 
PageValues::getDotValue(Page $page, string $key)
mixed nullGiven a 'field.subfield' type string traverse properties and return value 
PageValues::getFieldFirstValue(page $page, string $multiKey)
null mixedGiven a Multi Key, determine if there are multiple keys requested and return the first non-empty value 
PageValues::getFieldValue($page, string $key)
null mixedGet the value for a non-native page field, and call upon Fieldtype to join it if not autojoined 
PageValues::getMarkup(Page $page, string $key)
stringReturn the markup value for a given field name or {tag} string 
PageValues::getMultiple(page $page, $keys)
arrayGet multiple Page property/field values in an array 
PageValues::getText(Page $page, string $key)
stringSame as getMarkup() except returned value is plain text 
PageValues::removeStatus(Page $page, $statusFlag)
PageRemove the specified status from this page 
PageValues::setName($page, string $value)
PageSet the page name, optionally for specific language 
PageValues::setStatus(Page $page, $value)
PageSet the status setting, with some built-in protections 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 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