palmtree/wp-pagination

WordPress Pagination component for Palmtree PHP

v1.0.1 2022-05-30 10:33 UTC

Requires

• php: >=7.1

Requires (Dev)

• palmtree/php-cs-fixer-config: ^1.0.3
• roots/wordpress: ^5.7

MIT

• Andy Palmer

README

WordPress pagination component for Palmtree PHP

Generates pagination for the main WP_Query or any query provided and outputs with Bootstrap v4 classes.

Requirements

• PHP >= 7.1

Installation

Use composer to add the package to your dependencies:

composer require palmtree/wp-pagination

Usage

Basic

<?php
$pagination = new \Palmtree\WordPress\Pagination\Pagination();

// Get Bootstrap formatted pagination
echo $pagination->getHtml();

// __toString() is also implemented, which implicitly calls getHtml()
echo $pagination;

// Or get an array of unstyled links
$links = $pagination->getLinks();

Advanced

<?php
use Palmtree\WordPress\Pagination\Pagination;

$query = new \WP_Query();

$pagination = new Pagination();
$pagination->setQuery($query);
$pagination
    ->addArg('prev_text', 'Previous')
    ->addArg('next_text', 'Next');

License

Released under the MIT license