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-session-tokens.php

    r40998 r41162  
    1919     *
    2020     * @since 4.0.0
    21      * @access protected
    2221     * @var int User ID.
    2322     */
     
    4241     *
    4342     * @since 4.0.0
    44      * @access public
    4543     * @static
    4644     *
     
    6563     *
    6664     * @since 4.0.0
    67      * @access private
    6865     *
    6966     * @param string $token Session token to hash.
     
    8380     *
    8481     * @since 4.0.0
    85      * @access public
    8682     *
    8783     * @param string $token Session token
     
    9995     *
    10096     * @since 4.0.0
    101      * @access public
    10297     *
    10398     * @param string $token Token to verify.
     
    121116     *
    122117     * @since 4.0.0
    123      * @access public
    124118     *
    125119     * @param int $expiration Session expiration timestamp.
     
    165159     *
    166160     * @since 4.0.0
    167      * @access public
    168161     *
    169162     * @param string $token Session token to update.
     
    179172     *
    180173     * @since 4.0.0
    181      * @access public
    182174     *
    183175     * @param string $token Session token to destroy.
     
    193185     *
    194186     * @since 4.0.0
    195      * @access public
    196187     *
    197188     * @param string $token_to_keep Session token to keep.
     
    212203     *
    213204     * @since 4.0.0
    214      * @access protected
    215205     *
    216206     * @param array $session Session to check.
     
    225215     *
    226216     * @since 4.0.0
    227      * @access public
    228217     */
    229218    final public function destroy_all() {
     
    235224     *
    236225     * @since 4.0.0
    237      * @access public
    238226     * @static
    239227     */
     
    248236     *
    249237     * @since 4.0.0
    250      * @access public
    251238     *
    252239     * @return array Sessions of a user.
     
    260247     *
    261248     * @since 4.0.0
    262      * @access protected
    263249     *
    264250     * @return array Sessions of a user, keyed by verifier.
     
    270256     *
    271257     * @since 4.0.0
    272      * @access protected
    273258     *
    274259     * @param string $verifier Verifier of the session to retrieve.
     
    283268     *
    284269     * @since 4.0.0
    285      * @access protected
    286270     *
    287271     * @param string $verifier Verifier of the session to update.
     
    295279     *
    296280     * @since 4.0.0
    297      * @access protected
    298281     *
    299282     * @param string $verifier Verifier of the session to keep.
     
    305288     *
    306289     * @since 4.0.0
    307      * @access protected
    308290     */
    309291    abstract protected function destroy_all_sessions();
     
    313295     *
    314296     * @since 4.0.0
    315      * @access public
    316297     * @static
    317298     */
Note: See TracChangeset for help on using the changeset viewer.