ProcessTemplate::search()

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.251