Function __global->uninstall_check_maintenance_password

Definitions

uninstall.php

  • Check the given maintenance password is valid.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$password_given ?SHORT_TEXT No No required parameter N/A N/A Given maintenance password (null: none)

Returns

  • Whether it is valid
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Check the given maintenance password is valid.
 *
 * @param  ?SHORT_TEXT $password_given Given maintenance password (null: none)
 * @return boolean Whether it is valid
 */
function uninstall_check_maintenance_password(?string $password_given) : bool