Function __global->build_comcode_menu

Definitions

sources/menus_comcode.php

  • Takes some Comcode, and return an HTML menu created from it.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$comcode LONG_TEXT No No required parameter N/A N/A The contents of the Comcode menu tag
$menu SHORT_TEXT No No required parameter N/A N/A An identifier for this menu (will be used as a unique ID by menu javascript code)
$source_member MEMBER No No required parameter N/A N/A The member the menu is being built as
$type ID_TEXT No No required parameter N/A N/A The menu type (determines what templates get used)

Returns

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

Preview

Code (PHP)

/**
 * Takes some Comcode, and return an HTML menu created from it.
 *
 * @param  LONG_TEXT $comcode The contents of the Comcode menu tag
 * @param  SHORT_TEXT $menu An identifier for this menu (will be used as a unique ID by menu javascript code)
 * @param  MEMBER $source_member The member the menu is being built as
 * @param  ID_TEXT $type The menu type (determines what templates get used)
 * @return Tempcode The generated Tempcode of the menu
 */
function build_comcode_menu(string $comcode, string $menu, int $source_member, string $type) : object