<?php

/**

 * WordPress Query API

 *

 * The query API attempts to get which part of WordPress to the user is on. It

 * also provides functionality to getting URL query information.

 *

 * @link http://codex.wordpress.org/The_Loop More information on The Loop.

 *

 * @package WordPress

 * @subpackage Query

 */

/**

 * Retrieve variable in the WP_Query class.

 *

 * @see WP_Query::get()

 * @since 1.5.0

 * @uses $wp_query

 *

 * @param string $var The variable key to retrieve.

 * @return mixed

 */

function get_query_var($var) {

	global $wp_query;

	return $wp_query->get($var);

}

/**

 * Set query variable.

 *

 * @see WP_Query::set()

 * @since 2.2.0

 * @uses $wp_query

 *

 * @param string $var Query variable key.

 * @param mixed $value

 * @return null

 */

function set_query_var($var, $value) {

	global $wp_query;

	return $wp_query->set($var, $value);

}

/**

 * Setup The Loop with query parameters.

 *

 * This will override the current WordPress Loop and shouldn't be used more than

 * once. This must not be used within the WordPress Loop.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @param string $query

 * @return array List of posts

 */

function &query_posts($query) {

	unset($GLOBALS['wp_query']);

	$GLOBALS['wp_query'] =& new WP_Query();

	return $GLOBALS['wp_query']->query($query);

}

/**

 * Destroy the previous query and setup a new query.

 *

 * This should be used after {@link query_posts()} and before another {@link

 * query_posts()}. This will remove obscure bugs that occur when the previous

 * wp_query object is not destroyed properly before another is setup.

 *

 * @since 2.3.0

 * @uses $wp_query

 */

function wp_reset_query() {

	unset($GLOBALS['wp_query']);

	$GLOBALS['wp_query'] =& $GLOBALS['wp_the_query'];

	global $wp_query;

	if ( !empty($wp_query->post) ) {

		$GLOBALS['post'] = $wp_query->post;

		setup_postdata($wp_query->post);

	}

}

/*

 * Query type checks.

 */

/**

 * Whether the current request is in WordPress admin Panel

 *

 * Does not inform on whether the user is an admin! Use capability checks to

 * tell if the user should be accessing a section or not.

 *

 * @since 1.5.1

 *

 * @return bool True if inside WordPress administration pages.

 */

function is_admin () {

	if ( defined('WP_ADMIN') )

		return WP_ADMIN;

	return false;

}

/**

 * Is query requesting an archive page.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @return bool True if page is archive.

 */

function is_archive () {

	global $wp_query;

	return $wp_query->is_archive;

}

/**

 * Is query requesting an attachment page.

 *

 * @since 2.0.0

 * @uses $wp_query

 *

 * @return bool True if page is attachment.

 */

function is_attachment () {

	global $wp_query;

	return $wp_query->is_attachment;

}

/**

 * Is query requesting an author page.

 *

 * If the $author parameter is specified then the check will be expanded to

 * include whether the queried author matches the one given in the parameter.

 * You can match against integers and against strings.

 *

 * If matching against an integer, the ID should be used of the author for the

 * test. If the $author is an ID and matches the author page user ID, then

 * 'true' will be returned.

 *

 * If matching against strings, then the test will be matched against both the

 * nickname and user nicename and will return true on success.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @param string|int $author Optional. Is current page this author.

 * @return bool True if page is author or $author (if set).

 */

function is_author ($author = '') {

	global $wp_query;

	if ( !$wp_query->is_author )

		return false;

	if ( empty($author) )

		return true;

	$author_obj = $wp_query->get_queried_object();

	$author = (array) $author;

	if ( in_array( $author_obj->ID, $author ) )

		return true;

	elseif ( in_array( $author_obj->nickname, $author ) )

		return true;

	elseif ( in_array( $author_obj->user_nicename, $author ) )

		return true;

	return false;

}

/**

 * Whether current page query contains a category name or given category name.

 *

 * The category list can contain category IDs, names, or category slugs. If any

 * of them are part of the query, then it will return true.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @param string|array $category Optional.

 * @return bool

 */

function is_category ($category = '') {

	global $wp_query;

	if ( !$wp_query->is_category )

		return false;

	if ( empty($category) )

		return true;

	$cat_obj = $wp_query->get_queried_object();

	$category = (array) $category;

	if ( in_array( $cat_obj->term_id, $category ) )

		return true;

	elseif ( in_array( $cat_obj->name, $category ) )

		return true;

	elseif ( in_array( $cat_obj->slug, $category ) )

		return true;

	return false;

}

