Docs: First pass at some inline docs fixes mostly made by PHPCBF.

See #49572, #50744
Built from https://develop.svn.wordpress.org/trunk@48586


git-svn-id: http://core.svn.wordpress.org/trunk@48348 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2020-07-23 20:01:04 +00:00
parent 7f898dd9c4
commit 57a3f803ae
42 changed files with 155 additions and 152 deletions

View File

@ -207,7 +207,7 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
* @since 2.7.0 * @since 2.7.0
* *
* @param string $command * @param string $command
* @param bool $returnbool * @param bool $returnbool
* @return bool|string True on success, false on failure. String if the command was executed, `$returnbool` * @return bool|string True on success, false on failure. String if the command was executed, `$returnbool`
* is false (default), and data from the resulting stream was retrieved. * is false (default), and data from the resulting stream was retrieved.
*/ */

View File

@ -233,8 +233,8 @@ class WP_List_Table {
* *
* @since 4.0.0 * @since 4.0.0
* *
* @param string $name Method to call. * @param string $name Method to call.
* @param array $arguments Arguments to pass when calling. * @param array $arguments Arguments to pass when calling.
* @return mixed|bool Return value of the callback, false otherwise. * @return mixed|bool Return value of the callback, false otherwise.
*/ */
public function __call( $name, $arguments ) { public function __call( $name, $arguments ) {

View File

@ -213,7 +213,6 @@ class WP_MS_Sites_List_Table extends WP_List_Table {
* @since 5.3.0 * @since 5.3.0
* *
* @return array * @return array
*
*/ */
protected function get_views() { protected function get_views() {
$counts = wp_count_sites(); $counts = wp_count_sites();

View File

@ -443,8 +443,8 @@ class WP_MS_Users_List_Table extends WP_List_Table {
* *
* @since 4.3.0 * @since 4.3.0
* *
* @param WP_User $user The current WP_User object. * @param WP_User $user The current WP_User object.
* @param string $column_name The current column name. * @param string $column_name The current column name.
*/ */
public function column_default( $user, $column_name ) { public function column_default( $user, $column_name ) {
/** This filter is documented in wp-admin/includes/class-wp-users-list-table.php */ /** This filter is documented in wp-admin/includes/class-wp-users-list-table.php */

View File

@ -714,7 +714,7 @@ class WP_Posts_List_Table extends WP_List_Table {
* @global WP_Query $wp_query WordPress Query object. * @global WP_Query $wp_query WordPress Query object.
* @global int $per_page * @global int $per_page
* @param array $posts * @param array $posts
* @param int $level * @param int $level
*/ */
public function display_rows( $posts = array(), $level = 0 ) { public function display_rows( $posts = array(), $level = 0 ) {
global $wp_query, $per_page; global $wp_query, $per_page;
@ -734,7 +734,7 @@ class WP_Posts_List_Table extends WP_List_Table {
/** /**
* @param array $posts * @param array $posts
* @param int $level * @param int $level
*/ */
private function _display_rows( $posts, $level = 0 ) { private function _display_rows( $posts, $level = 0 ) {
$post_type = $this->screen->post_type; $post_type = $this->screen->post_type;
@ -759,8 +759,8 @@ class WP_Posts_List_Table extends WP_List_Table {
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* @global WP_Post $post Global post object. * @global WP_Post $post Global post object.
* @param array $pages * @param array $pages
* @param int $pagenum * @param int $pagenum
* @param int $per_page * @param int $per_page
*/ */
private function _display_rows_hierarchical( $pages, $pagenum = 1, $per_page = 20 ) { private function _display_rows_hierarchical( $pages, $pagenum = 1, $per_page = 20 ) {
global $wpdb; global $wpdb;
@ -865,11 +865,11 @@ class WP_Posts_List_Table extends WP_List_Table {
* @since 4.2.0 Added the `$to_display` parameter. * @since 4.2.0 Added the `$to_display` parameter.
* *
* @param array $children_pages * @param array $children_pages
* @param int $count * @param int $count
* @param int $parent * @param int $parent
* @param int $level * @param int $level
* @param int $pagenum * @param int $pagenum
* @param int $per_page * @param int $per_page
* @param array $to_display List of pages to be displayed. Passed by reference. * @param array $to_display List of pages to be displayed. Passed by reference.
*/ */
private function _page_rows( &$children_pages, &$count, $parent, $level, $pagenum, $per_page, &$to_display ) { private function _page_rows( &$children_pages, &$count, $parent, $level, $pagenum, $per_page, &$to_display ) {

View File

@ -10,6 +10,7 @@
class WP_Site_Health_Auto_Updates { class WP_Site_Health_Auto_Updates {
/** /**
* WP_Site_Health_Auto_Updates constructor. * WP_Site_Health_Auto_Updates constructor.
*
* @since 5.2.0 * @since 5.2.0
*/ */
public function __construct() { public function __construct() {

View File

@ -269,13 +269,13 @@ class WP_Terms_List_Table extends WP_List_Table {
/** /**
* @param string $taxonomy * @param string $taxonomy
* @param array $terms * @param array $terms
* @param array $children * @param array $children
* @param int $start * @param int $start
* @param int $per_page * @param int $per_page
* @param int $count * @param int $count
* @param int $parent * @param int $parent
* @param int $level * @param int $level
*/ */
private function _rows( $taxonomy, $terms, &$children, $start, $per_page, &$count, $parent = 0, $level = 0 ) { private function _rows( $taxonomy, $terms, &$children, $start, $per_page, &$count, $parent = 0, $level = 0 ) {
@ -332,8 +332,8 @@ class WP_Terms_List_Table extends WP_List_Table {
/** /**
* @global string $taxonomy * @global string $taxonomy
* @param WP_Term $tag Term object. * @param WP_Term $tag Term object.
* @param int $level * @param int $level
*/ */
public function single_row( $tag, $level = 0 ) { public function single_row( $tag, $level = 0 ) {
global $taxonomy; global $taxonomy;
@ -600,8 +600,8 @@ class WP_Terms_List_Table extends WP_List_Table {
} }
/** /**
* @param WP_Term $tag Term object. * @param WP_Term $tag Term object.
* @param string $column_name * @param string $column_name Name of the column.
* @return string * @return string
*/ */
public function column_default( $tag, $column_name ) { public function column_default( $tag, $column_name ) {

View File

@ -1167,7 +1167,7 @@ function wp_dashboard_trigger_widget_control( $widget_control_id = false ) {
* @since 2.5.0 * @since 2.5.0
* *
* @param string $widget_id * @param string $widget_id
* @param array $form_inputs * @param array $form_inputs
*/ */
function wp_dashboard_rss_control( $widget_id, $form_inputs = array() ) { function wp_dashboard_rss_control( $widget_id, $form_inputs = array() ) {
$widget_options = get_option( 'dashboard_widget_options' ); $widget_options = get_option( 'dashboard_widget_options' );

View File

@ -468,8 +468,8 @@ function _wp_make_subsizes( $new_sizes, $file, $image_meta, $attachment_id ) {
* *
* @since 2.1.0 * @since 2.1.0
* *
* @param int $attachment_id Attachment Id to process. * @param int $attachment_id Attachment Id to process.
* @param string $file Filepath of the Attached image. * @param string $file Filepath of the Attached image.
* @return mixed Metadata for attachment. * @return mixed Metadata for attachment.
*/ */
function wp_generate_attachment_metadata( $attachment_id, $file ) { function wp_generate_attachment_metadata( $attachment_id, $file ) {

View File

@ -665,7 +665,7 @@ function media_buttons( $editor_id = 'content' ) {
/** /**
* @global int $post_ID * @global int $post_ID
* @param string $type * @param string $type
* @param int $post_id * @param int $post_id
* @param string $tab * @param string $tab
* @return string * @return string
*/ */
@ -1086,7 +1086,7 @@ function media_upload_library() {
* @since 2.7.0 * @since 2.7.0
* *
* @param WP_Post $post * @param WP_Post $post
* @param string $checked * @param string $checked
* @return string * @return string
*/ */
function image_align_input_fields( $post, $checked = '' ) { function image_align_input_fields( $post, $checked = '' ) {
@ -1123,7 +1123,7 @@ function image_align_input_fields( $post, $checked = '' ) {
* *
* @since 2.7.0 * @since 2.7.0
* *
* @param WP_Post $post * @param WP_Post $post
* @param bool|string $check * @param bool|string $check
* @return array * @return array
*/ */
@ -1202,7 +1202,7 @@ function image_size_input_fields( $post, $check = '' ) {
* @since 2.7.0 * @since 2.7.0
* *
* @param WP_Post $post * @param WP_Post $post
* @param string $url_type * @param string $url_type
* @return string * @return string
*/ */
function image_link_input_fields( $post, $url_type = '' ) { function image_link_input_fields( $post, $url_type = '' ) {
@ -1250,7 +1250,7 @@ function wp_caption_input_textarea( $edit_post ) {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param array $form_fields * @param array $form_fields
* @param object $post * @param object $post
* @return array * @return array
*/ */
@ -1316,9 +1316,9 @@ function image_attachment_fields_to_save( $post, $attachment ) {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param string $html * @param string $html
* @param integer $attachment_id * @param integer $attachment_id
* @param array $attachment * @param array $attachment
* @return string * @return string
*/ */
function image_media_send_to_editor( $html, $attachment_id, $attachment ) { function image_media_send_to_editor( $html, $attachment_id, $attachment ) {
@ -1343,7 +1343,7 @@ function image_media_send_to_editor( $html, $attachment_id, $attachment ) {
* @since 2.5.0 * @since 2.5.0
* *
* @param WP_Post $post * @param WP_Post $post
* @param array $errors * @param array $errors
* @return array * @return array
*/ */
function get_attachment_fields_to_edit( $post, $errors = null ) { function get_attachment_fields_to_edit( $post, $errors = null ) {
@ -1486,8 +1486,8 @@ function get_attachment_fields_to_edit( $post, $errors = null ) {
* *
* @global WP_Query $wp_the_query WordPress Query object. * @global WP_Query $wp_the_query WordPress Query object.
* *
* @param int $post_id Optional. Post ID. * @param int $post_id Optional. Post ID.
* @param array $errors Errors for attachment, if any. * @param array $errors Errors for attachment, if any.
* @return string * @return string
*/ */
function get_media_items( $post_id, $errors ) { function get_media_items( $post_id, $errors ) {
@ -1539,8 +1539,8 @@ function get_media_items( $post_id, $errors ) {
* *
* @global string $redir_tab * @global string $redir_tab
* *
* @param int $attachment_id Attachment ID for modification. * @param int $attachment_id Attachment ID for modification.
* @param string|array $args Optional. Override defaults. * @param string|array $args Optional. Override defaults.
* @return string HTML form for attachment. * @return string HTML form for attachment.
*/ */
function get_media_item( $attachment_id, $args = null ) { function get_media_item( $attachment_id, $args = null ) {
@ -2271,8 +2271,8 @@ function media_upload_form( $errors = null ) {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param string $type * @param string $type
* @param object $errors * @param object $errors
* @param integer $id * @param integer $id
*/ */
function media_upload_type_form( $type = 'file', $errors = null, $id = null ) { function media_upload_type_form( $type = 'file', $errors = null, $id = null ) {
@ -2345,8 +2345,8 @@ function media_upload_type_form( $type = 'file', $errors = null, $id = null ) {
* *
* @since 2.7.0 * @since 2.7.0
* *
* @param string $type * @param string $type
* @param object $errors * @param object $errors
* @param integer $id * @param integer $id
*/ */
function media_upload_type_url_form( $type = null, $errors = null, $id = null ) { function media_upload_type_url_form( $type = null, $errors = null, $id = null ) {

View File

@ -903,7 +903,7 @@ function iis7_add_rewrite_rule( $filename, $rewrite_rule ) {
* @since 2.8.0 * @since 2.8.0
* *
* @param DOMDocument $doc * @param DOMDocument $doc
* @param string $filename * @param string $filename
*/ */
function saveDomDocument( $doc, $filename ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid function saveDomDocument( $doc, $filename ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
$config = $doc->saveXML(); $config = $doc->saveXML();

View File

@ -1136,8 +1136,8 @@ function _wp_delete_orphaned_draft_menu_items() {
* *
* @since 3.6.0 * @since 3.6.0
* *
* @param int|string $nav_menu_selected_id (id, slug, or name ) of the currently-selected menu * @param int|string $nav_menu_selected_id ID, slug, or name of the currently-selected menu.
* @param string $nav_menu_selected_title Title of the currently-selected menu * @param string $nav_menu_selected_title Title of the currently-selected menu.
* @return array The menu updated message * @return array The menu updated message
*/ */
function wp_nav_menu_update_menu_items( $nav_menu_selected_id, $nav_menu_selected_title ) { function wp_nav_menu_update_menu_items( $nav_menu_selected_id, $nav_menu_selected_title ) {

View File

@ -719,6 +719,7 @@ All at ###SITENAME###
/** /**
* Intercept personal data exporter page Ajax responses in order to assemble the personal data export file. * Intercept personal data exporter page Ajax responses in order to assemble the personal data export file.
*
* @see wp_privacy_personal_data_export_page * @see wp_privacy_personal_data_export_page
* @since 4.9.6 * @since 4.9.6
* *

View File

@ -29,8 +29,8 @@ $charset_collate = $wpdb->get_charset_collate();
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param string $scope Optional. The tables for which to retrieve SQL. Can be all, global, ms_global, or blog tables. Defaults to all. * @param string $scope Optional. The tables for which to retrieve SQL. Can be all, global, ms_global, or blog tables. Defaults to all.
* @param int $blog_id Optional. The site ID for which to retrieve SQL. Default is the current site ID. * @param int $blog_id Optional. The site ID for which to retrieve SQL. Default is the current site ID.
* @return string The SQL needed to create the requested tables. * @return string The SQL needed to create the requested tables.
*/ */
function wp_get_db_schema( $scope = 'all', $blog_id = null ) { function wp_get_db_schema( $scope = 'all', $blog_id = null ) {

View File

@ -1241,8 +1241,8 @@ function is_admin_bar_showing() {
* @access private * @access private
* *
* @param string $context Context of this preference check. Defaults to 'front'. The 'admin' * @param string $context Context of this preference check. Defaults to 'front'. The 'admin'
* preference is no longer used. * preference is no longer used.
* @param int $user Optional. ID of the user to check, defaults to 0 for current user. * @param int $user Optional. ID of the user to check, defaults to 0 for current user.
* @return bool Whether the admin bar should be showing for this user. * @return bool Whether the admin bar should be showing for this user.
*/ */
function _get_admin_bar_pref( $context = 'front', $user = 0 ) { function _get_admin_bar_pref( $context = 'front', $user = 0 ) {

View File

@ -22,7 +22,7 @@
* @since 2.1.0 * @since 2.1.0
* @access private * @access private
* *
* @param array $bookmarks List of bookmarks to traverse. * @param array $bookmarks List of bookmarks to traverse.
* @param string|array $args { * @param string|array $args {
* Optional. Bookmarks arguments. * Optional. Bookmarks arguments.
* *

View File

@ -14,9 +14,10 @@
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param int|stdClass $bookmark * @param int|stdClass $bookmark
* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond
* an stdClass object, an associative array, or a numeric array, respectively. Default OBJECT. * to an stdClass object, an associative array, or a numeric array, respectively.
* @param string $filter Optional. How to sanitize bookmark fields. Default 'raw'. * Default OBJECT.
* @param string $filter Optional. How to sanitize bookmark fields. Default 'raw'.
* @return array|object|null Type returned depends on $output value. * @return array|object|null Type returned depends on $output value.
*/ */
function get_bookmark( $bookmark, $output = OBJECT, $filter = 'raw' ) { function get_bookmark( $bookmark, $output = OBJECT, $filter = 'raw' ) {
@ -68,9 +69,9 @@ function get_bookmark( $bookmark, $output = OBJECT, $filter = 'raw' ) {
* *
* @since 2.3.0 * @since 2.3.0
* *
* @param string $field The name of the data field to return * @param string $field The name of the data field to return.
* @param int $bookmark The bookmark ID to get field * @param int $bookmark The bookmark ID to get field.
* @param string $context Optional. The context of how the field will be used. * @param string $context Optional. The context of how the field will be used.
* @return string|WP_Error * @return string|WP_Error
*/ */
function get_bookmark_field( $field, $bookmark, $context = 'display' ) { function get_bookmark_field( $field, $bookmark, $context = 'display' ) {

View File

@ -111,12 +111,12 @@ function wp_cache_flush() {
* @see WP_Object_Cache::get() * @see WP_Object_Cache::get()
* @global WP_Object_Cache $wp_object_cache Object cache global instance. * @global WP_Object_Cache $wp_object_cache Object cache global instance.
* *
* @param int|string $key The key under which the cache contents are stored. * @param int|string $key The key under which the cache contents are stored.
* @param string $group Optional. Where the cache contents are grouped. Default empty. * @param string $group Optional. Where the cache contents are grouped. Default empty.
* @param bool $force Optional. Whether to force an update of the local cache * @param bool $force Optional. Whether to force an update of the local cache
* from the persistent cache. Default false. * from the persistent cache. Default false.
* @param bool $found Optional. Whether the key was found in the cache (passed by reference). * @param bool $found Optional. Whether the key was found in the cache (passed by reference).
* Disambiguates a return of false, a storable value. Default null. * Disambiguates a return of false, a storable value. Default null.
* @return mixed|false The cache contents on success, false on failure to retrieve contents. * @return mixed|false The cache contents on success, false on failure to retrieve contents.
*/ */
function wp_cache_get( $key, $group = '', $force = false, &$found = null ) { function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {

View File

@ -35,8 +35,8 @@
* @global WP $wp Current WordPress environment instance. * @global WP $wp Current WordPress environment instance.
* *
* @param string $requested_url Optional. The URL that was requested, used to * @param string $requested_url Optional. The URL that was requested, used to
* figure if redirect is needed. * figure if redirect is needed.
* @param bool $do_redirect Optional. Redirect to the new URL. * @param bool $do_redirect Optional. Redirect to the new URL.
* @return string|void The string of the URL, if redirect needed. * @return string|void The string of the URL, if redirect needed.
*/ */
function redirect_canonical( $requested_url = null, $do_redirect = true ) { function redirect_canonical( $requested_url = null, $do_redirect = true ) {
@ -782,7 +782,7 @@ function redirect_canonical( $requested_url = null, $do_redirect = true ) {
* @access private * @access private
* *
* @param string $query_string * @param string $query_string
* @param array $args_to_check * @param array $args_to_check
* @param string $url * @param string $url
* @return string The altered query string * @return string The altered query string
*/ */

View File

@ -126,8 +126,8 @@ function get_the_category_by_ID( $cat_ID ) { // phpcs:ignore WordPress.NamingCon
* *
* @param string $separator Optional. Separator between the categories. By default, the links are placed * @param string $separator Optional. Separator between the categories. By default, the links are placed
* in an unordered list. An empty string will result in the default behavior. * in an unordered list. An empty string will result in the default behavior.
* @param string $parents Optional. How to display the parents. * @param string $parents Optional. How to display the parents.
* @param int $post_id Optional. Post ID to retrieve categories. * @param int $post_id Optional. Post ID to retrieve categories.
* @return string * @return string
*/ */
function get_the_category_list( $separator = '', $parents = '', $post_id = false ) { function get_the_category_list( $separator = '', $parents = '', $post_id = false ) {
@ -238,9 +238,10 @@ function get_the_category_list( $separator = '', $parents = '', $post_id = false
* Conditional Tags} article in the Theme Developer Handbook. * Conditional Tags} article in the Theme Developer Handbook.
* *
* @since 1.2.0 * @since 1.2.0
* @since 2.7.0 The `$post` parameter was added.
* *
* @param int|string|array $category Category ID, name or slug, or array of said. * @param int|string|array $category Category ID, name or slug, or array of said.
* @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0) * @param int|object $post Optional. Post to check instead of the current post.
* @return bool True if the current post is in any of the given categories. * @return bool True if the current post is in any of the given categories.
*/ */
function in_category( $category, $post = null ) { function in_category( $category, $post = null ) {
@ -258,8 +259,8 @@ function in_category( $category, $post = null ) {
* *
* @param string $separator Optional. Separator between the categories. By default, the links are placed * @param string $separator Optional. Separator between the categories. By default, the links are placed
* in an unordered list. An empty string will result in the default behavior. * in an unordered list. An empty string will result in the default behavior.
* @param string $parents Optional. How to display the parents. * @param string $parents Optional. How to display the parents.
* @param int $post_id Optional. Post ID to retrieve categories. * @param int $post_id Optional. Post ID to retrieve categories.
*/ */
function the_category( $separator = '', $parents = '', $post_id = false ) { function the_category( $separator = '', $parents = '', $post_id = false ) {
echo get_the_category_list( $separator, $parents, $post_id ); echo get_the_category_list( $separator, $parents, $post_id );
@ -1161,10 +1162,10 @@ function get_the_tags( $id = 0 ) {
* *
* @since 2.3.0 * @since 2.3.0
* *
* @param string $before Optional. Before tags. * @param string $before Optional. String to use before tags.
* @param string $sep Optional. Between tags. * @param string $sep Optional. String to use between the tags.
* @param string $after Optional. After tags. * @param string $after Optional. String to use after tags.
* @param int $id Optional. Post ID. Defaults to the current post. * @param int $id Optional. Post ID. Defaults to the current post.
* @return string|false|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure. * @return string|false|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.
*/ */
function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) { function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {
@ -1333,8 +1334,8 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = ''
* *
* @since 4.8.0 * @since 4.8.0
* *
* @param int $term_id Term ID. * @param int $term_id Term ID.
* @param string $taxonomy Taxonomy name. * @param string $taxonomy Taxonomy name.
* @param string|array $args { * @param string|array $args {
* Array of optional arguments. * Array of optional arguments.
* *

View File

@ -81,10 +81,10 @@ function get_categories( $args = '' ) {
* @since 1.5.1 * @since 1.5.1
* *
* @param int|object $category Category ID or Category row object * @param int|object $category Category ID or Category row object
* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N,
* which correspond to a WP_Term object, an associative array, or a numeric array, * which correspond to a WP_Term object, an associative array, or a numeric array,
* respectively. Default OBJECT. * respectively. Default OBJECT.
* @param string $filter Optional. How to sanitize category fields. Default 'raw'. * @param string $filter Optional. How to sanitize category fields. Default 'raw'.
* @return object|array|WP_Error|null Category data in type defined by $output parameter. * @return object|array|WP_Error|null Category data in type defined by $output parameter.
* WP_Error if $category is empty, null if it does not exist. * WP_Error if $category is empty, null if it does not exist.
*/ */

View File

@ -509,8 +509,8 @@ class WP_Http {
* *
* @since 3.2.0 * @since 3.2.0
* *
* @param array $args Request arguments. * @param array $args Request arguments.
* @param string $url URL to Request. * @param string $url URL to request.
* @return string|false Class name for the first transport that claims to support the request. * @return string|false Class name for the first transport that claims to support the request.
* False if no transport claims to support the request. * False if no transport claims to support the request.
*/ */
@ -559,8 +559,8 @@ class WP_Http {
* @deprecated 5.1.0 Use WP_Http::request() * @deprecated 5.1.0 Use WP_Http::request()
* @see WP_Http::request() * @see WP_Http::request()
* *
* @param string $url URL to Request. * @param string $url URL to request.
* @param array $args Request arguments. * @param array $args Request arguments.
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'.
* A WP_Error instance upon error. * A WP_Error instance upon error.
*/ */
@ -615,7 +615,7 @@ class WP_Http {
* *
* @since 2.7.0 * @since 2.7.0
* *
* @param string $url The request URL. * @param string $url The request URL.
* @param string|array $args Optional. Override the defaults. * @param string|array $args Optional. Override the defaults.
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'.
* A WP_Error instance upon error. * A WP_Error instance upon error.
@ -633,7 +633,7 @@ class WP_Http {
* *
* @since 2.7.0 * @since 2.7.0
* *
* @param string $url The request URL. * @param string $url The request URL.
* @param string|array $args Optional. Override the defaults. * @param string|array $args Optional. Override the defaults.
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'.
* A WP_Error instance upon error. * A WP_Error instance upon error.
@ -675,7 +675,7 @@ class WP_Http {
* @since 2.7.0 * @since 2.7.0
* *
* @param string|array $headers * @param string|array $headers
* @param string $url The URL that was requested. * @param string $url The URL that was requested.
* @return array Processed string headers. If duplicate headers are encountered, * @return array Processed string headers. If duplicate headers are encountered,
* then a numbered array is returned as the value of that header-key. * then a numbered array is returned as the value of that header-key.
*/ */

View File

@ -118,8 +118,8 @@ class WP_Comment_Query {
* *
* @since 4.0.0 * @since 4.0.0
* *
* @param string $name Method to call. * @param string $name Method to call.
* @param array $arguments Arguments to pass when calling. * @param array $arguments Arguments to pass when calling.
* @return mixed|false Return value of the callback, false otherwise. * @return mixed|false Return value of the callback, false otherwise.
*/ */
public function __call( $name, $arguments ) { public function __call( $name, $arguments ) {
@ -1085,7 +1085,7 @@ class WP_Comment_Query {
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param string $string * @param string $string
* @param array $cols * @param array $cols
* @return string * @return string
*/ */
protected function get_search_sql( $string, $cols ) { protected function get_search_sql( $string, $cols ) {

View File

@ -6008,7 +6008,7 @@ final class WP_Customize_Manager {
* @since 4.7.0 * @since 4.7.0
* *
* @param WP_Error $validity * @param WP_Error $validity
* @param mixed $value * @param mixed $value
* @return mixed * @return mixed
*/ */
public function _validate_header_video( $validity, $value ) { public function _validate_header_video( $validity, $value ) {
@ -6044,7 +6044,7 @@ final class WP_Customize_Manager {
* @since 4.7.0 * @since 4.7.0
* *
* @param WP_Error $validity * @param WP_Error $validity
* @param mixed $value * @param mixed $value
* @return mixed * @return mixed
*/ */
public function _validate_external_header_video( $validity, $value ) { public function _validate_external_header_video( $validity, $value ) {

View File

@ -69,7 +69,7 @@ class WP_Date_Query {
* @since 4.0.0 The $inclusive logic was updated to include all times within the date range. * @since 4.0.0 The $inclusive logic was updated to include all times within the date range.
* @since 4.1.0 Introduced 'dayofweek_iso' time type parameter. * @since 4.1.0 Introduced 'dayofweek_iso' time type parameter.
* *
* @param array $date_query { * @param array $date_query {
* Array of date query clauses. * Array of date query clauses.
* *
* @type array ...$0 { * @type array ...$0 {
@ -797,8 +797,8 @@ class WP_Date_Query {
* *
* @since 3.7.0 * @since 3.7.0
* *
* @param string $compare The compare operator to use * @param string $compare The compare operator to use.
* @param string|array $value The value * @param string|array $value The value.
* @return string|false|int The value to be used in SQL or false on error. * @return string|false|int The value to be used in SQL or false on error.
*/ */
public function build_value( $compare, $value ) { public function build_value( $compare, $value ) {
@ -956,11 +956,11 @@ class WP_Date_Query {
* *
* @since 3.7.0 * @since 3.7.0
* *
* @param string $column The column to query against. Needs to be pre-validated! * @param string $column The column to query against. Needs to be pre-validated!
* @param string $compare The comparison operator. Needs to be pre-validated! * @param string $compare The comparison operator. Needs to be pre-validated!
* @param int|null $hour Optional. An hour value (0-23). * @param int|null $hour Optional. An hour value (0-23).
* @param int|null $minute Optional. A minute value (0-59). * @param int|null $minute Optional. A minute value (0-59).
* @param int|null $second Optional. A second value (0-59). * @param int|null $second Optional. A second value (0-59).
* @return string|false A query part or false on failure. * @return string|false A query part or false on failure.
*/ */
public function build_time_query( $column, $compare, $hour = null, $minute = null, $second = null ) { public function build_time_query( $column, $compare, $hour = null, $minute = null, $second = null ) {

View File

@ -1449,7 +1449,8 @@ final class _WP_Editors {
* @since 3.9.0 * @since 3.9.0
* *
* @param string $mce_locale The locale used for the editor. * @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(). * @param bool $json_only Optional. Whether to include the JavaScript calls to tinymce.addI18n() and
* tinymce.ScriptLoader.markDone().
* @return string Translation object, JSON encoded. * @return string Translation object, JSON encoded.
*/ */
public static function wp_mce_translation( $mce_locale = '', $json_only = false ) { public static function wp_mce_translation( $mce_locale = '', $json_only = false ) {

View File

@ -120,8 +120,8 @@ class WP_Embed {
* *
* Do not use this function directly, use wp_embed_unregister_handler() instead. * Do not use this function directly, use wp_embed_unregister_handler() instead.
* *
* @param string $id The handler ID that should be removed. * @param string $id The handler ID that should be removed.
* @param int $priority Optional. The priority of the handler to be removed (default: 10). * @param int $priority Optional. The priority of the handler to be removed (default: 10).
*/ */
public function unregister_handler( $id, $priority = 10 ) { public function unregister_handler( $id, $priority = 10 ) {
unset( $this->handlers[ $priority ][ $id ] ); unset( $this->handlers[ $priority ][ $id ] );
@ -135,7 +135,7 @@ class WP_Embed {
* *
* @since 5.5.0 * @since 5.5.0
* *
* @param array $attr { * @param array $attr {
* Shortcode attributes. Optional. * Shortcode attributes. Optional.
* *
* @type int $width Width of the embed in pixels. * @type int $width Width of the embed in pixels.
@ -181,7 +181,7 @@ class WP_Embed {
* the registered embed handlers. If none of the regex matches and it's enabled, then the URL * the registered embed handlers. If none of the regex matches and it's enabled, then the URL
* will be given to the WP_oEmbed class. * will be given to the WP_oEmbed class.
* *
* @param array $attr { * @param array $attr {
* Shortcode attributes. Optional. * Shortcode attributes. Optional.
* *
* @type int $width Width of the embed in pixels. * @type int $width Width of the embed in pixels.

View File

@ -47,9 +47,9 @@ class WP_Error {
* *
* @since 2.1.0 * @since 2.1.0
* *
* @param string|int $code Error code * @param string|int $code Error code.
* @param string $message Error message * @param string $message Error message.
* @param mixed $data Optional. Error data. * @param mixed $data Optional. Error data.
*/ */
public function __construct( $code = '', $message = '', $data = '' ) { public function __construct( $code = '', $message = '', $data = '' ) {
if ( empty( $code ) ) { if ( empty( $code ) ) {
@ -180,9 +180,9 @@ class WP_Error {
* *
* @since 2.1.0 * @since 2.1.0
* *
* @param string|int $code Error code. * @param string|int $code Error code.
* @param string $message Error message. * @param string $message Error message.
* @param mixed $data Optional. Error data. * @param mixed $data Optional. Error data.
*/ */
public function add( $code, $message, $data = '' ) { public function add( $code, $message, $data = '' ) {
$this->errors[ $code ][] = $message; $this->errors[ $code ][] = $message;
@ -198,7 +198,7 @@ class WP_Error {
* *
* @since 2.1.0 * @since 2.1.0
* *
* @param mixed $data Error data. * @param mixed $data Error data.
* @param string|int $code Error code. * @param string|int $code Error code.
*/ */
public function add_data( $data, $code = '' ) { public function add_data( $data, $code = '' ) {

View File

@ -63,7 +63,7 @@ class WP_Http_Curl {
* *
* @since 2.7.0 * @since 2.7.0
* *
* @param string $url The request URL. * @param string $url The request URL.
* @param string|array $args Optional. Override the defaults. * @param string|array $args Optional. Override the defaults.
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
*/ */

View File

@ -13,10 +13,10 @@ class WP_HTTP_IXR_Client extends IXR_Client {
public $error; public $error;
/** /**
* @param string $server * @param string $server
* @param string|bool $path * @param string|bool $path
* @param int|bool $port * @param int|bool $port
* @param int $timeout * @param int $timeout
*/ */
public function __construct( $server, $path = false, $port = false, $timeout = 15 ) { public function __construct( $server, $path = false, $port = false, $timeout = 15 ) {
if ( ! $path ) { if ( ! $path ) {

View File

@ -32,8 +32,8 @@ class WP_HTTP_Requests_Hooks extends Requests_Hooks {
/** /**
* Constructor. * Constructor.
* *
* @param string $url URL to request. * @param string $url URL to request.
* @param array $request Request data in WP_Http format. * @param array $request Request data in WP_Http format.
*/ */
public function __construct( $url, $request ) { public function __construct( $url, $request ) {
$this->url = $url; $this->url = $url;
@ -43,8 +43,8 @@ class WP_HTTP_Requests_Hooks extends Requests_Hooks {
/** /**
* Dispatch a Requests hook to a native WordPress action. * Dispatch a Requests hook to a native WordPress action.
* *
* @param string $hook Hook name. * @param string $hook Hook name.
* @param array $parameters Parameters to pass to callbacks. * @param array $parameters Parameters to pass to callbacks.
* @return boolean True if hooks were run, false if nothing was hooked. * @return boolean True if hooks were run, false if nothing was hooked.
*/ */
public function dispatch( $hook, $parameters = array() ) { public function dispatch( $hook, $parameters = array() ) {

View File

@ -22,7 +22,7 @@ class WP_Http_Streams {
* @since 2.7.0 * @since 2.7.0
* @since 3.7.0 Combined with the fsockopen transport and switched to stream_socket_client(). * @since 3.7.0 Combined with the fsockopen transport and switched to stream_socket_client().
* *
* @param string $url The request URL. * @param string $url The request URL.
* @param string|array $args Optional. Override the defaults. * @param string|array $args Optional. Override the defaults.
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
*/ */

View File

@ -171,8 +171,8 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
} }
/** /**
* @param int $max_w * @param int $max_w
* @param int $max_h * @param int $max_h
* @param bool|array $crop * @param bool|array $crop
* @return resource|WP_Error * @return resource|WP_Error
*/ */
@ -415,7 +415,7 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
} }
/** /**
* @param resource $image * @param resource $image
* @param string|null $filename * @param string|null $filename
* @param string|null $mime_type * @param string|null $mime_type
* @return array|WP_Error * @return array|WP_Error
@ -499,8 +499,8 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* @since 3.5.0 * @since 3.5.0
* *
* @param string|stream $filename * @param string|stream $filename
* @param callable $function * @param callable $function
* @param array $arguments * @param array $arguments
* @return bool * @return bool
*/ */
protected function make_image( $filename, $function, $arguments ) { protected function make_image( $filename, $function, $arguments ) {

View File

@ -662,8 +662,8 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
/** /**
* @param Imagick $image * @param Imagick $image
* @param string $filename * @param string $filename
* @param string $mime_type * @param string $mime_type
* @return array|WP_Error * @return array|WP_Error
*/ */
protected function _save( $image, $filename = null, $mime_type = null ) { protected function _save( $image, $filename = null, $mime_type = null ) {

View File

@ -473,8 +473,8 @@ abstract class WP_Image_Editor {
* @since 3.5.0 * @since 3.5.0
* *
* @param string|stream $filename * @param string|stream $filename
* @param callable $function * @param callable $function
* @param array $arguments * @param array $arguments
* @return bool * @return bool
*/ */
protected function make_image( $filename, $function, $arguments ) { protected function make_image( $filename, $function, $arguments ) {

View File

@ -229,8 +229,8 @@ class WP_oEmbed {
* *
* @since 4.0.0 * @since 4.0.0
* *
* @param string $name Method to call. * @param string $name Method to call.
* @param array $arguments Arguments to pass when calling. * @param array $arguments Arguments to pass when calling.
* @return mixed|bool Return value of the callback, false otherwise. * @return mixed|bool Return value of the callback, false otherwise.
*/ */
public function __call( $name, $arguments ) { public function __call( $name, $arguments ) {
@ -247,8 +247,8 @@ class WP_oEmbed {
* *
* @see WP_oEmbed::discover() * @see WP_oEmbed::discover()
* *
* @param string $url The URL to the content. * @param string $url The URL to the content.
* @param string|array $args Optional provider arguments. * @param string|array $args Optional provider arguments.
* @return string|false The oEmbed provider URL on success, false on failure. * @return string|false The oEmbed provider URL on success, false on failure.
*/ */
public function get_provider( $url, $args = '' ) { public function get_provider( $url, $args = '' ) {

View File

@ -3593,8 +3593,8 @@ class WP_Query {
* *
* @since 4.0.0 * @since 4.0.0
* *
* @param string $name Method to call. * @param string $name Method to call.
* @param array $arguments Arguments to pass when calling. * @param array $arguments Arguments to pass when calling.
* @return mixed|false Return value of the callback, false otherwise. * @return mixed|false Return value of the callback, false otherwise.
*/ */
public function __call( $name, $arguments ) { public function __call( $name, $arguments ) {

View File

@ -339,7 +339,7 @@ class WP_Recovery_Mode {
* *
* @global array $wp_theme_directories * @global array $wp_theme_directories
* *
* @param array $error Error that was triggered. * @param array $error Error that was triggered.
* @return array|false { * @return array|false {
* @type string $slug The extension slug. This is the plugin or theme's directory. * @type string $slug The extension slug. This is the plugin or theme's directory.
* @type string $type The extension type. Either 'plugin' or 'theme'. * @type string $type The extension type. Either 'plugin' or 'theme'.

View File

@ -95,8 +95,8 @@ class WP_Roles {
* *
* @since 4.0.0 * @since 4.0.0
* *
* @param string $name Method to call. * @param string $name Method to call.
* @param array $arguments Arguments to pass when calling. * @param array $arguments Arguments to pass when calling.
* @return mixed|false Return value of the callback, false otherwise. * @return mixed|false Return value of the callback, false otherwise.
*/ */
public function __call( $name, $arguments ) { public function __call( $name, $arguments ) {
@ -200,10 +200,10 @@ class WP_Roles {
* *
* @since 2.0.0 * @since 2.0.0
* *
* @param string $role Role name. * @param string $role Role name.
* @param string $cap Capability name. * @param string $cap Capability name.
* @param bool $grant Optional. Whether role is capable of performing capability. * @param bool $grant Optional. Whether role is capable of performing capability.
* Default true. * Default true.
*/ */
public function add_cap( $role, $cap, $grant = true ) { public function add_cap( $role, $cap, $grant = true ) {
if ( ! isset( $this->roles[ $role ] ) ) { if ( ! isset( $this->roles[ $role ] ) ) {

View File

@ -697,7 +697,6 @@ class WP_Term_Query {
* @param array|null $terms Return an array of term data to short-circuit WP's term query, * @param array|null $terms Return an array of term data to short-circuit WP's term query,
* or null to allow WP queries to run normally. * or null to allow WP queries to run normally.
* @param WP_Term_Query $this The WP_Term_Query instance, passed by reference. * @param WP_Term_Query $this The WP_Term_Query instance, passed by reference.
*
*/ */
$this->terms = apply_filters_ref_array( 'terms_pre_query', array( $this->terms, &$this ) ); $this->terms = apply_filters_ref_array( 'terms_pre_query', array( $this->terms, &$this ) );

View File

@ -100,7 +100,7 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer {
/** /**
* @ignore * @ignore
* *
* @param array $lines * @param array $lines
* @param string $prefix * @param string $prefix
*/ */
public function _lines( $lines, $prefix = ' ' ) { public function _lines( $lines, $prefix = ' ' ) {
@ -150,7 +150,7 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer {
* @ignore * @ignore
* *
* @param array $lines * @param array $lines
* @param bool $encode * @param bool $encode
* @return string * @return string
*/ */
public function _added( $lines, $encode = true ) { public function _added( $lines, $encode = true ) {
@ -188,7 +188,7 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer {
* @ignore * @ignore
* *
* @param array $lines * @param array $lines
* @param bool $encode * @param bool $encode
* @return string * @return string
*/ */
public function _deleted( $lines, $encode = true ) { public function _deleted( $lines, $encode = true ) {
@ -213,7 +213,7 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer {
* @ignore * @ignore
* *
* @param array $lines * @param array $lines
* @param bool $encode * @param bool $encode
* @return string * @return string
*/ */
public function _context( $lines, $encode = true ) { public function _context( $lines, $encode = true ) {

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.5-beta3-48585'; $wp_version = '5.5-beta3-48586';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.