Custom query and global variables
 


WordPress-specific global variables are used throughout WordPress code for various reasons. Almost all data that WordPress generates can be found in a global variable.

Note that it's best to use the appropriate API functions when available, instead of modifying globals directly.

To access a global variable in your code, you first need to globalize the variable with global $variable;

Accessing other globals besides the ones listed below is not recommended.

Inside the Loop variables
While inside the loop, these globals are set, containing information about the current post being processed.
$post The whole post object.
$authordata (object) Returns an object with information about the author, set alongside the last $post. Object described in Function_Reference/get_userdata.
$currentday Day of the post.
$currentmonth Month of the post.
$page (int) The page of the post, as specified by the query var page.
$pages (int)The number of pages within a post, which are separated by elements.
$multipage (boolean)Returns true if the post has multiple pages, related to $page and $pages.
$more (boolean) Returns true if there are multiple pages in the post, related to $page and $pages.
$numpages (int) Returns the number of pages in the post, related to $page and $pages.

Browser Detection Booleans
These globals store data about which browser the user is on.
$is_iphone (boolean) iPhone Safari
$is_chrome (boolean) Google Chrome
$is_safari (boolean) Safari
$is_NS4 (boolean) Netscape 4
$is_opera (boolean) Opera
$is_macIE (boolean) Mac Internet Explorer
$is_winIE (boolean) Windows Internet Explorer
$is_gecko (boolean) FireFox
$is_lynx (boolean)
$is_IE (boolean) Internet Explorer

Web Server Detection Booleans
These globals store data about which web server WordPress is running on.
$is_apache (boolean) Apache HTTP Server
$is_IIS (boolean) Microsoft Internet Information Services (IIS)
$is_iis7 (boolean) Microsoft Internet Information Services (IIS) v7.x

Version Variables
$wp_version (string) The installed version of WordPress
$wp_db_version (int) The version number of the database
$tinymce_version (string) The installed version of TinyMCE
$manifest_version (string) The cache manifest version
$required_php_version (string) The version of PHP this install of WordPress requires
$required_mysql_version (string) The version of MySQL this install of WordPress requires

Misc
$wp_query (object) The global instance of the Class_Reference/WP_Query class.
$wp_rewrite (object) The global instance of the Class_Reference/WP_Rewrite class.
$wp (object) The global instance of the Class_Reference/WP class.
$wpdb (object) The global instance of the Class_Reference/wpdb class.
$wp_locale (object)
$pagenow (string) used in wp-admin
$allowedposttags (array)
$allowedtags (array)


Custom Queries
Plugins generally extend the functionality of WordPress by adding Hooks (Actions and Filters) that change the way WordPress behaves. But sometimes a plugin needs to go beyond basic hooks by doing a custom query, and it's not as simple as just adding one filter or action to WordPress. This article describes what custom queries are, and then explains how a plugin author can implement them.

Background Information
Definitions
In the context of this article, query refers to the database query that WordPress uses in the Loop to find the list of posts that are to be displayed on the screen ("database query" will be used in this article to refer to generic database queries). By default, the WordPress query searches for posts that belong on the currently-requested page, whether it is a single post, single static page, category archive, date archive, search results, feed, or the main list of blog posts; the query is limited to a certain maximum number of posts (set in the Options admin screens), and the posts are retrieved in reverse-date order (most recent post first). A plugin can use a custom query to override this behavior. Examples:

  • Display posts in a different order, such as alphabetically for a "glossary" category.
  • Override the default number of posts to be displayed on the page; for example, the glossary plugin might want to have a higher post limit when displaying the glossary category.
  • Exclude certain posts from certain pages; for example, posts from the glossary category might be excluded from the home page and archive pages, and appear only on their own category page.
  • Expand the default WordPress keyword search (which normally just searches in post title and content) to search in other fields, such as the city, state, and country fields of a geographical tagging plugin.
  • Allow custom URLs such as example.com/blog?geostate=oregon or example.com/blog/geostate/oregon to refer to the archive of posts tagged with the state of Oregon.

Default WordPress Behavior
Before you try to change the default behavior of queries in WordPress, it is important to understand what WordPress does by default. There is an overview of the process WordPress uses to build your blog pages, and what a plugin can do to modify this behavior, in Query Overview.

Implementing Custom Queries
Now we're ready to start actually doing some custom queries! This section of the article will use several examples to demonstrate how query modification can be implemented. We'll start with a simple example, and move on to more complex ones.

