$page->setUnformatted() method

Set the unformatted value of a field, regardless of current output formatting state

Use this when setting an unformatted value to a page that has (or might have) output formatting enabled. This will save you the steps of checking the output formatting state, turning it off, setting the value, and turning it back on again (if it was on). Note that the output formatting distinction matters for some field types and not others, just depending on the case—this method is safe to use either way.

Make sure you do not use this to set an already formatted value to a Page (like some text that has been entity encoded). This method skips over some of the checks that might otherwise flag the page as corrupted.

Available since version 3.0.169.

Example

// good usage
$page->setUnformatted('title', 'This & That');

// bad usage
$page->setUnformatted('title', 'This & That'); 

Usage

$self = $page->setUnformatted(string $key, mixed $value);

Arguments

NameType(s)Description
keystring
valuemixed

Return value

self

Exceptions

Method can throw exceptions on error:

  • WireException - if given an object value that indicates it is already formatted.

See Also


$page methods and properties

API reference based on ProcessWire core version 3.0.184

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #384
    In the 384th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new module called Session Allow, and highlight a new site of the week. Read on!
    Weekly.pw / 18 September 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani