Function __global->delete_cms_page

Definitions

sources/zones3.php

  • Delete a software page.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$zone ID_TEXT No No required parameter N/A N/A The zone
$page ID_TEXT No No required parameter N/A N/A The page
$type ID_TEXT No No comcode_custom modules modules_custom minimodules minimodules_custom comcode comcode_custom html html_custom N/A The page type [NB: page is deleted in all languages regardless of which is given]
$use_afm boolean No No False N/A N/A Whether to use the AFM
$only_lang ?LANGUAGE_NAME No No Null N/A N/A Only delete this specific language (null: none)

Preview

Code (PHP)

/**
 * Delete a software page.
 *
 * @param  ID_TEXT $zone The zone
 * @param  ID_TEXT $page The page
 * @param  ID_TEXT $type The page type [NB: page is deleted in all languages regardless of which is given]
 * @set modules modules_custom minimodules minimodules_custom comcode comcode_custom html html_custom
 * @param  boolean $use_afm Whether to use the AFM
 * @param  ?LANGUAGE_NAME $only_lang Only delete this specific language (null: none)
 */
function delete_cms_page(string $zone, string $page, string $type = 'comcode_custom', bool $use_afm = false, ?string $only_lang = null)