InputfieldPageAutocomplete class

This Inputfield connects the jQuery UI Autocomplete widget with the ProcessWire ProcessPageSearch AJAX API.

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

Common
Properties

Common

Name	Return	Summary
InputfieldPageAutocomplete::getConfigInputfields() InputfieldPageAutocomplete::getConfigInputfields() InputfieldPageAutocomplete::getConfigInputfields()	None	Provide configuration options for modifying the behavior when paired with InputfieldPage
InputfieldPageAutocomplete::processInput() InputfieldPageAutocomplete::processInput(WireInputData $input) InputfieldPageAutocomplete::processInput(WireInputData $input)	`$this`	Convert the CSV string provided in the $input to an array of ints needed for this fieldtype
InputfieldPageAutocomplete::render() InputfieldPageAutocomplete::render() InputfieldPageAutocomplete::render()	None	Render the autocompletion widget

Properties

Name	Return	Summary
InputfieldPageAutocomplete::allowAnyValue	`bool`	Allow any value to stay in the input, even if not selectable? DEFAULT: false
InputfieldPageAutocomplete::disableChars	`string`	Autocomplete won't be triggered if input contains any of the characters in this string. DEFAULT: blank
InputfieldPageAutocomplete::findPagesSelector	`string`	Optional selector to use for finding pages DEFAULT: blank
InputfieldPageAutocomplete::labelFieldFormat	`string`	Format string to display in the results, overrides labelFieldName when used . DEFAULT: blank
InputfieldPageAutocomplete::labelFieldName	`string`	Field to display in the results. DEFAULT: title
InputfieldPageAutocomplete::lang_id	`int`	Force use of this language ID for results DEFAULT: 0
InputfieldPageAutocomplete::maxSelectedItems	`int`	Maximum number of items that may be selected (0=unlimited) . DEFAULT: 0
InputfieldPageAutocomplete::operator	`string`	Selector operator to use in performing the search DEFAULT: %=
InputfieldPageAutocomplete::parent_id	`int`	Limit results to this parent ID, or if combined with findPagesSelector, the search is performed as $pages->get($parent_id)->find() rather than $pages->find(). DEFAULT: 0
InputfieldPageAutocomplete::searchFields	`string`	Field(s) to search for text. Separate multiple by a space. DEFAULT: title
InputfieldPageAutocomplete::template_id	`int`	Limit results to pages using this template ID. DEFAULT: 0
InputfieldPageAutocomplete::template_ids	`array`	Limit results to pages using these template IDs (alternate to the single template_id). DEFAULT: []
InputfieldPageAutocomplete::useAndWords	`bool`	When true, each word will be isolated to a separate searchFields=searchValue, which enables it to duplicate ~= operator behavior while using a %= operator . DEFAULT: false
InputfieldPageAutocomplete::useList	`bool`	Whether or not to use a separate selected list. If false specified, selected item will be populated directly to the input. DEFAULT: true

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.252