WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:40:27 AM (7 years ago)
Author:
DrewAPicture
Message:

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.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-wp-query.php

    r41042 r41162  
    2222     *
    2323     * @since 1.5.0
    24      * @access public
    2524     * @var array
    2625     */
    … …  
    3130     *
    3231     * @since 1.5.0
    33      * @access public
    3432     * @var array
    3533     */
    … …  
    4038     *
    4139     * @since 3.1.0
    42      * @access public
    4340     * @var object WP_Tax_Query
    4441     */
    … …  
    4946     *
    5047     * @since 3.2.0
    51      * @access public
    5248     * @var object WP_Meta_Query
    5349     */
    … …  
    5854     *
    5955     * @since 3.7.0
    60      * @access public
    6156     * @var object WP_Date_Query
    6257     */
    … …  
    6964     *
    7065     * @since 1.5.0
    71      * @access public
    7266     * @var object|array
    7367     */
    … …  
    7872     *
    7973     * @since 1.5.0
    80      * @access public
    8174     * @var int
    8275     */
    … …  
    8780     *
    8881     * @since 2.0.1
    89      * @access public
    9082     * @var string
    9183     */
    … …  
    9688     *
    9789     * @since 1.5.0
    98      * @access public
    9990     * @var array
    10091     */
    … …  
    10596     *
    10697     * @since 1.5.0
    107      * @access public
    10898     * @var int
    10999     */
    … …  
    114104     *
    115105     * @since 1.5.0
    116      * @access public
    117106     * @var int
    118107     */
    … …  
    123112     *
    124113     * @since 2.0.0
    125      * @access public
    126114     * @var bool
    127115     */
    … …  
    132120     *
    133121     * @since 1.5.0
    134      * @access public
    135122     * @var WP_Post
    136123     */
    … …  
    141128     *
    142129     * @since 2.2.0
    143      * @access public
    144130     * @var array
    145131     */
    … …  
    150136     *
    151137     * @since 2.2.0
    152      * @access public
    153138     * @var int
    154139     */
    … …  
    159144     *
    160145     * @since 2.2.0
    161      * @access public
    162146     * @var int
    163147     */
    … …  
    168152     *
    169153     * @since 2.2.0
    170      * @access public
    171154     * @var int
    172155     */
    … …  
    179162     *
    180163     * @since 2.1.0
    181      * @access public
    182164     * @var int
    183165     */
    … …  
    188170     *
    189171     * @since 2.1.0
    190      * @access public
    191172     * @var int
    192173     */
    … …  
    197178     *
    198179     * @since 2.7.0
    199      * @access public
    200180     * @var int
    201181     */
    … …  
    206186     *
    207187     * @since 1.5.0
    208      * @access public
    209188     * @var bool
    210189     */
    … …  
    215194     *
    216195     * @since 2.0.0
    217      * @access public
    218196     * @var bool
    219197     */
    … …  
    224202     *
    225203     * @since 1.5.0
    226      * @access public
    227204     * @var bool
    228205     */
    … …  
    233210     *
    234211     * @since 1.5.0
    235      * @access public
    236212     * @var bool
    237213     */
    … …  
    242218     *
    243219     * @since 1.5.0
    244      * @access public
    245220     * @var bool
    246221     */
    … …  
    251226     *
    252227     * @since 1.5.0
    253      * @access public
    254228     * @var bool
    255229     */
    … …  
    260234     *
    261235     * @since 1.5.0
    262      * @access public
    263236     * @var bool
    264237     */
    … …  
    269242     *
    270243     * @since 1.5.0
    271      * @access public
    272244     * @var bool
    273245     */
    … …  
    278250     *
    279251     * @since 1.5.0
    280      * @access public
    281252     * @var bool
    282253     */
    … …  
    287258     *
    288259     * @since 1.5.0
    289      * @access public
    290260     * @var bool
    291261     */
    … …  
    296266     *
    297267     * @since 1.5.0
    298      * @access public
    299268     * @var bool
    300269     */
    … …  
    305274     *
    306275     * @since 2.3.0
    307      * @access public
    308276     * @var bool
    309277     */
    … …  
    314282     *
    315283     * @since 2.5.0
    316      * @access public
    317284     * @var bool
    318285     */
    … …  
    323290     *
    324291     * @since 1.5.0
    325      * @access public
    326292     * @var bool
    327293     */
    … …  
    332298     *
    333299     * @since 1.5.0
    334      * @access public
    335300     * @var bool
    336301     */
    … …  
    341306     *
    342307     * @since 2.2.0
    343      * @access public
    344308     * @var bool
    345309     */
    … …  
    350314     *
    351315     * @since 1.5.0
    352      * @access public
    353316     * @var bool
    354317     */
    … …  
    359322     *
    360323     * @since 1.5.0
    361      * @access public
    362324     * @var bool
    363325     */
    … …  
    368330     *
    369331     * @since 1.5.0
    370      * @access public
    371332     * @var bool
    372333     */
    … …  
    377338     *
    378339     * @since 4.4.0
    379      * @access public
    380340     * @var bool
    381341     */
    … …  
    386346     *
    387347     * @since 1.5.0
    388      * @access public
    389348     * @var bool
    390349     */
    … …  
    395354     *
    396355     * @since 1.5.0
    397      * @access public
    398356     * @var bool
    399357     */
    … …  
    404362     *
    405363     * @since 2.0.0
    406      * @access public
    407364     * @var bool
    408365     */
    … …  
    414371     *
    415372     * @since 2.1.0
    416      * @access public
    417373     * @var bool
    418374     */
    … …  
    423379     *
    424380     * @since 2.1.0
    425      * @access public
    426381     * @var bool
    427382     */
    … …  
    434389     *
    435390     * @since 2.1.0
    436      * @access public
    437391     * @var bool
    438392     */
    … …  
    443397     *
    444398     * @since 3.1.0
    445      * @access public
    446399     * @var bool
    447400     */
    … …  
    453406     *
    454407     * @since 3.1.0
    455      * @access private
    456408     * @var bool|string
    457409     */
    … …  
    463415     *
    464416     * @since 3.1.1
    465      * @access private
    466417     */
    467418    private $query_vars_changed = true;
    … …  
    471422     *
    472423     * @since 3.2.0
    473      * @access public
    474424     * @var bool
    475425     */
    … …  
    494444     *
    495445     * @since 2.0.0
    496      * @access private
    497446     */
    498447    private function init_query_flags() {
    … …  
    529478     *
    530479     * @since 1.5.0
    531      * @access public
    532480     */
    533481    public function init() {
    … …  
    557505     *
    558506     * @since 1.5.0
    559      * @access public
    560507     */
    561508    public function parse_query_vars() {
    … …  
    568515     * @since 2.1.0
    569516     * @since 4.4.0 Removed the `comments_popup` public query variable.
    570      * @access public
    571517     *
    572518     * @param array $array Defined query variables.
    … …  
    643589     * @since 4.6.0 Added 'post_name__in' support for `$orderby`. Introduced the `$lazy_load_term_meta` argument.
    644590     * @since 4.9.0 Introduced the `$comment_count` parameter.
    645      * @access public
    646591     *
    647592     * @param string|array $query {
    … …  
    10671012     * For BC, this method is not marked as protected. See [28987].
    10681013     *
    1069      * @access protected
    10701014     * @since 3.1.0
    10711015     *
    … …  
    12961240     *
    12971241     * @since 3.7.0
    1298      * @access protected
    12991242     *
    13001243     * @global wpdb $wpdb WordPress database abstraction object.
    … …  
    14531396     *
    14541397     * @since 3.7.0
    1455      * @access protected
    14561398     *
    14571399     * @global wpdb $wpdb WordPress database abstraction object.
    … …  
    15101452     *
    15111453     * @since 4.0.0
    1512      * @access protected
    15131454     *
    15141455     * @global wpdb $wpdb WordPress database abstraction object.
    … …  
    16041545     *
    16051546     * @since 4.0.0
    1606      * @access protected
    16071547     *
    16081548     * @param string $order The 'order' query variable.
    … …  
    16251565     *
    16261566     * @since 2.0.0
    1627      * @access public
    16281567     */
    16291568    public function set_404() {
    … …  
    16421581     * @since 3.9.0 The `$default` argument was introduced.
    16431582     *
    1644      * @access public
    16451583     *
    16461584     * @param string $query_var Query variable key.
    … …  
    16601598     *
    16611599     * @since 1.5.0
    1662      * @access public
    16631600     *
    16641601     * @param string $query_var Query variable key.
    … …  
    16761613     *
    16771614     * @since 1.5.0
    1678      * @access public
    16791615     *
    16801616     * @return array List of posts.
    … …  
    30753011     *
    30763012     * @since 3.5.0
    3077      * @access private
    30783013     *
    30793014     * @param array  $q      Query variables.
    … …  
    31193054     *
    31203055     * @since 1.5.0
    3121      * @access public
    31223056     *
    31233057     * @return WP_Post Next post.
    … …  
    31383072     *
    31393073     * @since 1.5.0
    3140      * @access public
    31413074     *
    31423075     * @global WP_Post $post
    … …  
    31663099     *
    31673100     * @since 1.5.0
    3168      * @access public
    31693101     *
    31703102     * @return bool True if posts are available, false if end of loop.
    … …  
    32033135     *
    32043136     * @since 1.5.0
    3205      * @access public
    32063137     */
    32073138    public function rewind_posts() {
    … …  
    32163147     *
    32173148     * @since 2.2.0
    3218      * @access public
    32193149     *
    32203150     * @return WP_Comment Comment object.
    … …  
    32313161     *
    32323162     * @since 2.2.0
    3233      * @access public
    32343163     * @global WP_Comment $comment Current comment.
    32353164     */
    … …  
    32553184     *
    32563185     * @since 2.2.0
    3257      * @access public
    32583186     *
    32593187     * @return bool True, if more comments. False, if no more posts.
    … …  
    32733201     *
    32743202     * @since 2.2.0
    3275      * @access public
    32763203     */
    32773204    public function rewind_comments() {
    … …  
    32863213     *
    32873214     * @since 1.5.0
    3288      * @access public
    32893215     *
    32903216     * @param string|array $query URL query string or array of query arguments.
    … …  
    33053231     *
    33063232     * @since 1.5.0
    3307      * @access public
    33083233     *
    33093234     * @return object
    … …  
    33773302     *
    33783303     * @since 1.5.0
    3379      * @access public
    33803304     *
    33813305     * @return int
    … …  
    33973321     *
    33983322     * @since 1.5.0
    3399      * @access public
    34003323     *
    34013324     * @param string|array $query URL query string or array of vars.
    … …  
    34113334     *
    34123335     * @since 4.0.0
    3413      * @access public
    34143336     *
    34153337     * @param string $name Property to get.
    … …  
    34263348     *
    34273349     * @since 4.0.0
    3428      * @access public
    34293350     *
    34303351     * @param string $name Property to check if set.
    … …  
    34413362     *
    34423363     * @since 4.0.0
    3443      * @access public
    34443364     *
    34453365     * @param callable $name      Method to call.
Note: See TracChangeset for help on using the changeset viewer.