PageFinder::getQueryUnknownField()

Hook called when an unknown field is found in the selector

By default, PW will throw a PageFinderSyntaxException but that behavior can be overridden by hooking this method and making it return true rather than false. It may also choose to map it to a Field by returning a Field object. If it returns integer 1 then it indicates the fieldName mapped to an API variable. If this method returns false, then it signals the getQuery() method that it was unable to map it to anything and should be considered a fail.

This protected method is for hooks to monitor and it is likely not intended to be called directly.

Internal usage

$bool = $pageFinder->getQueryUnknownField(string $fieldName, array $data);

Arguments

NameType(s)Description
$fieldNamestring
$dataarray

Array of data containing the following in it:

  • subfield (string): First subfield
  • subfields (string): All subfields separated by period (i.e. subfield.tertiaryfield)
  • fields (array): Array of all other field names being processed in this selector.
  • query (DatabaseQuerySelect): Database query select object
  • selector (Selector): Selector that contains this field
  • selectors (Selectors): All the selectors

Return value

bool Field int

Exceptions

Method can throw exceptions on error:

  • PageFinderSyntaxException

Hooking PageFinder::getQueryUnknownField(…)

You can add your own hook events that are executed either before or after the PageFinder::getQueryUnknownField(…) 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 PageFinder::getQueryUnknownField(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('PageFinder::getQueryUnknownField', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $PageFinder = $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)
  $fieldName = $event->arguments(0);
  $data = $event->arguments(1);

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

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

PageFinder methods and properties

API reference based on ProcessWire core version 3.0.251