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/wp-db.php

    r40989 r41162  
    5757     *
    5858     * @since 0.71
    59      * @access private
    6059     * @var bool
    6160     */
    … …  
    6564     * Whether to suppress errors during the DB bootstrapping.
    6665     *
    67      * @access private
    6866     * @since 2.5.0
    6967     * @var bool
    … …  
    8381     *
    8482     * @since 1.2.0
    85      * @access public
    8683     * @var int
    8784     */
    … …  
    9289     *
    9390     * @since 0.71
    94      * @access public
    9591     * @var int
    9692     */
    … …  
    10197     *
    10298     * @since 0.71
    103      * @access private
    10499     * @var int
    105100     */
    … …  
    110105     *
    111106     * @since 0.71
    112      * @access public
    113107     * @var int
    114108     */
    … …  
    119113     *
    120114     * @since 0.71
    121      * @access private
    122115     * @var array
    123116     */
    … …  
    128121     *
    129122     * @since 0.71
    130      * @access private
    131123     * @var array|null
    132124     */
    … …  
    137129     *
    138130     * @since 0.71
    139      * @access protected
    140131     * @var mixed
    141132     */
    … …  
    146137     *
    147138     * @since 4.2.0
    148      * @access protected
    149139     * @var array
    150140     */
    … …  
    155145     *
    156146     * @since 4.2.0
    157      * @access protected
    158147     * @var array
    159148     */
    … …  
    164153     *
    165154     * @since 4.2.0
    166      * @access protected
    167155     * @var bool
    168156     */
    … …  
    173161     *
    174162     * @since 4.2.0
    175      * @access private
    176163     * @see wpdb::check_safe_collation()
    177164     * @var bool
    … …  
    183170     *
    184171     * @since 0.71
    185      * @access protected
    186172     * @var array
    187173     */
    … …  
    192178     *
    193179     * @since 1.5.0
    194      * @access private
    195180     * @var array
    196181     */
    … …  
    201186     *
    202187     * @since 3.9.0
    203      * @access protected
    204188     * @see wpdb::check_connection()
    205189     * @var int
    … …  
    215199     *
    216200     * @since 2.5.0
    217      * @access public
    218201     * @var string
    219202     */
    … …  
    224207     *
    225208     * @since 3.0.0
    226      * @access public
    227209     * @var string
    228210     */
    … …  
    233215     *
    234216     * @since 2.3.2
    235      * @access private
    236217     * @var bool
    237218     */
    … …  
    242223     *
    243224     * @since 3.0.0
    244      * @access public
    245225     * @var int
    246226     */
    … …  
    251231     *
    252232     * @since 3.0.0
    253      * @access public
    254233     * @var int
    255234     */
    … …  
    260239     *
    261240     * @since 2.5.0
    262      * @access private
    263241     * @see wpdb::tables()
    264242     * @var array
    … …  
    273251     *
    274252     * @since 2.9.0
    275      * @access private
    276253     * @see wpdb::tables()
    277254     * @var array
    … …  
    283260     *
    284261     * @since 3.0.0
    285      * @access private
    286262     * @see wpdb::tables()
    287263     * @var array
    … …  
    293269     *
    294270     * @since 3.0.0
    295      * @access private
    296271     * @see wpdb::tables()
    297272     * @var array
    … …  
    304279     *
    305280     * @since 1.5.0
    306      * @access public
    307281     * @var string
    308282     */
    … …  
    313287     *
    314288     * @since 2.9.0
    315      * @access public
    316289     * @var string
    317290     */
    … …  
    322295     *
    323296     * @since 1.5.0
    324      * @access public
    325297     * @var string
    326298     */
    … …  
    331303     *
    332304     * @since 1.5.0
    333      * @access public
    334305     * @var string
    335306     */
    … …  
    340311     *
    341312     * @since 1.5.0
    342      * @access public
    343313     * @var string
    344314     */
    … …  
    349319     *
    350320     * @since 1.5.0
    351      * @access public
    352321     * @var string
    353322     */
    … …  
    358327     *
    359328     * @since 2.3.0
    360      * @access public
    361329     * @var string
    362330     */
    … …  
    367335     *
    368336     * @since 2.3.0
    369      * @access public
    370337     * @var string
    371338     */
    … …  
    376343     *
    377344     * @since 2.3.0
    378      * @access public
    379345     * @var string
    380346     */
    … …  
    385351     *
    386352     * @since 4.4.0
    387      * @access public
    388353     * @var string
    389354     */
    … …  
    398363     *
    399364     * @since 2.3.0
    400      * @access public
    401365     * @var string
    402366     */
    … …  
    407371     *
    408372     * @since 1.5.0
    409      * @access public
    410373     * @var string
    411374     */
    … …  
    416379     *
    417380     * @since 3.0.0
    418      * @access public
    419381     * @var string
    420382     */
    … …  
    425387     *
    426388     * @since 3.0.0
    427      * @access public
    428389     * @var string
    429390     */
    … …  
    434395     *
    435396     * @since 3.0.0
    436      * @access public
    437397     * @var string
    438398     */
    … …  
    443403     *
    444404     * @since 3.0.0
    445      * @access public
    446405     * @var string
    447406     */
    … …  
    452411     *
    453412     * @since 3.0.0
    454      * @access public
    455413     * @var string
    456414     */
    … …  
    461419     *
    462420     * @since 3.0.0
    463      * @access public
    464421     * @var string
    465422     */
    … …  
    470427     *
    471428     * @since 3.0.0
    472      * @access public
    473429     * @var string
    474430     */
    … …  
    486442     * @see wpdb::delete()
    487443     * @see wp_set_wpdb_vars()
    488      * @access public
    489444     * @var array
    490445     */
    … …  
    495450     *
    496451     * @since 2.2.0
    497      * @access public
    498452     * @var string
    499453     */
    … …  
    504458     *
    505459     * @since 2.2.0
    506      * @access public
    507460     * @var string
    508461     */
    … …  
    513466     *
    514467     * @since 2.9.0
    515      * @access protected
    516468     * @var string
    517469     */
    … …  
    522474     *
    523475     * @since 3.1.0
    524      * @access protected
    525476     * @var string
    526477     */
    … …  
    531482     *
    532483     * @since 3.1.0
    533      * @access protected
    534484     * @var string
    535485     */
    … …  
    540490     *
    541491     * @since 3.1.0
    542      * @access protected
    543492     * @var string
    544493     */
    … …  
    549498     *
    550499     * @since 0.71
    551      * @access protected
    552500     * @var string
    553501     */
    … …  
    558506     *
    559507     * @since 3.0.0
    560      * @access public
    561508     * @var string
    562509     */
    … …  
    572519     *
    573520     * @since 3.3.0
    574      * @access public
    575521     * @var bool
    576522     */
    … …  
    581527     *
    582528     * @since 3.9.0
    583      * @access protected
    584529     * @var array
    585530     */
    … …  
    591536     *
    592537     * @since 3.9.0
    593      * @access private
    594538     * @var bool
    595539     */
    … …  
    600544     *
    601545     * @since 3.9.0
    602      * @access private
    603546     * @var bool
    604547     */
    … …  
    763706     *
    764707     * @since 4.6.0
    765      * @access public
    766708     *
    767709     * @param string $charset The character set to check.
    … …  
    950892     *
    951893     * @since 3.0.0
    952      * @access public
    953894     *
    954895     * @param int $blog_id
    … …  
    11421083     * @see wpdb::prepare
    11431084     * @see esc_sql()
    1144      * @access private
    11451085     *
    11461086     * @param string $string
    … …  
    11591099     * @see mysql_real_escape_string()
    11601100     * @since 2.8.0
    1161      * @access private
    11621101     *
    11631102     * @param  string $string to escape
    … …  
    11881127     * @uses wpdb::_real_escape()
    11891128     * @since  2.8.0
    1190      * @access public
    11911129     *
    11921130     * @param  string|array $data
    … …  
    13261264     *
    13271265     * @since 4.0.0
    1328      * @access public
    13291266     *
    13301267     * @param string $text The raw text to be escaped. The input typed by the user should have no
    … …  
    18621799     * @since 3.9.0
    18631800     *
    1864      * @access private
    18651801     * @see wpdb::query()
    18661802     *
    … …  
    19391875     * Runs an insert or replace query based on $type argument.
    19401876     *
    1941      * @access private
    19421877     * @since 3.0.0
    19431878     * @see wpdb::prepare()
    … …  
    21222057     *
    21232058     * @since 4.2.0
    2124      * @access protected
    21252059     *
    21262060     * @param string $table  Table name.
    … …  
    21592093     *
    21602094     * @since 4.2.0
    2161      * @access protected
    21622095     *
    21632096     * @param array $data   Array of fields to values.
    … …  
    21952128     *
    21962129     * @since 4.2.0
    2197      * @access protected
    21982130     *
    21992131     * @param array  $data  As it comes from the wpdb::process_field_formats() method.
    … …  
    22262158     *
    22272159     * @since 4.2.1
    2228      * @access protected
    22292160     *
    22302161     * @param array  $data  As it comes from the wpdb::process_field_charsets() method.
    … …  
    24282359     *
    24292360     * @since 4.2.0
    2430      * @access protected
    24312361     *
    24322362     * @param string $table Table name.
    … …  
    25292459     *
    25302460     * @since 4.2.0
    2531      * @access public
    25322461     *
    25332462     * @param string $table  Table name.
    … …  
    25942523     *
    25952524     * @since 4.2.1
    2596      * @access public
    25972525     *
    25982526     * @param string $table  Table name.
    … …  
    26872615     *
    26882616     * @since 4.2.0
    2689      * @access protected
    26902617     *
    26912618     * @param string $string String to check.
    … …  
    27082635     *
    27092636     * @since 4.2.0
    2710      * @access protected
    27112637     *
    27122638     * @param string $query The query to check.
    … …  
    27662692     *
    27672693     * @since 4.2.0
    2768      * @access protected
    27692694     *
    27702695     * @param array $data Array of value arrays. Each value array has the keys
    … …  
    29262851     *
    29272852     * @since 4.2.0
    2928      * @access protected
    29292853     *
    29302854     * @param string $query Query to convert.
    … …  
    29722896     *
    29732897     * @since 4.2.0
    2974      * @access public
    29752898     *
    29762899     * @param string $table  Table name.
    … …  
    30132936     *
    30142937     * @since 4.2.0
    3015      * @access protected
    30162938     *
    30172939     * @param string $query The query to search.
    … …  
    30803002     * @since 3.5.0
    30813003     *
    3082      * @access protected
    30833004     */
    30843005    protected function load_col_info() {
    … …  
    31773098     *
    31783099     * @since 4.5.0
    3179      * @access public
    31803100     *
    31813101     * @return bool True if the connection was successfully closed, false if it wasn't,
Note: See TracChangeset for help on using the changeset viewer.