mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-08-12 04:40:26 +00:00
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
This commit is contained in:
@@ -28,7 +28,6 @@ class WP_Roles {
|
||||
* List of roles and capabilities.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
* @var array
|
||||
*/
|
||||
public $roles;
|
||||
@@ -37,7 +36,6 @@ class WP_Roles {
|
||||
* List of the role objects.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
* @var array
|
||||
*/
|
||||
public $role_objects = array();
|
||||
@@ -46,7 +44,6 @@ class WP_Roles {
|
||||
* List of role names.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
* @var array
|
||||
*/
|
||||
public $role_names = array();
|
||||
@@ -55,7 +52,6 @@ class WP_Roles {
|
||||
* Option name for storing role list.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
* @var string
|
||||
*/
|
||||
public $role_key;
|
||||
@@ -64,7 +60,6 @@ class WP_Roles {
|
||||
* Whether to use the database for retrieval and storage.
|
||||
*
|
||||
* @since 2.1.0
|
||||
* @access public
|
||||
* @var bool
|
||||
*/
|
||||
public $use_db = true;
|
||||
@@ -82,7 +77,6 @@ class WP_Roles {
|
||||
* Make private/protected methods readable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param callable $name Method to call.
|
||||
* @param array $arguments Arguments to pass when calling.
|
||||
@@ -103,7 +97,6 @@ class WP_Roles {
|
||||
* be used and the role option will not be updated or used.
|
||||
*
|
||||
* @since 2.1.0
|
||||
* @access protected
|
||||
*
|
||||
* @global array $wp_user_roles Used to set the 'roles' property value.
|
||||
*/
|
||||
@@ -146,7 +139,6 @@ class WP_Roles {
|
||||
*
|
||||
* @since 3.5.0
|
||||
* @deprecated 4.7.0 Use new WP_Roles()
|
||||
* @access public
|
||||
*/
|
||||
public function reinit() {
|
||||
_deprecated_function( __METHOD__, '4.7.0', 'new WP_Roles()' );
|
||||
@@ -162,7 +154,6 @@ class WP_Roles {
|
||||
* To explicitly deny a role a capability you set the value for that capability to false.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $role Role name.
|
||||
* @param string $display_name Role display name.
|
||||
@@ -189,7 +180,6 @@ class WP_Roles {
|
||||
* Remove role by name.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $role Role name.
|
||||
*/
|
||||
@@ -212,7 +202,6 @@ class WP_Roles {
|
||||
* Add capability to role.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $role Role name.
|
||||
* @param string $cap Capability name.
|
||||
@@ -231,7 +220,6 @@ class WP_Roles {
|
||||
* Remove capability from role.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $role Role name.
|
||||
* @param string $cap Capability name.
|
||||
@@ -249,7 +237,6 @@ class WP_Roles {
|
||||
* Retrieve role object by name.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $role Role name.
|
||||
* @return WP_Role|null WP_Role object if found, null if the role does not exist.
|
||||
@@ -265,7 +252,6 @@ class WP_Roles {
|
||||
* Retrieve list of role names.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @return array List of role names.
|
||||
*/
|
||||
@@ -277,7 +263,6 @@ class WP_Roles {
|
||||
* Whether role name is currently in the list of available roles.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $role Role name to look up.
|
||||
* @return bool
|
||||
|
||||
Reference in New Issue
Block a user