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

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #456
    The 456th issue of ProcessWire Weekly covers latest core updates, introduces a new third party module called TextformatterRockDown, and more. Read on!
    Weekly.pw / 4 February 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK