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.

Common
Advanced

Common

Name	Return	Summary
PageValues::formatFieldValue() PageValues::formatFieldValue(Page $page, Field $field, mixed $value) PageValues::formatFieldValue(Page $page, Field $field, mixed $value)	`mixed`	Return a value consistent with the page’s output formatting state
PageValues::getBracketValue() PageValues::getBracketValue(Page $page, string $key) PageValues::getBracketValue(Page $page, string $key, mixed $value = null)	`mixed`	Get value that ends with square brackets to get iterable value, filtered value or property value
PageValues::getDotValue() PageValues::getDotValue(Page $page, string $key) PageValues::getDotValue(Page $page, string $key)	`mixed` `null`	Given a 'field.subfield' type string traverse properties and return value
PageValues::getFieldFirstValue() PageValues::getFieldFirstValue(page $page, string $multiKey) PageValues::getFieldFirstValue(page $page, string $multiKey, bool $getKey = false)	`null` `mixed`	Given a Multi Key, determine if there are multiple keys requested and return the first non-empty value
PageValues::getFieldValue() PageValues::getFieldValue($page, string $key) PageValues::getFieldValue($page, string $key, string $selector = '')	`null` `mixed`	Get the value for a non-native page field, and call upon Fieldtype to join it if not autojoined
PageValues::getMarkup() PageValues::getMarkup(Page $page, string $key) PageValues::getMarkup(Page $page, string $key)	`string`	Return the markup value for a given field name or {tag} string
PageValues::getMultiple() PageValues::getMultiple(page $page, $keys) PageValues::getMultiple(page $page, $keys, bool $assoc = false)	`array`	Get multiple Page property/field values in an array
PageValues::getText() PageValues::getText(Page $page, string $key) PageValues::getText(Page $page, string $key, bool $oneLine = false, $entities = null)	`string`	Same as getMarkup() except returned value is plain text
PageValues::removeStatus() PageValues::removeStatus(Page $page, $statusFlag) PageValues::removeStatus(Page $page, $statusFlag)	`Page`	Remove the specified status from this page
PageValues::setName() PageValues::setName($page, string $value) PageValues::setName($page, string $value, $language = null)	`Page`	Set the page name, optionally for specific language
PageValues::setStatus() PageValues::setStatus(Page $page, $value) PageValues::setStatus(Page $page, $value)	`Page`	Set the status setting, with some built-in protections

Advanced

Name	Return	Summary
PageValues::getField() PageValues::getField(Page $page, $field) PageValues::getField(Page $page, $field)	`Field` `null`	Get a Field object in context or NULL if not valid for this page
PageValues::getFields() PageValues::getFields(Page $page) PageValues::getFields(Page $page)	`FieldsArray`	Returns a FieldsArray of all Field objects in the context of this Page
PageValues::getInputfield() PageValues::getInputfield($page, string $fieldName) PageValues::getInputfield($page, string $fieldName)	`Inputfield` `InputfieldWrapper` `null`	Get a single Inputfield for the given field name
PageValues::getInputfields() PageValues::getInputfields($page) PageValues::getInputfields($page, $fieldName = '')	`null` `InputfieldWrapper`	Return all Inputfield objects necessary to edit this page
PageValues::hasField() PageValues::hasField(Page $page, $field) PageValues::hasField(Page $page, $field)	`bool` `string`	Returns whether or not given $field name, ID or object is valid for this Page

Additional methods and properties

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

Wire

API reference based on ProcessWire core version 3.0.251