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:
@@ -20,7 +20,6 @@ class WP_User_Query {
|
||||
* Query vars, after parsing
|
||||
*
|
||||
* @since 3.5.0
|
||||
* @access public
|
||||
* @var array
|
||||
*/
|
||||
public $query_vars = array();
|
||||
@@ -29,7 +28,6 @@ class WP_User_Query {
|
||||
* List of found user ids
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @access private
|
||||
* @var array
|
||||
*/
|
||||
private $results;
|
||||
@@ -38,7 +36,6 @@ class WP_User_Query {
|
||||
* Total number of found users for the current query
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @access private
|
||||
* @var int
|
||||
*/
|
||||
private $total_users = 0;
|
||||
@@ -47,7 +44,6 @@ class WP_User_Query {
|
||||
* Metadata query container.
|
||||
*
|
||||
* @since 4.2.0
|
||||
* @access public
|
||||
* @var WP_Meta_Query
|
||||
*/
|
||||
public $meta_query = false;
|
||||
@@ -56,7 +52,6 @@ class WP_User_Query {
|
||||
* The SQL query used to fetch matching users.
|
||||
*
|
||||
* @since 4.4.0
|
||||
* @access public
|
||||
* @var string
|
||||
*/
|
||||
public $request;
|
||||
@@ -88,7 +83,6 @@ class WP_User_Query {
|
||||
* Fills in missing query variables with default values.
|
||||
*
|
||||
* @since 4.4.0
|
||||
* @access public
|
||||
*
|
||||
* @param array $args Query vars, as passed to `WP_User_Query`.
|
||||
* @return array Complete query variables with undefined ones filled in with defaults.
|
||||
@@ -140,7 +134,6 @@ class WP_User_Query {
|
||||
* @since 4.7.0 Added 'nicename', 'nicename__in', 'nicename__not_in', 'login', 'login__in',
|
||||
* and 'login__not_in' parameters.
|
||||
*
|
||||
* @access public
|
||||
*
|
||||
* @global wpdb $wpdb WordPress database abstraction object.
|
||||
* @global int $blog_id
|
||||
@@ -637,7 +630,6 @@ class WP_User_Query {
|
||||
* Retrieve query variable.
|
||||
*
|
||||
* @since 3.5.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $query_var Query variable key.
|
||||
* @return mixed
|
||||
@@ -653,7 +645,6 @@ class WP_User_Query {
|
||||
* Set query variable.
|
||||
*
|
||||
* @since 3.5.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $query_var Query variable key.
|
||||
* @param mixed $value Query variable value.
|
||||
@@ -665,7 +656,6 @@ class WP_User_Query {
|
||||
/**
|
||||
* Used internally to generate an SQL string for searching across multiple columns
|
||||
*
|
||||
* @access protected
|
||||
* @since 3.1.0
|
||||
*
|
||||
* @global wpdb $wpdb WordPress database abstraction object.
|
||||
@@ -699,7 +689,6 @@ class WP_User_Query {
|
||||
* Return the list of users.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @access public
|
||||
*
|
||||
* @return array Array of results.
|
||||
*/
|
||||
@@ -711,7 +700,6 @@ class WP_User_Query {
|
||||
* Return the total number of users for the current query.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @access public
|
||||
*
|
||||
* @return int Number of total users.
|
||||
*/
|
||||
@@ -723,7 +711,6 @@ class WP_User_Query {
|
||||
* Parse and sanitize 'orderby' keys passed to the user query.
|
||||
*
|
||||
* @since 4.2.0
|
||||
* @access protected
|
||||
*
|
||||
* @global wpdb $wpdb WordPress database abstraction object.
|
||||
*
|
||||
@@ -783,7 +770,6 @@ class WP_User_Query {
|
||||
* Parse an 'order' query variable and cast it to ASC or DESC as necessary.
|
||||
*
|
||||
* @since 4.2.0
|
||||
* @access protected
|
||||
*
|
||||
* @param string $order The 'order' query variable.
|
||||
* @return string The sanitized 'order' query variable.
|
||||
@@ -804,7 +790,6 @@ class WP_User_Query {
|
||||
* Make private properties readable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $name Property to get.
|
||||
* @return mixed Property.
|
||||
@@ -819,7 +804,6 @@ class WP_User_Query {
|
||||
* Make private properties settable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $name Property to check if set.
|
||||
* @param mixed $value Property value.
|
||||
@@ -835,7 +819,6 @@ class WP_User_Query {
|
||||
* Make private properties checkable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $name Property to check if set.
|
||||
* @return bool Whether the property is set.
|
||||
@@ -850,7 +833,6 @@ class WP_User_Query {
|
||||
* Make private properties un-settable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $name Property to unset.
|
||||
*/
|
||||
@@ -864,7 +846,6 @@ class WP_User_Query {
|
||||
* 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.
|
||||
|
||||
Reference in New Issue
Block a user