Merge pull request #951 from Codeinwp/dev/phpstan

selul · web-flow · commit 387be28e7795 · 2025-09-24T12:01:16.000+03:00
dev: update PHPStan
diff --git a/.distignore b/.distignore
@@ -38,9 +38,10 @@ assets/src
 postcss.config.js
 tailwind.config.js
 phpstan.neon
+phpstan-baseline.neon
 development.php
 playwright.config.ts
 test-results
 wp-scripts.config.js
 README.md
-CHANGELOG.md
+CHANGELOG.md
diff --git a/.github/workflows/test-php.yml b/.github/workflows/test-php.yml
@@ -56,14 +56,22 @@ jobs:
     name: PHPStan on PHP 8.0
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
       - name: Setup PHP version
         uses: shivammathur/setup-php@v2
         with:
           php-version: '8.0'
           extensions: simplexml, mysql
-      - name: Checkout source code
-        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - name: Create the build file
+        run: |
+          npm ci
+          npm run build
       - name: Install Composer dependencies
         run: composer install --prefer-dist --no-progress --no-suggest
       - name: PHPStan Static Analysis
-        run: composer phpstan
+        run: composer phpstan
diff --git a/composer.json b/composer.json
@@ -43,14 +43,15 @@
     "wp-coding-standards/wpcs": "^3.1.0",
     "dealerdirect/phpcodesniffer-composer-installer": "^1.1.2",
     "yoast/phpunit-polyfills": "^4.0",
-    "phpstan/phpstan": "^1.10",
-    "szepeviktor/phpstan-wordpress": "^1.3",
-    "php-stubs/wp-cli-stubs": "^2.8"
+    "phpstan/phpstan": "^2.1",
+    "php-stubs/wp-cli-stubs": "^2.8",
+    "szepeviktor/phpstan-wordpress": "^2.0"
   },
   "scripts": {
     "format": "phpcbf --standard=phpcs.xml --report-summary --report-source",
     "phpcs": "phpcs --standard=phpcs.xml --extensions=php -s -d memory_limit=-1",
     "phpstan": "phpstan analyse --memory-limit=-1",
+    "phpstan:generate:baseline": "phpstan analyse --memory-limit=-1 --generate-baseline",
     "phpunit": "phpunit --configuration=phpunit.xml",
     "install-wp-tests": "bash bin/install-wp-tests.sh wordpress_tests root root 127.0.0.1 latest true"
   },
