$page->getText() method

Same as getMarkup() except returned value is plain text

If no $entities argument is provided, returned value is entity encoded when output formatting is on, and not entity encoded when output formatting is off.

Usage

// basic usage
$string = $page->getText(string $key);

// usage with all arguments
$string = $page->getText(string $key, bool $oneLine = false, $entities = null);

Arguments

NameType(s)Description
keystring

Field name or string with field {name} tags in it.

oneLine (optional)bool

Specify true if returned value must be on single line.

entities (optional)bool, null

True to entity encode, false to not. Null for auto, which follows page's outputFormatting state.

Return value

string

See Also


$page methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 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

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull