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

Twitter updates

  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021
  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021
  • ProcessWire updates for week of 21 May 2021— More
    22 May 2021

Latest news

  • ProcessWire Weekly #370
    In the 370th issue of ProcessWire Weekly we're going to check out the latest version of the commercial FormBuilder module, introduce a couple of brand new third party modules, and more. Read on!
    Weekly.pw / 12 June 2021
  • ProcessWire FormBuilder v50 updates
    Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we'll take a closer look at in this post.
    Blog / 11 June 2021
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.