Function __global->comcode_page_include_on_sitemap

Definitions

sources/global4.php

  • Find whether a page is included on the sitemap / indexable.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$zone ID_TEXT No No required parameter N/A N/A Zone name
$codename ID_TEXT No No required parameter N/A N/A Page name
$row ?array No No Null N/A N/A The database row (null: lookup directly from the database)

Returns

  • Whether it is indexable
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find whether a page is included on the sitemap / indexable.
 *
 * @param  ID_TEXT $zone Zone name
 * @param  ID_TEXT $codename Page name
 * @param  ?array $row The database row (null: lookup directly from the database)
 * @return boolean Whether it is indexable
 */
function comcode_page_include_on_sitemap(string $zone, string $codename, ?array $row = null) : bool