WireInputData::find() method

Find all input vars that match given pattern in name (or optionally value)

Available since version 3.0.163.

Example

// find all input vars having name beginning with "title_" (i.e. title_en, title_de, title_es)
$values = $input->post->find('title_*');

// find all input vars having name with "title" anywhere in it (i.e. title, subtitle, titles, title_de)
$values = $input->post->find('*title*');

// find all input vars having value with the term "wire" anywhere, regardless of case
$values = $input->post->find('/wire/i', [ 'type' => 'value' ]);

// example of result from above find operation:
$values = [
  'title' => 'ProcessWire CMS',
  'subtitle' => 'Have plenty of caffeine to make sure you are wired',
  'sidebar' => 'Learn how to rewire a flux capacitor...',
  'summary' => 'All about the $wire API variable',
];

Usage

// basic usage
$array = $wireInputData->find(string $pattern);

// usage with all arguments
$array = $wireInputData->find(string $pattern, array $options = []);

Arguments

NameType(s)Description
patternstring

Wildcard string or PCRE regular expression

options (optional)array
  • type (string): Specify "value" to match input value (rather input name), OR prefix pattern with "value=".
  • limit (int): Maximum number of items to return (default=0, no limit)
  • sanitizer (string): Name of sanitizer to run values through (default='', none)
  • arrays (bool): Also find on input varibles that are arrays? (default=false)

Return value

array

Returns associative array of values [ name => value ] if found, or empty array if none found.


WireInputData methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits