construct_page_nav Function

[Reven]

Hey,

I'm having difficulty understanding how to use the in-built function for page navigation (as used in multi-page threads, v3arcade and other addons). Here is the function:

Originally Posted by vBulletin API

construct_page_nav (line 1752)

Returns the HTML for multi-page navigation - based on code from 3dfrontier.com

* return: Page navigation HTML

string construct_page_nav (integer $pagenumber, string $perpage, string $results, mixed $address, [mixed $address2 = ''])

* integer $pagenumber: Total number of items found
* string $perpage: Base address for links eg: showthread.php?t=99{&page=4}
* string $results: Ending portion of address for links

Some questions:

1. Does $pagenumber hold the total number of pages viewable? So for instance in a thread with 12 pages, $pagenumber would equal '12'?

2. Am I right in saying that the variable $perpage holds the request parameter and value you're using to tell your script that it is to look at a specific page? So where you want to look at the second page of a thread using showthread.php?t=235&page=2, $perpage would equal 'page=2'?

3. What is $results supposed to hold? Is it supposed to hold any anchors you use such as '#thing' to be dumped on the end of the link to the next page?

I am sure some will agree that some of the descriptions given in the API aren't very descriptive. Thanks for any help, guys.

N.B. If construct_page_nav isn't the function which does this, slap me and direct me to the one that does. However, I'm fairly certain it is, since I've been digging around in the vBulletin files for this.