How To Setup Custom Queries For WP_Query Pagination

As written by Tom McFarlin. One of the nicest things about using WP_Queryis that it allows you to completely customize the data that you’re bringing back to the front end. For those of you who are completely unfamiliar with this API, it’s a powerful class that allows you to custom tailor a query against the WordPress database for retrieving information about posts, pages, custom post types, and so on. If you’re using one of the more common features of WordPress, such as those mentioned above, then it’s relatively easy to get started; however, if you’re doing more complicated work, such as including multiple custom queries in a single view, then there are some challenges that you may discover. Personally, I’ve been working on a project where I have two custom queries running in a template and I needed to paginate the results. The problem is that using the usual functions for doing this, that is:

Were not working as expected. Ultimately, it required me passing a little bit more information to the query’s arguments array and to the pagination link functions. Here’s how you can setup WP_Query Pagination to work properly in custom queries.

A Few Assumptions

There are two assumptions that I’m making about your setup:

You’re using pretty permalinks. That is, your permalink structure includes something like /%postname%/.
You’re familiar with get_query_var specifically or pagination.

Assuming that you’re familiar with both of these, you should be good to go from defining your custom queries and for getting pagination to work correctly without any custom helper functions and by using the native WordPress API.

A Working Example

Defining The Query

Let’s assume that we’re just going to be pulling back a set of records for a custom post type called goals. First, we need to define the arguments for the query. Personally, I think that defining the arguments in an array and then passing the array to theWP_Query class makes for more readable, manageable code, but that’scompletely subjective. [php]   // First, get a reference to the current author of the posts in this listing $current_author = ( isset($_GET['author_name'] ) ) ? get_user_by( 'slug', $author_name ) : get_userdata( intval( $author ) ); // Next, define a way to get the current offset function example_get_offset() { $number = 10; $page = get_query_var( 'paged' ) ? get_query_var( 'paged' ) : 1 return 1 == $page ? ( $page - 1 ) : ( ( $page - 1 ) * $number ); } // end example_get_offset // After that, set the arguments for the query $args = array( 'post_type' => array( 'goal' ), 'orderby' => 'date', 'order' => 'desc', 'posts_per_page' => 10, 'offset' => example_get_offset(), 'paged' => get_query_var( 'page' ) ? get_query_var( 'page' ) : 1, 'author' => $current_author->ID ); // Finally, instantiate the query $query = new WP_Query( $args ); [/php] The code comments should be relatively clear; however, there are two main arguments in the $args array that are worth noting:

posts_per_page. This is somewhat of an arbitrary value, but this simply tells WordPress how many posts you want to pull back for a given page.
paged. This parameter is what will give the pagination API functions their power. Above, we’re looking to see if the query variable exists. If so, we’ll use that value; otherwise, we’ll initialize it to one. The sublte nuance here is that the key is pagedbut the get_query_var parameter is page. Don’t miss that.

Finally, you may note that we’re pulling back all of those posts for the current author.

Setting The Pagination Links

Next, it’s time to setup the pagination links. For standard queries, we’re typically used to seeing something like this: [php] <div id="pagination"> <ul class="pagination"> <li id="previous-stories" class="arrow"> <?php previous_posts_link(); ?> </li> <li id="next-stories" class="arrow"> <?php next_posts_link(); ?> </li> </ul> </div> [/php] But that won’t actually work because of the custom query that we’ve defined above. Here’s what you need to do to take advantage of a custom setup with WP_Query Paging.

Using WP_Query Paging with Custom Queries

Notice that the API for both the next_posts_link and previous_posts_link functions accept two parameters:

The label for the link
The maximum number of pages that will be displayed

As such, here’s one way you’d define the markup provided above: [php] <div id="pagination"> <ul class="pagination"> <li id="previous-stories" class="arrow"> <?php previous_posts_link( '<< Previous Stories', $query->max_num_pages ); ?> </li> <li id="next-stories" class="arrow"> <?php next_posts_link( 'Next Stories >>', $query->max_num_pages ); ?> </li> </ul> </div> [/php] This way, you’re telling WordPress the maximum number of pages that are being retrieved based on the results of the custom query that has been executed. By doing this, you should have no problem setting up WP_Query Paging in your work.

