Update paginate_links() with 4 new arguments

anon66243189 · September 9, 2021, 11:26am

Context

The current implementation of paginate_links( $args = '' ) is a bit of a mess and misses a few crucial features.
Instead of hacking core or messing around with filters that are not supposed to do what I need the function to do, I did (use it myself on several plugins) “replace” that function by basically creating a new custom function (better_paginate_links) that I use in my plugins.

Now I would like to ask the community if the changes I made to the function in my own plugins, would be welcome in core, so we can push it.
The code is ready to be PRd, so no big work required other than review.
Nothing existing gets destroyed, only new features added.
The changes are useful for example when using Bootstrap or simply wanting more control over the HTML generated by the function.

New Features

These new args are added:

@type string $li_classes Classes to be added to each LIST element. Default: empty. Accepts: valid HTML classes.
@type string $ul_classes Classes to be added to the UL element. Default: empty. Accepts: valid HTML classes.
@type string $a_classes Classes to be added to each a href element. Default: empty. Accepts: valid HTML classes.
@type string $current_classes Classes to be added to each span (aria current) element. Default: empty. Accepts: valid HTML classes.

This allows you to control the generated HTML lists, ul and a href classes without having to use a (totally unperformant) filter to alter the HTML produced and add eventual classes you might need for example for a proper Bootstrap Pagination.

Will you be able to help with the implementation?

Already done, battle tested.
Just need to PR it.

Lets see if we can gather a few votes for this. If it is generally agreed that no votes are needed, we can also just comment a yay and I can still PR it.

viktor · September 9, 2021, 1:56pm

Voted, this makes sense. Working with pagination in WordPress can be difficult.

james · September 9, 2021, 3:42pm

These should be added as new values accepted for the existing $args array that this function receives, rather than new parameters to the paginate_links function.

The reason is that if we add new parameters to functions, and then WP ends up also adding a different new parameter to the same function, we have a mess and no way to retain compatibility. When there is another way to achieve something like this without changing a function signature it is best to do it that way. The $args arrays are perfect for this.

As long as it’s done that way, then no problem here.

anon66243189 · September 9, 2021, 4:54pm

Yeah same here

New $args array member, function arguments don’t change per se

anon66243189 · September 10, 2021, 5:34am

PR:

github.com/ClassicPress/ClassicPress

Add 4 new attributes to paginate_links

ClassicPress:develop ← smileBeda:patch-5

opened 05:32AM - 10 Sep 21 UTC

smileBeda

+29 -16

## Description Adds 4 new attributes to paginate links: ``` 'li_classes' … => '', 'ul_classes' => '', 'a_classes' => '', 'current_classes' => '', ``` This allows to control the produced HTML for paginate_links more granularly, particularly helpful when working with Bootstrap or other frameworks which expect certain classes added to ul, li and link + current item. See also https://forums.classicpress.net/t/update-paginate-links-with-4-new-arguments/ Example usage: ``` echo paginate_links( array( 'type' => 'list', 'li_classes' => 'li-class another-class', 'ul_classes' => 'ul-class more-stuff', 'a_classes' => 'link-class etc-class', 'current_classes' => 'current-item is-really-current', ) ); ``` ## Motivation and context The paginate_links is another instance in WP that needs a lot of love, this is the minimal required additional features that almost every one needs when producing paginate_links. I have seen tons of plugins replacing said function just to add these arguments. It should help developers get more control over the pagination items. ## How has this been tested? In my plugins and this pr as well locally ## Screenshots ### Before <img width="1272" alt="before" src="https://user-images.githubusercontent.com/11800236/132804647-2dfc8dfa-95d3-4717-8021-910ca67864d2.png"> ### After <img width="1340" alt="after" src="https://user-images.githubusercontent.com/11800236/132804603-262461fa-602e-40e3-90a0-e5308ce575e9.png"> ## Types of changes - New Feature (non invasive, backwards compatible)

viktor · September 10, 2021, 6:21am

Great job @anon66243189. Since this petition has a pull request now, I’ve updated its status and will set it to close to release votes. Any discussions related to PR should be done on GitHub.

viktor · September 15, 2021, 6:21am

This topic was automatically closed after 5 days. New replies are no longer allowed.