Function __global->get_tutorial_url

Definitions

sources/global3.php

  • Get a URL to a software tutorial.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$tutorial ?ID_TEXT No No required parameter N/A N/A Name of a tutorial (null: don't include the page part)

Returns

  • URL to a tutorial
  • Type: URLPATH
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a URL to a software tutorial.
 *
 * @param  ?ID_TEXT $tutorial Name of a tutorial (null: don't include the page part)
 * @return URLPATH URL to a tutorial
 */
function get_tutorial_url(?string $tutorial) : string