More type fixes

swissspidy · swissspidy · commit f2f3a25a9689 · 2025-07-03T16:01:41.000+02:00
diff --git a/src/Comment_Command.php b/src/Comment_Command.php
@@ -367,8 +367,6 @@ 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';
 		}
diff --git a/src/Comment_Meta_Command.php b/src/Comment_Meta_Command.php
@@ -76,8 +76,11 @@ protected function update_metadata( $object_id, $meta_key, $meta_value, $prev_va
 	 *                          specified.
 	 *
 	 * @return mixed Single metadata value, or array of values.
+	 *
+	 * @phpstan-return ($single is true ? string : $meta_key is "" ? array<array<string>> : array<string>)
 	 */
 	protected function get_metadata( $object_id, $meta_key = '', $single = false ) {
+		// @phpstan-ignore return.type
 		return get_comment_meta( $object_id, $meta_key, $single );
 	}
 
@@ -110,6 +113,6 @@ protected function delete_metadata( $object_id, $meta_key, $meta_value = '' ) {
 	protected function check_object_id( $object_id ) {
 		$fetcher = new CommentFetcher();
 		$comment = $fetcher->get_check( (string) $object_id );
-		return $comment->comment_ID;
+		return (int) $comment->comment_ID;
 	}
 }
diff --git a/src/Menu_Item_Command.php b/src/Menu_Item_Command.php
@@ -367,8 +367,10 @@ public function delete( $args, $assoc_args ) {
 
 		foreach ( $args as $arg ) {
 
-			$post           = get_post( $arg );
-			$menu_term      = get_the_terms( $arg, 'nav_menu' );
+			$post      = get_post( $arg );
+			$menu_term = get_the_terms( $arg, 'nav_menu' );
+
+			// @phpstan-ignore cast.int
 			$parent_menu_id = (int) get_post_meta( $arg, '_menu_item_menu_item_parent', true );
 			$result         = wp_delete_post( $arg, true );
 			if ( ! $result ) {
diff --git a/src/Menu_Location_Command.php b/src/Menu_Location_Command.php
@@ -77,8 +77,6 @@ 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 ) {
diff --git a/src/Option_Command.php b/src/Option_Command.php
@@ -329,7 +329,7 @@ function ( $a, $b ) use ( $orderby, $order ) {
 						: $b->$orderby <=> $a->$orderby;
 				}
 			);
-		} elseif ( 'option_id' === $orderby && 'desc' === $order ) { // Sort by default descending.
+		} elseif ( 'desc' === $order ) { // Sort by default descending.
 			krsort( $results );
 		}
 
diff --git a/src/Post_Command.php b/src/Post_Command.php
@@ -636,8 +636,6 @@ 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 );
@@ -744,6 +742,9 @@ function ( $post ) {
 	 *     Success: Added custom field.
 	 *     Success: Added custom field.
 	 *     Success: Added custom field.
+	 *
+	 * @param array<string> $args Positional arguments. Unused.
+	 * @param array{count: string, post_type: string, post_status: string, post_title: string, post_author: string, post_date?: string, post_date_gmt?: string, post_content?: string, max_depth: string, format: string} $assoc_args Associative arguments.
 	 */
 	public function generate( $args, $assoc_args ) {
 		global $wpdb;
@@ -800,7 +801,7 @@ public function generate( $args, $assoc_args ) {
 				WP_CLI::error( 'The parameter `post_content` reads from STDIN.' );
 			}
 
-			$post_data['post_content'] = file_get_contents( 'php://stdin' );
+			$post_data['post_content'] = (string) file_get_contents( 'php://stdin' );
 		}
 
 		// Get the total number of posts.
@@ -821,7 +822,7 @@ public function generate( $args, $assoc_args ) {
 
 		$notify = false;
 		if ( 'progress' === $format ) {
-			$notify = Utils\make_progress_bar( 'Generating posts', $post_data['count'] );
+			$notify = Utils\make_progress_bar( 'Generating posts', (int) $post_data['count'] );
 		}
 
 		$previous_post_id = 0;
@@ -851,7 +852,7 @@ public function generate( $args, $assoc_args ) {
 					? $label
 					: "{$label} {$index}",
 				'post_status'   => $post_data['post_status'],
-				'post_author'   => $post_data['post_author'],
+				'post_author'   => (int) $post_data['post_author'],
 				'post_parent'   => $current_parent,
 				'post_name'     => ! empty( $post_data['post_title'] )
 					? sanitize_title( $post_data['post_title'] . ( $index === $total ? '' : "-{$index}" ) )
@@ -875,10 +876,12 @@ public function generate( $args, $assoc_args ) {
 			}
 
 			if ( 'progress' === $format ) {
+				// @phpstan-ignore method.nonObject
 				$notify->tick();
 			}
 		}
 		if ( 'progress' === $format ) {
+			// @phpstan-ignore method.nonObject
 			$notify->finish();
 		}
 	}
diff --git a/src/Post_Meta_Command.php b/src/Post_Meta_Command.php
@@ -88,8 +88,11 @@ protected function update_metadata( $object_id, $meta_key, $meta_value, $prev_va
 	 *                          specified.
 	 *
 	 * @return mixed Single metadata value, or array of values.
+	 *
+	 * @phpstan-return ($single is true ? string : $meta_key is "" ? array<array<string>> : array<string>)
 	 */
 	protected function get_metadata( $object_id, $meta_key = '', $single = false ) {
+		// @phpstan-ignore return.type
 		return get_post_meta( $object_id, $meta_key, $single );
 	}
 
diff --git a/src/Site_Command.php b/src/Site_Command.php
@@ -72,7 +72,12 @@ private function empty_posts() {
 		$taxonomies = get_taxonomies();
 
 		while ( $posts->valid() ) {
-			$post_id = $posts->current()->ID;
+			/**
+			 * @var object{ID: int} $post
+			 */
+			$post = $posts->current();
+
+			$post_id = $post->ID;
 
 			wp_cache_delete( $post_id, 'posts' );
 			wp_cache_delete( $post_id, 'post_meta' );
@@ -138,7 +143,12 @@ private function empty_links() {
 		wp_cache_delete( 'get_bookmarks', 'bookmark' );
 
 		while ( $links->valid() ) {
-			$link_id = $links->current()->link_id;
+			/**
+			 * @var object{link_id: int} $link
+			 */
+			$link = $links->current();
+
+			$link_id = $link->link_id;
 
 			// Remove cache for the link.
 			wp_delete_object_term_relationships( $link_id, 'link_category' );
diff --git a/src/Site_Meta_Command.php b/src/Site_Meta_Command.php
@@ -36,6 +36,8 @@ class Site_Meta_Command extends CommandWithMeta {
 	protected function check_object_id( $object_id ) {
 		$fetcher = new SiteFetcher();
 		$site    = $fetcher->get_check( (string) $object_id );
+		// TODO: Fix upstream.
+		// @phpstan-ignore property.notFound
 		return $site->blog_id;
 	}
 
@@ -88,8 +90,11 @@ protected function update_metadata( $object_id, $meta_key, $meta_value, $prev_va
 	 *                          specified.
 	 *
 	 * @return mixed Single metadata value, or array of values.
+	 *
+	 * @phpstan-return ($single is true ? string : $meta_key is "" ? array<array<string>> : array<string>)
 	 */
 	protected function get_metadata( $object_id, $meta_key = '', $single = false ) {
+		// @phpstan-ignore return.type
 		return get_site_meta( $object_id, $meta_key, $single );
 	}
 
diff --git a/src/Term_Meta_Command.php b/src/Term_Meta_Command.php
@@ -54,6 +54,8 @@ protected function check_object_id( $object_id ) {
 	 *                           will be made.
 	 *
 	 * @return int|false|WP_Error The meta ID on success, false on failure, WP_Error when term_id is ambiguous between taxonomies.
+	 *
+	 * @phpstan-ignore method.childReturnType
 	 */
 	protected function add_metadata( $object_id, $meta_key, $meta_value, $unique = false ) {
 		return add_term_meta( $object_id, $meta_key, $meta_value, $unique );
@@ -72,6 +74,8 @@ protected function add_metadata( $object_id, $meta_key, $meta_value, $unique = f
 	 *
 	 * @return int|bool|WP_Error Meta ID if the key didn't exist, true on successful
 	 *                  update, false on failure, WP_Error when term_id is ambiguous between taxonomies.
+	 *
+	 * @phpstan-ignore method.childReturnType
 	 */
 	protected function update_metadata( $object_id, $meta_key, $meta_value, $prev_value = '' ) {
 		return update_term_meta( $object_id, $meta_key, $meta_value, $prev_value );
@@ -89,8 +93,11 @@ protected function update_metadata( $object_id, $meta_key, $meta_value, $prev_va
 	 *                          specified.
 	 *
 	 * @return mixed Single metadata value, or array of values.
+	 *
+	 * @phpstan-return ($single is true ? string : $meta_key is "" ? array<array<string>> : array<string>)
 	 */
 	protected function get_metadata( $object_id, $meta_key = '', $single = false ) {
+		// @phpstan-ignore return.type
 		return get_term_meta( $object_id, $meta_key, $single );
 	}
 
diff --git a/src/User_Command.php b/src/User_Command.php
@@ -154,8 +154,6 @@ 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 ( in_array( $formatter->format, [ 'ids', 'count' ], true ) ) {
 			$assoc_args['fields'] = 'ids';
 		} else {
@@ -398,6 +396,9 @@ function ( $user ) use ( $network, $reassign ) {
 	 *     # Create user without showing password upon success
 	 *     $ wp user create ann ann@example.com --porcelain
 	 *     4
+	 *
+	 * @param array{0: string, 1: string} $args Positional arguments.
+	 * @param array{role?: string, user_pass?: string, user_registered?: string, display_name?: string, user_nicename?: string, user_url?: string, nickname?: string, first_name?: string, last_name?: string, description?: string, rich_editing?: string, send_email?: bool, porcelain?: bool} $assoc_args Associative arguments.
 	 */
 	public function create( $args, $assoc_args ) {
 		$user = new stdClass();
@@ -439,7 +440,12 @@ public function create( $args, $assoc_args ) {
 			$generated_pass  = true;
 		}
 
-		$user->role = Utils\get_flag_value( $assoc_args, 'role', get_option( 'default_role' ) );
+		/**
+		 * @var string $default_role
+		 */
+		$default_role = get_option( 'default_role' );
+
+		$user->role = Utils\get_flag_value( $assoc_args, 'role', $default_role );
 		self::validate_role( $user->role );
 
 		if ( ! Utils\get_flag_value( $assoc_args, 'send-email' ) ) {
@@ -1131,14 +1137,19 @@ public function import_csv( $args, $assoc_args ) {
 		}
 
 		/**
-		 * @var array{ID: string, role: string, roles: string, user_pass: string, user_registered: string, display_name: string|false, user_login: string, user_email: string} $new_user
+		 * @var string $default_role
+		 */
+		$default_role = get_option( 'default_role' );
+
+		/**
+		 * @var array{ID: string, role: string, roles: string, user_pass: string, user_registered: string, display_name: string, user_login: string, user_email: string} $new_user
 		 */
 		foreach ( $csv_data as $new_user ) {
 			$defaults = [
-				'role'            => get_option( 'default_role' ),
+				'role'            => $default_role,
 				'user_pass'       => wp_generate_password( 24 ),
 				'user_registered' => current_time( 'mysql', true ),
-				'display_name'    => false,
+				'display_name'    => '',
 			];
 			$new_user = array_merge( $defaults, $new_user );
 
@@ -1159,7 +1170,7 @@ public function import_csv( $args, $assoc_args ) {
 				$new_user['role'] = array_shift( $roles );
 				$secondary_roles  = $roles;
 			} elseif ( 'none' === $new_user['role'] ) {
-				$new_user['role'] = false;
+				$new_user['role'] = '';
 			} elseif ( null === get_role( $new_user['role'] ) ) {
 				WP_CLI::warning( "{$new_user['user_login']} has an invalid role." );
 				continue;
diff --git a/src/User_Meta_Command.php b/src/User_Meta_Command.php
@@ -100,6 +100,9 @@ public function __construct() {
 	 *     +---------+-----------------+--------------------------------+
 	 *
 	 * @subcommand list
+	 *
+	 * @param array{0: string} $args Positional arguments.
+	 * @param array{keys?: string, fields?: string, format: 'table'|'csv'|'json'|'count'|'yaml', orderby: 'id'|'meta_key'|'meta_value', order: 'asc'|'desc', unserialize?: bool} $assoc_args Associative arguments.
 	 */
 	public function list_( $args, $assoc_args ) {
 		$args = $this->replace_login_with_user_id( $args );
@@ -137,6 +140,9 @@ public function list_( $args, $assoc_args ) {
 	 *     # Get the primary site of a user (for multisite)
 	 *     $ wp user meta get 2 primary_blog
 	 *     3
+	 *
+	 * @param array{0: string, 1: string} $args Positional arguments.
+	 * @param array{format: 'table'|'csv'|'json'|'yaml'} $assoc_args Associative arguments.
 	 */
 	public function get( $args, $assoc_args ) {
 		$args = $this->replace_login_with_user_id( $args );
@@ -162,6 +168,8 @@ public function get( $args, $assoc_args ) {
 	 *     # Delete user meta
 	 *     $ wp user meta delete 123 bio
 	 *     Success: Deleted custom field.
+	 *
+	 * @param array<string> $args Positional arguments.
 	 */
 	public function delete( $args, $assoc_args ) {
 		$args = $this->replace_login_with_user_id( $args );
@@ -196,6 +204,9 @@ public function delete( $args, $assoc_args ) {
 	 *     # Add user meta
 	 *     $ wp user meta add 123 bio "Mary is an WordPress developer."
 	 *     Success: Added custom field.
+	 *
+	 * @param array<string> $args Positional arguments.
+	 * @param array{format: 'plaintext'|'json'} $assoc_args Associative arguments.
 	 */
 	public function add( $args, $assoc_args ) {
 		$args = $this->replace_login_with_user_id( $args );
@@ -232,6 +243,9 @@ public function add( $args, $assoc_args ) {
 	 *     Success: Updated custom field 'bio'.
 	 *
 	 * @alias set
+	 *
+	 * @param array<string> $args Positional arguments.
+	 * @param array{format: 'plaintext'|'json'} $assoc_args Associative arguments.
 	 */
 	public function update( $args, $assoc_args ) {
 		$args = $this->replace_login_with_user_id( $args );
@@ -287,8 +301,11 @@ protected function update_metadata( $object_id, $meta_key, $meta_value, $prev_va
 	 *                          specified.
 	 *
 	 * @return mixed Single metadata value, or array of values.
+	 *
+	 * @phpstan-return ($single is true ? string : $meta_key is "" ? array<array<string>> : array<string>)
 	 */
 	protected function get_metadata( $object_id, $meta_key = '', $single = false ) {
+		// @phpstan-ignore return.type
 		return get_user_meta( $object_id, $meta_key, $single );
 	}
 
@@ -316,8 +333,10 @@ protected function delete_metadata( $object_id, $meta_key, $meta_value = '' ) {
 	 * Replaces user_login value with user ID
 	 * user meta is a special case that also supports user_login
 	 *
-	 * @param array $args
-	 * @return array
+	 * @template T of array
+	 *
+	 * @param T $args
+	 * @return T
 	 */
 	private function replace_login_with_user_id( $args ) {
 		$user    = $this->fetcher->get_check( $args[0] );
diff --git a/src/WP_CLI/CommandWithMeta.php b/src/WP_CLI/CommandWithMeta.php

Original file line number	Diff line number	Diff line change
`@@ -367,8 +367,6 @@ public function get( $args, $assoc_args ) {`
`367`	`367`	`public function list_( $args, $assoc_args ) {`
`368`	`368`	`$formatter = $this->get_formatter( $assoc_args );`
`369`	`369`
`370`		`- // To be fixed in wp-cli/wp-cli.`
`371`		`- // @phpstan-ignore property.notFound`
`372`	`370`	`if ( 'ids' === $formatter->format ) {`
`373`	`371`	`$assoc_args['fields'] = 'comment_ID';`
`374`	`372`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,8 +76,11 @@ protected function update_metadata( $object_id, $meta_key, $meta_value, $prev_va`
`76`	`76`	`* specified.`
`77`	`77`	`*`
`78`	`78`	`* @return mixed Single metadata value, or array of values.`
	`79`	`+ *`
	`80`	`+ * @phpstan-return ($single is true ? string : $meta_key is "" ? array<array<string>> : array<string>)`
`79`	`81`	`*/`
`80`	`82`	`protected function get_metadata( $object_id, $meta_key = '', $single = false ) {`
	`83`	`+ // @phpstan-ignore return.type`
`81`	`84`	`return get_comment_meta( $object_id, $meta_key, $single );`
`82`	`85`	`}`
`83`	`86`
`@@ -110,6 +113,6 @@ protected function delete_metadata( $object_id, $meta_key, $meta_value = '' ) {`
`110`	`113`	`protected function check_object_id( $object_id ) {`
`111`	`114`	`$fetcher = new CommentFetcher();`
`112`	`115`	`$comment = $fetcher->get_check( (string) $object_id );`
`113`		`- return $comment->comment_ID;`
	`116`	`+ return (int) $comment->comment_ID;`
`114`	`117`	`}`
`115`	`118`	`}`
Original file line number	Diff line number	Diff line change
`@@ -329,7 +329,7 @@ function ( $a, $b ) use ( $orderby, $order ) {`
`329`	`329`	`: $b->$orderby <=> $a->$orderby;`
`330`	`330`	`}`
`331`	`331`	`);`
`332`		`- } elseif ( 'option_id' === $orderby && 'desc' === $order ) { // Sort by default descending.`
	`332`	`+ } elseif ( 'desc' === $order ) { // Sort by default descending.`
`333`	`333`	`krsort( $results );`
`334`	`334`	`}`
`335`	`335`
Original file line number	Diff line number	Diff line change
`@@ -636,8 +636,6 @@ public function list_( $args, $assoc_args ) {`
`636`	`636`	`$query_args['post_type'] = explode( ',', $query_args['post_type'] );`
`637`	`637`	`}`
`638`	`638`
`639`		`- // To be fixed in wp-cli/wp-cli.`
`640`		`- // @phpstan-ignore property.notFound`
`641`	`639`	`if ( 'ids' === $formatter->format ) {`
`642`	`640`	`$query_args['fields'] = 'ids';`
`643`	`641`	`$query = new WP_Query( $query_args );`
`@@ -744,6 +742,9 @@ function ( $post ) {`
`744`	`742`	`* Success: Added custom field.`
`745`	`743`	`* Success: Added custom field.`
`746`	`744`	`* Success: Added custom field.`
	`745`	`+ *`
	`746`	`+ * @param array<string> $args Positional arguments. Unused.`
	`747`	`+ * @param array{count: string, post_type: string, post_status: string, post_title: string, post_author: string, post_date?: string, post_date_gmt?: string, post_content?: string, max_depth: string, format: string} $assoc_args Associative arguments.`
`747`	`748`	`*/`
`748`	`749`	`public function generate( $args, $assoc_args ) {`
`749`	`750`	`global $wpdb;`
`@@ -800,7 +801,7 @@ public function generate( $args, $assoc_args ) {`
`800`	`801`	WP_CLI::error( 'The parameter `post_content` reads from STDIN.' );
`801`	`802`	`}`
`802`	`803`
`803`		`- $post_data['post_content'] = file_get_contents( 'php://stdin' );`
	`804`	`+ $post_data['post_content'] = (string) file_get_contents( 'php://stdin' );`
`804`	`805`	`}`
`805`	`806`
`806`	`807`	`// Get the total number of posts.`
`@@ -821,7 +822,7 @@ public function generate( $args, $assoc_args ) {`
`821`	`822`
`822`	`823`	`$notify = false;`
`823`	`824`	`if ( 'progress' === $format ) {`
`824`		`- $notify = Utils\make_progress_bar( 'Generating posts', $post_data['count'] );`
	`825`	`+ $notify = Utils\make_progress_bar( 'Generating posts', (int) $post_data['count'] );`
`825`	`826`	`}`
`826`	`827`
`827`	`828`	`$previous_post_id = 0;`
`@@ -851,7 +852,7 @@ public function generate( $args, $assoc_args ) {`
`851`	`852`	`? $label`
`852`	`853`	`: "{$label} {$index}",`
`853`	`854`	`'post_status' => $post_data['post_status'],`
`854`		`- 'post_author' => $post_data['post_author'],`
	`855`	`+ 'post_author' => (int) $post_data['post_author'],`
`855`	`856`	`'post_parent' => $current_parent,`
`856`	`857`	`'post_name' => ! empty( $post_data['post_title'] )`
`857`	`858`	`? sanitize_title( $post_data['post_title'] . ( $index === $total ? '' : "-{$index}" ) )`
`@@ -875,10 +876,12 @@ public function generate( $args, $assoc_args ) {`
`875`	`876`	`}`
`876`	`877`
`877`	`878`	`if ( 'progress' === $format ) {`
	`879`	`+ // @phpstan-ignore method.nonObject`
`878`	`880`	`$notify->tick();`
`879`	`881`	`}`
`880`	`882`	`}`
`881`	`883`	`if ( 'progress' === $format ) {`
	`884`	`+ // @phpstan-ignore method.nonObject`
`882`	`885`	`$notify->finish();`
`883`	`886`	`}`
`884`	`887`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,8 +88,11 @@ protected function update_metadata( $object_id, $meta_key, $meta_value, $prev_va`
`88`	`88`	`* specified.`
`89`	`89`	`*`
`90`	`90`	`* @return mixed Single metadata value, or array of values.`
	`91`	`+ *`
	`92`	`+ * @phpstan-return ($single is true ? string : $meta_key is "" ? array<array<string>> : array<string>)`
`91`	`93`	`*/`
`92`	`94`	`protected function get_metadata( $object_id, $meta_key = '', $single = false ) {`
	`95`	`+ // @phpstan-ignore return.type`
`93`	`96`	`return get_post_meta( $object_id, $meta_key, $single );`
`94`	`97`	`}`
`95`	`98`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,8 @@ class Site_Meta_Command extends CommandWithMeta {`
`36`	`36`	`protected function check_object_id( $object_id ) {`
`37`	`37`	`$fetcher = new SiteFetcher();`
`38`	`38`	`$site = $fetcher->get_check( (string) $object_id );`
	`39`	`+ // TODO: Fix upstream.`
	`40`	`+ // @phpstan-ignore property.notFound`
`39`	`41`	`return $site->blog_id;`
`40`	`42`	`}`
`41`	`43`
`@@ -88,8 +90,11 @@ protected function update_metadata( $object_id, $meta_key, $meta_value, $prev_va`
`88`	`90`	`* specified.`
`89`	`91`	`*`
`90`	`92`	`* @return mixed Single metadata value, or array of values.`
	`93`	`+ *`
	`94`	`+ * @phpstan-return ($single is true ? string : $meta_key is "" ? array<array<string>> : array<string>)`
`91`	`95`	`*/`
`92`	`96`	`protected function get_metadata( $object_id, $meta_key = '', $single = false ) {`
	`97`	`+ // @phpstan-ignore return.type`
`93`	`98`	`return get_site_meta( $object_id, $meta_key, $single );`
`94`	`99`	`}`
`95`	`100`