TableRows::render()

Render a basic table containing the data from this TableRows

Usage

// basic usage
$string = $tableRows->render();

// usage with all arguments
$string = $tableRows->render(array $options = []);

Arguments

section? Default:truethead(string): contents of the section or omit to auto-generate.

Name	Type(s)	Description
`$options` (optional)	`array`	`tableClass` (string): class name for table Default:ft-table `columnClass` (string): class name for each column, col name will be appended: Default:ft-table-col `columns` (array): column names to render, or omit to render all. `useWidth` (bool): whether to use width attributes in columns Default:true `useHead` (bool): use a table header

Return value

string

Hooking TableRows::render(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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

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

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

TableRows methods and properties

API reference based on ProcessWire core version 3.0.261