PHPStan level 6

composer.json

@@ -20,14 +20,15 @@
         "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": "^4"
+        "wp-cli/wp-cli-tests": "dev-main"
     },
     "config": {
         "process-timeout": 7200,
         "sort-packages": true,
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true,
-            "johnpbloch/wordpress-core-installer": true
+            "johnpbloch/wordpress-core-installer": true,
+            "phpstan/extension-installer": true
         },
         "lock": false
     },
@@ -230,12 +231,14 @@
         "behat-rerun": "rerun-behat-tests",
         "lint": "run-linter-tests",
         "phpcs": "run-phpcs-tests",
+        "phpstan": "run-phpstan-tests",
         "phpunit": "run-php-unit-tests",
         "phpcbf": "run-phpcbf-cleanup",
         "prepare-tests": "install-package-tests",
         "test": [
             "@lint",
             "@phpcs",
+            "@phpstan",
             "@phpunit",
             "@behat"
         ]

features/post.feature

@@ -451,40 +451,6 @@ Feature: Manage WordPress posts
       Test Post
       """
 
-  @less-than-wp-4.4
-  Scenario: Creating/updating posts with meta keys for WP < 4.4 has no effect so should give warning
-    When I try `wp post create --post_title='Test Post' --post_content='Test post content' --meta_input='{"key1":"value1","key2":"value2"}' --porcelain`
-    Then the return code should be 0
-    And STDOUT should be a number
-    And save STDOUT as {POST_ID}
-    And STDERR should be:
-      """
-      Warning: The 'meta_input' field was only introduced in WordPress 4.4 so will have no effect.
-      """
-
-    When I run `wp post meta list {POST_ID} --format=count`
-    Then STDOUT should be:
-      """
-      0
-      """
-
-    When I try `wp post update {POST_ID} --meta_input='{"key2":"value2b","key3":"value3"}'`
-    Then the return code should be 0
-    And STDERR should be:
-      """
-      Warning: The 'meta_input' field was only introduced in WordPress 4.4 so will have no effect.
-      """
-    And STDOUT should be:
-      """
-      Success: Updated post {POST_ID}.
-      """
-
-    When I run `wp post meta list {POST_ID} --format=count`
-    Then STDOUT should be:
-      """
-      0
-      """
-
   Scenario: Publishing a post and setting a date fails if the edit_date flag is not passed.
     Given a WP install
 

phpstan.neon.dist

@@ -0,0 +1,20 @@
+parameters:
+  level: 6
+  paths:
+    - src
+    - entity-command.php
+  scanDirectories:
+    - vendor/wp-cli/wp-cli/php
+    - vendor/wp-cli/wp-cli-tests
+  scanFiles:
+    - vendor/php-stubs/wordpress-stubs/wordpress-stubs.php
+  treatPhpDocTypesAsCertain: false
+  dynamicConstantNames:
+  	- WP_DEBUG
+  	- WP_DEBUG_LOG
+  	- WP_DEBUG_DISPLAY
+  ignoreErrors:
+    - identifier: missingType.iterableValue
+    - identifier: missingType.property
+    - identifier: missingType.parameter
+    - identifier: missingType.return

src/Comment_Command.php

@@ -243,6 +243,7 @@ public function get( $args, $assoc_args ) {
 		}
 
 		if ( ! isset( $comment->url ) ) {
+			// @phpstan-ignore property.notFound
 			$comment->url = get_comment_link( $comment );
 		}
 
@@ -366,6 +367,8 @@ public function get( $args, $assoc_args ) {
 	public function list_( $args, $assoc_args ) {
 		$formatter = $this->get_formatter( $assoc_args );
 
+		// To be fixed in wp-cli/wp-cli.
+		// @phpstan-ignore property.notFound
 		if ( 'ids' === $formatter->format ) {
 			$assoc_args['fields'] = 'comment_ID';
 		}
@@ -642,16 +645,17 @@ public function unapprove( $args, $assoc_args ) {
 	 *     total_comments:  19
 	 */
 	public function count( $args, $assoc_args ) {
-		$post_id = Utils\get_flag_value( $args, 0, 0 );
+		$post_id = $args[0] ?? null;
 
 		$count = wp_count_comments( $post_id );
 
 		// Move total_comments to the end of the object
 		$total = $count->total_comments;
 		unset( $count->total_comments );
+		// @phpstan-ignore assign.propertyReadOnly
 		$count->total_comments = $total;
 
-		foreach ( $count as $status => $count ) {
+		foreach ( (array) $count as $status => $count ) {
 			WP_CLI::line( str_pad( "$status:", 17 ) . $count );
 		}
 	}

src/Comment_Meta_Command.php

@@ -104,11 +104,11 @@ protected function delete_metadata( $object_id, $meta_key, $meta_value = '' ) {
 	/**
 	 * Check that the comment ID exists
 	 *
-	 * @param int
+	 * @param int $object_id
 	 */
 	protected function check_object_id( $object_id ) {
 		$fetcher = new CommentFetcher();
-		$comment = $fetcher->get_check( $object_id );
+		$comment = $fetcher->get_check( (string) $object_id );
 		return $comment->comment_ID;
 	}
 }

src/Menu_Command.php

@@ -70,7 +70,7 @@
 
 		} elseif ( Utils\get_flag_value( $assoc_args, 'porcelain' ) ) {
 
-				WP_CLI::line( $menu_id );
+				WP_CLI::line( (string) $menu_id );
 		} else {
 			WP_CLI::success( "Created menu {$menu_id}." );
 		}
@@ -166,6 +166,7 @@
 		$menu_locations = get_nav_menu_locations();
 		foreach ( $menus as &$menu ) {
 
+			// @phpstan-ignore property.notFound
 			$menu->locations = [];
 			foreach ( $menu_locations as $location => $term_id ) {
 

src/Menu_Item_Command.php

@@ -92,7 +92,7 @@ class Menu_Item_Command extends WP_CLI_Command {
 	public function list_( $args, $assoc_args ) {
 
 		$items = wp_get_nav_menu_items( $args[0] );
-		if ( false === $items || is_wp_error( $items ) ) {
+		if ( false === $items ) {
 			WP_CLI::error( 'Invalid menu.' );
 		}
 
@@ -408,10 +408,10 @@ public function delete( $args, $assoc_args ) {
 	private function add_or_update_item( $method, $type, $args, $assoc_args ) {
 
 		$menu            = $args[0];
-		$menu_item_db_id = Utils\get_flag_value( $args, 1, 0 );
+		$menu_item_db_id = $args[1] ?? 0;
 
 		$menu = wp_get_nav_menu_object( $menu );
-		if ( ! $menu || is_wp_error( $menu ) ) {
+		if ( false === $menu ) {
 			WP_CLI::error( 'Invalid menu.' );
 		}
 
@@ -502,7 +502,7 @@ private function add_or_update_item( $method, $type, $args, $assoc_args ) {
 			}
 
 			if ( 'add' === $method && ! empty( $assoc_args['porcelain'] ) ) {
-				WP_CLI::line( $result );
+				WP_CLI::line( (string) $result );
 			} elseif ( 'add' === $method ) {
 					WP_CLI::success( 'Menu item added.' );
 			} elseif ( 'update' === $method ) {

src/Menu_Location_Command.php

@@ -77,6 +77,8 @@ public function list_( $args, $assoc_args ) {
 
 		$formatter = new Formatter( $assoc_args, [ 'location', 'description' ] );
 
+		// To be fixed in wp-cli/wp-cli.
+		// @phpstan-ignore property.notFound
 		if ( 'ids' === $formatter->format ) {
 			$ids = array_map(
 				function ( $o ) {
@@ -107,6 +109,8 @@ function ( $o ) {
 	 *     Success: Assigned location primary to menu primary-menu.
 	 *
 	 * @subcommand assign
+	 *
+	 * @param array{string, string} $args
 	 */
 	public function assign( $args, $assoc_args ) {
 
@@ -147,18 +151,20 @@ public function assign( $args, $assoc_args ) {
 	 *     Success: Removed location from menu.
 	 *
 	 * @subcommand remove
+	 *
+	 * @param array{string, string} $args
 	 */
 	public function remove( $args, $assoc_args ) {
 
 		list( $menu, $location ) = $args;
 
 		$menu = wp_get_nav_menu_object( $menu );
-		if ( ! $menu || is_wp_error( $menu ) ) {
+		if ( false === $menu ) {
 			WP_CLI::error( 'Invalid menu.' );
 		}
 
 		$locations = get_nav_menu_locations();
-		if ( Utils\get_flag_value( $locations, $location ) !== $menu->term_id ) {
+		if ( ( $locations[ $location ] ?? null ) !== $menu->term_id ) {
 			WP_CLI::error( "Menu isn't assigned to location." );
 		}
 

src/Option_Command.php

@@ -133,6 +133,7 @@ public function add( $args, $assoc_args ) {
 			$autoload = 'yes';
 		}
 
+		// @phpstan-ignore argument.type
 		if ( ! add_option( $key, $value, '', $autoload ) ) {
 			WP_CLI::error( "Could not add option '{$key}'. Does it already exist?" );
 		} else {
@@ -321,8 +322,8 @@ public function list_( $args, $assoc_args ) {
 				function ( $a, $b ) use ( $orderby, $order ) {
 					// Sort array.
 					return 'asc' === $order
-						? $a->$orderby > $b->$orderby
-						: $a->$orderby < $b->$orderby;
+						? $a->$orderby <=> $b->$orderby
+						: $b->$orderby <=> $a->$orderby;
 				}
 			);
 		} elseif ( 'option_id' === $orderby && 'desc' === $order ) { // Sort by default descending.
@@ -431,6 +432,7 @@ public function update( $args, $assoc_args ) {
 
 		if ( $value === $old_value && null === $autoload ) {
 			WP_CLI::success( "Value passed for '{$key}' option is unchanged." );
+			// @phpstan-ignore argument.type
 		} elseif ( update_option( $key, $value, $autoload ) ) {
 				WP_CLI::success( "Updated '{$key}' option." );
 		} else {

src/Post_Command.php

@@ -182,10 +182,6 @@ public function create( $args, $assoc_args ) {
 			$assoc_args['post_category'] = $this->get_category_ids( $assoc_args['post_category'] );
 		}
 
-		if ( isset( $assoc_args['meta_input'] ) && Utils\wp_version_compare( '4.4', '<' ) ) {
-			WP_CLI::warning( "The 'meta_input' field was only introduced in WordPress 4.4 so will have no effect." );
-		}
-
 		$array_arguments = [ 'meta_input' ];
 		$assoc_args      = Utils\parse_shell_arrays( $assoc_args, $array_arguments );
 
@@ -351,10 +347,6 @@ public function update( $args, $assoc_args ) {
 			$assoc_args['post_category'] = $this->get_category_ids( $assoc_args['post_category'] );
 		}
 
-		if ( isset( $assoc_args['meta_input'] ) && Utils\wp_version_compare( '4.4', '<' ) ) {
-			WP_CLI::warning( "The 'meta_input' field was only introduced in WordPress 4.4 so will have no effect." );
-		}
-
 		$array_arguments = [ 'meta_input' ];
 		$assoc_args      = Utils\parse_shell_arrays( $assoc_args, $array_arguments );
 
@@ -387,7 +379,7 @@ public function edit( $args, $assoc_args ) {
 		$result = $this->_edit( $post->post_content, "WP-CLI post {$post->ID}" );
 
 		if ( false === $result ) {
-			WP_CLI::warning( 'No change made to post content.', 'Aborted' );
+			WP_CLI::warning( 'No change made to post content.' );
 		} else {
 			$this->update( $args, [ 'post_content' => $result ] );
 		}
@@ -644,9 +636,12 @@ public function list_( $args, $assoc_args ) {
 			$query_args['post_type'] = explode( ',', $query_args['post_type'] );
 		}
 
+		// To be fixed in wp-cli/wp-cli.
+		// @phpstan-ignore property.notFound
 		if ( 'ids' === $formatter->format ) {
 			$query_args['fields'] = 'ids';
 			$query                = new WP_Query( $query_args );
+			// @phpstan-ignore argument.type
 			echo implode( ' ', $query->posts );
 		} elseif ( 'count' === $formatter->format ) {
 			$query_args['fields'] = 'ids';
@@ -656,8 +651,13 @@ public function list_( $args, $assoc_args ) {
 			$query = new WP_Query( $query_args );
 			$posts = array_map(
 				function ( $post ) {
-						$post->url = get_permalink( $post->ID );
-						return $post;
+					/**
+					 * @var \WP_Post $post
+					 */
+
+					// @phpstan-ignore property.notFound
+					$post->url = get_permalink( $post->ID );
+					return $post;
 				},
 				$query->posts
 			);

src/Post_Meta_Command.php

@@ -30,11 +30,11 @@ class Post_Meta_Command extends CommandWithMeta {
 	/**
 	 * Check that the post ID exists
 	 *
-	 * @param int
+	 * @param int $object_id
 	 */
 	protected function check_object_id( $object_id ) {
 		$fetcher = new PostFetcher();
-		$post    = $fetcher->get_check( $object_id );
+		$post    = $fetcher->get_check( (string) $object_id );
 		return $post->ID;
 	}
 

src/Post_Type_Command.php

@@ -147,8 +147,9 @@ public function list_( $args, $assoc_args ) {
 
 		$types = array_map(
 			function ( $type ) use ( $counts ) {
-					$type->count = isset( $counts[ $type->name ] ) ? $counts[ $type->name ] : 0;
-					return $type;
+				// @phpstan-ignore property.notFound
+				$type->count = isset( $counts[ $type->name ] ) ? $counts[ $type->name ] : 0;
+				return $type;
 			},
 			$types
 		);

src/Signup_Command.php

@@ -308,7 +308,7 @@ public function delete( $args, $assoc_args ) {
 	/**
 	 * Deletes signup.
 	 *
-	 * @param stdClasss $signup
+	 * @param object{signup_id: int|string} $signup
 	 * @return bool True if success; otherwise false.
 	 */
 	private function delete_signup( $signup ) {