WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:40:27 AM (9 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-rewrite.php

    r38751 r41162  
    4444     *
    4545     * @since 1.5.0
    46      * @access private
    4746     * @var string
    4847     */
    … …  
    5352     *
    5453     * @since 1.5.0
    55      * @access private
    5654     * @var string
    5755     */
    … …  
    6260     *
    6361     * @since 1.5.0
    64      * @access private
    6562     * @var string
    6663     */
    … …  
    7168     *
    7269     * @since 1.5.0
    73      * @access private
    7470     * @var string
    7571     */
    … …  
    8076     *
    8177     * @since 1.5.0
    82      * @access private
    8378     * @var string
    8479     */
    … …  
    8984     *
    9085     * @since 1.5.0
    91      * @access private
    9286     * @var string
    9387     */
    … …  
    9892     *
    9993     * @since 1.5.0
    100      * @access private
    10194     * @var string
    10295     */
    … …  
    115108     *
    116109     * @since 4.2.0
    117      * @access private
    118110     * @var string
    119111     */
    … …  
    124116     *
    125117     * @since 1.5.0
    126      * @access private
    127118     * @var string
    128119     */
    … …  
    133124     *
    134125     * @since 1.5.0
    135      * @access private
    136126     * @var string
    137127     */
    … …  
    142132     *
    143133     * @since 1.5.0
    144      * @access private
    145134     * @var string
    146135     */
    … …  
    155144     *
    156145     * @since 1.5.0
    157      * @access public
    158146     * @var string
    159147     *
    … …  
    170158     *
    171159     * @since 1.5.0
    172      * @access public
    173160     * @var string
    174161     *
    … …  
    182169     *
    183170     * @since 1.5.0
    184      * @access public
    185171     * @var string
    186172     */
    … …  
    191177     *
    192178     * @since 1.5.0
    193      * @access private
    194179     * @var string
    195180     */
    … …  
    200185     *
    201186     * @since 1.5.0
    202      * @access private
    203187     * @var array
    204188     */
    … …  
    211195     *
    212196     * @since 2.1.0
    213      * @access private
    214197     * @var array
    215198     */
    … …  
    222205     *
    223206     * @since 2.3.0
    224      * @access private
    225207     * @var array
    226208     */
    … …  
    234216     *
    235217     * @since 2.1.0
    236      * @access private
    237218     * @var array
    238219     */
    … …  
    243224     *
    244225     * @since 2.1.0
    245      * @access private
    246226     * @var array
    247227     */
    … …  
    252232     *
    253233     * @since 2.1.0
    254      * @access private
    255234     * @var array
    256235     */
    … …  
    264243     *
    265244     * @since 2.0.0
    266      * @access public
    267245     * @var bool
    268246     *
    … …  
    282260     *
    283261     * @since 2.5.0
    284      * @access public
    285262     * @var bool
    286263     *
    … …  
    299276     *
    300277     * @since 1.5.0
    301      * @access private
    302278     * @var array
    303279     */
    … …  
    321297     *
    322298     * @since 1.5.0
    323      * @access private
    324299     * @var array
    325300     */
    … …  
    342317     *
    343318     * @since 1.5.0
    344      * @access private
    345319     * @var array
    346320     */
    … …  
    373347     *
    374348     * @since 1.5.0
    375      * @access public
    376349     *
    377350     * @return bool True, if permalinks are enabled.
    … …  
    387360     *
    388361     * @since 1.5.0
    389      * @access public
    390362     *
    391363     * @return bool Whether permalink links are enabled and index.php is in the URL.
    … …  
    406378     *
    407379     * @since 1.5.0
    408      * @access public
    409380     *
    410381     * @return bool Whether permalink links are enabled and index.php is NOT in the URL.
    … …  
    425396     *
    426397     * @since 1.5.0
    427      * @access public
    428398     *
    429399     * @param int $number Index number.
    … …  
    449419     *
    450420     * @since 2.5.0
    451      * @access public
    452421     *
    453422     * @global wpdb $wpdb WordPress database abstraction object.
    … …  
    493462     *
    494463     * @since 1.5.0
    495      * @access public
    496464     *
    497465     * @return array Page rewrite rules.
    … …  
    520488     *
    521489     * @since 1.5.0
    522      * @access public
    523490     *
    524491     * @return string|false False on no permalink structure. Date permalink structure.
    … …  
    576543     *
    577544     * @since 1.5.0
    578      * @access public
    579545     *
    580546     * @return false|string False on failure. Year structure on success.
    … …  
    600566     *
    601567     * @since 1.5.0
    602      * @access public
    603568     *
    604569     * @return false|string False on failure. Year/Month structure on success.
    … …  
    622587     *
    623588     * @since 1.5.0
    624      * @access public
    625589     *
    626590     * @return string|false False on failure. Year/Month/Day structure on success.
    … …  
    639603     *
    640604     * @since 1.5.0
    641      * @access public
    642605     *
    643606     * @return string|false False on failure. Category permalink structure.
    … …  
    656619     *
    657620     * @since 2.3.0
    658      * @access public
    659621     *
    660622     * @return string|false False on failure. Tag permalink structure.
    … …  
    668630     *
    669631     * @since 2.5.0
    670      * @access public
    671632     *
    672633     * @param string $name Permalink structure name.
    … …  
    691652     *
    692653     * @since 1.5.0
    693      * @access public
    694654     *
    695655     * @return string|false False if not found. Permalink structure string.
    … …  
    717677     *
    718678     * @since 1.5.0
    719      * @access public
    720679     *
    721680     * @return string|false False if not found. Permalink structure string.
    … …  
    743702     *
    744703     * @since 1.5.0
    745      * @access public
    746704     *
    747705     * @return string|false False if not found. Permalink structure string.
    … …  
    769727     *
    770728     * @since 1.5.0
    771      * @access public
    772729     *
    773730     * @return string|false False if not found. Permalink structure string.
    … …  
    795752     *
    796753     * @since 1.5.0
    797      * @access public
    798754     *
    799755     * @return string|false False if not found. Permalink structure string.
    … …  
    820776     *
    821777     * @since 1.5.0
    822      * @access public
    823778     *
    824779     * @see WP_Rewrite::$rewritecode
    … …  
    847802     *
    848803     * @since 4.5.0
    849      * @access public
    850804     *
    851805     * @see WP_Rewrite::$rewritecode
    … …  
    872826     *
    873827     * @since 1.5.0
    874      * @access public
    875828     *
    876829     * @param string $permalink_structure The permalink structure.
    … …  
    12381191     *
    12391192     * @since 1.5.0
    1240      * @access public
    12411193     *
    12421194     * @see WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
    … …  
    12641216     *
    12651217     * @since 1.5.0
    1266      * @access public
    12671218     *
    12681219     * @return array An associate array of matches and queries.
    … …  
    14671418     *
    14681419     * @since 1.5.0
    1469      * @access public
    14701420     *
    14711421     * @return array Rewrite rules.
    … …  
    14961446     *
    14971447     * @since 1.5.0
    1498      * @access public
    14991448     *
    15001449     * @return string
    … …  
    15811530     *
    15821531     * @since 2.8.0
    1583      * @access public
    15841532     *
    15851533     * @param bool $add_parent_tags Optional. Whether to add parent tags to the rewrite rule sets.
    … …  
    16341582     * @since 2.1.0
    16351583     * @since 4.4.0 Array support was added to the `$query` parameter.
    1636      * @access public
    16371584     *
    16381585     * @param string       $regex Regular expression to match request against.
    … …  
    16681615     *
    16691616     * @since 2.1.0
    1670      * @access public
    16711617     *
    16721618     * @param string $regex Regular expression to match request against.
    … …  
    16831629     * @since 3.9.0 $query_var parameter added.
    16841630     * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`.
    1685      * @access public
    16861631     *
    16871632     * @see add_rewrite_endpoint() for full documentation.
    … …  
    17231668     *
    17241669     * @since 2.5.0
    1725      * @access public
    17261670     *
    17271671     * @param string $name   Name for permalink structure.
    … …  
    17791723     *
    17801724     * @since 4.5.0
    1781      * @access public
    17821725     *
    17831726     * @param string $name Name for permalink structure.
    … …  
    17941737     *
    17951738     * @since 2.0.1
    1796      * @access public
    17971739     *
    17981740     * @staticvar bool $do_hard_later
    … …  
    18441786     *
    18451787     * @since 1.5.0
    1846      * @access public
    18471788     */
    18481789    public function init() {
    … …  
    18811822     *
    18821823     * @since 1.5.0
    1883      * @access public
    18841824     *
    18851825     * @param string $permalink_structure Permalink structure.
    … …  
    19121852     *
    19131853     * @since 1.5.0
    1914      * @access public
    19151854     *
    19161855     * @param string $category_base Category permalink structure base.
    … …  
    19311870     *
    19321871     * @since 2.3.0
    1933      * @access public
    19341872     *
    19351873     * @param string $tag_base Tag permalink structure base.
    … …  
    19461884     *
    19471885     * @since 1.5.0
    1948      * @access public
    19491886     *
    19501887     */
Note: See TracChangeset for help on using the changeset viewer.