Skip to content

Commit

Permalink
Docs: Use third-person singular verbs for function descriptions in `W…
Browse files Browse the repository at this point in the history
…P_User_Query` Class, as per docs standards.

See #54729.


git-svn-id: https://develop.svn.wordpress.org/trunk@53256 602fd350-edb4-49c9-b593-d223f7449a82
  • Loading branch information
audrasjb committed Apr 25, 2022
1 parent bb76c79 commit 8b488cb
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions src/wp-includes/class-wp-user-query.php
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ public static function fill_query_vars( $args ) {
}

/**
* Prepare the query variables.
* Prepares the query variables.
*
* @since 3.1.0
* @since 4.1.0 Added the ability to order by the `include` value.
Expand Down Expand Up @@ -751,7 +751,7 @@ public function prepare_query( $query = array() ) {
}

/**
* Execute the query, with the current variables.
* Executes the query, with the current variables.
*
* @since 3.1.0
*
Expand Down Expand Up @@ -834,7 +834,7 @@ public function query() {
}

/**
* Retrieve query variable.
* Retrieves query variable.
*
* @since 3.5.0
*
Expand All @@ -850,7 +850,7 @@ public function get( $query_var ) {
}

/**
* Set query variable.
* Sets query variable.
*
* @since 3.5.0
*
Expand All @@ -862,7 +862,7 @@ public function set( $query_var, $value ) {
}

/**
* Used internally to generate an SQL string for searching across multiple columns
* Used internally to generate an SQL string for searching across multiple columns.
*
* @since 3.1.0
*
Expand Down Expand Up @@ -894,7 +894,7 @@ protected function get_search_sql( $string, $cols, $wild = false ) {
}

/**
* Return the list of users.
* Returns the list of users.
*
* @since 3.1.0
*
Expand All @@ -905,7 +905,7 @@ public function get_results() {
}

/**
* Return the total number of users for the current query.
* Returns the total number of users for the current query.
*
* @since 3.1.0
*
Expand All @@ -916,7 +916,7 @@ public function get_total() {
}

/**
* Parse and sanitize 'orderby' keys passed to the user query.
* Parses and sanitizes 'orderby' keys passed to the user query.
*
* @since 4.2.0
*
Expand Down Expand Up @@ -975,7 +975,7 @@ protected function parse_orderby( $orderby ) {
}

/**
* Parse an 'order' query variable and cast it to ASC or DESC as necessary.
* Parses an 'order' query variable and casts it to ASC or DESC as necessary.
*
* @since 4.2.0
*
Expand All @@ -995,7 +995,7 @@ protected function parse_order( $order ) {
}

/**
* Make private properties readable for backward compatibility.
* Makes private properties readable for backward compatibility.
*
* @since 4.0.0
*
Expand All @@ -1009,7 +1009,7 @@ public function __get( $name ) {
}

/**
* Make private properties settable for backward compatibility.
* Makes private properties settable for backward compatibility.
*
* @since 4.0.0
*
Expand All @@ -1024,7 +1024,7 @@ public function __set( $name, $value ) {
}

/**
* Make private properties checkable for backward compatibility.
* Makes private properties checkable for backward compatibility.
*
* @since 4.0.0
*
Expand All @@ -1038,7 +1038,7 @@ public function __isset( $name ) {
}

/**
* Make private properties un-settable for backward compatibility.
* Makes private properties un-settable for backward compatibility.
*
* @since 4.0.0
*
Expand All @@ -1051,7 +1051,7 @@ public function __unset( $name ) {
}

/**
* Make private/protected methods readable for backward compatibility.
* Makes private/protected methods readable for backward compatibility.
*
* @since 4.0.0
*
Expand Down

0 comments on commit 8b488cb

Please sign in to comment.