update WP CS to 3.0 (#6115)

Co-authored-by: Ahmed Saeed <[email protected]> Co-authored-by: engahmeds3ed <[email protected]> Co-authored-by: Vasilis Manthos <[email protected]>
wp-media · Sep 26, 2023 · 06381b8 · 06381b8
1 parent 539ecea
commit 06381b8
Show file tree

Hide file tree

Showing 113 changed files with 201 additions and 302 deletions.
diff --git a/.github/workflows/lint_phpcs.yml b/.github/workflows/lint_phpcs.yml
@@ -22,7 +22,7 @@ jobs:
     name: WPRocket lint with PHPCS. PHP ${{ matrix.php-versions }} on ${{ matrix.operating-system }}.
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
@@ -35,7 +35,5 @@ jobs:
       run: composer install --prefer-dist --no-interaction --no-scripts
 
     - name: Lint with phpcs
-      run: |
-        vendor/bin/phpcs --config-set installed_paths ../../phpcompatibility/phpcompatibility-paragonie,../../phpcompatibility/phpcompatibility-wp,../../wp-coding-standards/wpcs,../../phpcompatibility/php-compatibility
-        composer phpcs
+      run: composer phpcs
 
diff --git a/composer.json b/composer.json
@@ -60,7 +60,7 @@
 		"roave/security-advisories": "dev-master",
 		"szepeviktor/phpstan-wordpress": "^1.3",
 		"woocommerce/action-scheduler": "^3.4",
-		"wp-coding-standards/wpcs": "^2",
+		"wp-coding-standards/wpcs": "^3",
 		"wp-media/background-processing": "^1.3",
 		"wp-media/phpunit": "^3",
 		"wp-media/rocket-lazyload-common": "^3.0.11",

diff --git a/inc/3rd-party/hosting/flywheel.php b/inc/3rd-party/hosting/flywheel.php
@@ -69,7 +69,7 @@ function rocket_flywheel_remove_partial_purge_hooks() {
 
 	// Remove rocket_clean_post() from core action hooks.
 	array_map(
-		function( $hook ) {
+		function ( $hook ) {
 			remove_action( $hook, 'rocket_clean_post' );
 		},
 		$clean_post_hooks

diff --git a/inc/3rd-party/hosting/presslabs.php b/inc/3rd-party/hosting/presslabs.php
@@ -45,7 +45,7 @@ function rocket_pl_clean_post( $post = false, $permalink = false ) {
  *
  * @return void
  */
-function rocket_pl_clean_home( $root = false, $lang = false ) {
+function rocket_pl_clean_home( $root = false, $lang = false ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
 	if ( ! $post || ! $permalink ) {
 		return;
 	}
@@ -72,7 +72,7 @@ function rocket_pl_remove_partial_purge_hooks() {
 	];
 	// Remove rocket_clean_post() from core action hooks.
 	array_map(
-		function( $hook ) {
+		function ( $hook ) {
 			remove_action( $hook, 'rocket_clean_post' );
 		},
 		$clean_post_hooks

diff --git a/inc/3rd-party/plugins/cookies/weepie-cookie-allow.php b/inc/3rd-party/plugins/cookies/weepie-cookie-allow.php
@@ -23,7 +23,7 @@
  * @param array $old_value Previous values for the plugin options.
  * @param array $value New values for the plugin options.
  */
-function rocket_after_update_wp_cookie_allow_options( $old_value, $value ) {
+function rocket_after_update_wp_cookie_allow_options( $old_value, $value ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
 	// clear the cache because WeePie Cookie Allow plugin settings might have been changed.
 	rocket_clean_domain();
 }

diff --git a/inc/3rd-party/plugins/ecommerce/woocommerce-multilingual.php b/inc/3rd-party/plugins/ecommerce/woocommerce-multilingual.php
@@ -91,9 +91,9 @@ function rocket_wcml_reset_settings( $option, $old_data, $data ) {
 		'default_currencies',
 	];
 
-	$check_key = function( $result, $key ) use ( $old_data, $data ) {
-		$has_value_changed = function( $key ) use ( $old_data, $data ) {
-			$get_value = function( $key, $data ) {
+	$check_key = function ( $result, $key ) use ( $old_data, $data ) {
+		$has_value_changed = function ( $key ) use ( $old_data, $data ) {
+			$get_value = function ( $key, $data ) {
 				return isset( $data[ $key ] ) ? $data[ $key ] : null;
 			};
 

diff --git a/inc/3rd-party/plugins/envira-gallery.php b/inc/3rd-party/plugins/envira-gallery.php
@@ -29,5 +29,3 @@ function rocket_deactivate_lazyload_on_envira_gallery_indexable_images( $images
 	return $images;
 }
 add_filter( 'envira_gallery_indexable_images', 'rocket_deactivate_lazyload_on_envira_gallery_indexable_images', PHP_INT_MAX );
-
-
diff --git a/inc/Addon/Cloudflare/Auth/AuthFactoryInterface.php b/inc/Addon/Cloudflare/Auth/AuthFactoryInterface.php
@@ -12,5 +12,5 @@ interface AuthFactoryInterface {
 	 * @param array $data Data to inject into the  client.
 	 * @return AuthInterface
 	 */
-	public function create( array $data = []): AuthInterface;
+	public function create( array $data = [] ): AuthInterface;
 }
diff --git a/inc/Addon/Cloudflare/Cloudflare.php b/inc/Addon/Cloudflare/Cloudflare.php
@@ -160,7 +160,7 @@ public function purge_cloudflare() {
 	 *
 	 * @return mixed true if the purge is successful, WP_Error otherwise
 	 */
-	public function purge_by_url( $post, $purge_urls, $lang ) {
+	public function purge_by_url( $post, $purge_urls, $lang ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
 		$result = $this->endpoints->purge_files( $this->options->get( 'cloudflare_zone_id', '' ), $purge_urls );
 
 		if ( is_wp_error( $result ) ) {

diff --git a/inc/Addon/WebP/Subscriber.php b/inc/Addon/WebP/Subscriber.php
@@ -305,7 +305,7 @@ private function get_extensions() {
 		$extensions = apply_filters( 'rocket_file_extensions_for_webp', $extensions );
 		$extensions = array_filter(
 			(array) $extensions,
-			function( $extension ) {
+			function ( $extension ) {
 				return $extension && is_string( $extension );
 			}
 		);
@@ -334,7 +334,7 @@ private function get_attribute_names() {
 		$attributes = apply_filters( 'rocket_attributes_for_webp', $attributes );
 		$attributes = array_filter(
 			(array) $attributes,
-			function( $attributes ) {
+			function ( $attributes ) {
 				return $attributes && is_string( $attributes );
 			}
 		);
@@ -539,7 +539,7 @@ private function get_url_to_path_associations() {
 		$list = apply_filters( 'rocket_url_to_path_associations', $list );
 		$list = array_filter(
 			$list,
-			function( $path, $url ) {
+			function ( $path, $url ) {
 				return $path && $url && is_string( $path ) && is_string( $url );
 			},
 			ARRAY_FILTER_USE_BOTH
@@ -595,5 +595,4 @@ public function change_youtube_thumbnail( $extension ) {
 		}
 		return 'webp';
 	}
-
 }
diff --git a/inc/Engine/Admin/Beacon/Beacon.php b/inc/Engine/Admin/Beacon/Beacon.php
@@ -190,7 +190,7 @@ private function prefill_data() {
 	 *
 	 * @return array
 	 */
-	private function config_data() : array {
+	private function config_data(): array {
 		return [
 			'display' => [
 				'position' => is_rtl() ? 'left' : 'right',

diff --git a/inc/Engine/Admin/Database/OptimizationProcess.php b/inc/Engine/Admin/Database/OptimizationProcess.php
@@ -148,5 +148,4 @@ protected function complete() {
 
 		parent::complete();
 	}
-
 }
diff --git a/inc/Engine/Admin/Metaboxes/PostEditOptionsSubscriber.php b/inc/Engine/Admin/Metaboxes/PostEditOptionsSubscriber.php
@@ -159,10 +159,8 @@ public function save_metabox_options() {
 				if ( ! isset( $rejected_uris[ $path ] ) ) {
 					array_push( $new_cache_reject_uri, $path );
 				}
-			} else {
-				if ( isset( $rejected_uris[ $path ] ) ) {
-					unset( $new_cache_reject_uri[ $rejected_uris[ $path ] ] );
-				}
+			} elseif ( isset( $rejected_uris[ $path ] ) ) {
+				unset( $new_cache_reject_uri[ $rejected_uris[ $path ] ] );
 			}
 
 			if ( $new_cache_reject_uri !== $cache_reject_uri ) {

diff --git a/inc/Engine/Admin/Settings/Page.php b/inc/Engine/Admin/Settings/Page.php
@@ -2189,7 +2189,7 @@ private function hidden_fields() {
 	 * @param  string $tag_name Name of the HTML tag that will wrap each element of the list.
 	 * @return array
 	 */
-	private function sanitize_and_format_list( $list, $tag_name = 'strong' ) {
+	private function sanitize_and_format_list( $list, $tag_name = 'strong' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.listFound
 		if ( ! is_array( $list ) || empty( $list ) ) {
 			return [];
 		}

diff --git a/inc/Engine/Admin/Settings/Render.php b/inc/Engine/Admin/Settings/Render.php
@@ -84,7 +84,7 @@ public function render_navigation() {
 		];
 
 		$navigation = array_map(
-			function( array $item ) use ( $default ) {
+			function ( array $item ) use ( $default ) {
 				$item = wp_parse_args( $item, $default );
 
 				if ( ! empty( $item['class'] ) ) {

diff --git a/inc/Engine/Admin/Settings/Settings.php b/inc/Engine/Admin/Settings/Settings.php
@@ -436,7 +436,7 @@ public function sanitize_callback( $input ) {
 			$notices = array_merge( (array) $wp_settings_errors, (array) get_transient( 'settings_errors' ) );
 			$notices = array_filter(
 				$notices,
-				function( $error ) {
+				function ( $error ) {
 					if ( ! $error || ! is_array( $error ) ) {
 						return false;
 					}
@@ -472,7 +472,7 @@ function( $error ) {
 	 * @param string $key   Array key to check.
 	 * @return int
 	 */
-	public function sanitize_checkbox( $array, $key ) {
+	public function sanitize_checkbox( $array, $key ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound
 		return isset( $array[ $key ] ) && ! empty( $array[ $key ] ) ? 1 : 0;
 	}
 
@@ -520,7 +520,7 @@ private function sanitize_dns_prefetch( array $input ) {
 
 		return array_unique(
 			array_map(
-				function( $url ) {
+				function ( $url ) {
 					return '//' . wp_parse_url( $url, PHP_URL_HOST );
 				},
 				$urls
@@ -678,7 +678,7 @@ private function check_global_exclusion( $field ) {
 	 */
 	private function sanitize_cdn_cnames( array $cnames ) {
 		$cnames = array_map(
-			function( $cname ) {
+			function ( $cname ) {
 				$cname = trim( $cname );
 
 				if ( empty( $cname ) ) {

diff --git a/inc/Engine/Cache/AdminSubscriber.php b/inc/Engine/Cache/AdminSubscriber.php
@@ -50,7 +50,7 @@ class AdminSubscriber implements Event_Manager_Aware_Subscriber_Interface {
 	public function __construct( AdvancedCache $advanced_cache, WPCache $wp_cache, $filesystem = null ) {
 		$this->advanced_cache = $advanced_cache;
 		$this->wp_cache       = $wp_cache;
-		$this->filesystem     = $filesystem ?: rocket_direct_filesystem();
+		$this->filesystem     = ! empty( $filesystem ) ? $filesystem : rocket_direct_filesystem();
 	}
 
 	/**
@@ -77,7 +77,6 @@ public static function get_subscribed_events() {
 				[ 'delete_old_configs' ],
 				[ 'clear_cache', 10, 2 ],
 			],
-			'wp_rocket_upgrade'     => [ 'on_update', 10, 2 ],
 		];
 	}
 

diff --git a/inc/Engine/Cache/PurgeExpired/PurgeExpiredCache.php b/inc/Engine/Cache/PurgeExpired/PurgeExpiredCache.php
@@ -401,5 +401,4 @@ public function update_lifespan_value( $old_lifespan, $old_lifespan_unit ) {
 
 		update_option( 'wp_rocket_settings', $options );
 	}
-
 }
diff --git a/inc/Engine/Common/Context/ContextInterface.php b/inc/Engine/Common/Context/ContextInterface.php
@@ -10,5 +10,5 @@ interface ContextInterface {
 	 * @param array $data Data to pass to the context.
 	 * @return bool
 	 */
-	public function is_allowed( array $data = []): bool;
+	public function is_allowed( array $data = [] ): bool;
 }
diff --git a/inc/Engine/Common/ExtractCSS/Subscriber.php b/inc/Engine/Common/ExtractCSS/Subscriber.php
@@ -7,7 +7,8 @@
 use WP_Rocket\Logger\LoggerAwareInterface;
 
 class Subscriber implements Subscriber_Interface, LoggerAwareInterface {
-	use RegexTrait, LoggerAware;
+	use RegexTrait;
+	use LoggerAware;
 
 	/**
 	 * Returns an array of events that this subscriber wants to listen to.

diff --git a/inc/Engine/Common/Queue/Cleaner.php b/inc/Engine/Common/Queue/Cleaner.php
@@ -99,5 +99,4 @@ public function delete_old_actions() {
 			}
 		}
 	}
-
 }
diff --git a/inc/Engine/Common/Queue/QueueInterface.php b/inc/Engine/Common/Queue/QueueInterface.php
@@ -115,5 +115,4 @@ public function get_next( $hook, $args = null );
 	 * @return array
 	 */
 	public function search( $args = [], $return_format = OBJECT );
-
 }
diff --git a/inc/Engine/Common/Queue/RUCSSQueueRunner.php b/inc/Engine/Common/Queue/RUCSSQueueRunner.php
@@ -204,7 +204,7 @@ protected function do_batch( $size = 100, $context = '' ) {
 					break;
 				}
 				$this->process_action( $action_id, $context );
-				$processed_actions++;
+				++$processed_actions;
 
 				if ( $this->batch_limits_exceeded( $processed_actions ) ) {
 					break;
@@ -276,5 +276,4 @@ public function add_wp_cron_schedule( $schedules ) {
 	public function get_allowed_concurrent_batches() {
 		return 2;
 	}
-
 }
diff --git a/inc/Engine/CriticalPath/APIClient.php b/inc/Engine/CriticalPath/APIClient.php
@@ -230,7 +230,7 @@ private function get_response_data( $response ) {
 	 *
 	 * @return string response code.
 	 */
-	private function get_response_code( $response ) {
+	private function get_response_code( $response ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found
 		// Todo: we can return code based on the response status number, for example 404 not_found.
 		return 'cpcss_generation_failed';
 	}

diff --git a/inc/Engine/CriticalPath/Admin/Admin.php b/inc/Engine/CriticalPath/Admin/Admin.php
@@ -104,7 +104,7 @@ private function process_cpcss_pending_queue( array $cpcss_pending ) {
 		);
 
 		// Increment this item's threshold count.
-		$cpcss_pending[ $cpcss_item['path'] ]['check']++;
+		++$cpcss_pending[ $cpcss_item['path'] ]['check'];
 
 		$this->cpcss_heartbeat_notices( $cpcss_generation, $cpcss_item );
 

diff --git a/inc/Engine/CriticalPath/CriticalCSS.php b/inc/Engine/CriticalPath/CriticalCSS.php
@@ -281,15 +281,15 @@ private function update_process_running_transient() {
 
 		foreach ( $this->items as $item ) {
 			if ( ! isset( $item['mobile'] ) ) {
-				$total ++;
+				++$total;
 				continue;
 			}
 
 			if ( 1 === $item['mobile'] ) {
 				continue;
 			}
 
-			$total ++;
+			++$total;
 		}
 
 		$transient = [

diff --git a/inc/Engine/CriticalPath/CriticalCSSSubscriber.php b/inc/Engine/CriticalPath/CriticalCSSSubscriber.php
@@ -16,6 +16,7 @@
  */
 class CriticalCSSSubscriber implements Subscriber_Interface {
 	use RegexTrait;
+
 	/**
 	 * Instance of Critical CSS.
 	 *
@@ -371,7 +372,7 @@ public function critical_css_generation_running_notice() {
 				if ( $status_nonmobile && $status_mobile ) {
 					$items_message .= '<li>' . $item['status']['nonmobile']['message'] . '</li>';
 					if ( $item['status']['nonmobile']['success'] ) {
-						$success_counter ++;
+						++$success_counter;
 					}
 				}
 			}
@@ -450,7 +451,7 @@ public function critical_css_generation_complete_notice() {
 				}
 				$items_message .= '<li>' . $item['status']['nonmobile']['message'] . '</li>';
 				if ( $item['status']['nonmobile']['success'] ) {
-					$success_counter ++;
+					++$success_counter;
 				}
 			}
 
@@ -845,7 +846,6 @@ public function switch_to_rucss_notice() {
 				'dismiss_button_message' => __( 'Stay with the old option', 'rocket' ),
 			]
 		);
-
 	}
 
 	/**

diff --git a/inc/Engine/CriticalPath/ProcessorService.php b/inc/Engine/CriticalPath/ProcessorService.php
@@ -335,5 +335,4 @@ private function process_timeout( $item_url, $is_mobile = false, $item_type = 'c
 			]
 		);
 	}
-
 }
diff --git a/inc/Engine/CriticalPath/RESTCSSSubscriber.php b/inc/Engine/CriticalPath/RESTCSSSubscriber.php
@@ -51,5 +51,4 @@ public function register_routes() {
 		$this->rest_manager->register_generate_route();
 		$this->rest_manager->register_delete_route();
 	}
-
 }
diff --git a/inc/Engine/CriticalPath/RESTWP.php b/inc/Engine/CriticalPath/RESTWP.php
@@ -176,7 +176,6 @@ public function generate( WP_REST_Request $request ) {
 		return rest_ensure_response(
 			$this->return_success( $generated )
 		);
-
 	}
 
 	/**
@@ -318,5 +317,4 @@ protected function return_success( $data ) {
 			200
 		);
 	}
-
 }
diff --git a/inc/Engine/CriticalPath/RESTWPInterface.php b/inc/Engine/CriticalPath/RESTWPInterface.php
@@ -54,5 +54,4 @@ public function generate( WP_REST_Request $request );
 	 * @return WP_REST_Response
 	 */
 	public function delete( WP_REST_Request $request );
-
 }