Function Hook_ajax_tree_choose_homesite_addon->get_file

Definitions

sources/hooks/systems/ajax_tree/choose_homesite_addon.php

  • This will get the XML file from the homesite.
  • Visibility: protected
  • 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)
$default ?ID_TEXT No No required parameter N/A N/A The ID to select by default (null: none)

Returns

  • The XML file
  • Type: string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * This will get the XML file from the homesite.
 *
 * @param  ?ID_TEXT $id The ID to do under (null: root)
 * @param  ?ID_TEXT $default The ID to select by default (null: none)
 * @return string The XML file
 */

protected function get_file(?string $id, ?string $default) : string