vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-11 20:30:23 +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
src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php
-13
View File
@@ -21,7 +21,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* prepares for WP_Query.
*
* @since 4.7.0
* @access protected
*
* @param array $prepared_args Optional. Array of prepared arguments. Default empty array.
* @param WP_REST_Request $request Optional. Request to prepare items for.
@@ -59,7 +58,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* Checks if a given request has access to create an attachment.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|true Boolean true if the attachment may be created, or a WP_Error if not.
@@ -92,7 +90,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* Creates a single attachment.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response Response object on success, WP_Error object on failure.
@@ -200,7 +197,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* Updates a single attachment.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response Response object on success, WP_Error object on failure.
@@ -245,7 +241,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* Prepares a single attachment for create or update.
*
* @since 4.7.0
* @access public
*
* @param WP_REST_Request $request Request object.
* @return WP_Error|stdClass $prepared_attachment Post object.
@@ -282,7 +277,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* Prepares a single attachment output for response.
*
* @since 4.7.0
* @access public
*
* @param WP_Post $post Attachment object.
* @param WP_REST_Request $request Request object.
@@ -375,7 +369,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* Retrieves the attachment's schema, conforming to JSON Schema.
*
* @since 4.7.0
* @access public
*
* @return array Item schema as an array.
*/
@@ -481,7 +474,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* Handles an upload via raw POST data.
*
* @since 4.7.0
* @access protected
*
* @param array $data Supplied file data.
* @param array $headers HTTP headers from the request.
@@ -579,7 +571,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* ext-token = <the characters in token, followed by "*">
*
* @since 4.7.0
* @access public
*
* @link http://tools.ietf.org/html/rfc2388
* @link http://tools.ietf.org/html/rfc6266
@@ -632,7 +623,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* Retrieves the query params for collections of attachments.
*
* @since 4.7.0
* @access public
*
* @return array Query parameters for the attachment collection as an array.
*/
@@ -662,7 +652,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* Validates whether the user can query private statuses.
*
* @since 4.7.0
* @access public
*
* @param mixed $value Status value.
* @param WP_REST_Request $request Request object.
@@ -681,7 +670,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* Handles an upload via multipart/form-data ($_FILES).
*
* @since 4.7.0
* @access protected
*
* @param array $files Data from the `$_FILES` superglobal.
* @param array $headers HTTP headers from the request.
@@ -731,7 +719,6 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
* Media types are considered the MIME type category.
*
* @since 4.7.0
* @access protected
*
* @return array Array of supported media types.
*/