Function __global->load_comcode_page

Definitions

sources/site.php

  • Get the parsed contents of a Comcode page.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$string PATH No No required parameter N/A N/A The relative (to the software's base directory) path to the page (e.g. pages/comcode/EN/example.txt)
$zone ID_TEXT No No required parameter N/A N/A The zone the page is being loaded from
$codename ID_TEXT No No required parameter N/A N/A The codename of the page
$file_base ?PATH No No Null N/A N/A The file base to load from (null: standard)
$being_included boolean No No False N/A N/A Whether the page is being included from another

Returns

  • The page
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the parsed contents of a Comcode page.
 *
 * @param  PATH $string The relative (to the software's base directory) path to the page (e.g. pages/comcode/EN/example.txt)
 * @param  ID_TEXT $zone The zone the page is being loaded from
 * @param  ID_TEXT $codename The codename of the page
 * @param  ?PATH $file_base The file base to load from (null: standard)
 * @param  boolean $being_included Whether the page is being included from another
 * @return Tempcode The page
 */
function load_comcode_page(string $string, string $zone, string $codename, ?string $file_base = null, bool $being_included = false) : object