Function __global->get_comcode_page_title_from_disk

Definitions

sources/zones2.php

  • Get the title for a Comcode page via an efficient disk scan, or fall-back to a reasonable approximation if there is none.It's all an approximation, but a pretty good one. We don't support single quotes, or missing quotes for the subtitle, or tags that look like HTML tags but are not, or HTML tags opening and closing before the title tag.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$path PATH No No required parameter N/A N/A Path to Comcode page
$include_subtitle boolean No No False N/A N/A Whether to include the subtitle in parentheses after if it exists
$in_tempcode boolean No No False N/A N/A Whether to get in Tempcode format (which will be HTML)

Returns

  • Comcode page title
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the title for a Comcode page via an efficient disk scan, or fall-back to a reasonable approximation if there is none.It's all an approximation, but a pretty good one. We don't support single quotes, or missing quotes for the subtitle, or tags that look like HTML tags but are not, or HTML tags opening and closing before the title tag.
 *
 * @param  PATH $path Path to Comcode page
 * @param  boolean $include_subtitle Whether to include the subtitle in parentheses after if it exists
 * @param  boolean $in_tempcode Whether to get in Tempcode format (which will be HTML)
 * @return mixed Comcode page title
 */
function get_comcode_page_title_from_disk(string $path, bool $include_subtitle = false, bool $in_tempcode = false)