Function Module_search->results
Definitions
site/pages/modules/search.php
- The actualiser of a search.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $id | ID_TEXT | required parameter | N/A | N/A | Codename for what's being searched (blank: mixed search) |
| $author | string | required parameter | N/A | N/A | Author name |
| $author_id | ?AUTO_LINK | required parameter | N/A | N/A | Author ID (null: none given) |
| $cutoff | mixed | required parameter | N/A | N/A | Cutoff date (TIME or a pair representing the range or null) |
| $sort | ID_TEXT | required parameter | N/A | N/A | Sort key |
| $direction | ID_TEXT | required parameter | N/A | N/A | Sort direction |
| $only_titles | boolean | required parameter | N/A | N/A | Whether to only search titles |
| $search_under | string | required parameter | N/A | N/A | Comma-separated list of categories to search under |
Return
- A triple: The results, pagination, the number of results
- Type: array
- Set: N/A
- Range: N/A