InputfieldPassword class

Password input with confirmation field.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the InputfieldPassword class also inherits all the methods and properties of: InputfieldText, Inputfield, WireData and Wire.

Common

Name	Return	Summary
InputfieldPassword::getConfigInputfields() InputfieldPassword::getConfigInputfields() InputfieldPassword::getConfigInputfields()	`InputfieldWrapper`	Return the fields required to configure an instance of InputfieldPassword
InputfieldPassword::isValidPassword() InputfieldPassword::isValidPassword(string $value) InputfieldPassword::isValidPassword(string $value)	`bool`	Return whether or not the given password is valid according to configured requirements
InputfieldPassword::processInput() InputfieldPassword::processInput(WireInputData $input) InputfieldPassword::processInput(WireInputData $input)	`$this`	Process input
InputfieldPassword::render() InputfieldPassword::render() InputfieldPassword::render()	`string`	Render Password input(s)
InputfieldPassword::renderReady() InputfieldPassword::renderReady() InputfieldPassword::renderReady($parent = null, bool $renderValueMode = false)	`bool`	Called before render
InputfieldPassword::renderValue() InputfieldPassword::renderValue() InputfieldPassword::renderValue()	`string`	Render non-editable Inputfield
InputfieldPassword::set() InputfieldPassword::set(string $key, mixed $value) InputfieldPassword::set(string $key, mixed $value)	`Inputfield` `InputfieldPassword`	Set Inputfield setting
InputfieldPassword::setPage() InputfieldPassword::setPage(Page $page) InputfieldPassword::setPage(Page $page)	None	Sets the page being edited, not always applicable

Constants

Name	Return	Summary
InputfieldPassword::requireDigit const	digit	Requirements: digit required
InputfieldPassword::requireLetter const	letter	Requirements: letter required
InputfieldPassword::requireLowerLetter const	lower	Requirements: lowercase letter required
InputfieldPassword::requireNone const	none	Requirements: disable all above
InputfieldPassword::requireOldAuto const	0	Require old password before changes? Auto
InputfieldPassword::requireOldNo const	-1	Require old password before changes? No
InputfieldPassword::requireOldYes const	1	Require old password before changes? Yes
InputfieldPassword::requireOther const	other	Requirements: other character (symbol) required
InputfieldPassword::requireUpperLetter const	upper	Requirements: uppercase letter required

Properties

Name	Return	Summary
InputfieldPassword::complexifyBanMode	`string`	Complexify ban mode, 'loose' or 'strict' DEFAULT: loose
InputfieldPassword::complexifyFactor	`float`	Complexify factor, lower numbers enable simpler passwords DEFAULT: 0.7
InputfieldPassword::confirmLabel	`string`	Label for password confirm placeholder. DEFAULT: Confirm
InputfieldPassword::defaultLabel	`string`	Default label for field. Used when no 'label' has been set. DEFAULT: Set Password
InputfieldPassword::newPassLabel	`string`	Label for new password placeholder. DEFAULT: New Password
InputfieldPassword::oldPassLabel	`string`	Label for old/current password placeholder. DEFAULT: Current Password
InputfieldPassword::requireOld	`int`	Require previous password? 0=Auto, 1=Yes, -1=No DEFAULT: 0
InputfieldPassword::requirements	`array`	Array of requirements (See require* constants) DEFAULT: [ 'letter', 'digit' ]
InputfieldPassword::requirementsLabels	`array`	Text labels used for requirements
InputfieldPassword::showPass	`bool`	Allow password to be rendered in renderValue and/or re-populated in form? DEFAULT: false
InputfieldPassword::unmask	`bool`	Allow passwords to be unmasked (i.e. show user what they entered) ? 3.0.173+ DEFAULT: false

Additional methods and properties

In addition to the methods and properties above, InputfieldPassword also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.252