Function __global->render_news_category_box

Definitions

sources/news.php

  • Get Tempcode for a news category 'feature box' for the given row.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$row array No No required parameter N/A N/A The database field row of it
$zone ID_TEXT No No _SEARCH N/A N/A The zone to use
$give_context boolean No No True N/A N/A Whether to include context (i.e. say WHAT this is, not just show the actual content)
$attach_to_url_filter boolean No No False N/A N/A Whether to copy through any filter parameters in the URL, under the basis that they are associated with what this box is browsing
$blogs ?integer No No Null N/A N/A What to show (null: news and blogs, 0: news, 1: blogs)
$guid ID_TEXT No No Blank (empty string) N/A N/A Overridden GUID to send to templates (blank: none)

Returns

  • A box for it, linking to the full page
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get Tempcode for a news category 'feature box' for the given row.
 *
 * @param  array $row The database field row of it
 * @param  ID_TEXT $zone The zone to use
 * @param  boolean $give_context Whether to include context (i.e. say WHAT this is, not just show the actual content)
 * @param  boolean $attach_to_url_filter Whether to copy through any filter parameters in the URL, under the basis that they are associated with what this box is browsing
 * @param  ?integer $blogs What to show (null: news and blogs, 0: news, 1: blogs)
 * @param  ID_TEXT $guid Overridden GUID to send to templates (blank: none)
 * @return Tempcode A box for it, linking to the full page
 */
function render_news_category_box(array $row, string $zone = '_SEARCH', bool $give_context = true, bool $attach_to_url_filter = false, ?int $blogs = null, string $guid = '') : object