Display Order and Post Count Limit
For our first example, let's consider a glossary plugin that will let the site owner put posts in a specific "glossary" category (saved by the plugin in global variable $gloss_category). When someone is viewing the glossary category, we want to see the entries alphabetically rather than by date, and we want to see all the glossary entries, rather than the number chosen by the site owner in the options.

So, we need to modify the query in two ways:

  • Add a filter to the ORDER BY clause of query to change it to alphabetical order if we are viewing the glossary category. The name of the filter is 'posts_orderby', and it filters the text after the words ORDER BY in the SQL statement.
  • Add a filter to the LIMIT clause of the query to remove the limit. This filter is called 'post_limits', and it filters the SQL text for limits, including the LIMIT key word.

In both cases, the filter function will only make these modifications if we're viewing the glossary category (function is_category is used for that logic). So, here's what we need to do:

add_filter('posts_orderby', 'gloss_alphabetical' );
add_filter('post_limits', 'gloss_limits' );

function gloss_alphabetical( $orderby )
{
  global $gloss_category;

  if( is_category( $gloss_category )) {
 // alphabetical order by post title
 return "post_title ASC";
  }

  // not in glossary category, return default order by
  return $orderby;
}

function gloss_limits( $limits )
{
  global $gloss_category;

  if( is_category( $gloss_category )) {
 // remove limits
 return "";
  }

  // not in glossary category, return default limits
  return $limits;
}

Note: If you need to trigger the filter for an archive instead of a category, you need to also make sure that you are on the front end. Otherwise the filters will interfere with the entry listings and prevent the column sort order from working. In that case you need to modify the function conditionals like this:

 if( !is_admin() && is_archive( $your_archive ) ){ ... }

Category Exclusion
To continue with the glossary plugin, we also want to exclude glossary entries from appearing on certain screens (home, non-category archives) and feeds. To do this, we will add a 'pre_get_posts' action that will detect what type of screen was requested, and depending on the screen, exclude the glossary category. The entire WP_Query object is passed into this function "by reference", meaning that any changes you make to it inside the function will be made to the global query object. We'll also use the fact that in the query specification (which is stored in $wp_query->query_vars, see above), you can put a "-" sign before a category index number to exclude that category. So, here is the code:

add_action('pre_get_posts', 'gloss_remove_glossary_cat' );

function gloss_remove_glossary_cat( $wp_query ) {
    global $gloss_category; 

    // Figure out if we need to exclude glossary - exclude from
    // archives (except category archives), feeds, and home page
    if( is_home() || is_feed() || ( is_archive() && !is_category() )) {
        set_query_var('cat', '-' . $gloss_category);
        //which is merely the more elegant way to write:
        //$wp_query->set('cat', '-' . $gloss_category);
    }
}

Keyword Search in Plugin Table
For our next example, let's consider a geographical tagging plugin that tags each post with one or more cities, states, and countries. The plugin stores them in its own database table; we'll assume the table name is in global variable $geotag_table, and that it has fields geotag_post_id, geotag_city, geotag_state, geotag_country. For this example, the idea is that if someone does a keyword search (which normally searches the post title and post content), we also want to find posts where the keyword appears in the city, state, or country fields of our plugin's table.

