Page Links Filter
[WARNING: The HTML generated by AZIndex will be changed considerably in an upcoming release. Any page links filters written before then may have to be rewritten to work with the new HTML.]
The page links filter is called just before any index page that has page links in it is displayed, and contains the final HTML for formatted page links to be set to the browser. Using this filter allows you to modify the content of the HTML so that you can effect changes in the way the links are displayed.
To add the filter for all indexes in your blog use the following code:
add_filter('azindex_page_links', 'my_page_links_filter');
Then add the display index filter function with the name you specified:
function my_page_links_filter($output) {
/* My HTML modifying code here */
return $output;
}
The $output parameter contains the HTML for the page links to be displayed.
Page Links Filter Parameters
If you want to do more than tweak the links HTML, perhaps even build your own set of links from scratch, then you can opt to have your filter receive all the available parameters, which is 6:
add_filter('azindex_page_links', 'my_page_links_filter', 10, 6);
Note: the third parameter in the add_filter() call (10) is the default filter priority, and must be present so you can specify the number of parameters you want to be passed to your filter.
Now you can modify the filter function to receive the other parameters:
function my_item_filter($output, $idindex, $pagelink,
$currentpage, $pagecount, $anchor) {
/* My HTML modifying code here */
return $output;
}
The parameters are as follows:
| $output | The generated HTML for the alphabetical links. |
| $idindex | The id of the index being display (may be a string or numeric). Use this if you want your filter to do different things for different indexes. |
| $pagelink | The URL of the index page (without the page number). Needed for links to the other pages in the index. |
| $currentpage | The current page of the index to be displayed. |
| $pagecount | The number of pages in the index. |
| $anchor | This is the anchor for the index page. Add this to the links if you want the top of the index to appear at the top of the browser window when a link is clicked. |
Formatting the Links
If you are completely rebuilding page links HTML, you will need to create href attributes with the correct format. The each link contains URL of the index ($pagelink) and a page number in the format “?pgno=”.$pageno. Optionally, you can add $anchor to the end of the link. For example, the href for a link to the first page of an index appearing on this webpage would have the following format:
href="http://azindex.englishmike.net/page-links-filter/?pgno=1#azindex-11"
Note: the first page of an index is always pgno=1.
Other Notes about the Page Links Filter
There are some other things to be aware of when you are using the page links filter:
- If you just want to tweak the default appearance of the page links, then you might find it easier use the custom CSS options in the index settings page to modify the style of the links.
- The HTML you pass back to the plugin will always be placed at the beginning and/or at the end of the index page (depending on the settings for the index). If you need them to be put somewhere else, then use a display index filter to move the HTML for for page links.
- The filter will not be called if the index is empty or if the page links option is not selected in the settings.
Best Masters Degrees said:
This is so helpful to me! I have such trouble messing with Wordpress themes…
Will Writer Portsmouth said:
Thank you a lot for sharing this with all folks you actually recognize what you’re talking about! Bookmarked. Please additionally talk over with my website =). We will have a hyperlink exchange arrangement among us!
Will Writer Portsmouth said:
I not to mention my friends were viewing the best pointers on your web blog and then quickly got a terrible feeling I never expressed respect to you for those strategies. All the men had been so joyful to learn them and have now quite simply been enjoying those things. Thanks for genuinely quite helpful and then for opting for varieties of helpful useful guides most people are really desperate to be informed on. My personal honest apologies for not saying thanks to you sooner.
Will Writer Portsmouth said:
I would like to thank you for the efforts you have put in writing this site. I’m hoping the same high-grade site post from you in the upcoming as well. Actually your creative writing abilities has inspired me to get my own site now. Actually the blogging is spreading its wings fast. Your write up is a good example of it.
rent cheap textbooks said:
I don’t even understand how I finished up here, however I assumed this post was great. I do not recognize who you are however definitely you are going to a well-known blogger when you aren’t already
Cheers!
Body Massage Spa said:
I’ve been exploring for a little for any high-quality articles or blog posts on this kind of area . Exploring in Yahoo I ultimately stumbled upon this web site. Studying this info So i am happy to convey that I have an incredibly just right uncanny feeling I discovered just what I needed. I so much indubitably will make certain to don’t overlook this site and provides it a glance on a relentless basis.
gossip said:
Outstanding article once again! Thumbs up;)