Changeset 52827

Timestamp:

03/07/2022 01:05:52 PM (15 months ago)

Author:

audrasjb

Message:

Docs: Use third-person singular verbs for function descriptions in wp-includes/class-wp-user.php.

Props azouamauriac.
See #54729.

File:

• trunk/src/wp-includes/class-wp-user.php (modified) (18 diffs)

trunk/src/wp-includes/class-wp-user.php

@@ -179 +179 @@
 
     /**
-     * Return only the main user fields
+     * Returns only the main user fields.
      *
      * @since 3.3.0
@@ -187 +187 @@
      *
      * @param string     $field The field to query against: 'id', 'ID', 'slug', 'email' or 'login'.
-     * @param string|int $value The field value
-     * @return object|false Raw user object
+     * @param string|int $value The field value.
+     * @return object|false Raw user object.
      */
     public static function get_data_by( $field, $value ) {
@@ -390 +390 @@
 
     /**
-     * Determine whether the user exists in the database.
+     * Determines whether the user exists in the database.
      *
      * @since 3.4.0
@@ -401 +401 @@
 
     /**
-     * Retrieve the value of a property or meta key.
+     * Retrieves the value of a property or meta key.
      *
      * Retrieves from the users and usermeta table.
@@ -415 +415 @@
 
     /**
-     * Determine whether a property or meta key is set
+     * Determines whether a property or meta key is set.
      *
      * Consults the users and usermeta tables.
@@ -421 +421 @@
      * @since 3.3.0
      *
-     * @param string $key Property
+     * @param string $key Property.
      * @return bool
      */
@@ -429 +429 @@
 
     /**
-     * Return an array representation.
+     * Returns an array representation.
      *
      * @since 3.5.0
@@ -456 +456 @@
 
     /**
-     * Set up capability object properties.
+     * Sets up capability object properties.
      *
      * Will set the value for the 'cap_key' property to current database table
@@ -530 +530 @@
 
     /**
-     * Add role to user.
+     * Adds role to user.
      *
      * Updates the user's meta data option with capabilities and roles.
@@ -564 +564 @@
 
     /**
-     * Remove role from user.
+     * Removes role from user.
      *
      * @since 2.0.0
@@ -592 +592 @@
 
     /**
-     * Set the role of the user.
+     * Sets the role of the user.
      *
      * This will remove the previous roles of the user and assign the user the
@@ -652 +652 @@
 
     /**
-     * Choose the maximum level the user has.
+     * Chooses the maximum level the user has.
      *
      * Will compare the level from the $item parameter against the $max
@@ -679 +679 @@
 
     /**
-     * Update the maximum user level for the user.
+     * Updates the maximum user level for the user.
      *
      * Updates the 'user_level' user metadata (includes prefix that is the
@@ -696 +696 @@
 
     /**
-     * Add capability and grant or deny access to capability.
+     * Adds capability and grant or deny access to capability.
      *
      * @since 2.0.0
@@ -711 +711 @@
 
     /**
-     * Remove capability from user.
+     * Removes capability from user.
      *
      * @since 2.0.0
@@ -728 +728 @@
 
     /**
-     * Remove all of the capabilities of the user.
+     * Removes all of the capabilities of the user.
      *
      * @since 2.1.0
@@ -825 +825 @@
 
     /**
-     * Convert numeric level to level capability name.
+     * Converts numeric level to level capability name.
      *
      * Prepends 'level_' to level number.
@@ -839 +839 @@
 
     /**
-     * Set the site to operate on. Defaults to the current site.
+     * Sets the site to operate on. Defaults to the current site.
      *
      * @since 3.0.0