Function __global->wiki_derive_chain

Definitions

sources/wiki.php

  • Create a Wiki+ chain from the specified page ID.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id AUTO_LINK No No required parameter N/A N/A The ID of the page to derive a chain for
$root ?AUTO_LINK No No Null N/A N/A Virtual root to use (null: none)

Returns

  • The Wiki+ chain derived
  • Type: string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Create a Wiki+ chain from the specified page ID.
 *
 * @param  AUTO_LINK $id The ID of the page to derive a chain for
 * @param  ?AUTO_LINK $root Virtual root to use (null: none)
 * @return string The Wiki+ chain derived
 */
function wiki_derive_chain(int $id, ?int $root = null) : string