ProcessPageType::search() method

Search for items containing $text and return an array representation of them

Implementation for SearchableModule interface

Usage

// basic usage
$array = $processPageType->search(string $text);

// usage with all arguments
$array = $processPageType->search(string $text, array $options = []);

Arguments

NameType(s)Description
textstring

Text to search for

options (optional)array

Options to modify behavior:

  • edit (bool): True if any 'url' returned should be to edit items rather than view them
  • multilang (bool): If true, search all languages rather than just current (default=true).
  • start (int): Start index (0-based), if pagination active (default=0).
  • limit (int): Limit to this many items, if pagination active (default=0, disabled).

Return value

array


ProcessPageType methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #557
    In the 557th issue of ProcessWire Weekly we're going to share the latest core development news, introduce a new third party module, and more. Read on!
    Weekly.pw / 12 January 2025
  • 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

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK