$page→of()

Get or set the current output formatting state of the page

  • Always returns the current output formatting state: true if ON, or false if OFF.

  • To set the current output formatting state, provide a boolean true to turn it ON, or boolean false to turn it OFF.

  • Pages used for front-end output should have output formatting turned ON.

  • Pages that you are manipulating and saving should have output formatting turned OFF.

See this post about output formatting.

Example

// Set output formatting state off, for page manipulation
$page->of(false);
$page->title = 'About Us';
$page->save();

Usage

// basic usage
$bool = $page->of();

// usage with all arguments
$bool = $page->of(bool $outputFormatting = null);

Arguments

NameType(s)Description
$outputFormatting (optional)bool

If specified, sets output formatting state ON or OFF. If not specified, nothing is changed.

Return value

bool

Current output formatting state (before this function call, if it was changed)

$page methods and properties

API reference based on ProcessWire core version 3.0.251