Wire::callUnknown() method

If method call resulted in no handler, this hookable method is called.

This standard implementation just throws an exception. This is a template method, so the reason it exists is so that other classes can override and provide their own handler. Classes that provide their own handler should not do a parent::__callUnknown() unless they also fail, as that will cause an exception to be thrown.

If you want to override this method with a hook, see the example below.

Example

$wire->addHookBefore('Wire::callUnknown', function(HookEvent $event) {
  // Get information about unknown method that was called
  $methodObject = $event->object;
  $methodName = $event->arguments(0); // string
  $methodArgs = $event->arguments(1); // array
  // The replace option replaces the method and blocks the exception
  $event->replace = true;
  // Now do something with the information you have, for example
  // you might want to populate a value to $event->return if
  // you want the unknown method to return a value.
}); 

Usage

$mixed = $wire->callUnknown(string $method, array $arguments);

Arguments

NameType(s)Description
methodstring

Requested method name

argumentsarray

Arguments provided

Return value

null mixed

Return value of method (if applicable)

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking Wire::callUnknown(…)

You can add your own hook events that are executed either before or after the Wire::callUnknown(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each Wire::callUnknown(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Wire::callUnknown', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Wire = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $method = $event->arguments(0);
  $arguments = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $method);
  $event->arguments(1, $arguments);
});

Hooking after

The 'after' hooks are called immediately after each Wire::callUnknown(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Wire::callUnknown', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Wire = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $method = $event->arguments(0);
  $arguments = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

Wire 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

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