InputfieldPage::renderPageLabel() method

Render a label for the given page

This is the same as getPageLabel() but hookable.

Available since version 3.0.236.

Usage

// basic usage
$string = $inputfieldPage->renderPageLabel(Page $page);

// usage with all arguments
$string = $inputfieldPage->renderPageLabel(Page $page, bool $allowMarkup = false);

Arguments

Name	Type(s)	Description
`page`	Page
`allowMarkup` (optional)	bool	Whether or not to allow markup in the label (default=false)

Return value

string

Hooking InputfieldPage::renderPageLabel(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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

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

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

InputfieldPage methods and properties

API reference based on ProcessWire core version 3.0.236