$page->meta() method

Get or set page’s persistent meta data

This meta data is managed in the DB. Setting a value immediately saves it in the DB, while getting a value immediately loads it from the DB. As a result, this data is independent of the usual Page load and save operations. This is primarily for internal core use, but may be useful for other specific non-core purposes as well.

Note that this meta data is completely free-form and has no connection to ProcessWire fields. Values for meta data must be basic PHP types, whether arrays, strings, numbers, etc. Please do not use objects for meta values at this time.

Available since version 3.0.133.

Example

// set and save a meta value 
$page->meta()->set('colors', [ 'red, 'green', 'blue' ]);

// get a meta value
$colors = $page->meta()->get('colors');

// alternate shorter syntax for either of the above
$page->meta('colors', [ 'red', 'green', 'blue' ]); // set
$colors = $page->meta('colors'); // get

// delete a meta value
$page->meta()->remove('colors');

// get the WireDataDB instance that stores the meta values,
// it has all the same methods as WireData objects...
$meta = $page->meta();

// ...such as, get all values in an array:
$values = $meta->getArray();

Usage

// basic usage
$wireDataDB = $page->meta();

// usage with all arguments
$wireDataDB = $page->meta($key = '', $value = null);

Arguments

NameType(s)Description
key (optional)string, bool

Omit to get the WireData instance or specify property name to get or set.

value (optional)null, mixed

Value to set for given $key or omit if getting a value.

Return value

WireDataDB string array int float


$page methods and properties

API reference based on ProcessWire core version 3.0.135

Twitter updates

  • New post: A look at two new WireMail modules for sending email, plus details on how you can configure ProcessWire to use Gmail for sending email— More
    19 July 2019
  • New post: Version 3.0.135 of ProcessWire on the dev branch focuses on some .htaccess updates, adds clarity to debug mode, and improves upon the installer— More
    5 July 2019
  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019

Latest news

  • ProcessWire Weekly #270
    This week in the 270th issue of ProcessWire Weekly we're going to cover the SearchEngine module, feature some recent support forum highlights, and introduce a brand new site of the week. Read on!
    Weekly.pw / 13 July 2019
  • Two new WireMail modules and using Gmail with PW
    A look at two new WireMail modules for sending email, plus details on how you can configure ProcessWire to use Gmail for sending email.
    Blog / 19 July 2019
  • 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