WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.
Built from https://develop.svn.wordpress.org/trunk@42746


git-svn-id: http://core.svn.wordpress.org/trunk@42576 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2018-02-25 20:22:30 +00:00
parent 0fea564b7d
commit 08227812a0
26 changed files with 1 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
wp-includes/class-http.php
View File

@ -439,7 +439,6 @@ class WP_Http {
* Normalizes cookies for using in Requests.
*
* @since 4.6.0
* @static
*
* @param array $cookies List of cookies to send with the request.
* @return Requests_Cookie_Jar Cookie holder object.
@ -466,7 +465,6 @@ class WP_Http {
* specification for compatibility purposes.
*
* @since 4.6.0
* @static
*
* @param string $location URL to redirect to.
* @param array $headers Headers for the redirect.
@ -642,7 +640,6 @@ class WP_Http {
/**
* Parses the responses and splits the parts into headers and body.
*
* @static
* @since 2.7.0
*
* @param string $strResponse The full response string
@ -663,7 +660,6 @@ class WP_Http {
* If an array is given then it is assumed to be raw header data with numeric keys with the
* headers as the values. No headers must be passed that were already processed.
*
* @static
* @since 2.7.0
*
* @param string|array $headers
@ -751,7 +747,6 @@ class WP_Http {
* Edits the array by reference.
*
* @since 2.8.0
* @static
*
* @param array $r Full array of args passed into ::request()
*/
@ -787,7 +782,6 @@ class WP_Http {
* @link https://tools.ietf.org/html/rfc2616#section-19.4.6 Process for chunked decoding.
*
* @since 2.7.0
* @static
*
* @param string $body Body content
* @return string Chunked decoded body on success or raw body on failure.
@ -921,8 +915,6 @@ class WP_Http {
*
* @since 3.4.0
*
* @static
*
* @param string $maybe_relative_path The URL which might be relative
* @param string $url The URL which $maybe_relative_path is relative to
* @return string An Absolute URL, in a failure condition where the URL cannot be parsed, the relative URL will be returned.
@ -996,7 +988,6 @@ class WP_Http {
* Handles HTTP Redirects and follows them if appropriate.
*
* @since 3.7.0
* @static
*
* @param string $url The URL which was requested.
* @param array $args The Arguments which were used to make the request.
@ -1058,7 +1049,6 @@ class WP_Http {
* @link http://home.deds.nl/~aeron/regex/ for IPv6 regex
*
* @since 3.7.0
* @static
*
* @param string $maybe_ip A suspected IP address
* @return integer|bool Upon success, '4' or '6' to represent a IPv4 or IPv6 address, false upon failure

2
wp-includes/class-oembed.php
View File

@ -290,7 +290,6 @@ class WP_oEmbed {
*
* The just-in-time addition is for the benefit of the {@see 'oembed_providers'} filter.
*
* @static
* @since 4.0.0
*
* @see wp_oembed_add_provider()
@ -318,7 +317,6 @@ class WP_oEmbed {
* The just-in-time removal is for the benefit of the {@see 'oembed_providers'} filter.
*
* @since 4.0.0
* @static
*
* @see wp_oembed_remove_provider()
*

1
wp-includes/class-wp-comment.php
View File

@ -162,7 +162,6 @@ final class WP_Comment {
* Retrieves a WP_Comment instance.
*
* @since 4.4.0
* @static
*
* @global wpdb $wpdb WordPress database abstraction object.
*

15
wp-includes/class-wp-editor.php
View File

@ -35,7 +35,6 @@ final class _WP_Editors {
/**
* Parse default arguments for the editor instance.
*
* @static
* @param string $editor_id ID for the current editor instance.
* @param array $settings {
* Array of editor arguments.
@ -148,7 +147,6 @@ final class _WP_Editors {
/**
* Outputs the HTML for a single instance of the editor.
*
* @static
* @param string $content The initial content of the editor.
* @param string $editor_id ID for the textarea and TinyMCE and Quicktags instances (can contain only ASCII letters and numbers).
* @param array $settings See _WP_Editors::parse_settings() for description.
@ -307,8 +305,6 @@ final class _WP_Editors {
}
/**
* @static
*
* @global string $tinymce_version
*
* @param string $editor_id
@ -733,7 +729,6 @@ final class _WP_Editors {
}
/**
* @static
* @param array $init
* @return string
*/
@ -760,8 +755,6 @@ final class _WP_Editors {
}
/**
* @static
*
* @param bool $default_scripts Optional. Whether default scripts should be enqueued. Default false.
*/
public static function enqueue_scripts( $default_scripts = false ) {
@ -1338,7 +1331,6 @@ final class _WP_Editors {
* Translates the default TinyMCE strings and returns them as JSON encoded object ready to be loaded with tinymce.addI18n(),
* or as JS snippet that should run after tinymce.js is loaded.
*
* @static
* @param string $mce_locale The locale used for the editor.
* @param bool $json_only optional Whether to include the JavaScript calls to tinymce.addI18n() and tinymce.ScriptLoader.markDone().
* @return string Translation object, JSON encoded.
@ -1398,7 +1390,6 @@ final class _WP_Editors {
*
* @since 4.8.0
*
* @static
* @global string $tinymce_version
* @global bool $concatenate_scripts
* @global bool $compress_scripts
@ -1439,7 +1430,6 @@ final class _WP_Editors {
/**
* Print (output) the TinyMCE configuration and initialization scripts.
*
* @static
* @global string $tinymce_version
*/
public static function editor_js() {
@ -1595,8 +1585,6 @@ final class _WP_Editors {
*
* @since 3.2.0
* @deprecated 4.3.0
*
* @static
*/
public static function wp_fullscreen_html() {
_deprecated_function( __FUNCTION__, '4.3.0' );
@ -1607,7 +1595,6 @@ final class _WP_Editors {
*
* @since 3.1.0
*
* @static
* @param array $args Optional. Accepts 'pagenum' and 's' (search) arguments.
* @return false|array Results.
*/
@ -1697,8 +1684,6 @@ final class _WP_Editors {
* Dialog for internal linking.
*
* @since 3.1.0
*
* @static
*/
public static function wp_link_dialog() {
// Run once

1
wp-includes/class-wp-hook.php
View File

@ -356,7 +356,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Normalizes filters set up before WordPress has initialized to WP_Hook objects.
*
* @since 4.7.0
* @static
*
* @param array $filters Filters to normalize.
* @return WP_Hook[] Array of normalized filters.

1
wp-includes/class-wp-http-curl.php
View File

@ -373,7 +373,6 @@ class WP_Http_Curl {
/**
* Determines whether this class can be used for retrieving a URL.
*
* @static
* @since 2.7.0
*
* @param array $args Optional. Array of request arguments. Default empty array.

14
wp-includes/class-wp-http-encoding.php
View File

@ -23,8 +23,6 @@ class WP_Http_Encoding {
*
* @since 2.8.0
*
* @static
*
* @param string $raw String to compress.
* @param int $level Optional, default is 9. Compression level, 9 is highest.
* @param string $supports Optional, not used. When implemented it will choose the right compression based on what the server supports.
@ -44,8 +42,6 @@ class WP_Http_Encoding {
*
* @since 2.8.0
*
* @static
*
* @param string $compressed String to decompress.
* @param int $length The optional length of the compressed data.
* @return string|bool False on failure.
@ -96,8 +92,6 @@ class WP_Http_Encoding {
* @link https://secure.php.net/manual/en/function.gzinflate.php#70875
* @link https://secure.php.net/manual/en/function.gzinflate.php#77336
*
* @static
*
* @param string $gzData String to decompress.
* @return string|bool False on failure.
*/
@ -142,8 +136,6 @@ class WP_Http_Encoding {
*
* @since 2.8.0
*
* @static
*
* @param string $url
* @param array $args
* @return string Types of encoding to accept.
@ -194,8 +186,6 @@ class WP_Http_Encoding {
*
* @since 2.8.0
*
* @static
*
* @return string Content-Encoding string to send in the header.
*/
public static function content_encoding() {
@ -207,8 +197,6 @@ class WP_Http_Encoding {
*
* @since 2.8.0
*
* @static
*
* @param array|string $headers All of the available headers.
* @return bool
*/
@ -233,8 +221,6 @@ class WP_Http_Encoding {
*
* @since 2.8.0
*
* @static
*
* @return bool
*/
public static function is_available() {

2
wp-includes/class-wp-http-streams.php
View File

@ -358,7 +358,6 @@ class WP_Http_Streams {
* IP Address support is included if the request is being made to an IP address.
*
* @since 3.7.0
* @static
*
* @param stream $stream The PHP Stream which the SSL request is being made over
* @param string $host The hostname being requested
@ -420,7 +419,6 @@ class WP_Http_Streams {
/**
* Determines whether this class can be used for retrieving a URL.
*
* @static
* @since 2.7.0
* @since 3.7.0 Combined with the fsockopen transport and switched to stream_socket_client().
*

4
wp-includes/class-wp-image-editor-gd.php
View File

@ -33,8 +33,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
*
* @since 3.5.0
*
* @static
*
* @param array $args
* @return bool
*/
@ -59,8 +57,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
*
* @since 3.5.0
*
* @static
*
* @param string $mime_type
* @return bool
*/

4
wp-includes/class-wp-image-editor-imagick.php
View File

@ -37,8 +37,6 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
*
* @since 3.5.0
*
* @static
*
* @param array $args
* @return bool
*/
@ -98,8 +96,6 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
*
* @since 3.5.0
*
* @static
*
* @param string $mime_type
* @return bool
*/

6
wp-includes/class-wp-image-editor.php
View File

@ -34,7 +34,6 @@ abstract class WP_Image_Editor {
*
* @since 3.5.0
*
* @static
* @abstract
*
* @param array $args
@ -50,7 +49,6 @@ abstract class WP_Image_Editor {
*
* @since 3.5.0
*
* @static
* @abstract
*
* @param string $mime_type
@ -430,8 +428,6 @@ abstract class WP_Image_Editor {
*
* @since 3.5.0
*
* @static
*
* @param string $extension
* @return string|false
*/
@ -458,8 +454,6 @@ abstract class WP_Image_Editor {
*
* @since 3.5.0
*
* @static
*
* @param string $mime_type
* @return string|false
*/

2
wp-includes/class-wp-matchesmapregex.php
View File

@ -57,8 +57,6 @@ class WP_MatchesMapRegex {
*
* static helper function to ease use
*
* @static
*
* @param string $subject subject
* @param array $matches data used for substitution
* @return string

1
wp-includes/class-wp-network.php
View File

@ -318,7 +318,6 @@ class WP_Network {
* requested site address.
*
* @since 4.4.0
* @static
*
* @param string $domain Domain to check.
* @param string $path Path to check.

1
wp-includes/class-wp-post.php
View File

@ -222,7 +222,6 @@ final class WP_Post {
* Retrieve WP_Post instance.
*
* @since 3.5.0
* @static
*
* @global wpdb $wpdb WordPress database abstraction object.
*

3
wp-includes/class-wp-session-tokens.php
View File

@ -40,7 +40,6 @@ abstract class WP_Session_Tokens {
* the session manager for a subclass of `WP_Session_Tokens`.
*
* @since 4.0.0
* @static
*
* @param int $user_id User whose session to manage.
* @return WP_User_Meta_Session_Tokens WP_User_Meta_Session_Tokens class instance by default.
@ -223,7 +222,6 @@ abstract class WP_Session_Tokens {
* Destroy all session tokens for all users.
*
* @since 4.0.0
* @static
*/
final public static function destroy_all_for_all_users() {
/** This filter is documented in wp-includes/class-wp-session-tokens.php */
@ -294,7 +292,6 @@ abstract class WP_Session_Tokens {
* This static method should destroy all session tokens for all users.
*
* @since 4.0.0
* @static
*/
public static function drop_sessions() {}
}

1
wp-includes/class-wp-site.php
View File

@ -145,7 +145,6 @@ final class WP_Site {
/**
* Retrieves a site from the database by its ID.
*
* @static
* @since 4.5.0
*
* @global wpdb $wpdb WordPress database abstraction object.

2
wp-includes/class-wp-tax-query.php
View File

@ -224,8 +224,6 @@ class WP_Tax_Query {
*
* @since 4.1.0
*
* @static
*
* @param array $query Tax query arguments.
* @return bool Whether the query clause is a first-order clause.
*/

1
wp-includes/class-wp-term.php
View File

@ -102,7 +102,6 @@ final class WP_Term {
* Retrieve WP_Term instance.
*
* @since 4.4.0
* @static
*
* @global wpdb $wpdb WordPress database abstraction object.
*

16
wp-includes/class-wp-theme.php
View File

@ -1210,8 +1210,6 @@ final class WP_Theme implements ArrayAccess {
*
* @since 3.4.0
*
* @static
*
* @param string $path Absolute path to search.
* @param array|string|null $extensions Optional. Array of extensions to find, string of a single extension,
* or null for all extensions. Default null.
@ -1362,8 +1360,6 @@ final class WP_Theme implements ArrayAccess {
*
* @since 3.4.0
*
* @static
*
* @param int $blog_id Optional. ID of the site. Defaults to the current site.
* @return array Array of stylesheet names.
*/
@ -1388,8 +1384,6 @@ final class WP_Theme implements ArrayAccess {
*
* @since 3.4.0
*
* @static
*
* @staticvar array $allowed_themes
*
* @return array Array of stylesheet names.
@ -1417,8 +1411,6 @@ final class WP_Theme implements ArrayAccess {
*
* @since 3.4.0
*
* @static
*
* @staticvar array $allowed_themes
*
* @param int $blog_id Optional. ID of the site. Defaults to the current site.
@ -1498,7 +1490,6 @@ final class WP_Theme implements ArrayAccess {
* Enables a theme for all sites on the current network.
*
* @since 4.6.0
* @static
*
* @param string|array $stylesheets Stylesheet name or array of stylesheet names.
*/
@ -1523,7 +1514,6 @@ final class WP_Theme implements ArrayAccess {
* Disables a theme for all sites on the current network.
*
* @since 4.6.0
* @static
*
* @param string|array $stylesheets Stylesheet name or array of stylesheet names.
*/
@ -1551,8 +1541,6 @@ final class WP_Theme implements ArrayAccess {
*
* @since 3.4.0
*
* @static
*
* @param array $themes Array of themes to sort (passed by reference).
*/
public static function sort_by_name( &$themes ) {
@ -1574,8 +1562,6 @@ final class WP_Theme implements ArrayAccess {
*
* @since 3.4.0
*
* @static
*
* @param string $a First name.
* @param string $b Second name.
* @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.
@ -1590,8 +1576,6 @@ final class WP_Theme implements ArrayAccess {
*
* @since 3.4.0
*
* @static
*
* @param string $a First name.
* @param string $b Second name.
* @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.

1
wp-includes/class-wp-user-meta-session-tokens.php
View File

@ -124,7 +124,6 @@ class WP_User_Meta_Session_Tokens extends WP_Session_Tokens {
* Destroy all session tokens for all users.
*
* @since 4.0.0
* @static
*/
public static function drop_sessions() {
delete_metadata( 'user', 0, 'session_tokens', false, true );

2
wp-includes/class-wp-user.php
View File

@ -180,8 +180,6 @@ class WP_User {
* @since 3.3.0
* @since 4.4.0 Added 'ID' as an alias of 'id' for the `$field` parameter.
*
* @static
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $field The field to query against: 'id', 'ID', 'slug', 'email' or 'login'.

1
wp-includes/customize/class-wp-customize-nav-menu-item-setting.php
View File

@ -538,7 +538,6 @@ class WP_Customize_Nav_Menu_Item_Setting extends WP_Customize_Setting {
* Re-apply the tail logic also applied on $items by wp_get_nav_menu_items().
*
* @since 4.3.0
* @static
*
* @see wp_get_nav_menu_items()
*

4
wp-includes/pomo/po.php
View File

@ -100,7 +100,6 @@ if ( ! class_exists( 'PO', false ) ) :
/**
* Formats a string in PO-style
*
* @static
* @param string $string the string to format
* @return string the poified string
*/
@ -131,7 +130,6 @@ if ( ! class_exists( 'PO', false ) ) :
/**
* Gives back the original string from a PO-formatted string
*
* @static
* @param string $string PO-formatted string
* @return string enascaped string
*/
@ -173,7 +171,6 @@ if ( ! class_exists( 'PO', false ) ) :
* Inserts $with in the beginning of every new line of $string and
* returns the modified string
*
* @static
* @param string $string prepend lines in this string
* @param string $with prepend lines with this string
*/
@ -211,7 +208,6 @@ if ( ! class_exists( 'PO', false ) ) :
/**
* Builds a string from the entry for inclusion in PO file
*
* @static
* @param Translation_Entry $entry the entry to convert to po string (passed by reference).
* @return false|string PO-style formatted string for the entry or
* false if the entry is empty

2
wp-includes/rest-api/class-wp-rest-request.php
View File

@ -174,7 +174,6 @@ class WP_REST_Request implements ArrayAccess {
* @link https://nginx.org/en/docs/http/ngx_http_core_module.html#underscores_in_headers
*
* @since 4.4.0
* @static
*
* @param string $key Header name.
* @return string Canonicalized name.
@ -953,7 +952,6 @@ class WP_REST_Request implements ArrayAccess {
/**
* Retrieves a WP_REST_Request object from a full URL.
*
* @static
* @since 4.5.0
*
* @param string $url URL with protocol, domain, path and query args.

2
wp-includes/rest-api/class-wp-rest-server.php
View File

@ -459,7 +459,6 @@ class WP_REST_Server {
* direct output.
*
* @since 4.4.0
* @static
*
* @param WP_REST_Response $response Response to extract links from.
* @return array Map of link relation to list of link hashes.
@ -492,7 +491,6 @@ class WP_REST_Server {
* direct output.
*
* @since 4.5.0
* @static
*
* @param WP_REST_Response $response Response to extract links from.
* @return array Map of link relation to list of link hashes.

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.0-alpha-42745';
$wp_version = '5.0-alpha-42746';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.