wireInstanceOf() function

Does given instance (or class) represent an instance of the given className (or class names)?

Since version 3.0.108 the $className argument may also represent an interface, array of interfaces, or mixed array of interfaces and class names. Previous versions did not support interfaces unless the $instance argument was an object.

Usage

// basic usage
$bool = wireInstanceOf($instance, $className);

// usage with all arguments
$bool = wireInstanceOf($instance, $className, bool $autoload = true);

Arguments

NameType(s)Description
instanceobject, string

Object instance to test (or string of its class name).

classNamestring, array

Class/interface name or array of class/interface names to test against.

autoload (optional)bool

Allow PHP to autoload the class? (default=true)

Return value

bool string

Returns one of the following:

  • false (bool): if not an instance (whether $className argument is string or array).
  • true (bool): if given a single $className (string) and $instance is an instance of it.
  • ClassName (string): first matching class/interface name if $className was an array of classes to test.

Functions methods and properties

API reference based on ProcessWire core version 3.0.167

Twitter updates

  • This week a 2nd new module for processing Stripe payments has been added to FormBuilder. Unlike our other Stripe Inputfield, this new one supports 3D Secure (SCA) payments. We’ll take a closer look at it in this post, plus a live demo— More
    16 October 2020
  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020

Latest news

  • ProcessWire Weekly #337
    In the 337th issue of ProcessWire Weekly we're going to introduce a couple of brand new third party modules, take a closer look at the latest core updates, and more. Read on!
    Weekly.pw / 24 October 2020
  • Stripe Payment Processor for FormBuilder
    This week a second new module for processing Stripe payments has been added to FormBuilder. We’ll take a closer look at it in this blog post, plus we’ve got a demo of it here too.
    Blog / 16 October 2020
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits