InputfieldPassword class

Password input with confirmation field that doesn't ever echo the input back.

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.

Show class?             Show args?        

Common

NameReturnSummary 
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.  
InputfieldPassword::defaultLabel string Default label for field (default='Set Password'). Used when no 'label' has been set. 
InputfieldPassword::getConfigInputfields()
InputfieldWrapperReturn the fields required to configure an instance of InputfieldPassword
InputfieldPassword::isValidPassword(string $value)
boolReturn whether or not the given password is valid according to configured requirements 
InputfieldPassword::newPassLabel string Label for new password placeholder.  
InputfieldPassword::oldPassLabel string Label for old/current password placeholder.  
InputfieldPassword::processInput(WireInputData $input)
$thisProcess input
InputfieldPassword::render()
stringRender Password input(s)
InputfieldPassword::renderReady()
boolCalled before render 
InputfieldPassword::renderValue()
stringRender non-editable Inputfield
InputfieldPassword::requireOld int Require previous password? 0=Auto, 1=Yes, -1=No, Default=0 (Auto) 
InputfieldPassword::requirements array Array of requirements (See require* constants) 
InputfieldPassword::requirementsLabels array Text labels used for requirements 
InputfieldPassword::set(string $key, mixed $value)
Inputfield InputfieldPasswordSet Inputfield setting 
InputfieldPassword::setPage(Page $page)
(nothing)Sets the page being edited, not always applicable 
InputfieldPassword::showPass bool Allow password to be rendered in renderValue and/or re-populated in form? 
InputfieldPassword::unmask bool Allow passwords to be unmasked? (3.0.173+) 

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.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK