ProcessTemplate::getListTableRow() method

Get row for templates list table

Usage

// basic usage
$array = $processTemplate->getListTableRow(Template $template);

// usage with all arguments
$array = $processTemplate->getListTableRow(Template $template, bool $useLabel = true);

Arguments

NameType(s)Description
templateTemplate
useLabel (optional)bool

Return value

array


Hooking ProcessTemplate::getListTableRow(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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

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

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

ProcessTemplate methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #552
    In the 552nd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, take a quick look at a new e-commerce solution for ProcessWire, and more. Read on!
    Weekly.pw / 7 December 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

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer