Function __global->define_comcode_page_structure

Definitions

sources/zones3.php

  • Define a Comcode page structure programmatically.This function is intended for programmers, writing upgrade scripts for a custom site (dev>staging>live).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$structure array No No required parameter N/A N/A Comcode Page structure (see function code for an example)
$zone string No No Blank (empty string) N/A N/A The zone to do this in
$parent ID_TEXT No No Blank (empty string) N/A N/A Parent of current node in recursion (blank: no parent)
$overwrite_all boolean No No False N/A N/A Whether to flush out all existing data

Preview

Code (PHP)

/**
 * Define a Comcode page structure programmatically.This function is intended for programmers, writing upgrade scripts for a custom site (dev>staging>live).
 *
 * @param  array $structure Comcode Page structure (see function code for an example)
 * @param  string $zone The zone to do this in
 * @param  ID_TEXT $parent Parent of current node in recursion (blank: no parent)
 * @param  boolean $overwrite_all Whether to flush out all existing data
 */
function define_comcode_page_structure(array $structure, string $zone = '', string $parent = '', bool $overwrite_all = false)