vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 22:30:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.

Browse Source 
Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.


git-svn-id: https://develop.svn.wordpress.org/trunk@41162 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes
2017-07-27 00:40:27 +00:00
parent 829139ba1a
commit b4d81bd654
135 changed files with 2 additions and 1906 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php
View File

@@ -20,7 +20,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Instance of a user meta fields object.
*
* @since 4.7.0
* @access protected
* @var WP_REST_User_Meta_Fields
*/
protected $meta;
@@ -29,7 +28,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Constructor.
*
* @since 4.7.0
* @access public
*/
public function __construct() {
$this->namespace = 'wp/v2';
@@ -42,7 +40,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Registers the routes for the objects of the controller.
*
* @since 4.7.0
* @access public
*
* @see register_rest_route()
*/
@@ -148,7 +145,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* The value can be an integer, 'false', false, or ''.
*
* @since 4.7.0
* @access public
*
* @param int|bool $value The value passed to the reassign parameter.
* @param WP_REST_Request $request Full details about the request.
@@ -172,7 +168,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Permissions check for getting all users.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has read access, otherwise WP_Error object.
@@ -198,7 +193,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Retrieves all users.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
@@ -357,7 +351,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Checks if a given request has access to read a user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has read access for the item, otherwise WP_Error object.
@@ -387,7 +380,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Retrieves a single user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
@@ -408,7 +400,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Retrieves the current user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
@@ -432,7 +423,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Checks if a given request has access create users.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has access to create items, WP_Error object otherwise.
@@ -450,7 +440,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Creates a single user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
@@ -559,7 +548,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Checks if a given request has access to update a user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has access to update the item, WP_Error object otherwise.
@@ -585,7 +573,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Updates a single user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
@@ -671,7 +658,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Checks if a given request has access to update the current user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has access to update the item, WP_Error object otherwise.
@@ -686,7 +672,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Updates the current user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
@@ -701,7 +686,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Checks if a given request has access delete a user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has access to delete the item, WP_Error object otherwise.
@@ -723,7 +707,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Deletes a single user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
@@ -787,7 +770,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Checks if a given request has access to delete the current user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has access to delete the item, WP_Error object otherwise.
@@ -802,7 +784,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Deletes the current user.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
@@ -817,7 +798,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Prepares a single user output for response.
*
* @since 4.7.0
* @access public
*
* @param WP_User $user User object.
* @param WP_REST_Request $request Request object.
@@ -927,7 +907,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Prepares links for the user request.
*
* @since 4.7.0
* @access protected
*
* @param WP_Post $user User object.
* @return array Links for the given user.
@@ -949,7 +928,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Prepares a single user for creation or update.
*
* @since 4.7.0
* @access protected
*
* @param WP_REST_Request $request Request object.
* @return object $prepared_user User object.
@@ -1029,7 +1007,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Determines if the current user is allowed to make the desired roles change.
*
* @since 4.7.0
* @access protected
*
* @param integer $user_id User ID.
* @param array $roles New user roles.
@@ -1080,7 +1057,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Performs a couple of checks like edit_user() in wp-admin/includes/user.php.
*
* @since 4.7.0
* @access public
*
* @param mixed $value The username submitted in the request.
* @param WP_REST_Request $request Full details about the request.
@@ -1110,7 +1086,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Performs a couple of checks like edit_user() in wp-admin/includes/user.php.
*
* @since 4.7.0
* @access public
*
* @param mixed $value The password submitted in the request.
* @param WP_REST_Request $request Full details about the request.
@@ -1135,7 +1110,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Retrieves the user's schema, conforming to JSON Schema.
*
* @since 4.7.0
* @access public
*
* @return array Item schema data.
*/
@@ -1303,7 +1277,6 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Retrieves the query params for collections.
*
* @since 4.7.0
* @access public
*
* @return array Collection parameters.
*/