Documentation

do_search()

Takes a search string $search, as provided by the user, and returns a results set of matching resources. If there are no matches, instead returns an array of suggested searches

Parameters

$search : string

Search string

$restypes : string = ''

Optionally used to specify which resource types to search for

$order_by : string = 'relevance'

$archive : string = '0'

Allows searching in more than one archive state

$fetchrows : int|array<string|int, mixed> = -1

• If passing an integer, retrieve the specified number of rows (a limit with no offset). The returned array of resources will be padded with '0' elements up to the total without the limit.
• If passing an array, the first element must be the offset (int) and the second the limit (int) (the number of rows to return). See setup_search_chunks() for more detail. IMPORTANT: When passing an array, the returned array will be in structured form - as returned by sql_limit_with_total_count() i.e. the array will have 'total' (the count) and 'data' (the resources) named array elements, and the data will not be padded.

$sort : string = 'desc'

$access_override : bool = false

Used by smart collections, so that all all applicable resources can be judged regardless of the final access-based results

$starsearch : int = DEPRECATED_STARSEARCH

DEPRECATED_STARSEARCH passed in for backwards compatibility

$ignore_filters : bool = false

$return_disk_usage : bool = false

$recent_search_daylimit : string = ''

$go : string|bool = false

Paging direction (prev|next)

$stats_logging : bool = true

Log keyword usage

$return_refs_only : bool = false

$editable_only : bool = false

$returnsql : bool = false

Returns the query as a PreparedStatementQuery instance

$access : int = null

Search for resources with this access

$smartsearch : mixed = false

Tags

uses

debug()

hook()

ps_value()

ps_query()

split_keywords()

add_verbatim_keywords()

search_filter()

search_special()

resolve_given_nodes()

Parameters

$search : mixed

$node_bucket : mixed

$node_bucket_not : mixed