Function __global->_render_menu

Definitions

sources/menus.php

  • Render a menu to Tempcode.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$menu array No No required parameter N/A N/A Menu details
$source_member ?MEMBER No No required parameter N/A N/A The member the menu is being built as (null: current member)
$type ID_TEXT No No required parameter N/A N/A The menu type (determines what templates get used)
$as_admin boolean No No False N/A N/A Whether to generate Comcode with admin privilege
$apply_highlighting boolean No No True N/A N/A Whether to apply current-screen highlighting

Returns

  • The generated Tempcode of the menu
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Render a menu to Tempcode.
 *
 * @param  array $menu Menu details
 * @param  ?MEMBER $source_member The member the menu is being built as (null: current member)
 * @param  ID_TEXT $type The menu type (determines what templates get used)
 * @param  boolean $as_admin Whether to generate Comcode with admin privilege
 * @param  boolean $apply_highlighting Whether to apply current-screen highlighting
 * @return Tempcode The generated Tempcode of the menu
 */
function _render_menu(array $menu, ?int $source_member, string $type, bool $as_admin = false, bool $apply_highlighting = true) : object