$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.236

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer