vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-10-04 06:37:06 +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/class-wp-rest-response.php
-15
View File
@@ -20,7 +20,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* Links related to the response.
*
* @since 4.4.0
* @access protected
* @var array
*/
protected $links = array();
@@ -29,7 +28,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* The route that was to create the response.
*
* @since 4.4.0
* @access protected
* @var string
*/
protected $matched_route = '';
@@ -38,7 +36,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* The handler that was used to create the response.
*
* @since 4.4.0
* @access protected
* @var null|array
*/
protected $matched_handler = null;
@@ -49,7 +46,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* @internal The $rel parameter is first, as this looks nicer when sending multiple.
*
* @since 4.4.0
* @access public
*
* @link https://tools.ietf.org/html/rfc5988
* @link https://www.iana.org/assignments/link-relations/link-relations.xml
@@ -79,7 +75,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* Removes a link from the response.
*
* @since 4.4.0
* @access public
*
* @param string $rel Link relation. Either an IANA registered type, or an absolute URL.
* @param string $href Optional. Only remove links for the relation matching the given href.
@@ -110,7 +105,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* associative arrays.
*
* @since 4.4.0
* @access public
*
* @param array $links Map of link relation to list of links.
*/
@@ -131,7 +125,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* Retrieves links for the response.
*
* @since 4.4.0
* @access public
*
* @return array List of links.
*/
@@ -145,7 +138,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* @internal The $rel parameter is first, as this looks nicer when sending multiple.
*
* @since 4.4.0
* @access public
*
* @link https://tools.ietf.org/html/rfc5988
* @link https://www.iana.org/assignments/link-relations/link-relations.xml
@@ -171,7 +163,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* Retrieves the route that was used.
*
* @since 4.4.0
* @access public
*
* @return string The matched route.
*/
@@ -183,7 +174,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* Sets the route (regex for path) that caused the response.
*
* @since 4.4.0
* @access public
*
* @param string $route Route name.
*/
@@ -195,7 +185,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* Retrieves the handler that was used to generate the response.
*
* @since 4.4.0
* @access public
*
* @return null|array The handler that was used to create the response.
*/
@@ -207,7 +196,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* Retrieves the handler that was responsible for generating the response.
*
* @since 4.4.0
* @access public
*
* @param array $handler The matched handler.
*/
@@ -219,7 +207,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* Checks if the response is an error, i.e. >= 400 response code.
*
* @since 4.4.0
* @access public
*
* @return bool Whether the response is an error.
*/
@@ -231,7 +218,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* Retrieves a WP_Error object from the response.
*
* @since 4.4.0
* @access public
*
* @return WP_Error|null WP_Error or null on not an errored response.
*/
@@ -261,7 +247,6 @@ class WP_REST_Response extends WP_HTTP_Response {
* Retrieves the CURIEs (compact URIs) used for relations.
*
* @since 4.5.0
* @access public
*
* @return array Compact URIs.
*/