| 1 |
<?php |
| 2 |
/** |
| 3 |
* Minify module. |
| 4 |
* |
| 5 |
* Owns the minify_html / minify_css / minify_js settings. Engine work |
| 6 |
* still happens in XSpeed\Minifier (filters style_loader_src and |
| 7 |
* script_loader_src), but the Module is now the storage and editing |
| 8 |
* authority. Settings live in xspeed_module_minify; the legacy |
| 9 |
* xspeed_options blob is drained on first boot and on POST. |
| 10 |
* |
| 11 |
* Tier: Free. See SETTINGS.md for the contract this module satisfies. |
| 12 |
* |
| 13 |
* @package XSpeed |
| 14 |
*/ |
| 15 |
|
| 16 |
declare(strict_types=1); |
| 17 |
|
| 18 |
namespace XSpeed\Modules\Minify; |
| 19 |
|
| 20 |
defined( 'ABSPATH' ) || exit; |
| 21 |
|
| 22 |
use XSpeed\Minifier as LegacyMinifier; |
| 23 |
use XSpeed\Minify_Filters; |
| 24 |
use XSpeed\Module; |
| 25 |
use XSpeed\Settings_Manager; |
| 26 |
|
| 27 |
final class MinifyModule extends Module { |
| 28 |
|
| 29 |
public const SLUG = 'minify'; |
| 30 |
public const TIER = self::TIER_FREE; |
| 31 |
public const VERSION = '1.2.0'; |
| 32 |
|
| 33 |
public function ui_metadata(): array { |
| 34 |
return array( |
| 35 |
'label' => __( 'CSS & JavaScript', 'xspeed' ), |
| 36 |
'tab_label' => __( 'Minify', 'xspeed' ), // its own tab on the CSS & JavaScript page |
| 37 |
'icon' => 'Wand2', |
| 38 |
'description' => __( 'Strip whitespace and rewrite enqueued CSS / JS.', 'xspeed' ), |
| 39 |
// Host page: Minify (this module) / Critical CSS (Pro) / Unused |
| 40 |
// CSS (Pro) as tabs — the three CSS/JS optimizations live on one |
| 41 |
// page instead of three sidebar rows (FBS-83633). |
| 42 |
'custom_panel' => 'CssJsPanel', |
| 43 |
); |
| 44 |
} |
| 45 |
|
| 46 |
public function settings_schema(): array { |
| 47 |
return array( |
| 48 |
'minify_html' => array( |
| 49 |
'type' => 'bool', |
| 50 |
'default' => false, |
| 51 |
'label' => __( 'Minify HTML', 'xspeed' ), |
| 52 |
// Names the logged-out caveat up front: minification runs on the |
| 53 |
// request that WRITES a cache entry, and should_cache() refuses |
| 54 |
// logged-in requests — so "view source while logged in" shows |
| 55 |
// un-minified HTML and reads as the feature being broken. (#2) |
| 56 |
'description' => __( 'Strip whitespace and comments from HTML output, including inline <style> and <script> blocks. Safe on most themes. Applies to cached (logged-out) responses — view the page in a private window to see the result.', 'xspeed' ), |
| 57 |
), |
| 58 |
'minify_css' => array( |
| 59 |
'type' => 'bool', |
| 60 |
'default' => false, |
| 61 |
'label' => __( 'Minify CSS', 'xspeed' ), |
| 62 |
'description' => __( 'Compress and rewrite enqueued local stylesheets. External CSS is left untouched.', 'xspeed' ), |
| 63 |
), |
| 64 |
'minify_js' => array( |
| 65 |
'type' => 'bool', |
| 66 |
'default' => false, |
| 67 |
'label' => __( 'Minify JavaScript', 'xspeed' ), |
| 68 |
'description' => __( 'Compress enqueued local scripts. Disable if you hit script-loading conflicts on the frontend.', 'xspeed' ), |
| 69 |
), |
| 70 |
'defer_js' => array( |
| 71 |
'type' => 'bool', |
| 72 |
'default' => false, |
| 73 |
'label' => __( 'Defer JavaScript', 'xspeed' ), |
| 74 |
'description' => __( 'Add defer="defer" to enqueued script tags so they execute after HTML parsing. jQuery + its hard dependencies are skipped automatically.', 'xspeed' ), |
| 75 |
), |
| 76 |
'delay_js' => array( |
| 77 |
'type' => 'bool', |
| 78 |
'default' => false, |
| 79 |
'label' => __( 'Delay JavaScript Until Interaction', 'xspeed' ), |
| 80 |
'description' => __( 'Postpone script loading until the visitor scrolls, moves the mouse, taps, or presses a key. Drastically improves first paint on script-heavy pages; can break above-the-fold scripted UI — test before leaving on. Cookie-consent banners (CookieYes, Complianz, Cookiebot, NotificationX, Cookie Notice, Borlabs, Real Cookie Banner and others) are not delayed, so the visitor is still asked before anything else runs. To delay one on purpose, name it in Delay Only These Scripts.', 'xspeed' ), |
| 81 |
), |
| 82 |
'async_css' => array( |
| 83 |
'type' => 'bool', |
| 84 |
'default' => false, |
| 85 |
'label' => __( 'Load CSS Asynchronously', 'xspeed' ), |
| 86 |
'description' => __( 'Rewrite stylesheet link tags to load non-blocking via the print-then-all pattern. Pairs well with critical-CSS workflows; can cause a flash of unstyled content if the theme has no critical CSS.', 'xspeed' ), |
| 87 |
), |
| 88 |
'remove_query_strings' => array( |
| 89 |
'type' => 'bool', |
| 90 |
'default' => false, |
| 91 |
'label' => __( 'Remove Asset Query Strings', 'xspeed' ), |
| 92 |
'description' => __( 'Strip ?ver=X.Y from enqueued CSS / JS URLs. Some CDN caches and proxies cache better when query strings are absent. Files under wp-content/uploads keep their version — page builders and consent plugins rewrite generated CSS there in place, and ?ver is what tells browsers to refetch it. Plugin, theme and core assets are still stripped: with Browser Cache on, an update reaches returning visitors only when their browser cache expires.', 'xspeed' ), |
| 93 |
), |
| 94 |
'defer_js_excluded' => array( |
| 95 |
'type' => 'list', |
| 96 |
'default' => array( 'jquery-core', 'jquery-migrate' ), |
| 97 |
'item_type' => 'string', |
| 98 |
'label' => __( 'Defer / Delay Exclusions', 'xspeed' ), |
| 99 |
'description' => __( 'Script handles OR URL substrings that skip defer + delay. Defaults exclude jQuery (most themes depend on it being available synchronously). Cookie-consent banners are skipped without being listed here. An entry here also wins over the same script in Delay Only These Scripts. One per line.', 'xspeed' ), |
| 100 |
// Only relevant once defer OR delay is on — the exclusion list |
| 101 |
// governs both. Uses the `any` (OR) dependency form. (FBS-82227) |
| 102 |
'dependsOn' => array( |
| 103 |
'any' => array( |
| 104 |
array( 'field' => 'defer_js' ), |
| 105 |
array( 'field' => 'delay_js' ), |
| 106 |
), |
| 107 |
), |
| 108 |
), |
| 109 |
'delay_js_targets' => array( |
| 110 |
'type' => 'list', |
| 111 |
'default' => array(), |
| 112 |
'item_type' => 'string', |
| 113 |
'label' => __( 'Delay Only These Scripts', 'xspeed' ), |
| 114 |
'description' => __( 'Script handles OR URL substrings. When non-empty, matching scripts are delayed, plus the known third-party tags xSpeed recognises on its own (analytics, tag managers, chat widgets, review embeds, error trackers) — so a heavy vendor script is postponed even when it is not listed here. Leave empty to delay all scripts (minus the exclusions above). Handles are the more reliable selector — a URL substring has to match the script\'s original URL, and minification rewrites that to a hashed cache path. Cookie-consent banners are only delayed when an entry names one, for example notificationx or cookiebot. A broad entry such as /plugins/ does not delay them. One per line.', 'xspeed' ), |
| 115 |
'info_title' => __( 'Consent banners and Delay JS', 'xspeed' ), |
| 116 |
'info' => sprintf( |
| 117 |
/* translators: %s: comma-separated list of consent plugins, each followed by the word to type in parentheses. */ |
| 118 |
__( 'These consent banners load straight away, even with Delay JS on: %s. To delay one on purpose, add the word in parentheses, or the script handle, to this list. An entry that only matches part of the address, such as /plugins/ or .js, never delays a banner, and an entry in Defer / Delay Exclusions always wins.', 'xspeed' ), |
| 119 |
implode( ', ', Minify_Filters::consent_manager_labels() ) |
| 120 |
), |
| 121 |
'dependsOn' => array( 'field' => 'delay_js' ), |
| 122 |
), |
| 123 |
'delay_js_smart' => array( |
| 124 |
'type' => 'bool', |
| 125 |
'default' => false, |
| 126 |
'label' => __( 'Smart Delay (Carry Inline Snippets)', 'xspeed' ), |
| 127 |
'description' => __( 'Normally a script is left running at load when inline code on the page depends on it — on builder pages that keeps most scripts eager even with Delay JavaScript on. Smart Delay postpones those scripts anyway and parks their inline snippets with them; everything replays in page order on the first interaction. The most aggressive setting on this page: test menus, sliders, and toggles before leaving it on. Exclusions above still win, and consent banners still run first.', 'xspeed' ), |
| 128 |
'dependsOn' => array( 'field' => 'delay_js' ), |
| 129 |
), |
| 130 |
'delay_js_timeout' => array( |
| 131 |
'type' => 'int', |
| 132 |
'default' => 8000, |
| 133 |
'min' => 0, |
| 134 |
'max' => 60000, |
| 135 |
'label' => __( 'Delay Failsafe Timeout (ms)', 'xspeed' ), |
| 136 |
'unit' => 'ms', |
| 137 |
'description' => __( 'Load delayed scripts automatically after this many milliseconds when the visitor never interacts. Set to 0 for interaction-only, with no timer: a timer that fires inside a lab tool\'s measurement window loads the "delayed" scripts anyway and inflates the reported TTI. Keep a non-zero value if a delayed script must eventually run for visitors who never scroll, tap, or type.', 'xspeed' ), |
| 138 |
'dependsOn' => array( 'field' => 'delay_js' ), |
| 139 |
), |
| 140 |
'combine_css' => array( |
| 141 |
'type' => 'bool', |
| 142 |
'default' => false, |
| 143 |
'label' => __( 'Combine CSS Files', 'xspeed' ), |
| 144 |
'description' => __( 'Concatenate enqueued local stylesheets into a single file (with @import and url(…) paths resolved). External CSS is left alone. Pairs poorly with HTTP/2 push — only enable on HTTP/1.1 hosts.', 'xspeed' ), |
| 145 |
), |
| 146 |
'combine_js' => array( |
| 147 |
'type' => 'bool', |
| 148 |
'default' => false, |
| 149 |
'label' => __( 'Combine JavaScript Files', 'xspeed' ), |
| 150 |
'description' => __( 'Concatenate enqueued local scripts into a single file. External scripts + scripts marked async / deferred are left alone. Disable if you hit dependency-order issues; the combiner respects WordPress enqueue order but inline scripts attached via wp_add_inline_script can shift behavior.', 'xspeed' ), |
| 151 |
), |
| 152 |
); |
| 153 |
} |
| 154 |
|
| 155 |
/** |
| 156 |
* 1.1.0: drain minify_html / minify_css / minify_js from the legacy |
| 157 |
* `xspeed_options` blob into this module's per-module option, then |
| 158 |
* delete the keys from the legacy blob so duplicate sources can't |
| 159 |
* re-appear. Idempotent — re-running is a no-op once the keys are |
| 160 |
* gone from xspeed_options. |
| 161 |
*/ |
| 162 |
public function migrations(): array { |
| 163 |
return array( |
| 164 |
'1.1.0' => static function ( array $opts ): array { |
| 165 |
$legacy = get_option( 'xspeed_options', array() ); |
| 166 |
if ( ! is_array( $legacy ) ) { |
| 167 |
return $opts; |
| 168 |
} |
| 169 |
$dirty = false; |
| 170 |
foreach ( array( 'minify_html', 'minify_css', 'minify_js' ) as $key ) { |
| 171 |
if ( array_key_exists( $key, $legacy ) ) { |
| 172 |
$opts[ $key ] = (bool) $legacy[ $key ]; |
| 173 |
unset( $legacy[ $key ] ); |
| 174 |
$dirty = true; |
| 175 |
} |
| 176 |
} |
| 177 |
if ( $dirty ) { |
| 178 |
update_option( 'xspeed_options', $legacy ); |
| 179 |
} |
| 180 |
return $opts; |
| 181 |
}, |
| 182 |
); |
| 183 |
} |
| 184 |
|
| 185 |
/** |
| 186 |
* Conflict declarations. Detected automatically by Conflict_Registry, |
| 187 |
* but listing them here keeps the module self-documenting. |
| 188 |
*/ |
| 189 |
public function conflicts(): array { |
| 190 |
return array( |
| 191 |
array( |
| 192 |
'plugin' => 'autoptimize/autoptimize.php', |
| 193 |
'feature' => 'minify.html', |
| 194 |
'strategy' => \XSpeed\Conflict_Registry::STRATEGY_REFUSE, |
| 195 |
'reason' => 'Autoptimize is active and handles minification.', |
| 196 |
), |
| 197 |
array( |
| 198 |
'plugin' => 'wp-rocket/wp-rocket.php', |
| 199 |
'feature' => 'minify.html', |
| 200 |
'strategy' => \XSpeed\Conflict_Registry::STRATEGY_REFUSE, |
| 201 |
'reason' => 'WP Rocket already handles minification.', |
| 202 |
), |
| 203 |
); |
| 204 |
} |
| 205 |
|
| 206 |
public function cli_commands(): array { |
| 207 |
return array( |
| 208 |
array( |
| 209 |
'name' => 'xspeed minify', |
| 210 |
'callback' => array( $this, 'cli_handler' ), |
| 211 |
'shortdesc' => 'Inspect or purge xSpeed minify cache.', |
| 212 |
'ai_hint' => 'Which CSS/JS optimizations are active (minify, combine, defer, delay, async)? Use for questions about render-blocking resources, unminified assets in PageSpeed, or when JavaScript broke after enabling optimizations.', |
| 213 |
'synopsis' => array( |
| 214 |
array( |
| 215 |
'type' => 'positional', |
| 216 |
'name' => 'action', |
| 217 |
'options' => array( 'status', 'purge' ), |
| 218 |
'optional' => false, |
| 219 |
), |
| 220 |
), |
| 221 |
), |
| 222 |
); |
| 223 |
} |
| 224 |
|
| 225 |
/** |
| 226 |
* On boot: |
| 227 |
* 1. Seed our per-module option from the legacy blob if neither |
| 228 |
* our option nor the migration has run yet (covers the |
| 229 |
* already-installed-before-this-module-shipped path). |
| 230 |
* 2. Instantiate the v1 Minifier engine; it now reads from |
| 231 |
* Settings_Manager::get('minify') via its updated read path. |
| 232 |
*/ |
| 233 |
public function boot(): void { |
| 234 |
/* |
| 235 |
* Deferred to `init`: both calls below read this module's settings, |
| 236 |
* which builds settings_schema(), whose labels go through __(). |
| 237 |
* boot() runs on `plugins_loaded`, before `after_setup_theme` — the |
| 238 |
* earliest point WordPress 6.7+ considers safe to translate — so doing |
| 239 |
* it here fires _load_textdomain_just_in_time on every request and |
| 240 |
* resolves those labels against an unloaded domain. |
| 241 |
* |
| 242 |
* Every filter LegacyMinifier registers fires after `init`, so running |
| 243 |
* one hook later is equivalent. |
| 244 |
*/ |
| 245 |
add_action( 'init', array( $this, 'boot_on_init' ) ); |
| 246 |
} |
| 247 |
|
| 248 |
/** |
| 249 |
* The real boot body — see boot() for why it runs on `init`. |
| 250 |
*/ |
| 251 |
public function boot_on_init(): void { |
| 252 |
$this->seed_from_legacy_if_needed(); |
| 253 |
new LegacyMinifier(); |
| 254 |
} |
| 255 |
|
| 256 |
public function activate(): void { |
| 257 |
// Plugin activation hits all modules. Same seed logic — safe to |
| 258 |
// run more than once. |
| 259 |
$this->seed_from_legacy_if_needed(); |
| 260 |
} |
| 261 |
|
| 262 |
/** |
| 263 |
* Say so when HTML minification is switched on but suppressed. |
| 264 |
* |
| 265 |
* `Minifier::skip_reason()` was consulted only by `wp xspeed minify status` |
| 266 |
* — the dashboard read "on" while `minify_html()` returned its input |
| 267 |
* untouched, so the feature looked broken rather than paused. A field |
| 268 |
* report showed a live site with `minify_html: on` and 3,856 indented lines |
| 269 |
* delivered, and nothing anywhere explaining the contradiction. (#2) |
| 270 |
* |
| 271 |
* @return array<int,array<string,mixed>> |
| 272 |
*/ |
| 273 |
public function ui_notices(): array { |
| 274 |
$opts = $this->get_settings(); |
| 275 |
if ( empty( $opts['minify_html'] ) ) { |
| 276 |
return array(); |
| 277 |
} |
| 278 |
|
| 279 |
$reason = LegacyMinifier::skip_reason(); |
| 280 |
if ( '' === $reason ) { |
| 281 |
return array(); |
| 282 |
} |
| 283 |
|
| 284 |
// Two different causes, two different fixes — naming the wrong one |
| 285 |
// sends the user hunting in the wrong file. |
| 286 |
$body = 'wp_debug' === $reason |
| 287 |
? __( 'HTML minification is paused because WP_DEBUG is enabled in wp-config.php. Readable HTML is usually what you want while debugging, so xSpeed leaves the markup alone. Cached pages are served un-minified until WP_DEBUG is turned off.', 'xspeed' ) |
| 288 |
: __( 'HTML minification is paused because a plugin or theme is returning true from the xspeed_skip_minify filter. Cached pages are served un-minified until that filter stops suppressing it.', 'xspeed' ); |
| 289 |
|
| 290 |
return array( |
| 291 |
array( |
| 292 |
'tone' => 'info', |
| 293 |
'title' => __( 'HTML minification is on but currently paused', 'xspeed' ), |
| 294 |
'body' => $body, |
| 295 |
), |
| 296 |
); |
| 297 |
} |
| 298 |
|
| 299 |
private function seed_from_legacy_if_needed(): void { |
| 300 |
$existing = get_option( 'xspeed_module_minify', null ); |
| 301 |
if ( null !== $existing ) { |
| 302 |
return; |
| 303 |
} |
| 304 |
$legacy = get_option( 'xspeed_options', array() ); |
| 305 |
if ( ! is_array( $legacy ) ) { |
| 306 |
return; |
| 307 |
} |
| 308 |
$seed = array( '_version' => self::VERSION ); |
| 309 |
$dirty = false; |
| 310 |
foreach ( array( 'minify_html', 'minify_css', 'minify_js' ) as $key ) { |
| 311 |
if ( array_key_exists( $key, $legacy ) ) { |
| 312 |
$seed[ $key ] = (bool) $legacy[ $key ]; |
| 313 |
unset( $legacy[ $key ] ); |
| 314 |
$dirty = true; |
| 315 |
} |
| 316 |
} |
| 317 |
if ( $dirty ) { |
| 318 |
update_option( 'xspeed_module_minify', $seed ); |
| 319 |
update_option( 'xspeed_options', $legacy ); |
| 320 |
} |
| 321 |
} |
| 322 |
|
| 323 |
public function cli_handler( array $args, array $assoc ): void { |
| 324 |
$action = $args[0] ?? 'status'; |
| 325 |
|
| 326 |
if ( 'status' === $action ) { |
| 327 |
$opts = Settings_Manager::get( self::SLUG ); |
| 328 |
// A bare "on" is a lie when the skip guard is active: the |
| 329 |
// setting is stored, but Minifier::minify_html() returns its |
| 330 |
// input untouched and the delivered HTML is unchanged. Say so |
| 331 |
// on the same line, so the contradiction can never be read as |
| 332 |
// "minify is broken". |
| 333 |
$skip = \XSpeed\Minifier::skip_reason(); |
| 334 |
$html_state = $opts['minify_html'] ? 'on' : 'off'; |
| 335 |
if ( $opts['minify_html'] && '' !== $skip ) { |
| 336 |
$html_state .= ( 'wp_debug' === $skip ) |
| 337 |
? ' (NOT APPLIED — WP_DEBUG is enabled; set WP_DEBUG to false to minify HTML)' |
| 338 |
: ' (NOT APPLIED — suppressed by the xspeed_skip_minify filter)'; |
| 339 |
} |
| 340 |
\WP_CLI::log( sprintf( 'minify_html: %s', $html_state ) ); |
| 341 |
\WP_CLI::log( sprintf( 'minify_css : %s', $opts['minify_css'] ? 'on' : 'off' ) ); |
| 342 |
\WP_CLI::log( sprintf( 'minify_js : %s', $opts['minify_js'] ? 'on' : 'off' ) ); |
| 343 |
return; |
| 344 |
} |
| 345 |
|
| 346 |
if ( 'purge' === $action ) { |
| 347 |
LegacyMinifier::purge_minified(); |
| 348 |
\WP_CLI::success( 'Minify cache purged.' ); |
| 349 |
return; |
| 350 |
} |
| 351 |
|
| 352 |
\WP_CLI::error( "Unknown action: $action" ); |
| 353 |
} |
| 354 |
|
| 355 |
/** |
| 356 |
* Minify has no master switch -- it is on when any of minify_html / |
| 357 |
* minify_css / minify_js / defer_js / delay_js / async_css / |
| 358 |
* remove_query_strings is set. (#363) |
| 359 |
*/ |
| 360 |
public function is_active(): ?bool { |
| 361 |
return $this->any_bool_flag_on(); |
| 362 |
} |
| 363 |
} |
| 364 |
|
