page() function
Returns the current Page being viewed ($page API variable as a function)
This function behaves the same as the $page
API variable, though does support optional
arguments as shortcuts for getting from the page or setting values to it.
Please note this method is and thus not intended to be called directly.
Example
$page = page(); // Simply get $page API var
// Get the “body” field
$body = page()->body; // direct syntax
$body = page()->get('body'); // regular syntax
$body = page('body'); // shortcut syntax
// Get the “headline” field or fallback to “title’
$headline = page()->get('headline|title'); // regular syntax
$headline = page('headline|title'); // shortcut syntax
// Set the “headline” field
page()->headline = 'My headline'; // direct syntax
page()->set('headline', 'My headline'); // regular syntax
page('headline', 'My headline'); // shortcut syntax
Internal usage
// basic internal usage
$page = page();
// internal usage with all arguments
$page = page(string $key = '', null $value = null);
Arguments
Name | Type(s) | Description |
---|---|---|
$key (optional) | string | Optional property to get or set |
$value (optional) | null | Optional value to set |
Return value
Page
mixed
Functions methods and properties
API reference based on ProcessWire core version 3.0.251