You are here

function hook_finder_find_options_alter in Finder 6

Alter the choices or results returned by finder_find().

Parameters

&$options: The array of choices or results.

$finder: The finder object.

$finder_element_id: If $mode is 'choices', this is the finder element id to get choices for.

&$keywords: An array keyed by finder_element_id, where the values are any str/num/bool/null or an array of such values to be OR'd together.

$mode: 'choices' or 'results' depending on what we are fetching.

$match: The match method, see finder_match_operator().

$pager: Used to limit choices or results per page.

1 invocation of hook_finder_find_options_alter()
finder_find in ./finder.module
Get a list of choices for form or results.

File

./finder.api.php, line 288
Documents finder's hooks for api reference.

Code

function hook_finder_find_options_alter(&$options, $finder, $finder_element_id, $keywords, $mode, $match, $pager) {

  // no example code
}