Wire::getInstanceNum() method

Get this Wire object’s instance number

  • This is a unique number among all other Wire (or derived) instances in the system.
  • If this instance ID has not yet been set, this will set it.
  • Note that this is different from the ProcessWire instance ID.

Usage

// basic usage
$int = $wire->getInstanceNum();

// usage with all arguments
$int = $wire->getInstanceNum(bool $getTotal = false);

Arguments

NameType(s)Description
getTotal (optional)bool

Specify true to get the total quantity of Wire instances rather than this instance number.

Return value

int

Instance number


Wire methods and properties

API reference based on ProcessWire core version 3.0.244

“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