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

Twitter updates

  • This week we’ve got a couple of really useful API-side improvements to the core in 3.0.151, including predefined image settings and static language translation improvements— More
    21 February 2020
  • New post in the blog about all the fun we had driving around a DDOS attack on our forums, how we got it back under control, and what we learned along the way. Plus PW 3.0.150 dev details and links! More
    7 February 2020
  • New post: ProcessWire core updates (January 31, 2020)— More
    31 January 2020

Latest news

  • ProcessWire Weekly #302
    In the 302nd issue of ProcessWire Weekly we're going to dig into ProcessWire 3.0.151, introduce a new third party module called PrivacyWire, and showcase some interesting ProcessWire highlights from the past week or so. Read on!
    Weekly.pw / 22 February 2020
  • ProcessWire 3.0.151 core updates
    Blog / 21 February 2020
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH