Docs: Remove variable names from @return tags.

Per the [https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/ inline documentation standards], `@return` tags should only contain the type and an optional description, not the name of the returned variable. This commit removes the variable names from all remaining `@return` tags in core.

Developed in #13844.

Props Soean, mukesh27.
See #65860.

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

Author: SergeyBiryukov

src/wp-admin/includes/class-custom-background.php

@@ -593,8 +593,8 @@ public function ajax_background_add() {
 	 * @since 3.4.0
 	 * @deprecated 3.5.0
 	 *
-	 * @param array $form_fields
-	 * @return array $form_fields
+	 * @param array $form_fields An array of attachment form fields.
+	 * @return array Unmodified form fields.
 	 */
 	public function attachment_fields_to_edit( $form_fields ) {
 		return $form_fields;
@@ -604,8 +604,8 @@ public function attachment_fields_to_edit( $form_fields ) {
 	 * @since 3.4.0
 	 * @deprecated 3.5.0
 	 *
-	 * @param array $tabs
-	 * @return array $tabs
+	 * @param array $tabs An array of media upload tabs.
+	 * @return array Unmodified upload tabs.
 	 */
 	public function filter_upload_tabs( $tabs ) {
 		return $tabs;

src/wp-admin/includes/class-custom-image-header.php

@@ -1138,8 +1138,8 @@ public function admin_page() {
 	 *
 	 * @since 3.4.0
 	 *
-	 * @param array $form_fields
-	 * @return array $form_fields
+	 * @param array $form_fields An array of attachment form fields.
+	 * @return array Unmodified form fields.
 	 */
 	public function attachment_fields_to_edit( $form_fields ) {
 		return $form_fields;
@@ -1150,8 +1150,8 @@ public function attachment_fields_to_edit( $form_fields ) {
 	 *
 	 * @since 3.4.0
 	 *
-	 * @param array $tabs
-	 * @return array $tabs
+	 * @param array $tabs An array of media upload tabs.
+	 * @return array Unmodified upload tabs.
 	 */
 	public function filter_upload_tabs( $tabs ) {
 		return $tabs;

src/wp-admin/includes/media.php

@@ -39,7 +39,7 @@ function media_upload_tabs() {
  * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param array $tabs Associative array of default tab names.
- * @return array $tabs Filtered tabs with gallery if post has image attachment.
+ * @return array Filtered tabs with gallery if post has image attachment.
  */
 function update_gallery_tab( $tabs ) {
 	global $wpdb;

src/wp-includes/class-wp-editor.php

@@ -1769,7 +1769,7 @@ public static function wp_fullscreen_html() {
 	 *     @type int    $pagenum Page number. Default 1.
 	 *     @type string $s       Search keywords.
 	 * }
-	 * @return array|false $results {
+	 * @return array|false {
 	 *     An array of associative arrays of query results, false if there are none.
 	 *
 	 *     @type array ...$0 {

src/wp-includes/class-wp-theme-json.php

@@ -3430,7 +3430,7 @@ public function get_styles_block_nodes() {
 	 * @since 6.1.1
 	 *
 	 * @param array $declarations List of declarations.
-	 * @return array $declarations List of declarations filtered.
+	 * @return array List of declarations filtered.
 	 */
 	private static function update_separator_declarations( $declarations ) {
 		$background_color     = '';

src/wp-includes/comment.php

@@ -3902,7 +3902,7 @@ function _close_comments_for_old_posts( $posts, $query ) {
  *
  * @param bool $open    Comments open or closed.
  * @param int  $post_id Post ID.
- * @return bool $open
+ * @return bool True if comments are open, false otherwise.
  */
 function _close_comments_for_old_post( $open, $post_id ) {
 	if ( ! $open ) {

src/wp-includes/ms-blogs.php

@@ -741,7 +741,7 @@ function is_archived( $id ) {
  *
  * @param int    $id       Blog ID.
  * @param string $archived The new status.
- * @return string $archived
+ * @return string The new archived status.
  */
 function update_archived( $id, $archived ) {
 	update_blog_status( $id, 'archived', $archived );
@@ -760,7 +760,7 @@ function update_archived( $id, $archived ) {
  * @param string $pref       Field name.
  * @param string $value      Field value.
  * @param mixed  $deprecated Not used.
- * @return string|false $value
+ * @return string|false The passed field value, or false if the update failed.
  */
 function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
 	global $wpdb;
@@ -798,7 +798,7 @@ function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
  *
  * @param int    $id   Blog ID.
  * @param string $pref Field name.
- * @return bool|string|null $value
+ * @return bool|string|null The field value, or null if not found.
  */
 function get_blog_status( $id, $pref ) {
 	global $wpdb;

src/wp-includes/rest-api/endpoints/class-wp-rest-navigation-fallback-controller.php

@@ -147,7 +147,7 @@ public function get_item_schema() {
 	 *
 	 * @param WP_Post         $item    The wp_navigation Post object whose response is being prepared.
 	 * @param WP_REST_Request $request Request object.
-	 * @return WP_REST_Response $response The response data.
+	 * @return WP_REST_Response The response data.
 	 */
 	public function prepare_item_for_response( $item, $request ) {
 		$data = array();

tests/phpunit/tests/kses.php

@@ -2559,7 +2559,7 @@ public function data_wp_kses_object_data_url_with_port_number_allowed() {
 	 * Filter upload directory for tests using port number.
 	 *
 	 * @param  array $param See wp_upload_dir()
-	 * @return array        $param with a modified `url`.
+	 * @return array Upload directory data with a modified `url`.
 	 */
 	public function wp_kses_upload_dir_filter( $param ) {
 		// Take care to replace the entire domain, including cases where it already has a port number.

tests/phpunit/tests/query/searchColumns.php

@@ -342,7 +342,7 @@ public function test_search_columns_should_be_filterable() {
 	 * @param  string[] $search_columns Array of column names to be searched.
 	 * @param  string   $search         Text being searched.
 	 * @param  WP_Query $wp_query       The current WP_Query instance.
-	 * @return string[] $search_columns Array of column names to be searched.
+	 * @return string[] Array of column names to be searched.
 	 */
 	public function post_supported_search_column( $search_columns, $search, $wp_query ) {
 		$search_columns = array( 'post_title' );
@@ -373,7 +373,7 @@ public function test_search_columns_should_not_be_filterable_with_non_supported_
 	 * @param  string[] $search_columns Array of column names to be searched.
 	 * @param  string   $search         Text being searched.
 	 * @param  WP_Query $wp_query       The current WP_Query instance.
-	 * @return string[] $search_columns Array of column names to be searched.
+	 * @return string[] Array of column names to be searched.
 	 */
 	public function post_non_supported_search_column( $search_columns, $search, $wp_query ) {
 		$search_columns = array( 'post_name' );
@@ -404,7 +404,7 @@ public function test_search_columns_should_not_be_filterable_with_non_existing_s
 	 * @param  string[] $search_columns Array of column names to be searched.
 	 * @param  string   $search         Text being searched.
 	 * @param  WP_Query $wp_query       The current WP_Query instance.
-	 * @return string[] $search_columns Array of column names to be searched.
+	 * @return string[] Array of column names to be searched.
 	 */
 	public function post_non_existing_search_column( $search_columns, $search, $wp_query ) {
 		$search_columns = array( 'post_non_existing_column' );