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

Twitter updates

  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021
  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021
  • ProcessWire updates for week of 21 May 2021— More
    22 May 2021

Latest news

  • ProcessWire Weekly #370
    In the 370th issue of ProcessWire Weekly we're going to check out the latest version of the commercial FormBuilder module, introduce a couple of brand new third party modules, and more. Read on!
    Weekly.pw / 12 June 2021
  • ProcessWire FormBuilder v50 updates
    Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we'll take a closer look at in this post.
    Blog / 11 June 2021
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer