$pages->findJoin() method

Find pages and specify which fields to join (overriding configured autojoin settings)

This is a useful optimization when you know exactly which fields you will be using from the returned pages and you want to have their values joined into the page loading query to reduce overhead. Note that this overrides the configured autojoin settings in ProcessWire fields.

If a particular page in the returned set of pages was already loaded before this method call, then the one already in memory will be used rather than this method loading another copy of it.

Available since version 3.0.172.

Example

// 1. Example of loading blog posts where we want to join title, date, summary:
$posts = $pages->findJoin("template=blog-post", [ 'title', 'date', 'summary' ]);

// 2. You can also specify the join fields as a CSV string:
$posts = $pages->findJoin("template=blog-post", 'title, date, summary');

// 3. You can also use the join functionality on a regular $pages->find() by specifying
// property 'join' or 'field' in the selector. The words 'join' and 'field' are aliases
// of each other here, just in case you have an existing field with one of those names.
// Otherwise, use whichever makes more sense to you. The following examples demonstrate
// this and all do exactly the same thing as examples 1 and 2 above:
$posts = $pages->find("template=blog-post, join=title|date|summary");
$posts = $pages->find("template=blog-post, field=title|date|summary");
$posts = $pages->find("template=blog-post, join=title, join=date, join=summary");
$posts = $pages->find("template=blog-post, field=title, field=date, field=summary");

// 4. Let’s say you want to load pages with NO autojoin fields, here is how.
// The following loads all blog-post pages and prevents ANY fields from being joined,
// even if they are configured to be autojoin in ProcessWire:
$posts = $pages->findJoin("template=blog-post", false);
$posts = $pages->find("template=blog-post, join=none"); // same as above

Usage

// basic usage
$items = $pages->findJoin($selector, $joinFields);

// usage with all arguments
$items = $pages->findJoin($selector, $joinFields, array $options = []);

Arguments

NameType(s)Description
selectorstring, array, Selectors
joinFieldsarray, string, bool

Array or CSV string of field names to autojoin, or false to join none.

options (optional)array

Return value


$pages methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • New post: Multi-language field translation export/import — In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire… More
    5 August 2022
  • Weekly update, July 29: Continuing upgrades to ProcessWire’s comments system and FormBuilder, along with a working example—More
    29 July 2022
  • Weekly update for July 22– Looking back at what web development was like in the year 2000. Plus some more discussion on the path from CKEditor 4 to CkEditor 5 in ProcessWire: More
    22 July 2022

Latest news

  • ProcessWire Weekly #430
    In the 430th issue of ProcessWire Weekly we're going to check out some brand new third party modules, a new site of the week, and more. Read on!
    Weekly.pw / 7 August 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits