Function Hook_search_comcode_pages->decide_template
Definitions
sources/hooks/modules/search/comcode_pages.php
- Decide how to show a Comcode page in the search results.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $zone | ID_TEXT | No | No | required parameter | N/A | N/A | The zone for the page |
| $page | ID_TEXT | No | No | required parameter | N/A | N/A | The page name |
| $max | integer | No | No | required parameter | N/A | N/A | Maximum results to return |
Returns
- The Tempcode showing the Comcode page
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Decide how to show a Comcode page in the search results.
*
* @param ID_TEXT $zone The zone for the page
* @param ID_TEXT $page The page name
* @param integer $max Maximum results to return
* @return Tempcode The Tempcode showing the Comcode page
*/
public function decide_template(string $zone, string $page, int $max) : object
* Decide how to show a Comcode page in the search results.
*
* @param ID_TEXT $zone The zone for the page
* @param ID_TEXT $page The page name
* @param integer $max Maximum results to return
* @return Tempcode The Tempcode showing the Comcode page
*/
public function decide_template(string $zone, string $page, int $max) : object
