Inputfield::renderReady() method

Method called right before Inputfield markup is rendered, so that any dependencies can be loaded as well.

Called before Inputfield::render() or Inputfield::renderValue() method by the parent InputfieldWrapper instance. If you are calling either of those methods yourself for some reason, make sure that you call this renderReady() method first.

The default behavior of this method is to populate Inputfield-specific CSS and JS file assets into $config->styles and $config->scripts.

The return value is true if assets were just added, and false if assets have already been added in a previous call. This distinction probably doesn't matter in most usages, but here just in case a descending class needs to know when/if to add additional assets (i.e. when this method returns true).

Usage

// basic usage
$bool = $inputfield->renderReady();

// usage with all arguments
$bool = $inputfield->renderReady($parent = null, bool $renderValueMode = false);

Arguments

NameType(s)Description
parent (optional)
renderValueMode (optional)bool

Specify true only if this is for Inputfield::renderValue() rather than Inputfield::render().

Return value

bool

True if assets were just added, false if already added.


Inputfield methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • 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