Docs for page query.php

/ptests/samples/omitted/query.php

Description

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: More information on The Loop.

Classes

Class	Description
WP_Query	The WordPress Query class.

Functions

get_queried_object (line 41)

Retrieve the currently-queried object. Wrapper for $wp_query->get_queried_object()

since: 3.1.0
access: public
uses: WP_Query::get_queried_object

object get_queried_object ()

get_queried_object_id (line 56)

Retrieve ID of the current queried object. Wrapper for $wp_query->get_queried_object_id()

since: 3.1.0
access: public
uses: WP_Query::get_queried_object_id()

int get_queried_object_id ()

get_query_var (line 24)

Retrieve variable in the WP_Query class.

see: WP_Query::get()
since: 1.5.0
uses: $wp_query

mixed get_query_var (string $var)

string $var: The variable key to retrieve.

have_comments (line 792)

Whether there are comments to loop over.

see: WP_Query::have_comments()
since: 2.2.0
uses: $wp_query

bool have_comments ()

have_posts (line 731)

Whether current WordPress query has results to loop over.

see: WP_Query::have_posts()
since: 1.5.0
uses: $wp_query

bool have_posts ()

in_the_loop (line 745)

Whether the caller is in the Loop.

return: True if caller is within loop, false if loop hasn't started or ended.
since: 2.0.0
uses: $wp_query

bool in_the_loop ()

is_404 (line 707)

Is the query a 404 (returns no results)?

see: WP_Query::is_404()
since: 1.5.0
uses: $wp_query

bool is_404 ()

is_archive (line 142)

Is the query for an archive page?

Month, Year, Category, Author, Post Type archive...

see: WP_Query::is_archive()
since: 1.5.0
uses: $wp_query

bool is_archive ()

is_attachment (line 183)

Is the query for an attachment page?

see: WP_Query::is_attachment()
since: 2.0.0
uses: $wp_query

bool is_attachment ()

is_author (line 207)

Is the query for an author archive page?

If the $author parameter is specified, this function will additionally check if the query is for one of the authors specified.

see: WP_Query::is_author()
since: 1.5.0
uses: $wp_query

bool is_author ([mixed $author = ''])

mixed $author: Optional. User ID, nickname, nicename, or array of User IDs, nicknames, and nicenames

is_category (line 231)

Is the query for a category archive page?

If the $category parameter is specified, this function will additionally check if the query is for one of the categories specified.

see: WP_Query::is_category()
since: 1.5.0
uses: $wp_query

bool is_category ([mixed $category = ''])

mixed $category: Optional. Category ID, name, slug, or array of Category IDs, names, and slugs.

is_comments_popup (line 304)

Whether the current URL is within the comments popup window.

see: WP_Query::is_comments_popup()
since: 1.5.0
uses: $wp_query

bool is_comments_popup ()

is_comment_feed (line 385)

Is the query for a comments feed?

see: WP_Query::is_comments_feed()
since: 3.0.0
uses: $wp_query

bool is_comment_feed ()

is_date (line 324)

Is the query for a date archive?

see: WP_Query::is_date()
since: 1.5.0
uses: $wp_query

bool is_date ()

is_day (line 344)

Is the query for a day archive?

see: WP_Query::is_day()
since: 1.5.0
uses: $wp_query

bool is_day ()

is_feed (line 365)

Is the query for a feed?

see: WP_Query::is_feed()
since: 1.5.0
uses: $wp_query

bool is_feed ([string|array $feeds = ''])

string|array $feeds: Optional feed types to check.

is_front_page (line 415)

Is the query for the front page of the site?

This is for what is displayed at your site's main URL.

Depends on the site's "Front page displays" Reading Settings 'show_on_front' and 'page_on_front'.

If you set a static page for the front page of your site, this function will return true when viewing that page.

Otherwise the same as @see is_home()

return: True, if front of site.
see: WP_Query::is_front_page()
since: 2.5.0
uses: is_home()
uses: get_option()

bool is_front_page ()

is_home (line 444)

Is the query for the blog homepage?

This is the page which shows the time based blog content of your site.

Depends on the site's "Front page displays" Reading Settings 'show_on_front' and 'page_for_posts'.

If you set a static page for the front page of your site, this function will return true only on the page you set as the "Posts page".

return: True if blog view homepage.
see: is_front_page()
see: WP_Query::is_home()
since: 1.5.0
uses: $wp_query

bool is_home ()

is_month (line 464)

Is the query for a month archive?

see: WP_Query::is_month()
since: 1.5.0
uses: $wp_query

bool is_month ()

is_page (line 491)

Is the query for a single page?

If the $page parameter is specified, this function will additionally check if the query is for one of the pages specified.

see: is_single()
see: WP_Query::is_page()
see: is_singular()
since: 1.5.0
uses: $wp_query

bool is_page ([mixed $page = ''])

mixed $page: Page ID, title, slug, or array of such.

is_paged (line 511)

Is the query for paged result and not for the first page?

