Function __global->sort_search_results

Definitions

sources/database_search.php

  • Sort search results as returned by the search hook.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$hook_results array No No required parameter N/A N/A Search results from the search hook, assumed already sorted
$results array No No required parameter N/A N/A Existing array of results (originally starts blank)
$direction string No No required parameter ASC DESC N/A Sort direction

Returns

  • Sorted results
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Sort search results as returned by the search hook.
 *
 * @param  array $hook_results Search results from the search hook, assumed already sorted
 * @param  array $results Existing array of results (originally starts blank)
 * @param  string $direction Sort direction
 * @set ASC DESC
 * @return array Sorted results
 */
function sort_search_results(array $hook_results, array $results, string $direction) : array