$pages->findRaw() method

Find pages and return raw data from them in a PHP array

Note that the data returned from this method is raw and unformatted, directly as it exists in the database. In most cases you should use $pages->find() instead, but this method provides a convenient alternative for some cases.

The $selector argument can be any page-finding selector that you would provide to a regular $pages->find() call. The most interesting stuff relates to the $field argument though, which is what the rest of this section looks at:

If you omit the $field argument, it will return all data for the found pages in an array where the keys are the page IDs and the values are associative arrays containing all of each page raw field and property values indexed by name… $a = $pages->findRaw("template=blog"); …but findRaw() is more useful for cases where you want to retrieve specific things without having to load the entire page (or its data). Below are a few examples of how you can do this.

Available since version 3.0.172.

Example

// If you provide a string (field name) for `$field`, then it will return an 
// array with the values of the `data` column of that field. The `$field` can
// also be the name of a native pages table property like `id` or `name`.
$a = $pages->findRaw("template=blog", "title");

// The above would return an array of blog page titles indexed by page ID. If
// you provide an array for `$field` then it will return an array for each page,
// where each of those arrays is indexed by the field names you requested.
$a = $pages->findRaw("template=blog", [ "title", "date" ]);

// You may specify field name(s) like `field.subfield` to retrieve a specific
// column/subfield. When it comes to Page references or Repeaters, the subfield
// can also be the name of a field that exists on the Page reference or repeater.
$a = $pages->findRaw("template=blog", [ "title", "categories.title" ]);

// You can also use this format below to get multiple subfields from one field:
$a = $pages->findRaw("template=blog", [ "title", "categories" => [ "id", "title" ] ]);

// You can optionally rename fields in the returned value like this below, which
// asks the 'title' field to have the name 'headline' in return value (3.0.176+):
$a = $pages->findRaw("template=blog", [ "title" => "headline" ]);

// You may specify wildcard field name(s) like `field.*` to return all columns
// for `field`. This retrieves all columns from the field’s table. This is
// especially useful with fields like Table or Combo that might have several
// different columns:
$a = $pages->findRaw("template=villa", "rates_table.*" );

// If you prefer, you can specify the field name(s) in the selector (3.0.173+):
$a = $pages->findRaw("template=blog, field=title");
$a = $pages->findRaw("template=blog, field=title|categories.title");

// Specify “objects=1” in selector to use objects rather than associative arrays
// for pages and fields (3.0.174+):
$a = $pages->findRaw("template=blog, field=title|categories.title, objects=1");

// Specify “entities=1” to entity encode all string values:
$a = $pages->findRaw("template=blog, field=title|summary, entities=1");

// Specify “entities=field” or “entities=field1|field2” to entity encode just
// the specific fields that you name (3.0.174+):
$a = $pages->findRaw("template=blog, entities=title|summary");

// If you prefer, options can also be enabled this way (3.0.174+):
$a = $pages->findRaw("template=blog, options=objects|entities"); 

Usage

// basic usage
$array = $pages->findRaw($selector);

// usage with all arguments
$array = $pages->findRaw($selector, $field = '', array $options = []);

Arguments

NameType(s)Description
selectorstring, array, Selectors, int

Page matching selector or page ID

field (optional)string, array, Field

Name of field/property to get, or array of them, or omit to get all (default='') Note: this argument may also be specified in the $selector argument as "field=foo" or "field=foo|bar|baz" (3.0.173+).

options (optional)array

Options to adjust behavior (may also be specified in selector, i.e. “objects=1, entities=foo|bar”)

  • objects (bool): Use objects rather than associative arrays? (default=false) 3.0.174+
  • entities (bool|array): Entity encode string values? True or 1 to enable, or specify array of field names. (default=false) 3.0.174+

Return value

array


$pages methods and properties

API reference based on ProcessWire core version 3.0.185

Twitter updates

  • ProcessWire 3.0.187: This week we have some very useful new additions to both the core Repeater Fieldtype and the ProFields Repeater Matrix Fieldtype. This post covers all the details along with a couple of brief demonstration videos— More
    22 October 2021
  • 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

Latest news

  • ProcessWire Weekly #389
    The 389th issue of ProcessWire Weekly we'll check out the latest core updates, introduce the Session Viewer module, and more. Read on!
    Weekly.pw / 23 October 2021
  • New Repeater and Repeater Matrix features
    This week we have some very useful new additions to both the core Repeater Fieldtype and the ProFields Repeater Matrix Fieldtype. This post covers all the details along with a couple of brief demonstration videos. 
    Blog / 22 October 2021
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer