Function Hook_content_meta_aware_wiki_page->render_box

Definitions

sources/hooks/systems/content_meta_aware/wiki_page.php

  • Render a content box for a content 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 row for the content
$zone ID_TEXT No No required parameter N/A N/A The zone to display in
$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 ?ID_TEXT No No Null N/A N/A Virtual root to use (null: none)
$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
$guid ID_TEXT No No Blank (empty string) N/A N/A Overridden GUID to send to templates (blank: none)

Returns

  • Results
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Render a content box for a content row.
 *
 * @param  array $row The database row for the content
 * @param  ID_TEXT $zone The zone to display in
 * @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  ?ID_TEXT $root Virtual root to use (null: none)
 * @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  ID_TEXT $guid Overridden GUID to send to templates (blank: none)
 * @return Tempcode Results
 */
public function render_box(array $row, string $zone, bool $give_context = true, bool $include_breadcrumbs = true, ?string $root = null, bool $attach_to_url_filter = false, string $guid = '') : object