/**

 * Whether the current page query has the given tag slug or contains tag.

 *

 * @since 2.3.0

 * @uses $wp_query

 *

 * @param string|array $slug Optional. Single tag or list of tags to check for.

 * @return bool

 */

function is_tag( $slug = '' ) {

	global $wp_query;

	if ( !$wp_query->is_tag )

		return false;

	if ( empty( $slug ) )

		return true;

	$tag_obj = $wp_query->get_queried_object();

	$slug = (array) $slug;

	if ( in_array( $tag_obj->slug, $slug ) )

		return true;

	return false;

}

/**

 * Whether the current page query has the given taxonomy slug or contains taxonomy.

 *

 * @since 2.5.0

 * @uses $wp_query

 *

 * @param string|array $slug Optional. Slug or slugs to check in current query.

 * @return bool

 */

function is_tax( $slug = '' ) {

	global $wp_query;

	if ( !$wp_query->is_tax )

		return false;

	if ( empty($slug) )

		return true;

	$term = $wp_query->get_queried_object();

	$slug = (array) $slug;

	if ( in_array( $term->slug, $slug ) )

		return true;

	return false;

}

/**

 * Whether the current URL is within the comments popup window.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @return bool

 */

function is_comments_popup () {

	global $wp_query;

	return $wp_query->is_comments_popup;

}

/**

 * Whether current URL is based on a date.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @return bool

 */

function is_date () {

	global $wp_query;

	return $wp_query->is_date;

}

/**

 * Whether current blog URL contains a day.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @return bool

 */

function is_day () {

	global $wp_query;

	return $wp_query->is_day;

}

/**

 * Whether current page query is feed URL.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @return bool

 */

function is_feed () {

	global $wp_query;

	return $wp_query->is_feed;

}

/**

 * Whether current page query is the front of the site.

 *

 * @since 2.5.0

 * @uses is_home()

 * @uses get_option()

 *

 * @return bool True, if front of site.

 */

function is_front_page () {

	// most likely case

	if ( 'posts' == get_option('show_on_front') && is_home() )

		return true;

	elseif ( 'page' == get_option('show_on_front') && get_option('page_on_front') && is_page(get_option('page_on_front')) )

		return true;

	else

		return false;

}

/**

 * Whether current page view is the blog homepage.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @return bool True if blog view homepage.

 */

function is_home () {

	global $wp_query;

	return $wp_query->is_home;

}

/**

 * Whether current page query contains a month.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @return bool

 */

function is_month () {

	global $wp_query;

	return $wp_query->is_month;

}

/**

 * Whether query is page or contains given page(s).

 *

 * Calls the function without any parameters will only test whether the current

 * query is of the page type. Either a list or a single item can be tested

 * against for whether the query is a page and also is the value or one of the

 * values in the page parameter.

 *

 * The parameter can contain the page ID, page title, or page name. The

 * parameter can also be an array of those three values.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @param mixed $page Either page or list of pages to test against.

 * @return bool

 */

function is_page ($page = '') {

	global $wp_query;

	if ( !$wp_query->is_page )

		return false;

	if ( empty($page) )

		return true;

	$page_obj = $wp_query->get_queried_object();

	$page = (array) $page;

	if ( in_array( $page_obj->ID, $page ) )

		return true;

	elseif ( in_array( $page_obj->post_title, $page ) )

		return true;

	else if ( in_array( $page_obj->post_name, $page ) )

		return true;

	return false;

}

/**

 * Whether query contains multiple pages for the results.

 *

 * @since 1.5.0

 * @uses $wp_query

 *

 * @return bool

 */

function is_paged () {

	global $wp_query;

	return $wp_query->is_paged;

}

/**

 * Whether the current page was created by a plugin.

 *

 * The plugin can set this by using the global $plugin_page and setting it to

 * true.

 *

 * @since 1.5.0

 * @global bool $plugin_page Used by plugins to tell the query that current is a plugin page.

 *

 * @return bool

 */

function is_plugin_page() {

	global $plugin_page;

	if ( isset($plugin_page) )

		return true;

	return false;

}

/**

 * Whether the current query is preview of post or page.

 *

 * @since 2.0.0

 * @uses $wp_query

 *

 * @return bool

 */

function is_preview() {

	global $wp_query;

	return $wp_query->is_preview;

}

/**

 * Whether the current query post is robots.

 *

 * @since 2.1.0

 * @uses $wp_query

 *