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. Built from https://develop.svn.wordpress.org/trunk@41162 git-svn-id: http://core.svn.wordpress.org/trunk@41002 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
@@ -46,7 +46,6 @@ class WP_User {
|
||||
* The user's ID.
|
||||
*
|
||||
* @since 2.1.0
|
||||
* @access public
|
||||
* @var int
|
||||
*/
|
||||
public $ID = 0;
|
||||
@@ -55,7 +54,6 @@ class WP_User {
|
||||
* The individual capabilities the user has been given.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
* @var array
|
||||
*/
|
||||
public $caps = array();
|
||||
@@ -64,7 +62,6 @@ class WP_User {
|
||||
* User metadata option name.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
* @var string
|
||||
*/
|
||||
public $cap_key;
|
||||
@@ -73,7 +70,6 @@ class WP_User {
|
||||
* The roles the user is part of.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
* @var array
|
||||
*/
|
||||
public $roles = array();
|
||||
@@ -82,7 +78,6 @@ class WP_User {
|
||||
* All capabilities the user has, including individual and role based.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
* @var array
|
||||
*/
|
||||
public $allcaps = array();
|
||||
@@ -91,7 +86,6 @@ class WP_User {
|
||||
* The filter context applied to user data fields.
|
||||
*
|
||||
* @since 2.9.0
|
||||
* @access public
|
||||
* @var string
|
||||
*/
|
||||
public $filter = null;
|
||||
@@ -99,7 +93,6 @@ class WP_User {
|
||||
/**
|
||||
* @static
|
||||
* @since 3.3.0
|
||||
* @access private
|
||||
* @var array
|
||||
*/
|
||||
private static $back_compat_keys;
|
||||
@@ -110,7 +103,6 @@ class WP_User {
|
||||
* Retrieves the userdata and passes it to WP_User::init().
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @global wpdb $wpdb WordPress database abstraction object.
|
||||
*
|
||||
@@ -250,7 +242,6 @@ class WP_User {
|
||||
* Makes private/protected methods readable for backward compatibility.
|
||||
*
|
||||
* @since 4.3.0
|
||||
* @access public
|
||||
*
|
||||
* @param callable $name Method to call.
|
||||
* @param array $arguments Arguments to pass when calling.
|
||||
@@ -267,7 +258,6 @@ class WP_User {
|
||||
* Magic method for checking the existence of a certain custom field.
|
||||
*
|
||||
* @since 3.3.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $key User meta key to check if set.
|
||||
* @return bool Whether the given user meta key is set.
|
||||
@@ -297,7 +287,6 @@ class WP_User {
|
||||
* Magic method for accessing custom fields.
|
||||
*
|
||||
* @since 3.3.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $key User meta key to retrieve.
|
||||
* @return mixed Value of the given user meta key (if set). If `$key` is 'id', the user ID.
|
||||
@@ -336,7 +325,6 @@ class WP_User {
|
||||
* the value on the WP_User instance.
|
||||
*
|
||||
* @since 3.3.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $key User meta key.
|
||||
* @param mixed $value User meta value.
|
||||
@@ -361,7 +349,6 @@ class WP_User {
|
||||
* Magic method for unsetting a certain custom field.
|
||||
*
|
||||
* @since 4.4.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $key User meta key to unset.
|
||||
*/
|
||||
@@ -389,7 +376,6 @@ class WP_User {
|
||||
* Determine whether the user exists in the database.
|
||||
*
|
||||
* @since 3.4.0
|
||||
* @access public
|
||||
*
|
||||
* @return bool True if user exists in the database, false if not.
|
||||
*/
|
||||
@@ -444,7 +430,6 @@ class WP_User {
|
||||
* property matching the 'cap_key' exists and is an array. If so, it will be
|
||||
* used.
|
||||
*
|
||||
* @access protected
|
||||
* @since 2.1.0
|
||||
*
|
||||
* @global wpdb $wpdb WordPress database abstraction object.
|
||||
@@ -476,7 +461,6 @@ class WP_User {
|
||||
* granted permission to.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @return array List of all capabilities for the user.
|
||||
*/
|
||||
@@ -504,7 +488,6 @@ class WP_User {
|
||||
* Updates the user's meta data option with capabilities and roles.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $role Role name.
|
||||
*/
|
||||
@@ -533,7 +516,6 @@ class WP_User {
|
||||
* Remove role from user.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $role Role name.
|
||||
*/
|
||||
@@ -564,7 +546,6 @@ class WP_User {
|
||||
* of the roles from the user.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $role Role name.
|
||||
*/
|
||||
@@ -612,7 +593,6 @@ class WP_User {
|
||||
* value.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param int $max Max level of user.
|
||||
* @param string $item Level capability name.
|
||||
@@ -635,7 +615,6 @@ class WP_User {
|
||||
* the all of the capabilities that the user has.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @global wpdb $wpdb WordPress database abstraction object.
|
||||
*/
|
||||
@@ -649,7 +628,6 @@ class WP_User {
|
||||
* Add capability and grant or deny access to capability.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $cap Capability name.
|
||||
* @param bool $grant Whether to grant capability to user.
|
||||
@@ -665,7 +643,6 @@ class WP_User {
|
||||
* Remove capability from user.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $cap Capability name.
|
||||
*/
|
||||
@@ -683,7 +660,6 @@ class WP_User {
|
||||
* Remove all of the capabilities of the user.
|
||||
*
|
||||
* @since 2.1.0
|
||||
* @access public
|
||||
*
|
||||
* @global wpdb $wpdb WordPress database abstraction object.
|
||||
*/
|
||||
@@ -702,7 +678,6 @@ class WP_User {
|
||||
* in part, this practice is discouraged as it may produce unreliable results.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @see map_meta_cap()
|
||||
*
|
||||
@@ -766,7 +741,6 @@ class WP_User {
|
||||
* Prepends 'level_' to level number.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param int $level Level number, 1 to 10.
|
||||
* @return string
|
||||
|
||||
Reference in New Issue
Block a user