$hooks->isHooked() method

Returns true if the method/property hooked, false if it isn't.

This is for optimization use. It does not distinguish about class instance. It only distinguishes about class if you provide a class with the $method argument (i.e. Class::). As a result, a true return value indicates something "might" be hooked, as opposed to be being definitely hooked.

If checking for a hooked method, it should be in the form Class::method() or method() (with parenthesis). If checking for a hooked property, it should be in the form Class::property or property.

If you need to check if a method/property is hooked, including any of its parent classes, use the WireHooks::isMethodHooked(), WireHooks::isPropertyHooked(), or WireHooks::hasHook() methods instead.

Usage

// basic usage
$bool = $hooks->isHooked(string $method);

// usage with all arguments
$bool = $hooks->isHooked(string $method, $instance = null);

Arguments

NameType(s)Description
methodstring

Method or property name in one of the following formats: Class::method() Class::property method() property

instance (optional)Wire, null

Optional instance to check against (see hasHook method for details) Note that if specifying an $instance, you may not use the Class::method() or Class::property options for $method argument.

Return value

bool

See Also


$hooks methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 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

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.