sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Synchronize descriptions of some query functions and their counterpart methods in WP and WP_Query classes:

Browse Source 
* `set_query_var()`
* `get_query_var()`
* `get_queried_object()`
* `get_queried_object_id()`

Switch to third-person singular verbs, per the documentation standards.

See #50768, #42783.

git-svn-id: https://develop.svn.wordpress.org/trunk@49095 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-10-06 08:57:38 +00:00
parent 34a9527acf
commit 3ebeaffe80
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/wp-includes/class-wp-query.php
View File

@ -1721,7 +1721,7 @@ class WP_Query {
} }
/** /**
* Retrieve query variable. * Retrieves the value of a query variable.
* *
* @since 1.5.0 * @since 1.5.0
* @since 3.9.0 The `$default` argument was introduced. * @since 3.9.0 The `$default` argument was introduced.
@ -1739,7 +1739,7 @@ class WP_Query {
} }
/** /**
* Set query variable. * Sets the value of a query variable.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -3449,7 +3449,7 @@ class WP_Query {
} }
/** /**
* Retrieve queried object. * Retrieves the currently queried object.
* *
* If queried object is not set, then the queried object will be set from * If queried object is not set, then the queried object will be set from
* the category, tag, taxonomy, posts page, single post, page, or author * the category, tag, taxonomy, posts page, single post, page, or author
@ -3527,7 +3527,7 @@ class WP_Query {
} }
/** /**
* Retrieve ID of the current queried object. * Retrieves the ID of the currently queried object.
* *
* @since 1.5.0 * @since 1.5.0
* *

6
src/wp-includes/class-wp.php
View File

@ -83,7 +83,7 @@ class WP {
public $did_permalink = false; public $did_permalink = false;
/** /**
* Add name to list of public query variables. * Adds a query variable to the list of public query variables.
* *
* @since 2.1.0 * @since 2.1.0
* *
@ -107,7 +107,7 @@ class WP {
} }
/** /**
* Set the value of a query variable. * Sets the value of a query variable.
* *
* @since 2.3.0 * @since 2.3.0
* *
@ -119,7 +119,7 @@ class WP {
} }
/** /**
* Parse request to find correct WordPress query. * Parses the request to find the correct WordPress query.
* *
* Sets up the query variables based on the request. There are also many * Sets up the query variables based on the request. There are also many
* filters and actions that can be used to further manipulate the result. * filters and actions that can be used to further manipulate the result.

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

@ -12,7 +12,7 @@
*/ */
/** /**
* Retrieve variable in the WP_Query class. * Retrieves the value of a query variable in the WP_Query class.
* *
* @since 1.5.0 * @since 1.5.0
* @since 3.9.0 The `$default` argument was introduced. * @since 3.9.0 The `$default` argument was introduced.
@ -29,7 +29,7 @@ function get_query_var( $var, $default = '' ) {
} }
/** /**
* Retrieve the currently-queried object. * Retrieves the currently queried object.
* *
* Wrapper for WP_Query::get_queried_object(). * Wrapper for WP_Query::get_queried_object().
* *
@ -45,7 +45,7 @@ function get_queried_object() {
} }
/** /**
* Retrieve ID of the current queried object. * Retrieves the ID of the currently queried object.
* *
* Wrapper for WP_Query::get_queried_object_id(). * Wrapper for WP_Query::get_queried_object_id().
* *
@ -61,7 +61,7 @@ function get_queried_object_id() {
} }
/** /**
* Set variable in the WP_Query class. * Sets the value of a query variable in the WP_Query class.
* *
* @since 2.2.0 * @since 2.2.0
* *