Function __global->upgrader_link

Definitions

sources/upgrade.php

  • Generate a form-based link to relay POST information to a URL.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$url string No No required parameter N/A N/A The URL (something like 'upgrader.php?type=cns')
$text string No No required parameter N/A N/A The URL caption text
$is_get boolean No No False N/A N/A If the form should use the GET action instead of POST (true: POST fields including password will not be relayed)
$disabled boolean No No False N/A N/A Whether it is disabled
$js string No No Blank (empty string) N/A N/A Extra confirmation

Returns

  • The form-based link
  • Type: string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Generate a form-based link to relay POST information to a URL.
 *
 * @param  string $url The URL (something like 'upgrader.php?type=cns')
 * @param  string $text The URL caption text
 * @param  boolean $is_get If the form should use the GET action instead of POST (true: POST fields including password will not be relayed)
 * @param  boolean $disabled Whether it is disabled
 * @param  string $js Extra confirmation
 * @return string The form-based link
 */
function upgrader_link(string $url, string $text, bool $is_get = false, bool $disabled = false, string $js = '') : string