AdminPluginCacheService.php
126 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\WordPress\Admin\PluginCache; |
| 4 | |
| 5 | /** |
| 6 | * Admin plugin cache service. |
| 7 | */ |
| 8 | class AdminPluginCacheService { |
| 9 | /** |
| 10 | * Default documentation URL for cache plugins. |
| 11 | */ |
| 12 | private const DEFAULT_DOCS_URL = 'https://surecart.com/docs/caching/'; |
| 13 | |
| 14 | /** |
| 15 | * Plugin-specific documentation URLs. |
| 16 | */ |
| 17 | private const PLUGIN_DOCS_URLS = [ |
| 18 | // 'litespeed-cache/litespeed-cache.php' => 'https://surecart.com/docs/lsp-config/', // we added support for this in the plugin |
| 19 | ]; |
| 20 | |
| 21 | /** |
| 22 | * Bootstrap related hooks. |
| 23 | * |
| 24 | * @return void |
| 25 | */ |
| 26 | public function bootstrap() { |
| 27 | add_action( 'admin_notices', [ $this, 'showNotice' ] ); |
| 28 | } |
| 29 | |
| 30 | /** |
| 31 | * Get list of cache plugins. |
| 32 | * |
| 33 | * @return array |
| 34 | */ |
| 35 | public function getCachePlugins(): array { |
| 36 | return apply_filters( |
| 37 | 'surecart_cache_plugins', |
| 38 | [ |
| 39 | // 'w3-total-cache/w3-total-cache.php', // we added support for this in the plugin |
| 40 | // 'litespeed-cache/litespeed-cache.php', // we added support for this in the plugin |
| 41 | // 'sg-cachepress/sg-cachepress.php', // we added support for this in the plugin |
| 42 | // 'wp-fastest-cache/wpFastestCache.php', // we added support for this in the plugin |
| 43 | 'wp-rocket/wp-rocket.php', |
| 44 | 'wp-super-cache/wp-cache.php', |
| 45 | 'autoptimize/autoptimize.php', |
| 46 | 'cache-enabler/cache-enabler.php', |
| 47 | 'swift-performance-lite/performance.php', |
| 48 | 'hummingbird-performance/wp-hummingbird.php', |
| 49 | 'wp-optimize/wp-optimize.php', |
| 50 | 'nitropack/main.php', |
| 51 | 'perfmatters/perfmatters.php', |
| 52 | 'wp-asset-clean-up/wpacu.php', |
| 53 | 'flying-pages/flying-pages.php', |
| 54 | 'fast-velocity-minify/fvm.php', |
| 55 | 'breeze/breeze.php', |
| 56 | 'wp-performance-score-booster/wp-performance-score-booster.php', |
| 57 | 'clearfy/clearfy.php', |
| 58 | 'psn-pagespeed-ninja/pagespeedninja.php', |
| 59 | ] |
| 60 | ); |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Get documentation URL for a specific cache plugin. |
| 65 | * |
| 66 | * @param string $plugin Plugin path/slug. |
| 67 | * @return string Documentation URL. |
| 68 | */ |
| 69 | public function getDocumentationUrl( string $plugin ): string { |
| 70 | $plugin_docs = apply_filters( 'surecart_cache_plugin_documentation_urls', self::PLUGIN_DOCS_URLS ); |
| 71 | |
| 72 | return $plugin_docs[ $plugin ] ?? self::DEFAULT_DOCS_URL; |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Show the plugin cache notice. |
| 77 | * |
| 78 | * @return void |
| 79 | */ |
| 80 | public function showNotice(): void { |
| 81 | $cache_plugins = $this->getCachePlugins(); |
| 82 | |
| 83 | // Loop through each cache plugin. |
| 84 | foreach ( $cache_plugins as $plugin ) { |
| 85 | // If the plugin is not active, skip it. |
| 86 | if ( ! is_plugin_active( $plugin ) ) { |
| 87 | continue; |
| 88 | } |
| 89 | |
| 90 | // Get the plugin data. |
| 91 | $plugin_data = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin ); |
| 92 | |
| 93 | // If the plugin data is not found, skip it. |
| 94 | if ( empty( $plugin_data['Name'] ) ) { |
| 95 | continue; |
| 96 | } |
| 97 | |
| 98 | // Get the documentation URL for this plugin. |
| 99 | $docs_url = $this->getDocumentationUrl( $plugin ); |
| 100 | |
| 101 | // Render the notice. |
| 102 | echo wp_kses_post( |
| 103 | \SureCart::notices()->render( |
| 104 | [ |
| 105 | 'name' => 'sc_plugin_cache_notice_' . sanitize_title( $plugin ), |
| 106 | 'type' => 'warning', |
| 107 | 'title' => sprintf( |
| 108 | /* translators: 1: plugin name, 2: plugin version */ |
| 109 | esc_html__( 'Action Required: Configure %s for SureCart', 'surecart' ), |
| 110 | $plugin_data['Name'] |
| 111 | ), |
| 112 | 'text' => sprintf( |
| 113 | /* translators: 1: plugin name, 2: plugin version */ |
| 114 | '<p>' . esc_html__( '%1$s (%2$s) detected. To ensure optimal performance with SureCart, configure the plugin properly.', 'surecart' ) . '</p>', |
| 115 | $plugin_data['Name'], |
| 116 | $plugin_data['Version'] |
| 117 | ) |
| 118 | . |
| 119 | '<p><a href="' . esc_url( $docs_url ) . '" target="_blank">' . esc_html__( 'Review Configuration Guide', 'surecart' ) . '</a></p>', |
| 120 | ] |
| 121 | ) |
| 122 | ); |
| 123 | } |
| 124 | } |
| 125 | } |
| 126 |