vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-30 23:30:05 +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

80
src/wp-includes/class-wp-query.php
View File

@@ -21,7 +21,6 @@ class WP_Query {
* Query vars set by the user
*
* @since 1.5.0
* @access public
* @var array
*/
public $query;
@@ -30,7 +29,6 @@ class WP_Query {
* Query vars, after parsing
*
* @since 1.5.0
* @access public
* @var array
*/
public $query_vars = array();
@@ -39,7 +37,6 @@ class WP_Query {
* Taxonomy query, as passed to get_tax_sql()
*
* @since 3.1.0
* @access public
* @var object WP_Tax_Query
*/
public $tax_query;
@@ -48,7 +45,6 @@ class WP_Query {
* Metadata query container
*
* @since 3.2.0
* @access public
* @var object WP_Meta_Query
*/
public $meta_query = false;
@@ -57,7 +53,6 @@ class WP_Query {
* Date query container
*
* @since 3.7.0
* @access public
* @var object WP_Date_Query
*/
public $date_query = false;
@@ -68,7 +63,6 @@ class WP_Query {
* Holds the contents of a post, page, category, attachment.
*
* @since 1.5.0
* @access public
* @var object|array
*/
public $queried_object;
@@ -77,7 +71,6 @@ class WP_Query {
* The ID of the queried object.
*
* @since 1.5.0
* @access public
* @var int
*/
public $queried_object_id;
@@ -86,7 +79,6 @@ class WP_Query {
* Get post database query.
*
* @since 2.0.1
* @access public
* @var string
*/
public $request;
@@ -95,7 +87,6 @@ class WP_Query {
* List of posts.
*
* @since 1.5.0
* @access public
* @var array
*/
public $posts;
@@ -104,7 +95,6 @@ class WP_Query {
* The amount of posts for the current query.
*
* @since 1.5.0
* @access public
* @var int
*/
public $post_count = 0;
@@ -113,7 +103,6 @@ class WP_Query {
* Index of the current item in the loop.
*
* @since 1.5.0
* @access public
* @var int
*/
public $current_post = -1;
@@ -122,7 +111,6 @@ class WP_Query {
* Whether the loop has started and the caller is in the loop.
*
* @since 2.0.0
* @access public
* @var bool
*/
public $in_the_loop = false;
@@ -131,7 +119,6 @@ class WP_Query {
* The current post.
*
* @since 1.5.0
* @access public
* @var WP_Post
*/
public $post;
@@ -140,7 +127,6 @@ class WP_Query {
* The list of comments for current post.
*
* @since 2.2.0
* @access public
* @var array
*/
public $comments;
@@ -149,7 +135,6 @@ class WP_Query {
* The amount of comments for the posts.
*
* @since 2.2.0
* @access public
* @var int
*/
public $comment_count = 0;
@@ -158,7 +143,6 @@ class WP_Query {
* The index of the comment in the comment loop.
*
* @since 2.2.0
* @access public
* @var int
*/
public $current_comment = -1;
@@ -167,7 +151,6 @@ class WP_Query {
* Current comment ID.
*
* @since 2.2.0
* @access public
* @var int
*/
public $comment;
@@ -178,7 +161,6 @@ class WP_Query {
* If limit clause was not used, equals $post_count.
*
* @since 2.1.0
* @access public
* @var int
*/
public $found_posts = 0;
@@ -187,7 +169,6 @@ class WP_Query {
* The amount of pages.
*
* @since 2.1.0
* @access public
* @var int
*/
public $max_num_pages = 0;
@@ -196,7 +177,6 @@ class WP_Query {
* The amount of comment pages.
*
* @since 2.7.0
* @access public
* @var int
*/
public $max_num_comment_pages = 0;
@@ -205,7 +185,6 @@ class WP_Query {
* Signifies whether the current query is for a single post.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_single = false;
@@ -214,7 +193,6 @@ class WP_Query {
* Signifies whether the current query is for a preview.
*
* @since 2.0.0
* @access public
* @var bool
*/
public $is_preview = false;
@@ -223,7 +201,6 @@ class WP_Query {
* Signifies whether the current query is for a page.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_page = false;
@@ -232,7 +209,6 @@ class WP_Query {
* Signifies whether the current query is for an archive.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_archive = false;
@@ -241,7 +217,6 @@ class WP_Query {
* Signifies whether the current query is for a date archive.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_date = false;
@@ -250,7 +225,6 @@ class WP_Query {
* Signifies whether the current query is for a year archive.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_year = false;
@@ -259,7 +233,6 @@ class WP_Query {
* Signifies whether the current query is for a month archive.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_month = false;
@@ -268,7 +241,6 @@ class WP_Query {
* Signifies whether the current query is for a day archive.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_day = false;
@@ -277,7 +249,6 @@ class WP_Query {
* Signifies whether the current query is for a specific time.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_time = false;
@@ -286,7 +257,6 @@ class WP_Query {
* Signifies whether the current query is for an author archive.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_author = false;
@@ -295,7 +265,6 @@ class WP_Query {
* Signifies whether the current query is for a category archive.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_category = false;
@@ -304,7 +273,6 @@ class WP_Query {
* Signifies whether the current query is for a tag archive.
*
* @since 2.3.0
* @access public
* @var bool
*/
public $is_tag = false;
@@ -313,7 +281,6 @@ class WP_Query {
* Signifies whether the current query is for a taxonomy archive.
*
* @since 2.5.0
* @access public
* @var bool
*/
public $is_tax = false;
@@ -322,7 +289,6 @@ class WP_Query {
* Signifies whether the current query is for a search.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_search = false;
@@ -331,7 +297,6 @@ class WP_Query {
* Signifies whether the current query is for a feed.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_feed = false;
@@ -340,7 +305,6 @@ class WP_Query {
* Signifies whether the current query is for a comment feed.
*
* @since 2.2.0
* @access public
* @var bool
*/
public $is_comment_feed = false;
@@ -349,7 +313,6 @@ class WP_Query {
* Signifies whether the current query is for trackback endpoint call.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_trackback = false;
@@ -358,7 +321,6 @@ class WP_Query {
* Signifies whether the current query is for the site homepage.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_home = false;
@@ -367,7 +329,6 @@ class WP_Query {
* Signifies whether the current query couldn't find anything.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_404 = false;
@@ -376,7 +337,6 @@ class WP_Query {
* Signifies whether the current query is for an embed.
*
* @since 4.4.0
* @access public
* @var bool
*/
public $is_embed = false;
@@ -385,7 +345,6 @@ class WP_Query {
* Signifies whether the current query is for a paged result and not for the first page.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_paged = false;
@@ -394,7 +353,6 @@ class WP_Query {
* Signifies whether the current query is for an administrative interface page.
*
* @since 1.5.0
* @access public
* @var bool
*/
public $is_admin = false;
@@ -403,7 +361,6 @@ class WP_Query {
* Signifies whether the current query is for an attachment page.
*
* @since 2.0.0
* @access public
* @var bool
*/
public $is_attachment = false;
@@ -413,7 +370,6 @@ class WP_Query {
* (post, attachment, page, custom post types).
*
* @since 2.1.0
* @access public
* @var bool
*/
public $is_singular = false;
@@ -422,7 +378,6 @@ class WP_Query {
* Signifies whether the current query is for the robots.txt file.
*
* @since 2.1.0
* @access public
* @var bool
*/
public $is_robots = false;
@@ -433,7 +388,6 @@ class WP_Query {
* Basically, the homepage if the option isn't set for the static homepage.
*
* @since 2.1.0
* @access public
* @var bool
*/
public $is_posts_page = false;
@@ -442,7 +396,6 @@ class WP_Query {
* Signifies whether the current query is for a post type archive.
*
* @since 3.1.0
* @access public
* @var bool
*/
public $is_post_type_archive = false;
@@ -452,7 +405,6 @@ class WP_Query {
* whether we have to re-parse because something has changed
*
* @since 3.1.0
* @access private
* @var bool|string
*/
private $query_vars_hash = false;
@@ -462,7 +414,6 @@ class WP_Query {
* via pre_get_posts hooks.
*
* @since 3.1.1
* @access private
*/
private $query_vars_changed = true;
@@ -470,7 +421,6 @@ class WP_Query {
* Set if post thumbnails are cached
*
* @since 3.2.0
* @access public
* @var bool
*/
public $thumbnails_cached = false;
@@ -493,7 +443,6 @@ class WP_Query {
* The query flags are what page info WordPress was able to figure out.
*
* @since 2.0.0
* @access private
*/
private function init_query_flags() {
$this->is_single = false;
@@ -528,7 +477,6 @@ class WP_Query {
* Initiates object properties and sets default values.
*
* @since 1.5.0
* @access public
*/
public function init() {
unset($this->posts);
@@ -556,7 +504,6 @@ class WP_Query {
* Reparse the query vars.
*
* @since 1.5.0
* @access public
*/
public function parse_query_vars() {
$this->parse_query();
@@ -567,7 +514,6 @@ class WP_Query {
*
* @since 2.1.0
* @since 4.4.0 Removed the `comments_popup` public query variable.
* @access public
*
* @param array $array Defined query variables.
* @return array Complete query variables with undefined ones filled in empty.
@@ -642,7 +588,6 @@ class WP_Query {
* Introduced `RAND(x)` syntax for `$orderby`, which allows an integer seed value to random sorts.
* @since 4.6.0 Added 'post_name__in' support for `$orderby`. Introduced the `$lazy_load_term_meta` argument.
* @since 4.9.0 Introduced the `$comment_count` parameter.
* @access public
*
* @param string|array $query {
* Optional. Array or string of Query parameters.
@@ -1066,7 +1011,6 @@ class WP_Query {
*
* For BC, this method is not marked as protected. See [28987].
*
* @access protected
* @since 3.1.0
*
* @param array $q The query variables. Passed by reference.
@@ -1295,7 +1239,6 @@ class WP_Query {
* Generates SQL for the WHERE clause based on passed search terms.
*
* @since 3.7.0
* @access protected
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -1452,7 +1395,6 @@ class WP_Query {
* Generates SQL for the ORDER BY condition based on passed search terms.
*
* @since 3.7.0
* @access protected
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -1509,7 +1451,6 @@ class WP_Query {
* Converts the given orderby alias (if allowed) to a properly-prefixed value.
*
* @since 4.0.0
* @access protected
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -1603,7 +1544,6 @@ class WP_Query {
* Parse an 'order' query variable and cast it to ASC or DESC as necessary.
*
* @since 4.0.0
* @access protected
*
* @param string $order The 'order' query variable.
* @return string The sanitized 'order' query variable.
@@ -1624,7 +1564,6 @@ class WP_Query {
* Sets the 404 property and saves whether query is feed.
*
* @since 2.0.0
* @access public
*/
public function set_404() {
$is_feed = $this->is_feed;
@@ -1641,7 +1580,6 @@ class WP_Query {
* @since 1.5.0
* @since 3.9.0 The `$default` argument was introduced.
*
* @access public
*
* @param string $query_var Query variable key.
* @param mixed $default Optional. Value to return if the query variable is not set. Default empty.
@@ -1659,7 +1597,6 @@ class WP_Query {
* Set query variable.
*
* @since 1.5.0
* @access public
*
* @param string $query_var Query variable key.
* @param mixed $value Query variable value.
@@ -1675,7 +1612,6 @@ class WP_Query {
* database query.
*
* @since 1.5.0
* @access public
*
* @return array List of posts.
*/
@@ -3074,7 +3010,6 @@ class WP_Query {
* for the current query.
*
* @since 3.5.0
* @access private
*
* @param array $q Query variables.
* @param string $limits LIMIT clauses of the query.
@@ -3118,7 +3053,6 @@ class WP_Query {
* Set up the next post and iterate current post index.
*
* @since 1.5.0
* @access public
*
* @return WP_Post Next post.
*/
@@ -3137,7 +3071,6 @@ class WP_Query {
* property to true.
*
* @since 1.5.0
* @access public
*
* @global WP_Post $post
*/
@@ -3165,7 +3098,6 @@ class WP_Query {
* Calls the {@see 'loop_end'} action when the loop is complete.
*
* @since 1.5.0
* @access public
*
* @return bool True if posts are available, false if end of loop.
*/
@@ -3202,7 +3134,6 @@ class WP_Query {
* Rewind the posts and reset post index.
*
* @since 1.5.0
* @access public
*/
public function rewind_posts() {
$this->current_post = -1;
@@ -3215,7 +3146,6 @@ class WP_Query {
* Iterate current comment index and return WP_Comment object.
*
* @since 2.2.0
* @access public
*
* @return WP_Comment Comment object.
*/
@@ -3230,7 +3160,6 @@ class WP_Query {
* Sets up the current comment.
*
* @since 2.2.0
* @access public
* @global WP_Comment $comment Current comment.
*/
public function the_comment() {
@@ -3254,7 +3183,6 @@ class WP_Query {
* Automatically rewinds comments when finished.
*
* @since 2.2.0
* @access public
*
* @return bool True, if more comments. False, if no more posts.
*/
@@ -3272,7 +3200,6 @@ class WP_Query {
* Rewind the comments, resets the comment index and comment to first.
*
* @since 2.2.0
* @access public
*/
public function rewind_comments() {
$this->current_comment = -1;
@@ -3285,7 +3212,6 @@ class WP_Query {
* Sets up the WordPress query by parsing query string.
*
* @since 1.5.0
* @access public
*
* @param string|array $query URL query string or array of query arguments.
* @return array List of posts.
@@ -3304,7 +3230,6 @@ class WP_Query {
* query variable. After it is set up, it will be returned.
*
* @since 1.5.0
* @access public
*
* @return object
*/
@@ -3376,7 +3301,6 @@ class WP_Query {
* Retrieve ID of the current queried object.
*
* @since 1.5.0
* @access public
*
* @return int
*/
@@ -3396,7 +3320,6 @@ class WP_Query {
* Sets up the WordPress query, if parameter is not empty.
*
* @since 1.5.0
* @access public
*
* @param string|array $query URL query string or array of vars.
*/
@@ -3410,7 +3333,6 @@ class WP_Query {
* Make private properties readable for backward compatibility.
*
* @since 4.0.0
* @access public
*
* @param string $name Property to get.
* @return mixed Property.
@@ -3425,7 +3347,6 @@ class WP_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.
@@ -3440,7 +3361,6 @@ class WP_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.