ProcessPageSearch class

Provides page searching within the ProcessWire admin

For more details about how Process modules work, please see: wire/core/Process.php

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProcessPageSearch class also inherits all the methods and properties of: Process, WireData and Wire.

Common

Name	Return	Summary
ProcessPageSearch::execute() ProcessPageSearch::execute() ProcessPageSearch::execute()	None	Perform an interactive search and provide a search form (default)
ProcessPageSearch::executeEditBookmark() ProcessPageSearch::executeEditBookmark() ProcessPageSearch::executeEditBookmark()	None
ProcessPageSearch::executeFor() ProcessPageSearch::executeFor() ProcessPageSearch::executeFor()	None	Perform a non-interactive search (based on URL GET vars)
ProcessPageSearch::executeLive() ProcessPageSearch::executeLive() ProcessPageSearch::executeLive()	`string`	Execute live search
ProcessPageSearch::executeReset() ProcessPageSearch::executeReset() ProcessPageSearch::executeReset()	None
ProcessPageSearch::getOperators() ProcessPageSearch::getOperators() ProcessPageSearch::getOperators()	`array`	Get operators used for searches, where key is operator and value is description
ProcessPageSearch::getRepeatersPageID() ProcessPageSearch::getRepeatersPageID() ProcessPageSearch::getRepeatersPageID()	`int`	Get ID of the repeaters root page ID or 0 if not installed
ProcessPageSearch::renderSearchForm() ProcessPageSearch::renderSearchForm() ProcessPageSearch::renderSearchForm(string $placeholder = '')	`string`	Render search for that submits to this process
ProcessPageSearch::set() ProcessPageSearch::set($key, $value) ProcessPageSearch::set($key, $value)	None
ProcessPageSearch::setDisplayFormat() ProcessPageSearch::setDisplayFormat(string $name, string $format) ProcessPageSearch::setDisplayFormat(string $name, string $format, bool $textOnly = false)	None	Set a display format
ProcessPageSearch::setForSelector() ProcessPageSearch::setForSelector(string $name, string $selector) ProcessPageSearch::setForSelector(string $name, string $selector, array $data = [])	`string`	Set a selector to use when $_GET['for_selector_name'] matches given $name

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
ProcessPageSearch::findReady() ProcessPageSearch::findReady(string $selector) ProcessPageSearch::findReady(string $selector)	`string`	Hookable function to optionally modify selector before it is sent to $pages->find()

Properties

Name	Return	Summary
ProcessPageSearch::adminSearchMode	`bool` `int`	Deprecated/no longer in use?
ProcessPageSearch::displayField	`string`
ProcessPageSearch::noSearchTypes	`array`
ProcessPageSearch::operator	`string`	Single-word/partial match operator
ProcessPageSearch::operator2	`string`	Multi-word operator
ProcessPageSearch::searchFields	`string`
ProcessPageSearch::searchFields2	`string`
ProcessPageSearch::searchTypesOrder	`array`

Additional methods and properties

In addition to the methods and properties above, ProcessPageSearch also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.253