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

See #49572, #50744

git-svn-id: https://develop.svn.wordpress.org/trunk@48586 602fd350-edb4-49c9-b593-d223f7449a82

src/wp-admin/includes/class-wp-filesystem-ssh2.php

@@ -207,7 +207,7 @@ public function sftp_path( $path ) {
 	 * @since 2.7.0
 	 *
 	 * @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`
 	 *                     is false (default), and data from the resulting stream was retrieved.
 	 */

src/wp-admin/includes/class-wp-list-table.php

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

src/wp-admin/includes/class-wp-ms-sites-list-table.php

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

src/wp-admin/includes/class-wp-ms-users-list-table.php

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

src/wp-admin/includes/class-wp-posts-list-table.php

@@ -714,7 +714,7 @@ protected function get_sortable_columns() {
 	 * @global WP_Query $wp_query WordPress Query object.
 	 * @global int $per_page
 	 * @param array $posts
-	 * @param int $level
+	 * @param int   $level
 	 */
 	public function display_rows( $posts = array(), $level = 0 ) {
 		global $wp_query, $per_page;
@@ -734,7 +734,7 @@ public function display_rows( $posts = array(), $level = 0 ) {
 
 	/**
 	 * @param array $posts
-	 * @param int $level
+	 * @param int   $level
 	 */
 	private function _display_rows( $posts, $level = 0 ) {
 		$post_type = $this->screen->post_type;
@@ -759,8 +759,8 @@ private function _display_rows( $posts, $level = 0 ) {
 	 * @global wpdb    $wpdb WordPress database abstraction object.
 	 * @global WP_Post $post Global post object.
 	 * @param array $pages
-	 * @param int $pagenum
-	 * @param int $per_page
+	 * @param int   $pagenum
+	 * @param int   $per_page
 	 */
 	private function _display_rows_hierarchical( $pages, $pagenum = 1, $per_page = 20 ) {
 		global $wpdb;
@@ -865,11 +865,11 @@ private function _display_rows_hierarchical( $pages, $pagenum = 1, $per_page = 2
 	 * @since 4.2.0 Added the `$to_display` parameter.
 	 *
 	 * @param array $children_pages
-	 * @param int $count
-	 * @param int $parent
-	 * @param int $level
-	 * @param int $pagenum
-	 * @param int $per_page
+	 * @param int   $count
+	 * @param int   $parent
+	 * @param int   $level
+	 * @param int   $pagenum
+	 * @param int   $per_page
 	 * @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 ) {

src/wp-admin/includes/class-wp-site-health-auto-updates.php

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

src/wp-admin/includes/class-wp-terms-list-table.php

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

src/wp-admin/includes/dashboard.php

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

src/wp-admin/includes/image.php

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

src/wp-admin/includes/media.php

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

src/wp-admin/includes/misc.php

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

src/wp-admin/includes/nav-menu.php

@@ -1136,8 +1136,8 @@ function _wp_delete_orphaned_draft_menu_items() {
  *
  * @since 3.6.0
  *
- * @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 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.
  * @return array The menu updated message
  */
 function wp_nav_menu_update_menu_items( $nav_menu_selected_id, $nav_menu_selected_title ) {

src/wp-admin/includes/privacy-tools.php

@@ -719,6 +719,7 @@ function wp_privacy_send_personal_data_export_email( $request_id ) {
 
 /**
  * Intercept personal data exporter page Ajax responses in order to assemble the personal data export file.
+ *
  * @see wp_privacy_personal_data_export_page
  * @since 4.9.6
  *

src/wp-admin/includes/schema.php

@@ -29,8 +29,8 @@
  *
  * @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 int $blog_id Optional. The site ID for which to retrieve SQL. Default is the current site ID.
+ * @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.
  * @return string The SQL needed to create the requested tables.
  */
 function wp_get_db_schema( $scope = 'all', $blog_id = null ) {

src/wp-includes/admin-bar.php

@@ -1241,8 +1241,8 @@ function is_admin_bar_showing() {
  * @access private
  *
  * @param string $context Context of this preference check. Defaults to 'front'. The 'admin'
- *  preference is no longer used.
- * @param int $user Optional. ID of the user to check, defaults to 0 for current user.
+ *                        preference is no longer used.
+ * @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.
  */
 function _get_admin_bar_pref( $context = 'front', $user = 0 ) {

src/wp-includes/bookmark-template.php

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

src/wp-includes/bookmark.php

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

src/wp-includes/cache.php

@@ -111,12 +111,12 @@ function wp_cache_flush() {
  * @see WP_Object_Cache::get()
  * @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 string      $group  Optional. Where the cache contents are grouped. Default empty.
- * @param bool        $force  Optional. Whether to force an update of the local cache
- *                            from the persistent cache. Default false.
- * @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.
+ * @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 bool       $force Optional. Whether to force an update of the local cache
+ *                          from the persistent cache. Default false.
+ * @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.
  * @return mixed|false The cache contents on success, false on failure to retrieve contents.
  */
 function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {

src/wp-includes/canonical.php

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