PageValues class

Provides implementation for several Page value get() functions.

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?       Only hookable?    

Common

NameReturnSummary 
PageValues::formatFieldValue(Page $page, Field $field, mixed $value)
mixed

Return a value consistent with the page’s output formatting state

 
PageValues::getBracketValue(Page $page, string $key)
mixed

Get value that ends with square brackets to get iterable value, filtered value or property value

 
PageValues::getDotValue(Page $page, string $key)
mixed null

Given a 'field.subfield' type string traverse properties and return value

 
PageValues::getFieldFirstValue(page $page, string $multiKey)
null mixed

Given a Multi Key, determine if there are multiple keys requested and return the first non-empty value

 
PageValues::getFieldValue($page, string $key)
null mixed

Get the value for a non-native page field, and call upon Fieldtype to join it if not autojoined

 
PageValues::getMarkup(Page $page, string $key)
string

Return the markup value for a given field name or {tag} string

 
PageValues::getMultiple(page $page, $keys)
array

Get multiple Page property/field values in an array

 
PageValues::getText(Page $page, string $key)
string

Same as getMarkup() except returned value is plain text

 
PageValues::removeStatus(Page $page, $statusFlag)
Page

Remove the specified status from this page

 
PageValues::setName($page, string $value)
Page

Set the page name, optionally for specific language

 
PageValues::setStatus(Page $page, $value)
Page

Set 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.252