Function Hook_page_groupings_debrand->run
Definitions
sources/hooks/systems/page_groupings/debrand.php
- Run function for do_next_menu hooks. They find links to put on standard navigation menus of the system.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $member_id | ?MEMBER | No | No | Null | N/A | N/A | Member ID to run as (null: current member) |
| $extensive_docs | boolean | No | No | False | N/A | N/A | Whether to use extensive documentation tooltips, rather than short summaries |
Returns
- List of tuple of links (page grouping, icon, do-next-style linking data), label, help (optional) and/or nulls
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Run function for do_next_menu hooks. They find links to put on standard navigation menus of the system.
*
* @param ?MEMBER $member_id Member ID to run as (null: current member)
* @param boolean $extensive_docs Whether to use extensive documentation tooltips, rather than short summaries
* @return array List of tuple of links (page grouping, icon, do-next-style linking data), label, help (optional) and/or nulls
*/
public function run(?int $member_id = null, bool $extensive_docs = false) : array
* Run function for do_next_menu hooks. They find links to put on standard navigation menus of the system.
*
* @param ?MEMBER $member_id Member ID to run as (null: current member)
* @param boolean $extensive_docs Whether to use extensive documentation tooltips, rather than short summaries
* @return array List of tuple of links (page grouping, icon, do-next-style linking data), label, help (optional) and/or nulls
*/
public function run(?int $member_id = null, bool $extensive_docs = false) : array
