Function __global->generate_wiki_page_entry_description

Definitions

sources/hooks/systems/content_meta_aware/wiki_page.php

  • Find an entry description.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$row array No No required parameter N/A N/A Database row of entry
$render_type integer No No 1 N/A N/A A FIELD_RENDER_* constant
$resource_fs_style boolean No No False N/A N/A Whether to use the content API as resource-fs requires (may be slightly different)

Returns

  • Content description (string or Tempcode, depending on $render_type) (null: could not generate)
  • Type: ?mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find an entry description.
 *
 * @param  array $row Database row of entry
 * @param  integer $render_type A FIELD_RENDER_* constant
 * @param  boolean $resource_fs_style Whether to use the content API as resource-fs requires (may be slightly different)
 * @return ?mixed Content description (string or Tempcode, depending on $render_type) (null: could not generate)
 */
function generate_wiki_page_entry_description(array $row, int $render_type = 1, bool $resource_fs_style = false)