Function __global->render_wiki_page_box

Definitions

sources/wiki.php

  • Get Tempcode for a Wiki+ page '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)
$include_breadcrumbs boolean No No True N/A N/A Whether to include breadcrumbs (if there are any)
$root ?AUTO_LINK No No Null N/A N/A Virtual root to use (null: none)
$guid ID_TEXT No No Blank (empty string) N/A N/A Overridden GUID to send to templates (blank: none)
$text_summary ?Tempcode No No Null N/A N/A Text summary for result (e.g. highlighted portion of actual file from search result) (null: 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 Wiki+ page '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 $include_breadcrumbs Whether to include breadcrumbs (if there are any)
 * @param  ?AUTO_LINK $root Virtual root to use (null: none)
 * @param  ID_TEXT $guid Overridden GUID to send to templates (blank: none)
 * @param  ?Tempcode $text_summary Text summary for result (e.g. highlighted portion of actual file from search result) (null: none)
 * @return Tempcode A box for it, linking to the full page
 */
function render_wiki_page_box(array $row, string $zone = '_SEARCH', bool $give_context = true, bool $include_breadcrumbs = true, ?int $root = null, string $guid = '', ?object $text_summary = null) : object