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 #519
    In the 519th issue of ProcessWire Weekly we'll check out a new third party module called RockForms, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 20 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

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