Make WordPress Core

Changeset 52827


Ignore:
Timestamp:
03/07/2022 01:05:52 PM (2 years 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-user.php

    r52823 r52827  
    179179
    180180    /**
    181      * Return only the main user fields
     181     * Returns only the main user fields.
    182182     *
    183183     * @since 3.3.0
     
    187187     *
    188188     * @param string     $field The field to query against: 'id', 'ID', 'slug', 'email' or 'login'.
    189      * @param string|int $value The field value
    190      * @return object|false Raw user object
     189     * @param string|int $value The field value.
     190     * @return object|false Raw user object.
    191191     */
    192192    public static function get_data_by( $field, $value ) {
     
    390390
    391391    /**
    392      * Determine whether the user exists in the database.
     392     * Determines whether the user exists in the database.
    393393     *
    394394     * @since 3.4.0
     
    401401
    402402    /**
    403      * Retrieve the value of a property or meta key.
     403     * Retrieves the value of a property or meta key.
    404404     *
    405405     * Retrieves from the users and usermeta table.
     
    415415
    416416    /**
    417      * Determine whether a property or meta key is set
     417     * Determines whether a property or meta key is set.
    418418     *
    419419     * Consults the users and usermeta tables.
     
    421421     * @since 3.3.0
    422422     *
    423      * @param string $key Property
     423     * @param string $key Property.
    424424     * @return bool
    425425     */
     
    429429
    430430    /**
    431      * Return an array representation.
     431     * Returns an array representation.
    432432     *
    433433     * @since 3.5.0
     
    456456
    457457    /**
    458      * Set up capability object properties.
     458     * Sets up capability object properties.
    459459     *
    460460     * Will set the value for the 'cap_key' property to current database table
     
    530530
    531531    /**
    532      * Add role to user.
     532     * Adds role to user.
    533533     *
    534534     * Updates the user's meta data option with capabilities and roles.
     
    564564
    565565    /**
    566      * Remove role from user.
     566     * Removes role from user.
    567567     *
    568568     * @since 2.0.0
     
    592592
    593593    /**
    594      * Set the role of the user.
     594     * Sets the role of the user.
    595595     *
    596596     * This will remove the previous roles of the user and assign the user the
     
    652652
    653653    /**
    654      * Choose the maximum level the user has.
     654     * Chooses the maximum level the user has.
    655655     *
    656656     * Will compare the level from the $item parameter against the $max
     
    679679
    680680    /**
    681      * Update the maximum user level for the user.
     681     * Updates the maximum user level for the user.
    682682     *
    683683     * Updates the 'user_level' user metadata (includes prefix that is the
     
    696696
    697697    /**
    698      * Add capability and grant or deny access to capability.
     698     * Adds capability and grant or deny access to capability.
    699699     *
    700700     * @since 2.0.0
     
    711711
    712712    /**
    713      * Remove capability from user.
     713     * Removes capability from user.
    714714     *
    715715     * @since 2.0.0
     
    728728
    729729    /**
    730      * Remove all of the capabilities of the user.
     730     * Removes all of the capabilities of the user.
    731731     *
    732732     * @since 2.1.0
     
    825825
    826826    /**
    827      * Convert numeric level to level capability name.
     827     * Converts numeric level to level capability name.
    828828     *
    829829     * Prepends 'level_' to level number.
     
    839839
    840840    /**
    841      * Set the site to operate on. Defaults to the current site.
     841     * Sets the site to operate on. Defaults to the current site.
    842842     *
    843843     * @since 3.0.0
Note: See TracChangeset for help on using the changeset viewer.