Revisions

April 2, 2013 @ 05:09:44 [Current Revision] by PeterLugg
April 2, 2013 @ 05:07:39 by PeterLugg

Revision Differences

--- April 2, 2013 @ 05:07:39
+++ Current Revision
+Added: As written by <a href="http:// tommcfarlin.com/wp_query- pagination/" target="_blank">Tom McFarlin</a>.
+Added: One of the nicest things about using <code><a title="WP_Query" href="http:// codex.wordpress.org/Class_ Reference/WP_Query" target="_blank" >WP_Query</a></code>is that it allows you to completely customize the data that you’re bringing back to the front end.
+Added: For those of you who are completely unfamiliar with this API, it’s a powerful class that allows you to custom tailor a query against the WordPress database for retrieving information about posts, pages, custom post types, and so on.
+Added: If you’re using one of the more common features of WordPress, such as those mentioned above, then it’s relatively easy to get started; however, if you’re doing more complicated work, such as including multiple custom queries in a single view, then there are some challenges that you may discover.
+Added: Personally, I’ve been working on a project where I have two custom queries running in a template and I needed to paginate the results. The problem is that using the usual functions for doing this, that is:
+Added: <ul>
+Added:  <li><code><a title="posts_nav_link" href="http:// codex.wordpress.org/Function_ Reference/posts_nav_link" target="_blank" >posts_nav_link< /a></code></li>
+Added:  <li><code><a title="previous_posts_link" href="http:// codex.wordpress.org/Function_ Reference/previous_posts_link" target="_blank" >previous_posts_links</a> </code></li>
+Added:  <li><code><a title="next_posts_link" href="http:// codex.wordpress.org/Function_ Reference/next_posts_link" target="_blank" >next_posts_links< /a></code></li>
+Added: </ul>
+Added: Were not working as expected.
+Added: Ultimately, it required me passing a little bit more information to the query’s arguments array and to the pagination link functions. Here’s how you can setup WP_Query Pagination to work properly in custom queries.
+Added: &nbsp;
+Added: <h2>A Few Assumptions</h2>
+Added: There are two assumptions that I’m making about your setup:
+Added: <ol>
+Added:  <li>You’re using pretty permalinks. That is, your permalink structure includes something like <code>/ %postname%/</code>.</li>
+Added:  <li>You’re familiar with <code><a title="get_query_var" href="http:// codex.wordpress.org/Function_ Reference/get_query_var" target="_blank" >get_query_var</a></code>  specifically or pagination.</li>
+Added: </ol>
+Added: Assuming that you’re familiar with both of these, you should be good to go from defining your custom queries and for getting pagination to work correctly without any custom helper functions and by using the native WordPress API.
+Added: <h2>A Working Example</h2>
+Added: <h3>Defining The Query</h3>
+Added: Let’s assume that we’re just going to be pulling back a set of records for a custom post type called goals. First, we need to define the arguments for the query.
+Added: Personally, I think that defining the arguments in an array and then passing the array to the<code>WP_Query< /code> class makes for more readable, manageable code, but that’s<em>completely < /em>subjective.
+Added: [php]
+Added: &amp;nbsp;
+Added: // First, get a reference to the current author of the posts in this listing
+Added: $current_author = ( isset($_GET['author_name'] ) ) ? get_user_by( 'slug', $author_name ) : get_userdata( intval( $author ) );
+Added: // Next, define a way to get the current offset
+Added: function example_get_offset() {
+Added:  $number = 10;
+Added:  $page = get_query_var( 'paged' ) ? get_query_var( 'paged' ) : 1
+Added:  return 1 == $page ? ( $page - 1 ) : ( ( $page - 1 ) * $number );
+Added: } // end example_get_offset
+Added: // After that, set the arguments for the query
+Added: $args = array(
+Added:  'post_type' =&gt; array( 'goal' ),
+Added:  'orderby' =&gt; 'date',
+Added:  'order' =&gt; 'desc',
+Added:  'posts_per_page' =&gt; 10,
+Added:  'offset' =&gt; example_get_offset(),
+Added:  'paged' =&gt; get_query_var( 'page' ) ? get_query_var( 'page' ) : 1,
+Added:  'author' =&gt; $current_author-&gt;ID
-Deleted:
+Added: );
+Added: // Finally, instantiate the query
+Added: $query = new WP_Query( $args );
+Added: [/php]
+Added: The code comments should be relatively clear; however, there are two main arguments in the <code>$args< /code> array that are worth noting:
+Added: <ol>
+Added:  <li><code>posts_ per_page</code>. This is somewhat of an arbitrary value, but this simply tells WordPress how many posts you want to pull back for a given page.</li>
+Added:  <li><code>paged</code>. This parameter is what will give the pagination API functions their power. Above, we’re looking to see if the query variable exists. If so, we’ll use that value; otherwise, we’ll initialize it to one. The sublte nuance here is that the key is <code>paged</code>but the <code>get_ query_var</code> parameter is <code>page</code>. Don’t miss that.</li>
+Added: </ol>
+Added: Finally, you may note that we’re pulling back all of those posts for the current author.
+Added: <h3>Setting The Pagination Links</h3>
+Added: Next, it’s time to setup the pagination links. For standard queries, we’re typically used to seeing something like this:
+Added: [php]
+Added: &lt;div id=&quot;pagination&quot;&gt;
+Added:  &lt;ul class=&quot;pagination&quot;&gt;
+Added:  &lt;li id=&quot;previous- stories&quot; class=&quot;arrow&quot;&gt;
+Added:  &lt;?php previous_posts_link(); ?&gt;
+Added:  &lt;/li&gt;
+Added:  &lt;li id=&quot;next- stories&quot; class=&quot;arrow&quot;&gt;
+Added:  &lt;?php next_posts_link(); ?&gt;
+Added:  &lt;/li&gt;
+Added:  &lt;/ul&gt;
+Added: &lt;/div&gt;&lt;!-- /#pagination --&gt;
+Added: [/php]
+Added: But that won’t actually work because of the custom query that we’ve defined above. Here’s what you need to do to take advantage of a custom setup with WP_Query Paging.
+Added: <h3>Using WP_Query Paging with Custom Queries</h3>
+Added: Notice that the API for both the <a title="next_posts_link" href="http:// codex.wordpress.org/Function_ Reference/next_posts_link" target="_blank" >next_posts_link< /a> and <a title="previous_posts_link" href="http:// codex.wordpress.org/Function_ Reference/previous_posts_link" target="_blank" >previous_posts_ link</a> functions accept two parameters:
+Added: <ol>
+Added: <ol>
+Added:  <li>The label for the link</li>
+Added:  <li>The maximum number of pages that will be displayed</li>
+Added: </ol>
+Added: </ol>
+Added: As such, here’s one way you’d define the markup provided above:
+Added: [php]
+Added: &lt;div id=&quot;pagination&quot;&gt;
+Added:  &lt;ul class=&quot;pagination&quot;&gt;
+Added:  &lt;li id=&quot;previous- stories&quot; class=&quot;arrow&quot;&gt;
+Added:  &lt;?php previous_posts_link( '&lt;&lt; Previous Stories', $query-&gt;max_num_pages ); ?&gt;
+Added:  &lt;/li&gt;
+Added:  &lt;li id=&quot;next- stories&quot; class=&quot;arrow&quot;&gt;
+Added:  &lt;?php next_posts_link( 'Next Stories &gt;&gt;', $query-&gt;max_num_pages ); ?&gt;
+Added:  &lt;/li&gt;
+Added:  &lt;/ul&gt;
+Added: &lt;/div&gt;&lt;!-- /#pagination --&gt;
+Added: [/php]
+Added: This way, you’re telling WordPress the maximum number of pages that are being retrieved based on the results of the custom query that has been executed.
+Added: By doing this, you should have no problem setting up WP_Query Paging in your work.

Note: Spaces may be added to comparison text to allow better line wrapping.