PageFinder::getQueryAllowedTemplatesWhere()

Method that allows external hooks to add to or modify the access control WHERE conditions

Called only if it's hooked. To utilize it, modify the $where argument in a BEFORE hook or the $event->return in an AFTER hook.

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

Internal usage

$string = $pageFinder->getQueryAllowedTemplatesWhere(DatabaseQuerySelect $query, string $where);

Arguments

NameType(s)Description
$queryDatabaseQuerySelect
$wherestring

SQL string for WHERE statement, not including the actual "WHERE"

Return value

string


Hooking PageFinder::getQueryAllowedTemplatesWhere(…)

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

$this->addHookBefore('PageFinder::getQueryAllowedTemplatesWhere', 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)
  $query = $event->arguments(0);
  $where = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each PageFinder::getQueryAllowedTemplatesWhere(…) 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::getQueryAllowedTemplatesWhere', 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)
  $query = $event->arguments(0);
  $where = $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.252