Fix PHPStan issues

aristath · aristath · commit 4899d239219b · 2025-11-03T10:45:32.000+02:00
diff --git a/classes/admin/class-page-settings.php b/classes/admin/class-page-settings.php
@@ -58,27 +58,28 @@ public function add_admin_page_content() {
 	public function get_settings() {
 		$settings = [];
 		foreach ( \progress_planner()->get_page_types()->get_page_types() as $page_type ) {
-			if ( ! $this->should_show_setting( $page_type['slug'] ) ) {
+			$slug = (string) $page_type['slug']; // @phpstan-ignore offsetAccess.invalidOffset
+			if ( ! $this->should_show_setting( $slug ) ) {
 				continue;
 			}
 
-			$settings[ $page_type['slug'] ] = [
-				'id'          => $page_type['slug'],
+			$settings[ $slug ] = [
+				'id'          => $slug,
 				'value'       => '_no_page_needed',
 				'isset'       => 'no',
-				'title'       => $page_type['title'],
-				'description' => $page_type['description'] ?? '',
+				'title'       => $page_type['title'], // @phpstan-ignore offsetAccess.invalidOffset
+				'description' => $page_type['description'] ?? '', // @phpstan-ignore offsetAccess.invalidOffset
 				'type'        => 'page-select',
-				'page'        => $page_type['slug'],
+				'page'        => $slug,
 			];
 
-			if ( \progress_planner()->get_page_types()->is_page_needed( $page_type['slug'] ) ) {
-				$type_pages = \progress_planner()->get_page_types()->get_posts_by_type( 'any', $page_type['slug'] );
+			if ( \progress_planner()->get_page_types()->is_page_needed( $slug ) ) {
+				$type_pages = \progress_planner()->get_page_types()->get_posts_by_type( 'any', $slug );
 				if ( empty( $type_pages ) ) {
-					$settings[ $page_type['slug'] ]['value'] = \progress_planner()->get_page_types()->get_default_page_id_by_type( $page_type['slug'] );
+					$settings[ $slug ]['value'] = \progress_planner()->get_page_types()->get_default_page_id_by_type( $slug );
 				} else {
-					$settings[ $page_type['slug'] ]['value'] = $type_pages[0]->ID;
-					$settings[ $page_type['slug'] ]['isset'] = 'yes';
+					$settings[ $slug ]['value'] = $type_pages[0]->ID;
+					$settings[ $slug ]['isset'] = 'yes';
 
 					// If there is more than one page, we need to check if the page has a parent with the same page-type assigned.
 					if ( 1 < \count( $type_pages ) ) {
@@ -89,7 +90,7 @@ public function get_settings() {
 						foreach ( $type_pages as $type_page ) {
 							$parent = \get_post_field( 'post_parent', $type_page->ID );
 							if ( $parent && \in_array( (int) $parent, $type_pages_ids, true ) ) {
-								$settings[ $page_type['slug'] ]['value'] = $parent;
+								$settings[ $slug ]['value'] = $parent;
 								break;
 							}
 						}
diff --git a/classes/admin/widgets/class-activity-scores.php b/classes/admin/widgets/class-activity-scores.php
@@ -98,7 +98,8 @@ public function get_checklist_results() {
 		$items   = $this->get_checklist();
 		$results = [];
 		foreach ( $items as $item ) {
-			$results[ $item['label'] ] = $item['callback']();
+			$label = (string) $item['label']; // @phpstan-ignore offsetAccess.invalidOffset
+			$results[ $label ] = $item['callback'](); // @phpstan-ignore offsetAccess.invalidOffset
 		}
 		return $results;
 	}
diff --git a/classes/class-base.php b/classes/class-base.php
@@ -86,10 +86,12 @@ class Base {
 	 */
 	public function init() {
 		if ( ! \function_exists( 'current_user_can' ) ) {
-			require_once ABSPATH . 'wp-includes/capabilities.php'; // @phpstan-ignore requireOnce.fileNotFound
+			// @phpstan-ignore-next-line requireOnce.fileNotFound
+			require_once ABSPATH . 'wp-includes/capabilities.php';
 		}
 		if ( ! \function_exists( 'wp_get_current_user' ) ) {
-			require_once ABSPATH . 'wp-includes/pluggable.php'; // @phpstan-ignore requireOnce.fileNotFound
+			// @phpstan-ignore-next-line requireOnce.fileNotFound
+			require_once ABSPATH . 'wp-includes/pluggable.php';
 		}
 
 		if ( \defined( '\IS_PLAYGROUND_PREVIEW' ) && \constant( '\IS_PLAYGROUND_PREVIEW' ) === true ) {
@@ -421,7 +423,8 @@ public function get_file_version( $file ) {
 
 		// Otherwise, use the plugin header.
 		if ( ! \function_exists( 'get_file_data' ) ) {
-			require_once ABSPATH . 'wp-includes/functions.php'; // @phpstan-ignore requireOnce.fileNotFound
+			// @phpstan-ignore-next-line requireOnce.fileNotFound
+			require_once ABSPATH . 'wp-includes/functions.php';
 		}
 
 		if ( ! self::$plugin_version ) {
diff --git a/classes/class-suggested-tasks.php b/classes/class-suggested-tasks.php
@@ -479,7 +479,9 @@ public function rest_api_tax_query( $args, $request ) {
 
 		// Handle sorting parameters.
 		if ( isset( $request['filter']['orderby'] ) ) {
-			$args['orderby'] = \sanitize_sql_orderby( $request['filter']['orderby'] );
+			// @phpstan-ignore-next-line argument.templateType
+			$orderby = \sanitize_sql_orderby( $request['filter']['orderby'] ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+			$args['orderby'] = $orderby !== false ? $orderby : 'date';
 		}
 		if ( isset( $request['filter']['order'] ) ) {
 			$args['order'] = \in_array( \strtoupper( $request['filter']['order'] ), [ 'ASC', 'DESC' ], true )
diff --git a/classes/suggested-tasks/class-task.php b/classes/suggested-tasks/class-task.php
@@ -200,12 +200,14 @@ public function get_rest_formatted_data( $post_id = null ): array {
 
 		// Make sure WP_REST_Posts_Controller is loaded.
 		if ( ! \class_exists( 'WP_REST_Posts_Controller' ) ) {
-			require_once ABSPATH . 'wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php'; // @phpstan-ignore requireOnce.fileNotFound
+			// @phpstan-ignore-next-line requireOnce.fileNotFound
+			require_once ABSPATH . 'wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php';
 		}
 
 		// Make sure WP_REST_Request is loaded.
 		if ( ! \class_exists( 'WP_REST_Request' ) ) {
-			require_once ABSPATH . 'wp-includes/rest-api/class-wp-rest-request.php'; // @phpstan-ignore requireOnce.fileNotFound
+			// @phpstan-ignore-next-line requireOnce.fileNotFound
+			require_once ABSPATH . 'wp-includes/rest-api/class-wp-rest-request.php';
 		}
 
 		// Use the appropriate controller for the post type.
diff --git a/classes/suggested-tasks/data-collector/class-inactive-plugins.php b/classes/suggested-tasks/data-collector/class-inactive-plugins.php
@@ -47,7 +47,8 @@ public function update_inactive_plugins_cache() {
 	 */
 	protected function calculate_data() {
 		if ( ! \function_exists( 'get_plugins' ) ) {
-			require_once ABSPATH . 'wp-admin/includes/plugin.php'; // @phpstan-ignore requireOnce.fileNotFound
+			// @phpstan-ignore-next-line requireOnce.fileNotFound
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
 		}
 
 		// Clear the plugins cache, so get_plugins() returns the latest plugins.
diff --git a/classes/suggested-tasks/providers/class-core-update.php b/classes/suggested-tasks/providers/class-core-update.php
@@ -107,7 +107,8 @@ public function add_core_update_link( $update_actions ) {
 	public function should_add_task() {
 		// Without this \wp_get_update_data() might not return correct data for the core updates (depending on the timing).
 		if ( ! \function_exists( 'get_core_updates' ) ) {
-			require_once ABSPATH . 'wp-admin/includes/update.php'; // @phpstan-ignore requireOnce.fileNotFound
+			// @phpstan-ignore-next-line requireOnce.fileNotFound
+			require_once ABSPATH . 'wp-admin/includes/update.php';
 		}
 
 		// For wp_get_update_data() to return correct data it needs to be called after the 'admin_init' action (with priority 10).
diff --git a/classes/suggested-tasks/providers/class-fewer-tags.php b/classes/suggested-tasks/providers/class-fewer-tags.php
@@ -154,7 +154,8 @@ public function is_task_completed( $task_id = '' ) {
 	protected function is_plugin_active() {
 		if ( null === $this->is_plugin_active ) {
 			if ( ! \function_exists( 'get_plugins' ) ) {
-				require_once ABSPATH . 'wp-admin/includes/plugin.php'; // @phpstan-ignore requireOnce.fileNotFound
+				// @phpstan-ignore-next-line requireOnce.fileNotFound
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
 			}
 
 			$plugins                = \get_plugins();
diff --git a/classes/suggested-tasks/providers/class-select-locale.php b/classes/suggested-tasks/providers/class-select-locale.php
@@ -205,7 +205,8 @@ public function print_popover_instructions() {
 	public function print_popover_form_contents() {
 
 		if ( ! \function_exists( 'wp_get_available_translations' ) ) {
-			require_once ABSPATH . 'wp-admin/includes/translation-install.php'; // @phpstan-ignore requireOnce.fileNotFound
+			// @phpstan-ignore-next-line requireOnce.fileNotFound
+			require_once ABSPATH . 'wp-admin/includes/translation-install.php';
 		}
 
 		$languages    = \get_available_languages();
@@ -277,7 +278,8 @@ public function handle_interactive_task_specific_submit() {
 
 		// Handle translation installation.
 		if ( \current_user_can( 'install_languages' ) ) {
-			require_once ABSPATH . 'wp-admin/includes/translation-install.php'; // @phpstan-ignore requireOnce.fileNotFound
+			// @phpstan-ignore-next-line requireOnce.fileNotFound
+			require_once ABSPATH . 'wp-admin/includes/translation-install.php';
 
 			if ( \wp_can_install_language_pack() ) {
 				$language = \wp_download_language_pack( $language_for_update );
diff --git a/classes/ui/class-chart.php b/classes/ui/class-chart.php
@@ -125,7 +125,8 @@ public function get_chart_data( $args = [] ) {
 			$previous_period_activities = $period_data['previous_period_activities'];
 			$period_data_filtered       = [];
 			foreach ( $args['return_data'] as $key ) {
-				$period_data_filtered[ $key ] = $period_data[ $key ];
+				$key_string = (string) $key; // @phpstan-ignore offsetAccess.invalidOffset
+				$period_data_filtered[ $key_string ] = $period_data[ $key_string ]; // @phpstan-ignore offsetAccess.invalidOffset
 			}
 			$data[] = $period_data_filtered;
 		}
diff --git a/classes/update/class-update-140.php b/classes/update/class-update-140.php
@@ -41,10 +41,12 @@ private function rename_tasks_option() {
 		// This is to ensure that we don't lose any tasks, and at the same time we don't have duplicate tasks.
 		$tasks = [];
 		foreach ( $new_tasks as $new_task ) {
-			$tasks[ isset( $new_task['task_id'] ) ? $new_task['task_id'] : \md5( \maybe_serialize( $new_task ) ) ] = $new_task;
+			$key = isset( $new_task['task_id'] ) ? (string) $new_task['task_id'] : \md5( \maybe_serialize( $new_task ) ); // @phpstan-ignore offsetAccess.invalidOffset
+			$tasks[ $key ] = $new_task;
 		}
 		foreach ( $old_tasks as $old_task ) {
-			$tasks[ isset( $old_task['task_id'] ) ? $old_task['task_id'] : \md5( \maybe_serialize( $old_task ) ) ] = $old_task;
+			$key = isset( $old_task['task_id'] ) ? (string) $old_task['task_id'] : \md5( \maybe_serialize( $old_task ) ); // @phpstan-ignore offsetAccess.invalidOffset
+			$tasks[ $key ] = $old_task;
 		}
 
 		// Set the tasks option.
diff --git a/classes/utils/class-color-customizer.php b/classes/utils/class-color-customizer.php
@@ -125,12 +125,13 @@ private function save_colors() {
 
 		foreach ( $color_variables as $section => $variables ) {
 			foreach ( $variables as $variable => $default_value ) {
-				$key = "color_{$variable}";
+				$variable_string = (string) $variable; // @phpstan-ignore offsetAccess.invalidOffset
+				$key = "color_{$variable_string}";
 				if ( isset( $_POST[ $key ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
 					$post_value  = isset( $_POST[ $key ] ) ? \sanitize_text_field( \wp_unslash( $_POST[ $key ] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
 					$color_value = \sanitize_text_field( \wp_unslash( $post_value ) );
 					if ( ! empty( $color_value ) ) {
-						$colors[ $variable ] = $color_value;
+						$colors[ $variable_string ] = $color_value;
 					}
 				}
 			}

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,8 @@ public function get_checklist_results() {`
`98`	`98`	`$items = $this->get_checklist();`
`99`	`99`	`$results = [];`
`100`	`100`	`foreach ( $items as $item ) {`
`101`		`- $results[ $item['label'] ] = $item['callback']();`
	`101`	`+ $label = (string) $item['label']; // @phpstan-ignore offsetAccess.invalidOffset`
	`102`	`+ $results[ $label ] = $item['callback'](); // @phpstan-ignore offsetAccess.invalidOffset`
`102`	`103`	`}`
`103`	`104`	`return $results;`
`104`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -200,12 +200,14 @@ public function get_rest_formatted_data( $post_id = null ): array {`
`200`	`200`
`201`	`201`	`// Make sure WP_REST_Posts_Controller is loaded.`
`202`	`202`	`if ( ! \class_exists( 'WP_REST_Posts_Controller' ) ) {`
`203`		`- require_once ABSPATH . 'wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php'; // @phpstan-ignore requireOnce.fileNotFound`
	`203`	`+ // @phpstan-ignore-next-line requireOnce.fileNotFound`
	`204`	`+ require_once ABSPATH . 'wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php';`
`204`	`205`	`}`
`205`	`206`
`206`	`207`	`// Make sure WP_REST_Request is loaded.`
`207`	`208`	`if ( ! \class_exists( 'WP_REST_Request' ) ) {`
`208`		`- require_once ABSPATH . 'wp-includes/rest-api/class-wp-rest-request.php'; // @phpstan-ignore requireOnce.fileNotFound`
	`209`	`+ // @phpstan-ignore-next-line requireOnce.fileNotFound`
	`210`	`+ require_once ABSPATH . 'wp-includes/rest-api/class-wp-rest-request.php';`
`209`	`211`	`}`
`210`	`212`
`211`	`213`	`// Use the appropriate controller for the post type.`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,8 @@ public function update_inactive_plugins_cache() {`
`47`	`47`	`*/`
`48`	`48`	`protected function calculate_data() {`
`49`	`49`	`if ( ! \function_exists( 'get_plugins' ) ) {`
`50`		`- require_once ABSPATH . 'wp-admin/includes/plugin.php'; // @phpstan-ignore requireOnce.fileNotFound`
	`50`	`+ // @phpstan-ignore-next-line requireOnce.fileNotFound`
	`51`	`+ require_once ABSPATH . 'wp-admin/includes/plugin.php';`
`51`	`52`	`}`
`52`	`53`
`53`	`54`	`// Clear the plugins cache, so get_plugins() returns the latest plugins.`
Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,8 @@ public function add_core_update_link( $update_actions ) {`
`107`	`107`	`public function should_add_task() {`
`108`	`108`	`// Without this \wp_get_update_data() might not return correct data for the core updates (depending on the timing).`
`109`	`109`	`if ( ! \function_exists( 'get_core_updates' ) ) {`
`110`		`- require_once ABSPATH . 'wp-admin/includes/update.php'; // @phpstan-ignore requireOnce.fileNotFound`
	`110`	`+ // @phpstan-ignore-next-line requireOnce.fileNotFound`
	`111`	`+ require_once ABSPATH . 'wp-admin/includes/update.php';`
`111`	`112`	`}`
`112`	`113`
`113`	`114`	`// For wp_get_update_data() to return correct data it needs to be called after the 'admin_init' action (with priority 10).`
Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,8 @@ public function is_task_completed( $task_id = '' ) {`
`154`	`154`	`protected function is_plugin_active() {`
`155`	`155`	`if ( null === $this->is_plugin_active ) {`
`156`	`156`	`if ( ! \function_exists( 'get_plugins' ) ) {`
`157`		`- require_once ABSPATH . 'wp-admin/includes/plugin.php'; // @phpstan-ignore requireOnce.fileNotFound`
	`157`	`+ // @phpstan-ignore-next-line requireOnce.fileNotFound`
	`158`	`+ require_once ABSPATH . 'wp-admin/includes/plugin.php';`
`158`	`159`	`}`
`159`	`160`
`160`	`161`	`$plugins = \get_plugins();`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,8 @@ public function get_chart_data( $args = [] ) {`
`125`	`125`	`$previous_period_activities = $period_data['previous_period_activities'];`
`126`	`126`	`$period_data_filtered = [];`
`127`	`127`	`foreach ( $args['return_data'] as $key ) {`
`128`		`- $period_data_filtered[ $key ] = $period_data[ $key ];`
	`128`	`+ $key_string = (string) $key; // @phpstan-ignore offsetAccess.invalidOffset`
	`129`	`+ $period_data_filtered[ $key_string ] = $period_data[ $key_string ]; // @phpstan-ignore offsetAccess.invalidOffset`
`129`	`130`	`}`
`130`	`131`	`$data[] = $period_data_filtered;`
`131`	`132`	`}`