perch_pages_next_page()

Output details of the next page, based on the navigational hierarchy using perch_pages_next_page(). The primary purpose of this function is for navigation, but can be used in other ways too.

Parameters

Type	Description
Array	Options array, see table below
Boolean	Set to `true` to have the value returned instead of echoed.

Options array

Name	Value
hide-extensions	true/false. Strips the file extension from any links generated.
hide-default-doc	true/false. Strips the default document (normally index.php) from the end of the links.
template	The name of the template file to be used.
skip-template	true/false. Returns a PHP associative array rather than the templated HTML.

Usage examples

By default, this uses the navigation item template, so would output a list item with the next page as a link. The templates live in perch/templates/navigation and the default template is called item.html.

<?php perch_pages_next_page(); ?>

The following can be used to output details of the next page using a custom template perch/templates/navigation/custom.html.

<?php
    perch_pages_next_page(array(
        'template'=>'custom.html'
    ));
?>

A full example with all options would be:

<?php
    perch_pages_next_page(array(
        'hide-extensions'  => false,
        'hide-default-doc' => true,
        'template'         => 'custom.html',
        'skip-template'    => false
    ));
?>

The skip-template option returns a PHP associative array of the raw data for generating your own sort of breadcrumbs. When skip-template is set, the function returns its value rather than outputting it to the page.

<?php
    $crumbs = perch_pages_next_page(array(
        'skip-template'=>true
    ));
?>

To return the templated HTML for other purposes, pass a second argument of true.

<?php
    $crumbs = perch_pages_next_page(array(), true);
?>