$page->of() method

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.

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

Latest news

  • ProcessWire Weekly #572
    The 572nd issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 26 April 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer