Make WordPress Core

Changeset 42746


Ignore:
Timestamp:
02/25/2018 08:21:37 PM (9 years ago)
Author:
SergeyBiryukov
Message:

Docs: Remove @static notations from method DocBlocks in wp-includes/* classes.

This tag has been used in the past, but should no longer be used. Just using the static keyword in code is enough for PhpDocumentor on PHP5+ to recognize static variables and methods, and PhpDocumentor will mark them as static.

Props birgire.
See #42803.

Location:
trunk/src/wp-includes
Files:
25 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-http.php

    r42682 r42746  
    440440         *
    441441         * @since 4.6.0
    442          * @static
    443442         *
    444443         * @param array $cookies List of cookies to send with the request.
     
    467466         *
    468467         * @since 4.6.0
    469          * @static
    470468         *
    471469         * @param string            $location URL to redirect to.
     
    643641         * Parses the responses and splits the parts into headers and body.
    644642         *
    645          * @static
    646643         * @since 2.7.0
    647644         *
     
    664661         * headers as the values. No headers must be passed that were already processed.
    665662         *
    666          * @static
    667663         * @since 2.7.0
    668664         *
     
    752748         *
    753749         * @since 2.8.0
    754          * @static
    755750         *
    756751         * @param array $r Full array of args passed into ::request()
     
    788783         *
    789784         * @since 2.7.0
    790          * @static
    791785         *
    792786         * @param string $body Body content
     
    922916         * @since 3.4.0
    923917         *
    924          * @static
    925          *
    926918         * @param string $maybe_relative_path The URL which might be relative
    927919         * @param string $url                 The URL which $maybe_relative_path is relative to
     
    997989         *
    998990         * @since 3.7.0
    999          * @static
    1000991         *
    1001992         * @param string $url The URL which was requested.
     
    10591050         *
    10601051         * @since 3.7.0
    1061          * @static
    10621052         *
    10631053         * @param string $maybe_ip A suspected IP address
  • trunk/src/wp-includes/class-oembed.php

    r42343 r42746  
    291291         * The just-in-time addition is for the benefit of the {@see 'oembed_providers'} filter.
    292292         *
    293          * @static
    294293         * @since 4.0.0
    295294         *
     
    319318         *
    320319         * @since 4.0.0
    321          * @static
    322320         *
    323321         * @see wp_oembed_remove_provider()
  • trunk/src/wp-includes/class-wp-comment.php

    r42343 r42746  
    163163         *
    164164         * @since 4.4.0
    165          * @static
    166165         *
    167166         * @global wpdb $wpdb WordPress database abstraction object.
  • trunk/src/wp-includes/class-wp-editor.php

    r42630 r42746  
    3636         * Parse default arguments for the editor instance.
    3737         *
    38          * @static
    3938         * @param string $editor_id ID for the current editor instance.
    4039         * @param array  $settings {
     
    149148         * Outputs the HTML for a single instance of the editor.
    150149         *
    151          * @static
    152150         * @param string $content The initial content of the editor.
    153151         * @param string $editor_id ID for the textarea and TinyMCE and Quicktags instances (can contain only ASCII letters and numbers).
     
    308306
    309307        /**
    310          * @static
    311          *
    312308         * @global string $tinymce_version
    313309         *
     
    734730
    735731        /**
    736          * @static
    737732         * @param array $init
    738733         * @return string
     
    761756
    762757        /**
    763          * @static
    764          *
    765758         * @param bool $default_scripts Optional. Whether default scripts should be enqueued. Default false.
    766759         */
     
    13391332         * or as JS snippet that should run after tinymce.js is loaded.
    13401333         *
    1341          * @static
    13421334         * @param string $mce_locale The locale used for the editor.
    13431335         * @param bool $json_only optional Whether to include the JavaScript calls to tinymce.addI18n() and tinymce.ScriptLoader.markDone().
     
    13991391         * @since 4.8.0
    14001392         *
    1401          * @static
    14021393         * @global string $tinymce_version
    14031394         * @global bool   $concatenate_scripts
     
    14401431         * Print (output) the TinyMCE configuration and initialization scripts.
    14411432         *
    1442          * @static
    14431433         * @global string $tinymce_version
    14441434         */
     
    15961586         * @since 3.2.0
    15971587         * @deprecated 4.3.0
    1598          *
    1599          * @static
    16001588         */
    16011589        public static function wp_fullscreen_html() {
     
    16081596         * @since 3.1.0
    16091597         *
    1610          * @static
    16111598         * @param array $args Optional. Accepts 'pagenum' and 's' (search) arguments.
    16121599         * @return false|array Results.
     
    16981685         *
    16991686         * @since 3.1.0
    1700          *
    1701          * @static
    17021687         */
    17031688        public static function wp_link_dialog() {
  • trunk/src/wp-includes/class-wp-hook.php

    r42343 r42746  
    357357         *
    358358         * @since 4.7.0
    359          * @static
    360359         *
    361360         * @param array $filters Filters to normalize.
  • trunk/src/wp-includes/class-wp-http-curl.php

    r42682 r42746  
    374374         * Determines whether this class can be used for retrieving a URL.
    375375         *
    376          * @static
    377376         * @since 2.7.0
    378377         *
  • trunk/src/wp-includes/class-wp-http-encoding.php

    r42343 r42746  
    2424         * @since 2.8.0
    2525         *
    26          * @static
    27          *
    2826         * @param string $raw String to compress.
    2927         * @param int $level Optional, default is 9. Compression level, 9 is highest.
     
    4543         * @since 2.8.0
    4644         *
    47          * @static
    48          *
    4945         * @param string $compressed String to decompress.
    5046         * @param int $length The optional length of the compressed data.
     
    9692         * @link https://secure.php.net/manual/en/function.gzinflate.php#70875
    9793         * @link https://secure.php.net/manual/en/function.gzinflate.php#77336
    98          *
    99          * @static
    10094         *
    10195         * @param string $gzData String to decompress.
     
    142136         *
    143137         * @since 2.8.0
    144          *
    145          * @static
    146138         *
    147139         * @param string $url
     
    195187         * @since 2.8.0
    196188         *
    197          * @static
    198          *
    199189         * @return string Content-Encoding string to send in the header.
    200190         */
     
    207197         *
    208198         * @since 2.8.0
    209          *
    210          * @static
    211199         *
    212200         * @param array|string $headers All of the available headers.
     
    234222         * @since 2.8.0
    235223         *
    236          * @static
    237          *
    238224         * @return bool
    239225         */
  • trunk/src/wp-includes/class-wp-http-streams.php

    r42682 r42746  
    359359         *
    360360         * @since 3.7.0
    361          * @static
    362361         *
    363362         * @param stream $stream The PHP Stream which the SSL request is being made over
     
    421420         * Determines whether this class can be used for retrieving a URL.
    422421         *
    423          * @static
    424422         * @since 2.7.0
    425423         * @since 3.7.0 Combined with the fsockopen transport and switched to stream_socket_client().
  • trunk/src/wp-includes/class-wp-image-editor-gd.php

    r42343 r42746  
    3434         * @since 3.5.0
    3535         *
    36          * @static
    37          *
    3836         * @param array $args
    3937         * @return bool
     
    5957         *
    6058         * @since 3.5.0
    61          *
    62          * @static
    6359         *
    6460         * @param string $mime_type
  • trunk/src/wp-includes/class-wp-image-editor-imagick.php

    r42343 r42746  
    3737         *
    3838         * @since 3.5.0
    39          *
    40          * @static
    4139         *
    4240         * @param array $args
     
    9997         * @since 3.5.0
    10098         *
    101          * @static
    102          *
    10399         * @param string $mime_type
    104100         * @return bool
  • trunk/src/wp-includes/class-wp-image-editor.php

    r42702 r42746  
    3535         * @since 3.5.0
    3636         *
    37          * @static
    3837         * @abstract
    3938         *
     
    5150         * @since 3.5.0
    5251         *
    53          * @static
    5452         * @abstract
    5553         *
     
    431429         * @since 3.5.0
    432430         *
    433          * @static
    434          *
    435431         * @param string $extension
    436432         * @return string|false
     
    459455         * @since 3.5.0
    460456         *
    461          * @static
    462          *
    463457         * @param string $mime_type
    464458         * @return string|false
  • trunk/src/wp-includes/class-wp-matchesmapregex.php

    r42343 r42746  
    5858         * static helper function to ease use
    5959         *
    60          * @static
    61          *
    6260         * @param string $subject subject
    6361         * @param array  $matches data used for substitution
  • trunk/src/wp-includes/class-wp-network.php

    r42343 r42746  
    319319         *
    320320         * @since 4.4.0
    321          * @static
    322321         *
    323322         * @param string   $domain   Domain to check.
  • trunk/src/wp-includes/class-wp-post.php

    r42343 r42746  
    223223         *
    224224         * @since 3.5.0
    225          * @static
    226225         *
    227226         * @global wpdb $wpdb WordPress database abstraction object.
  • trunk/src/wp-includes/class-wp-session-tokens.php

    r42343 r42746  
    4141         *
    4242         * @since 4.0.0
    43          * @static
    4443         *
    4544         * @param int $user_id User whose session to manage.
     
    224223         *
    225224         * @since 4.0.0
    226          * @static
    227225         */
    228226        final public static function destroy_all_for_all_users() {
     
    295293         *
    296294         * @since 4.0.0
    297          * @static
    298295         */
    299296        public static function drop_sessions() {}
  • trunk/src/wp-includes/class-wp-site.php

    r42343 r42746  
    146146         * Retrieves a site from the database by its ID.
    147147         *
    148          * @static
    149148         * @since 4.5.0
    150149         *
  • trunk/src/wp-includes/class-wp-tax-query.php

    r42343 r42746  
    224224         *
    225225         * @since 4.1.0
    226          *
    227          * @static
    228226         *
    229227         * @param array $query Tax query arguments.
  • trunk/src/wp-includes/class-wp-term.php

    r42343 r42746  
    103103         *
    104104         * @since 4.4.0
    105          * @static
    106105         *
    107106         * @global wpdb $wpdb WordPress database abstraction object.
  • trunk/src/wp-includes/class-wp-theme.php

    r42734 r42746  
    12111211         * @since 3.4.0
    12121212         *
    1213          * @static
    1214          *
    12151213         * @param string            $path          Absolute path to search.
    12161214         * @param array|string|null $extensions    Optional. Array of extensions to find, string of a single extension,
     
    13621360         *
    13631361         * @since 3.4.0
    1364          *
    1365          * @static
    13661362         *
    13671363         * @param int $blog_id Optional. ID of the site. Defaults to the current site.
     
    13891385         * @since 3.4.0
    13901386         *
    1391          * @static
    1392          *
    13931387         * @staticvar array $allowed_themes
    13941388         *
     
    14171411         *
    14181412         * @since 3.4.0
    1419          *
    1420          * @static
    14211413         *
    14221414         * @staticvar array $allowed_themes
     
    14991491         *
    15001492         * @since 4.6.0
    1501          * @static
    15021493         *
    15031494         * @param string|array $stylesheets Stylesheet name or array of stylesheet names.
     
    15241515         *
    15251516         * @since 4.6.0
    1526          * @static
    15271517         *
    15281518         * @param string|array $stylesheets Stylesheet name or array of stylesheet names.
     
    15511541         *
    15521542         * @since 3.4.0
    1553          *
    1554          * @static
    15551543         *
    15561544         * @param array $themes Array of themes to sort (passed by reference).
     
    15751563         * @since 3.4.0
    15761564         *
    1577          * @static
    1578          *
    15791565         * @param string $a First name.
    15801566         * @param string $b Second name.
     
    15911577         * @since 3.4.0
    15921578         *
    1593          * @static
    1594          *
    15951579         * @param string $a First name.
    15961580         * @param string $b Second name.
  • trunk/src/wp-includes/class-wp-user-meta-session-tokens.php

    r41162 r42746  
    125125         *
    126126         * @since 4.0.0
    127          * @static
    128127         */
    129128        public static function drop_sessions() {
  • trunk/src/wp-includes/class-wp-user.php

    r42735 r42746  
    181181         * @since 4.4.0 Added 'ID' as an alias of 'id' for the `$field` parameter.
    182182         *
    183          * @static
    184          *
    185183         * @global wpdb $wpdb WordPress database abstraction object.
    186184         *
  • trunk/src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php

    r42343 r42746  
    539539         *
    540540         * @since 4.3.0
    541          * @static
    542541         *
    543542         * @see wp_get_nav_menu_items()
  • trunk/src/wp-includes/pomo/po.php

    r42343 r42746  
    101101                 * Formats a string in PO-style
    102102                 *
    103                  * @static
    104103                 * @param string $string the string to format
    105104                 * @return string the poified string
     
    132131                 * Gives back the original string from a PO-formatted string
    133132                 *
    134                  * @static
    135133                 * @param string $string PO-formatted string
    136134                 * @return string enascaped string
     
    174172                 * returns the modified string
    175173                 *
    176                  * @static
    177174                 * @param string $string prepend lines in this string
    178175                 * @param string $with prepend lines with this string
     
    212209                 * Builds a string from the entry for inclusion in PO file
    213210                 *
    214                  * @static
    215211                 * @param Translation_Entry $entry the entry to convert to po string (passed by reference).
    216212                 * @return false|string PO-style formatted string for the entry or
  • trunk/src/wp-includes/rest-api/class-wp-rest-request.php

    r42343 r42746  
    175175         *
    176176         * @since 4.4.0
    177          * @static
    178177         *
    179178         * @param string $key Header name.
     
    954953         * Retrieves a WP_REST_Request object from a full URL.
    955954         *
    956          * @static
    957955         * @since 4.5.0
    958956         *
  • trunk/src/wp-includes/rest-api/class-wp-rest-server.php

    r42421 r42746  
    460460         *
    461461         * @since 4.4.0
    462          * @static
    463462         *
    464463         * @param WP_REST_Response $response Response to extract links from.
     
    493492         *
    494493         * @since 4.5.0
    495          * @static
    496494         *
    497495         * @param WP_REST_Response $response Response to extract links from.
Note: See TracChangeset for help on using the changeset viewer.