Allow extra control over CSS Classes in paginate_links()

[maor]

Currently, paginate_links() does not allow any flexibility in terms of customizing CSS classes in the outputted HTML.

The idea here is to introduce some degree of control in this area.

This idea rose from the need to implement a pagination component in ​Bootstrap and Zurb's ​Foundation. As of now, there is no way to implement these components without workarounds / hacks to paginate_links().

Currently, paginate_links() lets me output such HTML:

<ul class="page-numbers">
	<li><span class="page-numbers current">1</span></li>
	<li><a class="page-numbers" href="https://example.com/blog/page/2/">2</a></li>
	<li><a class="page-numbers" href="https://example.com/blog/page/3/">3</a></li>
	<li><a class="next page-numbers" href="https://example.com/blog/page/2/">Next &raquo;</a></li>
</ul>

I would expect paginate_links() to allow me to attach custom CSS classes to <ul>, <li> and <a> elements.

<ul class="pagination">
	<li class="page-numbers active"><a href="#">1 <span class="sr-only">(current)</span></a></li>
	<li><a class="page-numbers" href="https://example.com/blog/page/2/">2</a></li>
	<li><a class="page-numbers" href="https://example.com/blog/page/3/">3</a></li>
	<li><a class="next page-numbers" href="https://example.com/blog/page/2/"><i class="fa fa-arrow-right"></i></a></li>
</ul>

This will allow for much more flexibility and less dirty workarounds.

[maor]

@ramiy this has to do with what we discussed today, check this ticket out.

[ramiy]

Yes, I remember.

It's a simple fix, give me 5 minutes to create the patch.

[ramiy]

The attached patch adds a $classes argument. It's an array of classes.

WordPress Pagination (those are also the default values for backwards-compatibility):

$args = array(
	'classes' => array(
		'ul'      => 'page-numbers',
		'li'      => '',
		'a'       => 'page-numbers',
		'prev'    => 'prev',
		'next'    => 'next',
		'current' => 'current',
		'dots'    => 'dots'
	)
);
echo paginate_links( $args );

​Bootstrap Pagination:

$args = array(
	'classes' => array(
		'ul'      => 'pagination pagination-lg',
		'li'      => '',
		'a'       => '',
		'prev'    => '',
		'next'    => '',
		'current' => 'active',
		'dots'    => ''
	)
);
echo paginate_links( $args );

​Foundation Pagination:

$args = array(
	'classes' => array(
		'ul'      => 'pagination',
		'li'      => '',
		'a'       => '',
		'prev'    => 'pagination-previous',
		'next'    => 'pagination-next',
		'current' => 'current',
		'dots'    => 'ellipsis'
	)
);
echo paginate_links( $args );