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

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 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

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer