Function __global->get_forum_sort_order

Definitions

sources/cns_forumview.php

  • Get the active forum sort order from a URL specifier.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$_sort string No No first_post N/A N/A Sort order keyword
$simplified boolean No No False N/A N/A Whether to not include pinning etc in the order

Returns

  • A tuple: Sort order in SQL form, keyset pagination field pattern, keyset pagination field
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the active forum sort order from a URL specifier.
 *
 * @param  string $_sort Sort order keyword
 * @param  boolean $simplified Whether to not include pinning etc in the order
 * @return array A tuple: Sort order in SQL form, keyset pagination field pattern, keyset pagination field
 */

function get_forum_sort_order(string $_sort = 'first_post', bool $simplified = false) : array