InputfieldPageAutocomplete class

Multiple Page selection using auto completion and sorting capability. Intended for use as an input field for Page reference fields.

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.

Show class?             Show args?        

Common

NameReturnSummary 
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::getConfigInputfields()
InputfieldWrapperProvide configuration options for modifying the behavior when paired with InputfieldPage
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 for results 
InputfieldPageAutocomplete::maxSelectedItems int Maximum number of items that may be selected (0=unlimited, default). 
InputfieldPageAutocomplete::operator string Selector operator to use in performing the search (default: %=) 
InputfieldPageAutocomplete::parent_id int Limit results to this parent, or if combined with findPagesSelector, the search is performed as $pages->get($parent_id)->find() rather than $pages->find(). 
InputfieldPageAutocomplete::processInput(WireInputData $input)
$thisConvert the CSV string provided in the $input to an array of ints needed for this fieldtype
InputfieldPageAutocomplete::render()
stringRender the autocompletion widget
InputfieldPageAutocomplete::renderList()
string
InputfieldPageAutocomplete::renderListItem($label, $value)
string
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. 
InputfieldPageAutocomplete::template_ids array Limit results to pages using this templates (alternate to the single template_id).  
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.200

Twitter updates

  • Weekly update: Smooth rollout for ProcessWire 3.0.200 main/master, plus getting started on a new WP-to-PW site conversion and why they can be so rewarding— More
    20 May 2022
  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022

Latest news

  • ProcessWire Weekly #419
    In issue 419 of ProcessWire Weekly we'll check out this week's core updates, introduce a brand new recipe of the week, and more. Read on!
    Weekly.pw / 21 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH