$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 #543
    In the 543rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a couple of new third party modules — both authored by Bernhard Baumrock — and more. Read on!
    Weekly.pw / 5 October 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

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH