Function Hook_search_news->get_tree

Definitions

sources/hooks/modules/search/news.php

  • Get a list of entries for the content covered by this search hook. In hierarchical list selection format.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$_selected string No No required parameter N/A N/A The default selected item

Returns

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

Preview

Code (PHP)

/**
 * Get a list of entries for the content covered by this search hook. In hierarchical list selection format.
 *
 * @param  string $_selected The default selected item
 * @return Tempcode Tree structure
 */
public function get_tree(string $_selected) : object