function hook_finder_find in Finder 6
Same name and namespace in other branches
- 7.2 finder.api.php \hook_finder_find()
Fetch an array of choices or results.
This function will be called in the base handler module, it must return an array of results. See finder_node_finder_find() and finder_views_finder_find() for two different approaches to this function. The former uses Finder's internal query engine as well as a helper function it shares with Finder User, the latter loads a View and makes some programmatic changes to fetch the results.
Parameters
$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.
Return value
An array of choices/results.
See also
finder_node_finder_views()
3 functions implement hook_finder_find()
Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.
- finder_node_finder_find in modules/
finder_node/ finder_node.module - Implementation of hook_finder_find().
- finder_user_finder_find in modules/
finder_user/ finder_user.module - Implementation of hook_finder_find().
- finder_views_finder_find in modules/
finder_views/ finder_views.module - Implementation of hook_finder_find().
1 invocation of hook_finder_find()
- finder_find in ./
finder.module - Get a list of choices for form or results.
File
- ./
finder.api.php, line 144 - Documents finder's hooks for api reference.
Code
function hook_finder_find($finder, $finder_element_id, $keywords, $mode, $match, $pager) {
// no example code
}