Changeset 53179
- Timestamp:
- 04/14/2022 07:06:12 AM (2 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/wp-includes/user.php
r53178 r53179 113 113 114 114 /** 115 * Authenticate a user, confirming the username and password are valid.115 * Authenticates a user, confirming the username and password are valid. 116 116 * 117 117 * @since 2.8.0 … … 159 159 160 160 /** 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. 162 162 * 163 163 * @since 2.5.0 … … 262 262 263 263 /** 264 * Authenticate the user using the WordPress auth cookie.264 * Authenticates the user using the WordPress auth cookie. 265 265 * 266 266 * @since 2.8.0 … … 386 386 387 387 /* 388 * Strip out anything non-alphanumeric. This is so passwords can be used with388 * Strips out anything non-alphanumeric. This is so passwords can be used with 389 389 * or without spaces to indicate the groupings for readability. 390 390 * … … 483 483 484 484 /** 485 * For Multisite blogs, check if the authenticated user has been marked as a485 * For Multisite blogs, checks if the authenticated user has been marked as a 486 486 * spammer, or if the user's primary blog has been marked as spam. 487 487 * … … 538 538 539 539 /** 540 * Number of postsuser has written.540 * Gets the number of posts a user has written. 541 541 * 542 542 * @since 3.0.0 … … 575 575 576 576 /** 577 * Number of posts written by a list of users.577 * Gets the number of posts written by a list of users. 578 578 * 579 579 * @since 3.0.0 … … 616 616 617 617 /** 618 * Get the current user's ID618 * Gets the current user's ID. 619 619 * 620 620 * @since MU (3.0.0) … … 631 631 632 632 /** 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. 634 634 * 635 635 * If the user ID is not given, then the current user will be used instead. If … … 689 689 690 690 /** 691 * Update user option with global blog capability.691 * Updates user option with global blog capability. 692 692 * 693 693 * User options are just like user metadata except that they have support for … … 720 720 721 721 /** 722 * Delete user option with global blog capability.722 * Deletes user option with global blog capability. 723 723 * 724 724 * User options are just like user metadata except that they have support for … … 746 746 747 747 /** 748 * Retrieve list of users matching criteria.748 * Retrieves list of users matching criteria. 749 749 * 750 750 * @since 3.1.0 … … 767 767 768 768 /** 769 * List all the users of the site, with several options available.769 * Lists all the users of the site, with several options available. 770 770 * 771 771 * @since 5.9.0 … … 887 887 888 888 /** 889 * Get the sites a user belongs to.889 * Gets the sites a user belongs to. 890 890 * 891 891 * @since 3.0.0 … … 1019 1019 1020 1020 /** 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. 1022 1022 * 1023 1023 * @since MU (3.0.0) … … 1101 1101 1102 1102 /** 1103 * Remove metadata matching criteria from a user.1103 * Removes metadata matching criteria from a user. 1104 1104 * 1105 1105 * You can match based on the key, or key and value. Removing based on key and … … 1123 1123 1124 1124 /** 1125 * Retrieve user meta field for a user.1125 * Retrieves user meta field for a user. 1126 1126 * 1127 1127 * @since 3.0.0 … … 1145 1145 1146 1146 /** 1147 * Update user meta field based on user ID.1147 * Updates user meta field based on user ID. 1148 1148 * 1149 1149 * Use the $prev_value parameter to differentiate between meta fields with the … … 1171 1171 1172 1172 /** 1173 * Count number of users who have each of the user roles.1173 * Counts number of users who have each of the user roles. 1174 1174 * 1175 1175 * Assumes there are neither duplicated nor orphaned capabilities meta_values. … … 1455 1455 1456 1456 /** 1457 * Set up global user vars.1457 * Sets up global user vars. 1458 1458 * 1459 1459 * Used by wp_set_current_user() for back compat. Might be deprecated in the future. … … 1500 1500 1501 1501 /** 1502 * Create dropdown HTML content of users.1502 * Creates dropdown HTML content of users. 1503 1503 * 1504 1504 * The content can either be displayed, which it is by default or retrieved by … … 1710 1710 1711 1711 /** 1712 * Sanitize user field based on context.1712 * Sanitizes user field based on context. 1713 1713 * 1714 1714 * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The … … 1828 1828 1829 1829 /** 1830 * Update all user caches1830 * Updates all user caches. 1831 1831 * 1832 1832 * @since 3.0.0 … … 1851 1851 1852 1852 /** 1853 * Clean all user caches1853 * Cleans all user caches. 1854 1854 * 1855 1855 * @since 3.0.0 … … 1984 1984 1985 1985 /** 1986 * Insert a user into the database.1986 * Inserts a user into the database. 1987 1987 * 1988 1988 * Most of the `$userdata` array fields have filters associated with the values. Exceptions are … … 2470 2470 2471 2471 /** 2472 * Update a user in the database.2472 * Updates a user in the database. 2473 2473 * 2474 2474 * It is possible to update a user's password by specifying the 'user_pass' … … 2710 2710 2711 2711 /** 2712 * Asimpler way of inserting a user into the database.2712 * Provides a simpler way of inserting a user into the database. 2713 2713 * 2714 2714 * Creates a new user with just the username, password, and email. For more … … 2752 2752 2753 2753 /** 2754 * Set up the user contact methods.2754 * Sets up the user contact methods. 2755 2755 * 2756 2756 * Default contact methods were removed in 3.6. A filter dictates contact methods. … … 2912 2912 2913 2913 /** 2914 * Retrieves a user row based on password reset key and login 2914 * Retrieves a user row based on password reset key and login. 2915 2915 * 2916 2916 * A key is considered 'expired' if it exactly matches the value of the … … 3420 3420 3421 3421 /** 3422 * Retrieve the current session token from the logged_in cookie.3422 * Retrieves the current session token from the logged_in cookie. 3423 3423 * 3424 3424 * @since 4.0.0 … … 3432 3432 3433 3433 /** 3434 * Retrieve a list of sessions for the current user.3434 * Retrieves a list of sessions for the current user. 3435 3435 * 3436 3436 * @since 4.0.0 … … 3444 3444 3445 3445 /** 3446 * Remove the current session token from the database.3446 * Removes the current session token from the database. 3447 3447 * 3448 3448 * @since 4.0.0 … … 3457 3457 3458 3458 /** 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. 3460 3460 * 3461 3461 * @since 4.0.0 … … 3470 3470 3471 3471 /** 3472 * Remove all session tokens for the current user from the database.3472 * Removes all session tokens for the current user from the database. 3473 3473 * 3474 3474 * @since 4.0.0 … … 3480 3480 3481 3481 /** 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. 3483 3483 * 3484 3484 * @since 4.4.0 … … 3593 3593 3594 3594 /** 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. 3596 3596 * 3597 3597 * @since 3.0.0 … … 3724 3724 3725 3725 /** 3726 * Get all personal data request types.3726 * Gets all personal data request types. 3727 3727 * 3728 3728 * @since 4.9.6 … … 3830 3830 3831 3831 /** 3832 * Filter to extendthe user's profile data for the privacy exporter.3832 * Filters the user's profile data for the privacy exporter. 3833 3833 * 3834 3834 * @since 5.4.0 … … 3954 3954 3955 3955 /** 3956 * Update log when privacy request is confirmed.3956 * Updates log when privacy request is confirmed. 3957 3957 * 3958 3958 * @since 4.9.6 … … 3982 3982 3983 3983 /** 3984 * Notif ythe site administrator via email when a request is confirmed.3984 * Notifies the site administrator via email when a request is confirmed. 3985 3985 * 3986 3986 * Without this, the admin would have to manually check the site to see if any … … 4195 4195 4196 4196 /** 4197 * Notif ythe user when their erasure request is fulfilled.4197 * Notifies the user when their erasure request is fulfilled. 4198 4198 * 4199 4199 * Without this, the user would never know if their data was actually erased. … … 4468 4468 4469 4469 /** 4470 * Return request confirmation message HTML.4470 * Returns request confirmation message HTML. 4471 4471 * 4472 4472 * @since 4.9.6 … … 4506 4506 4507 4507 /** 4508 * Create and loga user request to perform a specific action.4508 * Creates and logs a user request to perform a specific action. 4509 4509 * 4510 4510 * Requests are stored inside a post type named `user_request` since they can apply to both … … 4577 4577 4578 4578 /** 4579 * Get action description from the name and return a string.4579 * Gets action description from the name and return a string. 4580 4580 * 4581 4581 * @since 4.9.6 … … 4795 4795 4796 4796 /** 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. 4798 4798 * 4799 4799 * @since 4.9.6 … … 4850 4850 4851 4851 /** 4852 * Return the user request object for the specified request ID.4852 * Returns the user request object for the specified request ID. 4853 4853 * 4854 4854 * @since 4.9.6
Note: See TracChangeset
for help on using the changeset viewer.