So, we are going to need to modify the SQL query used to find posts in several ways (but only if we're on a search screen):

Join the plugin's table to the post table. This is done with the 'posts_join' filter, which acts on the SQL JOIN clause(s).
Expand the WHERE clause of the query to look in the plugin table fields. This is done with the 'posts_where' filter, and we'll use the idea that whatever WordPress did to search the post title field, we'll do the same thing with our custom table fields (rather than trying to duplicate WordPress's rather complex logic). WordPress adds clauses like this: (post_title LIKE 'xyz').
Add a GROUP BY clause to the query, so that, for instance, if a post is tagged with both Portland, Oregon, and Salem, Oregon, and the viewer searches on "Oregon", we won't end up returning the same post twice. This is done with the 'posts_groupby' filter, which acts on the text after the words GROUP BY in the SQL statement.

With those ideas in mind, here is the code:

add_filter('posts_join', 'geotag_search_join' );
add_filter('posts_where', 'geotag_search_where' );
add_filter('posts_groupby', 'geotag_search_groupby' );

function geotag_search_join( $join )
{
  global $geotag_table, $wpdb;

  if( is_search() ) {
$join .= " LEFT JOIN $geotag_table ON " .
   $wpdb->posts . ".ID = " . $geotag_table .
   ".geotag_post_id ";
  }

  return $join;
}

function geotag_search_where( $where )
{
  if( is_search() ) {
$where = preg_replace(
   "/\(\s*post_title\s+LIKE\s*(\'[^\']+\')\s*\)/",
   "(post_title LIKE $1) OR (geotag_city LIKE $1) OR (geotag_state LIKE $1) OR (geotag_country LIKE $1)", $where );
   }

  return $where;
}

function geotag_search_groupby( $groupby )
{
  global $wpdb;

  if( !is_search() ) {
return $groupby;
  }

  // we need to group on post ID

  $mygroupby = "{$wpdb->posts}.ID";

  if( preg_match( "/$mygroupby/", $groupby )) {
// grouping we need is already there
return $groupby;
  }

  if( !strlen(trim($groupby))) {
// groupby was empty, use ours
return $mygroupby;
  }

  // wasn't empty, append ours
  return $groupby . ", " . $mygroupby;
}

Custom Archives
To continue with the geo-tagging plugin from the last example, let's assume we want the plugin to enable custom permalinks of the form www.example.com/blog?geostate=oregon to tell WordPress to find posts whose state matches "oregon" and display them.

To get this to work, the plugin must do the following:

Ensure that when WordPress parses the URL, the state gets saved in the query variables; to do this, we have to add "geostate" to the list of query variables WordPress understands (query_vars filter). Here's how to do that:

add_filter('query_vars', 'geotag_queryvars' );

function geotag_queryvars( $qvars )
{
  $qvars[] = 'geostate';
  return $qvars;
}

Perform the appropriate query when the "geostate" query variable is set; this is similar to the custom queries discussed in the previous examples. The only difference is that instead of testing for is_search or something similar in posts_where and other database query filters, we'll instead test to see whether the "geostate" query variable has been detected. Here is the code to replace the if( is_search() ) statements in the examples above:

global $wp_query;
if( isset( $wp_query->query_vars['geostate'] )) {
   // modify the where/join/groupby similar to above examples
}

Our plugin could also generate the corresponding permalinks. For instance, the plugin might define the function geotags_list_states to determine which states exist in its geotag table (that we created earlier), and then return a list of states as links:

function geotags_list_states( $sep = ", " )
{
  global $geotag_table, $wpdb;

  // find list of states in DB
  $qry = "SELECT geotag_state FROM $geotag_table " .
  " GROUP BY geotag_state ORDER BY geotag_state";
  $states = $wpdb->get_results( $qry );

  // make list of links

  $before = '';
  $after = "
";
  $cur_sep = "";
  foreach( $states as $row ) {
$state = $row->state;

echo $cur_sep . $before . rawurlencode($state) . $mid .
 $state . $after;

// after the first time, we need separator
$cur_sep = $sep;
  }

}

Permalinks for Custom Archives
If the blog administrator has non-default permalinks enabled, we can further refine our previous custom archives example, and rewrite the URL example.com/blog?geostate=oregon as example.com/blog/geostate/oregon. WordPress's "rewrite rules" are used to tell WordPress how to interpret permalink-style URLs. (See Query Overview for more information on the rewrite process.)

In practice, there are two steps to defining a new rewrite rule : (1) "flush" the cached rewrite rules using the flush_rewrite_rules() or by going to settings > permalinks and clicking "save" from within the wp-admin. Both methods force WordPress to refresh the stored rewrite rules. (note: To save resources, one should avoid using the flush_rules any more than it is necessary) (2) use the generate_rewrite_rules action to add a new rule when they are calculated. Here's the sample "flush" code:

add_action('admin_init', 'flush_rewrite_rules');

The rule generation is slightly more complex. Basically, the rewrite rules array is an associative array with permalink URLs as regular expressions (regex) keys, and the corresponding non-permalink-style URLs as values. The following defines a rule that maps URLs like /geostate/oregon to a URL request like ?geostate=oregon :

add_action('generate_rewrite_rules', 'geotags_add_rewrite_rules');

function geotags_add_rewrite_rules( $wp_rewrite )
{
  $new_rules = array(
 'geostate/(.+)' => 'index.php?geostate=' .
   $wp_rewrite->preg_index(1) );

  /​/​ Add the new rewrite rule into the top of the global rules array
  $wp_rewrite->rules = $new_rules + $wp_rewrite->rules;
}