From 3ebeaffe80d31511a0de7f0aa37fb181d9832e82 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Tue, 6 Oct 2020 08:57:38 +0000 Subject: [PATCH] Docs: Synchronize descriptions of some query functions and their counterpart methods in `WP` and `WP_Query` classes: * `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 --- src/wp-includes/class-wp-query.php | 8 ++++---- src/wp-includes/class-wp.php | 6 +++--- src/wp-includes/query.php | 8 ++++---- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/wp-includes/class-wp-query.php b/src/wp-includes/class-wp-query.php index 051fee9c6b..ece28bf4fb 100644 --- a/src/wp-includes/class-wp-query.php +++ b/src/wp-includes/class-wp-query.php @@ -1721,7 +1721,7 @@ class WP_Query { } /** - * Retrieve query variable. + * Retrieves the value of a query variable. * * @since 1.5.0 * @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 * @@ -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 * 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 * diff --git a/src/wp-includes/class-wp.php b/src/wp-includes/class-wp.php index 23bc6c80af..08976d6d1b 100644 --- a/src/wp-includes/class-wp.php +++ b/src/wp-includes/class-wp.php @@ -83,7 +83,7 @@ class WP { 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 * @@ -107,7 +107,7 @@ class WP { } /** - * Set the value of a query variable. + * Sets the value of a query variable. * * @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 * filters and actions that can be used to further manipulate the result. diff --git a/src/wp-includes/query.php b/src/wp-includes/query.php index 071d81ff75..d4d297de8a 100644 --- a/src/wp-includes/query.php +++ b/src/wp-includes/query.php @@ -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 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(). * @@ -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(). * @@ -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 *