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

29
src/wp-includes/rest-api/class-wp-rest-server.php
View File

@@ -58,7 +58,6 @@ class WP_REST_Server {
* Namespaces registered to the server.
*
* @since 4.4.0
* @access protected
* @var array
*/
protected $namespaces = array();
@@ -67,7 +66,6 @@ class WP_REST_Server {
* Endpoints registered to the server.
*
* @since 4.4.0
* @access protected
* @var array
*/
protected $endpoints = array();
@@ -76,7 +74,6 @@ class WP_REST_Server {
* Options defined for the routes.
*
* @since 4.4.0
* @access protected
* @var array
*/
protected $route_options = array();
@@ -85,7 +82,6 @@ class WP_REST_Server {
* Instantiates the REST server.
*
* @since 4.4.0
* @access public
*/
public function __construct() {
$this->endpoints = array(
@@ -107,7 +103,6 @@ class WP_REST_Server {
* Checks the authentication headers if supplied.
*
* @since 4.4.0
* @access public
*
* @return WP_Error|null WP_Error indicates unsuccessful login, null indicates successful
* or no authentication provided
@@ -148,7 +143,6 @@ class WP_REST_Server {
* list in JSON rather than an object/map.
*
* @since 4.4.0
* @access protected
*
* @param WP_Error $error WP_Error instance.
* @return WP_REST_Response List of associative arrays with code and message keys.
@@ -191,7 +185,6 @@ class WP_REST_Server {
* a 'status' key, with the value being the HTTP status to send.
*
* @since 4.4.0
* @access protected
*
* @param string $code WP_Error-style code.
* @param string $message Human-readable message.
@@ -215,7 +208,6 @@ class WP_REST_Server {
* callback then outputs a JSON representation of the returned value.
*
* @since 4.4.0
* @access public
*
* @see WP_REST_Server::dispatch()
*
@@ -425,7 +417,6 @@ class WP_REST_Server {
* Converts a response to data to send.
*
* @since 4.4.0
* @access public
*
* @param WP_REST_Response $response Response object.
* @param bool $embed Whether links should be embedded.
@@ -463,7 +454,6 @@ class WP_REST_Server {
* direct output.
*
* @since 4.4.0
* @access public
* @static
*
* @param WP_REST_Response $response Response to extract links from.
@@ -497,7 +487,6 @@ class WP_REST_Server {
* direct output.
*
* @since 4.5.0
* @access public
* @static
*
* @param WP_REST_Response $response Response to extract links from.
@@ -547,7 +536,6 @@ class WP_REST_Server {
* Embeds the links from the data into the request.
*
* @since 4.4.0
* @access protected
*
* @param array $data Data from the request.
* @return array {
@@ -623,7 +611,6 @@ class WP_REST_Server {
* data instead.
*
* @since 4.4.0
* @access public
*
* @param WP_REST_Response $response Response object.
* @param bool $embed Whether links should be embedded.
@@ -654,7 +641,6 @@ class WP_REST_Server {
* Registers a route to the server.
*
* @since 4.4.0
* @access public
*
* @param string $namespace Namespace.
* @param string $route The REST route.
@@ -709,7 +695,6 @@ class WP_REST_Server {
* used as the delimiter with preg_match()
*
* @since 4.4.0
* @access public
*
* @return array `'/path/regex' => array( $callback, $bitmask )` or
* `'/path/regex' => array( array( $callback, $bitmask ), ...)`.
@@ -784,7 +769,6 @@ class WP_REST_Server {
* Retrieves namespaces registered on the server.
*
* @since 4.4.0
* @access public
*
* @return array List of registered namespaces.
*/
@@ -796,7 +780,6 @@ class WP_REST_Server {
* Retrieves specified options for a route.
*
* @since 4.4.0
* @access public
*
* @param string $route Route pattern to fetch options for.
* @return array|null Data as an associative array if found, or null if not found.
@@ -813,7 +796,6 @@ class WP_REST_Server {
* Matches the request to a callback and call it.
*
* @since 4.4.0
* @access public
*
* @param WP_REST_Request $request Request to attempt dispatching.
* @return WP_REST_Response Response returned by the callback.
@@ -993,7 +975,6 @@ class WP_REST_Server {
* "Encoding error: Maximum stack depth exceeded".
*
* @since 4.4.0
* @access protected
*
* @return bool|string Boolean false or string error message.
*/
@@ -1018,7 +999,6 @@ class WP_REST_Server {
* This endpoint describes the capabilities of the site.
*
* @since 4.4.0
* @access public
*
* @param array $request {
* Request.
@@ -1063,7 +1043,6 @@ class WP_REST_Server {
* Retrieves the index for a namespace.
*
* @since 4.4.0
* @access public
*
* @param WP_REST_Request $request REST request instance.
* @return WP_REST_Response|WP_Error WP_REST_Response instance if the index was found,
@@ -1106,7 +1085,6 @@ class WP_REST_Server {
* Retrieves the publicly-visible data for routes.
*
* @since 4.4.0
* @access public
*
* @param array $routes Routes to get data for.
* @param string $context Optional. Context for data. Accepts 'view' or 'help'. Default 'view'.
@@ -1151,7 +1129,6 @@ class WP_REST_Server {
* Retrieves publicly-visible data for the route.
*
* @since 4.4.0
* @access public
*
* @param string $route Route to get data for.
* @param array $callbacks Callbacks to convert to data.
@@ -1237,7 +1214,6 @@ class WP_REST_Server {
* Sends an HTTP status code.
*
* @since 4.4.0
* @access protected
*
* @param int $code HTTP status.
*/
@@ -1249,7 +1225,6 @@ class WP_REST_Server {
* Sends an HTTP header.
*
* @since 4.4.0
* @access public
*
* @param string $key Header key.
* @param string $value Header value.
@@ -1270,7 +1245,6 @@ class WP_REST_Server {
* Sends multiple HTTP headers.
*
* @since 4.4.0
* @access public
*
* @param array $headers Map of header name to header value.
*/
@@ -1284,7 +1258,6 @@ class WP_REST_Server {
* Removes an HTTP header from the current response.
*
* @since 4.8.0
* @access public
*
* @param string $key Header key.
*/
@@ -1308,7 +1281,6 @@ class WP_REST_Server {
* Retrieves the raw request entity (body).
*
* @since 4.4.0
* @access public
*
* @global string $HTTP_RAW_POST_DATA Raw post data.
*
@@ -1332,7 +1304,6 @@ class WP_REST_Server {
* Extracts headers from a PHP-style $_SERVER array.
*
* @since 4.4.0
* @access public
*
* @param array $server Associative array similar to `$_SERVER`.
* @return array Headers extracted from the input.