Make WordPress Core


Ignore:
Timestamp:
04/14/2022 07:06:12 AM (23 months ago)
Author:
audrasjb
Message:

Docs: Misc. Docblocks improvements in the Core User API.

See #54729.

File:
1 edited

Legend:

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

    r53178 r53179  
    113113
    114114/**
    115  * Authenticate a user, confirming the username and password are valid.
     115 * Authenticates a user, confirming the username and password are valid.
    116116 *
    117117 * @since 2.8.0
     
    159159
    160160    /**
    161      * Filters whether the given user can be authenticated with the provided $password.
     161     * Filters whether the given user can be authenticated with the provided password.
    162162     *
    163163     * @since 2.5.0
     
    262262
    263263/**
    264  * Authenticate the user using the WordPress auth cookie.
     264 * Authenticates the user using the WordPress auth cookie.
    265265 *
    266266 * @since 2.8.0
     
    386386
    387387    /*
    388      * Strip out anything non-alphanumeric. This is so passwords can be used with
     388     * Strips out anything non-alphanumeric. This is so passwords can be used with
    389389     * or without spaces to indicate the groupings for readability.
    390390     *
     
    483483
    484484/**
    485  * For Multisite blogs, check if the authenticated user has been marked as a
     485 * For Multisite blogs, checks if the authenticated user has been marked as a
    486486 * spammer, or if the user's primary blog has been marked as spam.
    487487 *
     
    538538
    539539/**
    540  * Number of posts user has written.
     540 * Gets the number of posts a user has written.
    541541 *
    542542 * @since 3.0.0
     
    575575
    576576/**
    577  * Number of posts written by a list of users.
     577 * Gets the number of posts written by a list of users.
    578578 *
    579579 * @since 3.0.0
     
    616616
    617617/**
    618  * Get the current user's ID
     618 * Gets the current user's ID.
    619619 *
    620620 * @since MU (3.0.0)
     
    631631
    632632/**
    633  * Retrieve user option that can be either per Site or per Network.
     633 * Retrieves user option that can be either per Site or per Network.
    634634 *
    635635 * If the user ID is not given, then the current user will be used instead. If
     
    689689
    690690/**
    691  * Update user option with global blog capability.
     691 * Updates user option with global blog capability.
    692692 *
    693693 * User options are just like user metadata except that they have support for
     
    720720
    721721/**
    722  * Delete user option with global blog capability.
     722 * Deletes user option with global blog capability.
    723723 *
    724724 * User options are just like user metadata except that they have support for
     
    746746
    747747/**
    748  * Retrieve list of users matching criteria.
     748 * Retrieves list of users matching criteria.
    749749 *
    750750 * @since 3.1.0
     
    767767
    768768/**
    769  * List all the users of the site, with several options available.
     769 * Lists all the users of the site, with several options available.
    770770 *
    771771 * @since 5.9.0
     
    887887
    888888/**
    889  * Get the sites a user belongs to.
     889 * Gets the sites a user belongs to.
    890890 *
    891891 * @since 3.0.0
     
    10191019
    10201020/**
    1021  * Find out whether a user is a member of a given blog.
     1021 * Finds out whether a user is a member of a given blog.
    10221022 *
    10231023 * @since MU (3.0.0)
     
    11011101
    11021102/**
    1103  * Remove metadata matching criteria from a user.
     1103 * Removes metadata matching criteria from a user.
    11041104 *
    11051105 * You can match based on the key, or key and value. Removing based on key and
     
    11231123
    11241124/**
    1125  * Retrieve user meta field for a user.
     1125 * Retrieves user meta field for a user.
    11261126 *
    11271127 * @since 3.0.0
     
    11451145
    11461146/**
    1147  * Update user meta field based on user ID.
     1147 * Updates user meta field based on user ID.
    11481148 *
    11491149 * Use the $prev_value parameter to differentiate between meta fields with the
     
    11711171
    11721172/**
    1173  * Count number of users who have each of the user roles.
     1173 * Counts number of users who have each of the user roles.
    11741174 *
    11751175 * Assumes there are neither duplicated nor orphaned capabilities meta_values.
     
    14551455
    14561456/**
    1457  * Set up global user vars.
     1457 * Sets up global user vars.
    14581458 *
    14591459 * Used by wp_set_current_user() for back compat. Might be deprecated in the future.
     
    15001500
    15011501/**
    1502  * Create dropdown HTML content of users.
     1502 * Creates dropdown HTML content of users.
    15031503 *
    15041504 * The content can either be displayed, which it is by default or retrieved by
     
    17101710
    17111711/**
    1712  * Sanitize user field based on context.
     1712 * Sanitizes user field based on context.
    17131713 *
    17141714 * Possible context values are:  'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
     
    18281828
    18291829/**
    1830  * Update all user caches
     1830 * Updates all user caches.
    18311831 *
    18321832 * @since 3.0.0
     
    18511851
    18521852/**
    1853  * Clean all user caches
     1853 * Cleans all user caches.
    18541854 *
    18551855 * @since 3.0.0
     
    19841984
    19851985/**
    1986  * Insert a user into the database.
     1986 * Inserts a user into the database.
    19871987 *
    19881988 * Most of the `$userdata` array fields have filters associated with the values. Exceptions are
     
    24702470
    24712471/**
    2472  * Update a user in the database.
     2472 * Updates a user in the database.
    24732473 *
    24742474 * It is possible to update a user's password by specifying the 'user_pass'
     
    27102710
    27112711/**
    2712  * A simpler way of inserting a user into the database.
     2712 * Provides a simpler way of inserting a user into the database.
    27132713 *
    27142714 * Creates a new user with just the username, password, and email. For more
     
    27522752
    27532753/**
    2754  * Set up the user contact methods.
     2754 * Sets up the user contact methods.
    27552755 *
    27562756 * Default contact methods were removed in 3.6. A filter dictates contact methods.
     
    29122912
    29132913/**
    2914  * Retrieves a user row based on password reset key and login
     2914 * Retrieves a user row based on password reset key and login.
    29152915 *
    29162916 * A key is considered 'expired' if it exactly matches the value of the
     
    34203420
    34213421/**
    3422  * Retrieve the current session token from the logged_in cookie.
     3422 * Retrieves the current session token from the logged_in cookie.
    34233423 *
    34243424 * @since 4.0.0
     
    34323432
    34333433/**
    3434  * Retrieve a list of sessions for the current user.
     3434 * Retrieves a list of sessions for the current user.
    34353435 *
    34363436 * @since 4.0.0
     
    34443444
    34453445/**
    3446  * Remove the current session token from the database.
     3446 * Removes the current session token from the database.
    34473447 *
    34483448 * @since 4.0.0
     
    34573457
    34583458/**
    3459  * Remove all but the current session token for the current user for the database.
     3459 * Removes all but the current session token for the current user for the database.
    34603460 *
    34613461 * @since 4.0.0
     
    34703470
    34713471/**
    3472  * Remove all session tokens for the current user from the database.
     3472 * Removes all session tokens for the current user from the database.
    34733473 *
    34743474 * @since 4.0.0
     
    34803480
    34813481/**
    3482  * Get the user IDs of all users with no role on this site.
     3482 * Gets the user IDs of all users with no role on this site.
    34833483 *
    34843484 * @since 4.4.0
     
    35933593
    35943594/**
    3595  * Send a confirmation request email when a change of user email address is attempted.
     3595 * Sends a confirmation request email when a change of user email address is attempted.
    35963596 *
    35973597 * @since 3.0.0
     
    37243724
    37253725/**
    3726  * Get all personal data request types.
     3726 * Gets all personal data request types.
    37273727 *
    37283728 * @since 4.9.6
     
    38303830
    38313831    /**
    3832      * Filter to extend the user's profile data for the privacy exporter.
     3832     * Filters the user's profile data for the privacy exporter.
    38333833     *
    38343834     * @since 5.4.0
     
    39543954
    39553955/**
    3956  * Update log when privacy request is confirmed.
     3956 * Updates log when privacy request is confirmed.
    39573957 *
    39583958 * @since 4.9.6
     
    39823982
    39833983/**
    3984  * Notify the site administrator via email when a request is confirmed.
     3984 * Notifies the site administrator via email when a request is confirmed.
    39853985 *
    39863986 * Without this, the admin would have to manually check the site to see if any
     
    41954195
    41964196/**
    4197  * Notify the user when their erasure request is fulfilled.
     4197 * Notifies the user when their erasure request is fulfilled.
    41984198 *
    41994199 * Without this, the user would never know if their data was actually erased.
     
    44684468
    44694469/**
    4470  * Return request confirmation message HTML.
     4470 * Returns request confirmation message HTML.
    44714471 *
    44724472 * @since 4.9.6
     
    45064506
    45074507/**
    4508  * Create and log a user request to perform a specific action.
     4508 * Creates and logs a user request to perform a specific action.
    45094509 *
    45104510 * Requests are stored inside a post type named `user_request` since they can apply to both
     
    45774577
    45784578/**
    4579  * Get action description from the name and return a string.
     4579 * Gets action description from the name and return a string.
    45804580 *
    45814581 * @since 4.9.6
     
    47954795
    47964796/**
    4797  * Validate a user request by comparing the key with the request's key.
     4797 * Validates a user request by comparing the key with the request's key.
    47984798 *
    47994799 * @since 4.9.6
     
    48504850
    48514851/**
    4852  * Return the user request object for the specified request ID.
     4852 * Returns the user request object for the specified request ID.
    48534853 *
    48544854 * @since 4.9.6
Note: See TracChangeset for help on using the changeset viewer.