Function Hook_ajax_tree_choose_theme_files->run

Definitions

sources/hooks/systems/ajax_tree/choose_theme_files.php

  • Run function for ajax-tree hooks. Generates XML for a tree list, which is interpreted by JavaScript and expanded on-demand (via new calls).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id ?ID_TEXT No No required parameter N/A N/A The ID to do under (null: root)
$options array No No required parameter N/A N/A Options being passed through
$default ?ID_TEXT No No Null N/A N/A The ID to select by default (null: none)

Returns

  • XML in the special category,entry format
  • Type: string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Run function for ajax-tree hooks. Generates XML for a tree list, which is interpreted by JavaScript and expanded on-demand (via new calls).
 *
 * @param  ?ID_TEXT $id The ID to do under (null: root)
 * @param  array $options Options being passed through
 * @param  ?ID_TEXT $default The ID to select by default (null: none)
 * @return string XML in the special category,entry format
 */
public function run(?string $id, array $options, ?string $default = null) : string