ProcessTemplate::search() method

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

Implementation for SearchableModule interface

Usage

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

// usage with all arguments
$array = $processTemplate->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


ProcessTemplate methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #552
    In the 552nd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, take a quick look at a new e-commerce solution for ProcessWire, and more. Read on!
    Weekly.pw / 7 December 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

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer