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

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

src/wp-includes/rest-api/fields/class-wp-rest-comment-meta-fields.php

@@ -20,7 +20,6 @@ class WP_REST_Comment_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Retrieves the object type for comment meta.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @return string The meta type.
 	 */
@@ -32,7 +31,6 @@ class WP_REST_Comment_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Retrieves the type for register_rest_field() in the context of comments.
 	 *
 	 * @since 4.7.0
-	 * @access public
 	 *
 	 * @return string The REST field type.
 	 */

src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php

@@ -18,7 +18,6 @@ abstract class WP_REST_Meta_Fields {
 	 * Retrieves the object meta type.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @return string One of 'post', 'comment', 'term', 'user', or anything
 	 *                else supported by `_get_meta_table()`.
@@ -29,7 +28,6 @@ abstract class WP_REST_Meta_Fields {
 	 * Retrieves the object type for register_rest_field().
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @return string The REST field type, such as post type name, taxonomy name, 'comment', or `user`.
 	 */
@@ -39,7 +37,6 @@ abstract class WP_REST_Meta_Fields {
 	 * Registers the meta field.
 	 *
 	 * @since 4.7.0
-	 * @access public
 	 *
 	 * @see register_rest_field()
 	 */
@@ -55,7 +52,6 @@ abstract class WP_REST_Meta_Fields {
 	 * Retrieves the meta field value.
 	 *
 	 * @since 4.7.0
-	 * @access public
 	 *
 	 * @param int             $object_id Object ID to fetch meta for.
 	 * @param WP_REST_Request $request   Full details about the request.
@@ -96,7 +92,6 @@ abstract class WP_REST_Meta_Fields {
 	 * type before passing back to JSON.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @param mixed           $value   Meta value to prepare.
 	 * @param WP_REST_Request $request Current request object.
@@ -115,7 +110,6 @@ abstract class WP_REST_Meta_Fields {
 	 * Updates meta values.
 	 *
 	 * @since 4.7.0
-	 * @access public
 	 *
 	 * @param array           $meta      Array of meta parsed from the request.
 	 * @param int             $object_id Object ID to fetch meta for.
@@ -167,7 +161,6 @@ abstract class WP_REST_Meta_Fields {
 	 * Deletes a meta value for an object.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @param int    $object_id Object ID the field belongs to.
 	 * @param string $meta_key  Key for the field.
@@ -202,7 +195,6 @@ abstract class WP_REST_Meta_Fields {
 	 * Alters the list of values in the database to match the list of provided values.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @param int    $object_id Object ID to update.
 	 * @param string $meta_key  Key for the custom field.
@@ -274,7 +266,6 @@ abstract class WP_REST_Meta_Fields {
 	 * Updates a meta value for an object.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @param int    $object_id Object ID to update.
 	 * @param string $meta_key  Key for the custom field.
@@ -320,7 +311,6 @@ abstract class WP_REST_Meta_Fields {
 	 * Retrieves all the registered meta fields.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @return array Registered fields.
 	 */
@@ -379,7 +369,6 @@ abstract class WP_REST_Meta_Fields {
 	 * Retrieves the object's meta schema, conforming to JSON Schema.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @return array Field schema data.
 	 */
@@ -411,7 +400,6 @@ abstract class WP_REST_Meta_Fields {
 	 * `prepare_callback` in your `show_in_rest` options.
 	 *
 	 * @since 4.7.0
-	 * @access public
 	 *
 	 * @param mixed           $value   Meta value from the database.
 	 * @param WP_REST_Request $request Request object.
@@ -453,7 +441,6 @@ abstract class WP_REST_Meta_Fields {
 	 * Check the 'meta' value of a request is an associative array.
 	 *
 	 * @since 4.7.0
-	 * @access public
 	 *
 	 * @param  mixed           $value   The meta value submitted in the request.
 	 * @param  WP_REST_Request $request Full details about the request.

src/wp-includes/rest-api/fields/class-wp-rest-post-meta-fields.php

@@ -20,7 +20,6 @@ class WP_REST_Post_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Post type to register fields for.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 * @var string
 	 */
 	protected $post_type;
@@ -29,7 +28,6 @@ class WP_REST_Post_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Constructor.
 	 *
 	 * @since 4.7.0
-	 * @access public
 	 *
 	 * @param string $post_type Post type to register fields for.
 	 */
@@ -41,7 +39,6 @@ class WP_REST_Post_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Retrieves the object meta type.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @return string The meta type.
 	 */
@@ -53,7 +50,6 @@ class WP_REST_Post_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Retrieves the type for register_rest_field().
 	 *
 	 * @since 4.7.0
-	 * @access public
 	 *
 	 * @see register_rest_field()
 	 *

src/wp-includes/rest-api/fields/class-wp-rest-term-meta-fields.php

@@ -20,7 +20,6 @@ class WP_REST_Term_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Taxonomy to register fields for.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 * @var string
 	 */
 	protected $taxonomy;
@@ -29,7 +28,6 @@ class WP_REST_Term_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Constructor.
 	 *
 	 * @since 4.7.0
-	 * @access public
 	 *
 	 * @param string $taxonomy Taxonomy to register fields for.
 	 */
@@ -41,7 +39,6 @@ class WP_REST_Term_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Retrieves the object meta type.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @return string The meta type.
 	 */
@@ -53,7 +50,6 @@ class WP_REST_Term_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Retrieves the type for register_rest_field().
 	 *
 	 * @since 4.7.0
-	 * @access public
 	 *
 	 * @return string The REST field type.
 	 */

src/wp-includes/rest-api/fields/class-wp-rest-user-meta-fields.php

@@ -20,7 +20,6 @@ class WP_REST_User_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Retrieves the object meta type.
 	 *
 	 * @since 4.7.0
-	 * @access protected
 	 *
 	 * @return string The user meta type.
 	 */
@@ -32,7 +31,6 @@ class WP_REST_User_Meta_Fields extends WP_REST_Meta_Fields {
 	 * Retrieves the type for register_rest_field().
 	 *
 	 * @since 4.7.0
-	 * @access public
 	 *
 	 * @return string The user REST field type.
 	 */