Function Hook_notification_download->create_category_tree

Definitions

sources/hooks/systems/notifications/download.php

  • Standard function to create the standardised category tree.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$notification_code ID_TEXT No No required parameter N/A N/A Notification code
$id ?ID_TEXT No No required parameter N/A N/A The ID of where we're looking under (null: N/A)

Returns

  • Tree structure
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Standard function to create the standardised category tree.
 *
 * @param  ID_TEXT $notification_code Notification code
 * @param  ?ID_TEXT $id The ID of where we're looking under (null: N/A)
 * @return array Tree structure
 */

public function create_category_tree(string $notification_code, ?string $id) : array