diff --git a/composer.lock b/composer.lock
diff --git a/inc/admin.php b/inc/admin.php
@@ -576,15 +576,11 @@ public function inline_bootstrap_script() {
 	/**
 	 * Add settings links in the plugin listing page.
 	 *
-	 * @param array $links Old plugin links.
+	 * @param string[] $links Old plugin links.
 	 *
-	 * @return array Altered links.
+	 * @return string[] Altered links.
 	 */
 	public function add_action_links( $links ) {
-		if ( ! is_array( $links ) ) {
-			return $links;
-		}
-
 		return array_merge(
 			$links,
 			[
@@ -599,7 +595,7 @@ public function add_action_links( $links ) {
 	 * @return bool Should show?
 	 */
 	public function should_show_notice() {
-		if ( ( defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
+		if ( wp_doing_ajax() ) {
 			return false;
 		}
 
@@ -676,7 +672,7 @@ public function add_notice_upgrade() {
 	 */
 	public function should_show_upgrade() {
 		$current_screen = get_current_screen();
-		if ( ( defined( 'DOING_AJAX' ) && DOING_AJAX ) ||
+		if ( wp_doing_ajax() ||
 			is_network_admin() ||
 			! current_user_can( 'manage_options' ) ||
 			! $this->settings->is_connected() ||
@@ -1003,7 +999,7 @@ public function maybe_redirect() {
 			return;
 		}
 
-		if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
+		if ( wp_doing_ajax() ) {
 			return;
 		}
 
diff --git a/inc/api.php b/inc/api.php
@@ -160,9 +160,7 @@ public function request( $path, $method = 'GET', $params = [], $extra_headers =
 		if ( ! empty( $this->api_key ) ) {
 			$headers['Authorization'] = 'Bearer ' . $this->api_key;
 		}
-		if ( is_array( $headers ) ) {
-			$headers = array_merge( $headers, $extra_headers );
-		}
+		$headers = array_merge( $headers, $extra_headers );
 		$url  = trailingslashit( $this->api_root ) . ltrim( $path, '/' );
 		// If there is a extra, add that as a url var.
 		if ( 'GET' === $method && ! empty( $params ) ) {
diff --git a/inc/app_replacer.php b/inc/app_replacer.php
@@ -490,7 +490,7 @@ public static function listen_to_sizes( $value, $orig_w, $orig_h, $dest_w, $dest
 	/**
 	 * Extract domains and use them as keys for fast processing.
 	 *
-	 * @param array $urls Input urls.
+	 * @param array|null $urls Input urls.
 	 *
 	 * @return array Array of domains as keys.
 	 */
@@ -529,7 +529,7 @@ function ( $value ) {
 	/**
 	 * Check if we can replace the url.
 	 *
-	 * @param string $url Url to change.
+	 * @param string|mixed $url Url to change.
 	 *
 	 * @return bool Either we can replace this url or not.
 	 */
@@ -668,7 +668,7 @@ protected function get_optimized_image_url( $url, $width, $height, $resize = []
 			->width( $width )
 			->height( $height );
 
-		if ( is_array( $resize ) && ! empty( $resize['type'] ) ) {
+		if ( ! empty( $resize['type'] ) ) {
 			$optimized_image->resize( $resize['type'], $resize['gravity'] ?? Position::CENTER, $resize['enlarge'] ?? false );
 
 		}
diff --git a/inc/compatibilities/pinterest.php b/inc/compatibilities/pinterest.php
@@ -31,7 +31,7 @@ public function should_load() {
 			$selectors_array[] = '.heateorSssSharing.heateorSssPinterestBackground';
 			$load = true;
 		}
-		$this->selectors = implode( ', ', array_filter( $selectors_array ) );
+		$this->selectors = implode( ', ', $selectors_array );
 		return $load;
 	}
 
diff --git a/inc/conflicts/conflicting_plugins.php b/inc/conflicts/conflicting_plugins.php
@@ -158,7 +158,7 @@ public function dismiss_conflicting_plugins() {
 	 * @return bool Should show?
 	 */
 	public function should_show_notice() {
-		if ( ( defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
+		if ( wp_doing_ajax() ) {
 			return false;
 		}
 
diff --git a/inc/manager.php b/inc/manager.php
@@ -435,7 +435,7 @@ public function replace_content( $html, $partial = false ) {
 					$hmac = wp_hash( $profile_id . $time, 'nonce' );
 					$js_optimizer = str_replace(
 						[ Profile::PLACEHOLDER, Profile::PLACEHOLDER_MISSING, Profile::PLACEHOLDER_TIME, Profile::PLACEHOLDER_HMAC ],
-						[ $profile_id, implode( ',', $missing ), $time, $hmac ],
+						[ $profile_id, implode( ',', $missing ), strval( $time ), $hmac ],
 						$js_optimizer
 					);
 					$html = str_replace( Optml_Admin::get_optimizer_script( true ), $js_optimizer, $html );
diff --git a/inc/media_offload.php b/inc/media_offload.php
@@ -376,15 +376,16 @@ public static function get_image_size_from_width( $sizes, $width, $filename, $ju
 	/**
 	 * Replace image URLs in the srcset attributes.
 	 *
-	 * @param array  $sources Array of image sources.
-	 * @param array  $size_array Array of width and height values in pixels (in that order).
-	 * @param string $image_src The 'src' of the image.
-	 * @param array  $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'.
-	 * @param int    $attachment_id Image attachment ID.
+	 * @param mixed|array<int, array{url: string, descriptor: string, value: int}> $sources Array of image sources.
+	 * @param array{0: int, 1: int}                                                $size_array Array of width and height values in pixels (in that order).
+	 * @param string                                                               $image_src The 'src' of the image.
+	 * @param array<string, mixed>                                                 $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'.
+	 * @param int                                                                  $attachment_id Image attachment ID or 0.
 	 *
-	 * @return array
+	 * @return array<int, array{url: string, descriptor: string, value: int}>|mixed
 	 */
 	public function calculate_image_srcset( $sources, $size_array, $image_src, $image_meta, $attachment_id ) {
+
 		if ( ! is_array( $sources ) ) {
 			return $sources;
 		}
diff --git a/inc/media_rename/attachment_db_renamer.php b/inc/media_rename/attachment_db_renamer.php
@@ -551,7 +551,7 @@ private function replace_in_data( $data, $old_url, $new_url ) {
 	/**
 	 * Check if a string is serialized
 	 *
-	 * @param string $data String to check.
+	 * @param string|mixed $data String to check.
 	 *
 	 * @return bool True if serialized
 	 */
diff --git a/inc/rest.php b/inc/rest.php
@@ -631,7 +631,6 @@ private function fetch_sample_image() {
 	/**
 	 * Disconnect from optimole service.
 	 *
-	 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 	 * @param WP_REST_Request $request disconnect rest request.
 	 */
 	public function disconnect( WP_REST_Request $request ) {
@@ -784,7 +783,7 @@ public function check_redirects( WP_REST_Request $request ) {
 
 			if ( $processed_images > 0 ) {
 				$response = wp_remote_get( $value['src'][ rand( 0, $processed_images - 1 ) ], $args );
-				if ( ! is_wp_error( $response ) && is_array( $response ) ) {
+				if ( ! is_wp_error( $response ) ) {
 					$headers     = $response['headers']; // array of http header lines
 					$status_code = $response['response']['code'];
 					if ( $status_code === 301 ) {
diff --git a/inc/tag_replacer.php b/inc/tag_replacer.php
diff --git a/inc/url_replacer.php b/inc/url_replacer.php
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
diff --git a/phpstan.neon b/phpstan.neon
diff --git a/tests/static-analysis-stubs/optimole-wp.php b/tests/static-analysis-stubs/optimole-wp.php

Original file line number	Diff line number	Diff line change
`@@ -490,7 +490,7 @@ public static function listen_to_sizes( $value, $orig_w, $orig_h, $dest_w, $dest`
`490`	`490`	`/**`
`491`	`491`	`* Extract domains and use them as keys for fast processing.`
`492`	`492`	`*`
`493`		`- * @param array $urls Input urls.`
	`493`	`+ * @param array\|null $urls Input urls.`
`494`	`494`	`*`
`495`	`495`	`* @return array Array of domains as keys.`
`496`	`496`	`*/`
`@@ -529,7 +529,7 @@ function ( $value ) {`
`529`	`529`	`/**`
`530`	`530`	`* Check if we can replace the url.`
`531`	`531`	`*`
`532`		`- * @param string $url Url to change.`
	`532`	`+ * @param string\|mixed $url Url to change.`
`533`	`533`	`*`
`534`	`534`	`* @return bool Either we can replace this url or not.`
`535`	`535`	`*/`
`@@ -668,7 +668,7 @@ protected function get_optimized_image_url( $url, $width, $height, $resize = []`
`668`	`668`	`->width( $width )`
`669`	`669`	`->height( $height );`
`670`	`670`
`671`		`- if ( is_array( $resize ) && ! empty( $resize['type'] ) ) {`
	`671`	`+ if ( ! empty( $resize['type'] ) ) {`
`672`	`672`	`$optimized_image->resize( $resize['type'], $resize['gravity'] ?? Position::CENTER, $resize['enlarge'] ?? false );`
`673`	`673`
`674`	`674`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function should_load() {`
`31`	`31`	`$selectors_array[] = '.heateorSssSharing.heateorSssPinterestBackground';`
`32`	`32`	`$load = true;`
`33`	`33`	`}`
`34`		`- $this->selectors = implode( ', ', array_filter( $selectors_array ) );`
	`34`	`+ $this->selectors = implode( ', ', $selectors_array );`
`35`	`35`	`return $load;`
`36`	`36`	`}`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -158,7 +158,7 @@ public function dismiss_conflicting_plugins() {`
`158`	`158`	`* @return bool Should show?`
`159`	`159`	`*/`
`160`	`160`	`public function should_show_notice() {`
`161`		`- if ( ( defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {`
	`161`	`+ if ( wp_doing_ajax() ) {`
`162`	`162`	`return false;`
`163`	`163`	`}`
`164`	`164`