$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 #519
    In the 519th issue of ProcessWire Weekly we'll check out a new third party module called RockForms, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 20 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer