Template::getConnectedField()

Get Field object connected with this template

Available since version 3.0.142.

Usage

$field = $template->getConnectedField();

Return value

Field null

Returns Field object or null if not applicable


Hooking Template::getConnectedField()

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

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

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

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

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

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

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

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

Template methods and properties

API reference based on ProcessWire core version 3.0.251