see: WP_Query::is_paged()
since: 1.5.0
uses: $wp_query

bool is_paged ()

is_post_type_archive (line 163)

Is the query for a post type archive page?

see: WP_Query::is_post_type_archive()
since: 3.1.0
uses: $wp_query

bool is_post_type_archive ([mixed $post_types = ''])

mixed $post_types: Optional. Post type or array of posts types to check against.

is_preview (line 531)

Is the query for a post or page preview?

see: WP_Query::is_preview()
since: 2.0.0
uses: $wp_query

bool is_preview ()

is_robots (line 551)

Is the query for the robots file?

see: WP_Query::is_robots()
since: 2.1.0
uses: $wp_query

bool is_robots ()

is_search (line 571)

Is the query for a search?

see: WP_Query::is_search()
since: 1.5.0
uses: $wp_query

bool is_search ()

is_single (line 600)

Is the query for a single post?

Works for any post type, except attachments and pages

If the $post parameter is specified, this function will additionally check if the query is for one of the Posts specified.

see: is_page()
see: WP_Query::is_single()
see: is_singular()
since: 1.5.0
uses: $wp_query

bool is_single ([mixed $post = ''])

mixed $post: Post ID, title, slug, or array of such.

is_singular (line 627)

Is the query for a single post of any post type (post, attachment, page, ... )?

If the $post_types parameter is specified, this function will additionally check if the query is for one of the Posts Types specified.

see: is_page()
see: WP_Query::is_singular()
see: is_single()
since: 1.5.0
uses: $wp_query

bool is_singular ([mixed $post_types = ''])

mixed $post_types: Optional. Post Type or array of Post Types

is_tag (line 255)

Is the query for a tag archive page?

If the $tag parameter is specified, this function will additionally check if the query is for one of the tags specified.

see: WP_Query::is_tag()
since: 2.3.0
uses: $wp_query

bool is_tag ([mixed $slug = ''])

mixed $slug: Optional. Tag slug or array of slugs.

is_tax (line 284)

Is the query for a taxonomy archive page?

If the $taxonomy parameter is specified, this function will additionally check if the query is for that specific $taxonomy.

If the $term parameter is specified in addition to the $taxonomy parameter, this function will additionally check if the query is for one of the terms specified.

see: WP_Query::is_tax()
since: 2.5.0
uses: $wp_query

bool is_tax ([mixed $taxonomy = ''], [mixed $term = ''])

mixed $taxonomy: Optional. Taxonomy slug or slugs.
mixed $term: Optional. Term ID, name, slug or array of Term IDs, names, and slugs.

is_time (line 647)

Is the query for a specific time?

see: WP_Query::is_time()
since: 1.5.0
uses: $wp_query

bool is_time ()

is_trackback (line 667)

Is the query for a trackback endpoint call?

see: WP_Query::is_trackback()
since: 1.5.0
uses: $wp_query

bool is_trackback ()

is_year (line 687)

Is the query for a specific year?

see: WP_Query::is_year()
since: 1.5.0
uses: $wp_query

bool is_year ()

query_posts (line 90)

Set up 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.

return: List of posts
since: 1.5.0
uses: $wp_query

array &query_posts (string $query)

string $query

rewind_posts (line 760)

Rewind the loop posts.

see: WP_Query::rewind_posts()
since: 1.5.0
uses: $wp_query

null rewind_posts ()

setup_postdata (line 3541)

Set up global post data.

return: True when finished.
since: 1.5.0
uses: do_action_ref_array() - Calls 'the_post'

bool setup_postdata (object $post)

object $post: Post data.

set_query_var (line 72)

Set query variable.

see: WP_Query::set()
since: 2.2.0
uses: $wp_query

null set_query_var (string $var, mixed $value)

string $var: Query variable key.
mixed $value

the_comment (line 806)

Iterate comment index in the comment loop.

see: WP_Query::the_comment()
since: 2.2.0
uses: $wp_query

object the_comment ()

the_post (line 773)

Iterate the post index in the loop.

see: WP_Query::the_post()
since: 1.5.0
uses: $wp_query

void the_post ()

wp_old_slug_redirect (line 3483)

Redirect old slugs to the correct permalink.

Attempts to find the current slug from the past slugs.

return: If no link is found, null is returned.
since: 2.1.0
uses: $wp_query
uses: $wpdb

null wp_old_slug_redirect ()

wp_reset_postdata (line 119)

After looping through a separate query, this function restores the $post global to the current post in the main query

since: 3.0.0
uses: $wp_query

void wp_reset_postdata ()

wp_reset_query (line 106)

Destroy the previous query and set up a new query.

This should be used after query_posts() and before another query_posts(). This will remove obscure bugs that occur when the previous wp_query object is not destroyed properly before another is set up.

since: 2.3.0
uses: $wp_query

void wp_reset_query ()

Documentation generated on Thu, 29 Sep 2011 01:44:46 +0530 by phpDocumentor 1.4.3