vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-04-03 20:24:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Add missing description for $wp_query and $wp_the_query globals.

Browse Source 
Props mukesh27.
See #45604, #47110.

git-svn-id: https://develop.svn.wordpress.org/trunk@45739 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2019-08-04 01:58:03 +00:00
parent 5af994b4ed
commit d19f4d7ff4
20 changed files with 84 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
src/wp-includes/query.php
View File

@@ -17,7 +17,7 @@
* @since 1.5.0
* @since 3.9.0 The `$default` argument was introduced.
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param string $var The variable key to retrieve.
* @param mixed $default Optional. Value to return if the query variable is not set. Default empty.
@@ -35,7 +35,7 @@ function get_query_var( $var, $default = '' ) {
*
* @since 3.1.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return object Queried object.
*/
@@ -51,7 +51,7 @@ function get_queried_object() {
*
* @since 3.1.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return int ID of the queried object.
*/
@@ -65,7 +65,7 @@ function get_queried_object_id() {
*
* @since 2.2.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param string $var Query variable key.
* @param mixed $value Query variable value.
@@ -88,7 +88,7 @@ function set_query_var( $var, $value ) {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param array|string $query Array or string of WP_Query arguments.
* @return array List of post objects.
@@ -107,7 +107,7 @@ function query_posts( $query ) {
*
* @since 2.3.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
* @global WP_Query $wp_the_query Copy of the global WP_Query instance created during wp_reset_query().
*/
function wp_reset_query() {
@@ -121,7 +121,7 @@ function wp_reset_query() {
*
* @since 3.0.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*/
function wp_reset_postdata() {
global $wp_query;
@@ -146,7 +146,7 @@ function wp_reset_postdata() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -170,7 +170,7 @@ function is_archive() {
*
* @since 3.1.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param string|array $post_types Optional. Post type or array of posts types to check against.
* @return bool
@@ -195,7 +195,7 @@ function is_post_type_archive( $post_types = '' ) {
*
* @since 2.0.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param int|string|array|object $attachment Attachment ID, title, slug, or array of such.
* @return bool
@@ -223,7 +223,7 @@ function is_attachment( $attachment = '' ) {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param mixed $author Optional. User ID, nickname, nicename, or array of User IDs, nicknames, and nicenames
* @return bool
@@ -251,7 +251,7 @@ function is_author( $author = '' ) {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param mixed $category Optional. Category ID, name, slug, or array of Category IDs, names, and slugs.
* @return bool
@@ -279,7 +279,7 @@ function is_category( $category = '' ) {
*
* @since 2.3.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param mixed $tag Optional. Tag ID, name, slug, or array of Tag IDs, names, and slugs.
* @return bool
@@ -311,7 +311,7 @@ function is_tag( $tag = '' ) {
*
* @since 2.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param string|array $taxonomy Optional. Taxonomy slug or slugs.
* @param int|string|array $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs.
@@ -337,7 +337,7 @@ function is_tax( $taxonomy = '', $term = '' ) {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -363,7 +363,7 @@ function is_date() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -387,7 +387,7 @@ function is_day() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param string|array $feeds Optional feed types to check.
* @return bool
@@ -408,7 +408,7 @@ function is_feed( $feeds = '' ) {
*
* @since 3.0.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -441,7 +441,7 @@ function is_comment_feed() {
*
* @since 2.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool True, if front of site.
*/
@@ -474,7 +474,7 @@ function is_front_page() {
* @since 1.5.0
*
* @see is_front_page()
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool True if blog view homepage, otherwise false.
*/
@@ -504,7 +504,7 @@ function is_home() {
*
* @since 5.2.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -528,7 +528,7 @@ function is_privacy_policy() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -558,7 +558,7 @@ function is_month() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param int|string|array $page Optional. Page ID, title, slug, or array of such. Default empty.
* @return bool Whether the query is for an existing single page.
@@ -583,7 +583,7 @@ function is_page( $page = '' ) {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -607,7 +607,7 @@ function is_paged() {
*
* @since 2.0.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -627,7 +627,7 @@ function is_preview() {
*
* @since 2.1.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -651,7 +651,7 @@ function is_robots() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -683,7 +683,7 @@ function is_search() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param int|string|array $post Optional. Post ID, title, slug, or array of such. Default empty.
* @return bool Whether the query is for an existing single post.
@@ -715,7 +715,7 @@ function is_single( $post = '' ) {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param string|array $post_types Optional. Post type or array of post types. Default empty.
* @return bool Whether the query is for an existing single post of any of the given post types.
@@ -740,7 +740,7 @@ function is_singular( $post_types = '' ) {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -764,7 +764,7 @@ function is_time() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -788,7 +788,7 @@ function is_trackback() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -812,7 +812,7 @@ function is_year() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -832,7 +832,7 @@ function is_404() {
*
* @since 4.4.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool Whether we're in an embedded post or not.
*/
@@ -856,7 +856,7 @@ function is_embed() {
*
* @since 3.3.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -886,7 +886,7 @@ function is_main_query() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -904,7 +904,7 @@ function have_posts() {
*
* @since 2.0.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool True if caller is within loop, false if loop hasn't started or ended.
*/
@@ -918,7 +918,7 @@ function in_the_loop() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*/
function rewind_posts() {
global $wp_query;
@@ -930,7 +930,7 @@ function rewind_posts() {
*
* @since 1.5.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*/
function the_post() {
global $wp_query;
@@ -946,7 +946,7 @@ function the_post() {
*
* @since 2.2.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return bool
*/
@@ -960,7 +960,7 @@ function have_comments() {
*
* @since 2.2.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @return object
*/
@@ -1127,7 +1127,7 @@ function _find_post_by_old_date( $post_type ) {
* @since 1.5.0
* @since 4.4.0 Added the ability to pass a post ID to `$post`.
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param WP_Post|object|int $post WP_Post instance or Post ID/object.
* @return bool True when finished.
@@ -1147,7 +1147,7 @@ function setup_postdata( $post ) {
*
* @since 5.2.0
*
* @global WP_Query $wp_query Global WP_Query instance.
* @global WP_Query $wp_query WordPress Query object.
*
* @param WP_Post|object|int $post WP_Post instance or Post ID/object.
* @return array|bool Elements of post, or false on failure.