Function __global->autogenerate_new_url_moniker

Definitions

sources/urls2.php

  • Called from 'find_id_moniker'. We tried to lookup a moniker, found a hook, but found no stored moniker. So we'll try and auto-generate one.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$ob_info array No No required parameter N/A N/A The hooks info profile
$url_parts array No No required parameter N/A N/A The URL component map (must contain 'page', 'type', and 'id' if this function is to do anything)
$zone ID_TEXT No No required parameter N/A N/A The URL zone name (only used for Comcode Page URL monikers)

Returns

  • The moniker ID (null: error generating it somehow, can not do it)
  • Type: ?string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Called from 'find_id_moniker'. We tried to lookup a moniker, found a hook, but found no stored moniker. So we'll try and auto-generate one.
 *
 * @param  array $ob_info The hooks info profile
 * @param  array $url_parts The URL component map (must contain 'page', 'type', and 'id' if this function is to do anything)
 * @param  ID_TEXT $zone The URL zone name (only used for Comcode Page URL monikers)
 * @return ?string The moniker ID (null: error generating it somehow, can not do it)
 */
function autogenerate_new_url_moniker(array $ob_info, array $url_parts, string $zone) : ?string