MarkupPagerNav::render() method

Render pagination markup

Example

$items = $pages->find("id>0, limit=10"); // replace id>0 with your selector
if($items->count()) {
  echo "<ul>" . $items->each("<li>{title}</li>") . "</ul>";
  $pager = $modules->get("MarkupPagerNav");
  $options = [ 'numPageLinks' => 5 ];
  echo $pager->render($items, $options); // render the pagination navigation
} else {
  echo "<p>Sorry there were no items found</p>";
}

Usage

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

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

Arguments

NameType(s)Description
itemsWirePaginatable, PageArray, PaginatedArray

Items used in the pagination that have had a "limit=n" selector applied when they were loaded.

options (optional)array

Any options to override the defaults. See the MarkupPagerNav reference for all options.

Return value

string


Hooking $pager->render(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $pager->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('MarkupPagerNav::render', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $MarkupPagerNav = $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)
  $items = $event->arguments(0);
  $options = $event->arguments(1);

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

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

See Also


$pager methods and properties

API reference based on ProcessWire core version 3.0.130

Twitter updates

  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019

Latest news

  • ProcessWire Weekly #258
    In the 258th issue of ProcessWire Weekly we'll cover a hosting upgrade for the processwire.com site and it's subdomains, introduce PW Review and Terminal module, and feature the new site of O'Neil Cinema. Read on!
    Weekly.pw / 20 April 2019
  • ProcessWire.com website hosting upgrades
    Quietly and without interruption this week, our whole website moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before.
    Blog / 19 April 2019
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer