Update to WPCS v3 (#419)

* Update to wp-cli-tests v4 (which requires WPCS v3) * Fix all autofixable CS issues * Address PHPCS warning * Ignore a few deprecation notices * Ignore a couple unused parameters * Restore loose comparison to fix test failure --------- Co-authored-by: Daniel Bachhuber <daniel.bachhuber@automattic.com>
wp-cli · Sep 1, 2023 · be63876 · be63876
1 parent 4f39024
commit be63876
Show file tree

Hide file tree

Showing 22 changed files with 66 additions and 100 deletions.
diff --git a/composer.json b/composer.json
@@ -20,7 +20,7 @@
         "wp-cli/extension-command": "^1.2 || ^2",
         "wp-cli/media-command": "^1.1 || ^2",
         "wp-cli/super-admin-command": "^1 || ^2",
-        "wp-cli/wp-cli-tests": "^3.1"
+        "wp-cli/wp-cli-tests": "^4"
     },
     "config": {
         "process-timeout": 7200,

diff --git a/entity-command.php b/entity-command.php
@@ -6,7 +6,7 @@
 	return;
 }
 
-$wpcli_entity_autoloader = dirname( __FILE__ ) . '/vendor/autoload.php';
+$wpcli_entity_autoloader = __DIR__ . '/vendor/autoload.php';
 if ( file_exists( $wpcli_entity_autoloader ) ) {
 	require_once $wpcli_entity_autoloader;
 }
@@ -37,7 +37,7 @@
 	'site meta',
 	'Site_Meta_Command',
 	array(
-		'before_invoke' => function() {
+		'before_invoke' => function () {
 			if ( ! is_multisite() ) {
 				WP_CLI::error( 'This is not a multisite installation.' );
 			}
@@ -51,7 +51,7 @@
 	'site option',
 	'Site_Option_Command',
 	array(
-		'before_invoke' => function() {
+		'before_invoke' => function () {
 			if ( ! is_multisite() ) {
 				WP_CLI::error( 'This is not a multisite installation.' );
 			}
@@ -64,7 +64,7 @@
 	'term meta',
 	'Term_Meta_Command',
 	array(
-		'before_invoke' => function() {
+		'before_invoke' => function () {
 			if ( Utils\wp_version_compare( '4.4', '<' ) ) {
 				WP_CLI::error( 'Requires WordPress 4.4 or greater.' );
 			}
@@ -76,7 +76,7 @@
 	'user application-password',
 	'User_Application_Password_Command',
 	array(
-		'before_invoke' => function() {
+		'before_invoke' => function () {
 			if ( Utils\wp_version_compare( '5.6', '<' ) ) {
 				WP_CLI::error( 'Requires WordPress 5.6 or greater.' );
 			}
@@ -88,7 +88,7 @@
 	'user session',
 	'User_Session_Command',
 	array(
-		'before_invoke' => function() {
+		'before_invoke' => function () {
 			if ( Utils\wp_version_compare( '4.0', '<' ) ) {
 				WP_CLI::error( 'Requires WordPress 4.0 or greater.' );
 			}

diff --git a/src/Comment_Command.php b/src/Comment_Command.php
@@ -202,7 +202,6 @@ public function generate( $args, $assoc_args ) {
 		if ( 'progress' === $format ) {
 			$notify->finish();
 		}
-
 	}
 
 	/**
@@ -376,7 +375,7 @@ public function list_( $args, $assoc_args ) {
 				$comments = wp_list_pluck( $comments, 'comment_ID' );
 			} elseif ( is_array( $comments ) ) {
 				$comments = array_map(
-					function( $comment ) {
+					function ( $comment ) {
 							$comment->url = get_comment_link( $comment->comment_ID );
 							return $comment;
 					},

diff --git a/src/Menu_Command.php b/src/Menu_Command.php
@@ -68,13 +68,11 @@ public function create( $args, $assoc_args ) {
 
 			WP_CLI::error( $menu_id->get_error_message() );
 
-		} else {
+		} elseif ( Utils\get_flag_value( $assoc_args, 'porcelain' ) ) {
 
-			if ( Utils\get_flag_value( $assoc_args, 'porcelain' ) ) {
 				WP_CLI::line( $menu_id );
-			} else {
-				WP_CLI::success( "Created menu {$menu_id}." );
-			}
+		} else {
+			WP_CLI::success( "Created menu {$menu_id}." );
 		}
 	}
 
@@ -99,10 +97,10 @@ public function delete( $args, $assoc_args ) {
 			$ret = wp_delete_nav_menu( $arg );
 			if ( ! $ret || is_wp_error( $ret ) ) {
 				WP_CLI::warning( "Couldn't delete menu '{$arg}'." );
-				$errors++;
+				++$errors;
 			} else {
 				WP_CLI::log( "Deleted menu '{$arg}'." );
-				$count++;
+				++$count;
 			}
 		}
 
@@ -185,7 +183,7 @@ public function list_( $args, $assoc_args ) {
 
 		if ( 'ids' === $formatter->format ) {
 			$ids = array_map(
-				function( $o ) {
+				function ( $o ) {
 					return $o->term_id;
 				},
 				$menus
@@ -199,5 +197,4 @@ function( $o ) {
 	protected function get_formatter( &$assoc_args ) {
 		return new Formatter( $assoc_args, $this->obj_fields, $this->obj_type );
 	}
-
 }
diff --git a/src/Menu_Item_Command.php b/src/Menu_Item_Command.php
@@ -99,7 +99,7 @@ public function list_( $args, $assoc_args ) {
 		// Correct position inconsistency and
 		// protected `url` param in WP-CLI
 		$items = array_map(
-			function( $item ) {
+			function ( $item ) {
 					$item->position = $item->menu_order;
 					$item->link     = $item->url;
 					return $item;
@@ -109,7 +109,7 @@ function( $item ) {
 
 		if ( ! empty( $assoc_args['format'] ) && 'ids' === $assoc_args['format'] ) {
 			$items = array_map(
-				function( $item ) {
+				function ( $item ) {
 						return $item->db_id;
 				},
 				$items
@@ -118,7 +118,6 @@ function( $item ) {
 
 		$formatter = $this->get_formatter( $assoc_args );
 		$formatter->display_items( $items );
-
 	}
 
 	/**
@@ -343,7 +342,6 @@ public function update( $args, $assoc_args ) {
 		}
 		$type = get_post_meta( $args[1], '_menu_item_type', true );
 		$this->add_or_update_item( 'update', $type, $args, $assoc_args );
-
 	}
 
 	/**
@@ -375,7 +373,7 @@ public function delete( $args, $assoc_args ) {
 			$result         = wp_delete_post( $arg, true );
 			if ( ! $result ) {
 				WP_CLI::warning( "Couldn't delete menu item {$arg}." );
-				$errors++;
+				++$errors;
 			} else {
 
 				if ( is_array( $menu_term ) && ! empty( $menu_term ) && $post ) {
@@ -395,9 +393,9 @@ public function delete( $args, $assoc_args ) {
 				}
 			}
 
-			// phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison -- Will increase count for non existent menu.
+			// phpcs:ignore Universal.Operators.StrictComparisons.LooseNotEqual -- Will increase count for non existent menu.
 			if ( false != $result ) {
-				$count++;
+				++$count;
 			}
 		}
 
@@ -505,15 +503,12 @@ private function add_or_update_item( $method, $type, $args, $assoc_args ) {
 
 			if ( 'add' === $method && ! empty( $assoc_args['porcelain'] ) ) {
 				WP_CLI::line( $result );
-			} else {
-				if ( 'add' === $method ) {
+			} elseif ( 'add' === $method ) {
 					WP_CLI::success( 'Menu item added.' );
-				} elseif ( 'update' === $method ) {
-					WP_CLI::success( 'Menu item updated.' );
-				}
+			} elseif ( 'update' === $method ) {
+				WP_CLI::success( 'Menu item updated.' );
 			}
 		}
-
 	}
 
 	/**
@@ -534,5 +529,4 @@ private function reorder_menu_items( $menu_id, $min_position, $increment, $ignor
 	protected function get_formatter( &$assoc_args ) {
 		return new Formatter( $assoc_args, $this->obj_fields );
 	}
-
 }
diff --git a/src/Menu_Location_Command.php b/src/Menu_Location_Command.php
@@ -79,7 +79,7 @@ public function list_( $args, $assoc_args ) {
 
 		if ( 'ids' === $formatter->format ) {
 			$ids = array_map(
-				function( $o ) {
+				function ( $o ) {
 					return $o->location;
 				},
 				$location_objs
@@ -166,7 +166,5 @@ public function remove( $args, $assoc_args ) {
 		set_theme_mod( 'nav_menu_locations', $locations );
 
 		WP_CLI::success( 'Removed location from menu.' );
-
 	}
-
 }
diff --git a/src/Option_Command.php b/src/Option_Command.php
@@ -427,12 +427,10 @@ public function update( $args, $assoc_args ) {
 
 		if ( $value === $old_value && null === $autoload ) {
 			WP_CLI::success( "Value passed for '{$key}' option is unchanged." );
-		} else {
-			if ( update_option( $key, $value, $autoload ) ) {
+		} elseif ( update_option( $key, $value, $autoload ) ) {
 				WP_CLI::success( "Updated '{$key}' option." );
-			} else {
-				WP_CLI::error( "Could not update option '{$key}'." );
-			}
+		} else {
+			WP_CLI::error( "Could not update option '{$key}'." );
 		}
 	}
 
@@ -591,7 +589,7 @@ public function pluck( $args, $assoc_args ) {
 		}
 
 		$key_path = array_map(
-			function( $key ) {
+			function ( $key ) {
 				if ( is_numeric( $key ) && ( (string) intval( $key ) === $key ) ) {
 					return (int) $key;
 				}
@@ -672,7 +670,7 @@ function( $key ) {
 	public function patch( $args, $assoc_args ) {
 		list( $action, $key ) = $args;
 		$key_path             = array_map(
-			function( $key ) {
+			function ( $key ) {
 				if ( is_numeric( $key ) && ( (string) intval( $key ) === $key ) ) {
 					return (int) $key;
 				}
@@ -690,12 +688,10 @@ function( $key ) {
 
 			if ( ! empty( $stdin_value ) ) {
 				$patch_value = WP_CLI::read_value( $stdin_value, $assoc_args );
-			} else {
-				if ( count( $key_path ) > 1 ) {
+			} elseif ( count( $key_path ) > 1 ) {
 					$patch_value = WP_CLI::read_value( array_pop( $key_path ), $assoc_args );
-				} else {
-					$patch_value = null;
-				}
+			} else {
+				$patch_value = null;
 			}
 
 			if ( null === $patch_value ) {
@@ -722,12 +718,10 @@ function( $key ) {
 
 		if ( $patched_value === $old_value ) {
 			WP_CLI::success( "Value passed for '{$key}' option is unchanged." );
-		} else {
-			if ( update_option( $key, $patched_value ) ) {
+		} elseif ( update_option( $key, $patched_value ) ) {
 				WP_CLI::success( "Updated '{$key}' option." );
-			} else {
-				WP_CLI::error( "Could not update option '{$key}'." );
-			}
+		} else {
+			WP_CLI::error( "Could not update option '{$key}'." );
 		}
 	}
 

diff --git a/src/Post_Command.php b/src/Post_Command.php
@@ -654,7 +654,7 @@ public function list_( $args, $assoc_args ) {
 		} else {
 			$query = new WP_Query( $query_args );
 			$posts = array_map(
-				function( $post ) {
+				function ( $post ) {
 						$post->url = get_permalink( $post->ID );
 						return $post;
 				},
@@ -817,7 +817,7 @@ public function generate( $args, $assoc_args ) {
 				if ( $this->maybe_make_child() && $current_depth < $post_data['max_depth'] ) {
 
 					$current_parent = $previous_post_id;
-					$current_depth++;
+					++$current_depth;
 
 				} elseif ( $this->maybe_reset_depth() ) {
 

diff --git a/src/Post_Type_Command.php b/src/Post_Type_Command.php
@@ -146,7 +146,7 @@ public function list_( $args, $assoc_args ) {
 		}
 
 		$types = array_map(
-			function( $type ) use ( $counts ) {
+			function ( $type ) use ( $counts ) {
 					$type->count = isset( $counts[ $type->name ] ) ? $counts[ $type->name ] : 0;
 					return $type;
 			},

diff --git a/src/Site_Command.php b/src/Site_Command.php
@@ -157,6 +157,7 @@ private function insert_default_terms() {
 		/* translators: Default category slug */
 		$cat_slug = sanitize_title( _x( 'Uncategorized', 'Default category slug' ) );
 
+		// phpcs:ignore WordPress.WP.DeprecatedFunctions.global_terms_enabledFound -- Required for backwards compatibility.
 		if ( global_terms_enabled() ) {
 			$cat_id = $wpdb->get_var( $wpdb->prepare( "SELECT cat_ID FROM {$wpdb->sitecategories} WHERE category_nicename = %s", $cat_slug ) );
 			if ( null === $cat_id ) {
@@ -615,7 +616,7 @@ public function list_( $args, $assoc_args ) {
 
 		$iterator = Utils\iterator_map(
 			$iterator,
-			function( $blog ) {
+			function ( $blog ) {
 				$blog->url = trailingslashit( get_home_url( $blog->blog_id ) );
 				return $blog;
 			}

diff --git a/src/Site_Meta_Command.php b/src/Site_Meta_Command.php
@@ -111,5 +111,4 @@ protected function get_metadata( $object_id, $meta_key = '', $single = false ) {
 	protected function delete_metadata( $object_id, $meta_key, $meta_value = '' ) {
 		return delete_site_meta( $object_id, $meta_key, $meta_value );
 	}
-
 }
diff --git a/src/Site_Option_Command.php b/src/Site_Option_Command.php
@@ -245,12 +245,10 @@ public function update( $args, $assoc_args ) {
 
 		if ( $value === $old_value ) {
 			WP_CLI::success( "Value passed for '{$key}' site option is unchanged." );
-		} else {
-			if ( update_site_option( $key, $value ) ) {
+		} elseif ( update_site_option( $key, $value ) ) {
 				WP_CLI::success( "Updated '{$key}' site option." );
-			} else {
-				WP_CLI::error( "Could not update site option '{$key}'." );
-			}
+		} else {
+			WP_CLI::error( "Could not update site option '{$key}'." );
 		}
 	}
 
@@ -307,7 +305,7 @@ public function pluck( $args, $assoc_args ) {
 		}
 
 		$key_path = array_map(
-			function( $key ) {
+			function ( $key ) {
 				if ( is_numeric( $key ) && ( (string) intval( $key ) === $key ) ) {
 					return (int) $key;
 				}
@@ -362,7 +360,7 @@ function( $key ) {
 	public function patch( $args, $assoc_args ) {
 		list( $action, $key ) = $args;
 		$key_path             = array_map(
-			function( $key ) {
+			function ( $key ) {
 				if ( is_numeric( $key ) && ( (string) intval( $key ) === $key ) ) {
 					return (int) $key;
 				}
@@ -401,12 +399,10 @@ function( $key ) {
 
 		if ( $patched_value === $old_value ) {
 			WP_CLI::success( "Value passed for '{$key}' site option is unchanged." );
-		} else {
-			if ( update_site_option( $key, $patched_value ) ) {
+		} elseif ( update_site_option( $key, $patched_value ) ) {
 				WP_CLI::success( "Updated '{$key}' site option." );
-			} else {
-				WP_CLI::error( "Could not update site option '{$key}'." );
-			}
+		} else {
+			WP_CLI::error( "Could not update site option '{$key}'." );
 		}
 	}
 

diff --git a/src/Taxonomy_Command.php b/src/Taxonomy_Command.php
@@ -172,7 +172,7 @@ public function list_( $args, $assoc_args ) {
 		}
 
 		$taxonomies = array_map(
-			function( $taxonomy ) use ( $counts ) {
+			function ( $taxonomy ) use ( $counts ) {
 					$taxonomy->object_type = implode( ', ', $taxonomy->object_type );
 					$taxonomy->count       = isset( $counts[ $taxonomy->name ] ) ? $counts[ $taxonomy->name ] : 0;
 					return $taxonomy;