PluginProbe
OpenStation: Desktop Windows, Dock & Virtual Desktops for WP Admin / 0.9.1
OpenStation: Desktop Windows, Dock & Virtual Desktops for WP Admin v0.9.1
1.1.10 1.1.9 1.1.8 1.1.7 1.1.6 1.1.5 1.1.4 1.1.3 1.1.2 1.1.1 1.1.0 1.0.1 1.0.0 0.9.8 0.9.7 0.9.6 0.9.4 0.9.5 0.9.3 0.9.2 0.9.1 0.9.0 0.8.9 0.8.8 0.8.7 All 34 releases
desktop-mode / includes / render / assets.php

assets.php in OpenStation: Desktop Windows, Dock & Virtual Desktops for WP Admin 0.9.1, at includes/render/assets.php

917 lines 41.9 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * Desktop Mode — Asset enqueue.
4 *
5 * Loads the desktop shell CSS + JS bundles when desktop mode is
6 * active and the request isn't chromeless / classic-overridden.
7 * Owns the entire `desktop_mode_enqueue_assets()` body — the
8 * largest hook in the original render.php and the natural seam
9 * for "what does the shell ship to the browser today?".
10 *
11 * Extracted from `render.php` during the architecture-0.8.1 PHP
12 * slicing (phase 6).
13 *
14 * @package Desktop_Mode
15 * @since 0.8.1
16 */
17
18 defined( 'ABSPATH' ) || exit;
19
20 /**
21 * Enqueues the desktop mode shell assets (CSS + JS) when desktop mode is active.
22 *
23 * Only loads the full desktop shell scripts and styles when the user has
24 * desktop mode enabled and the request is not a chromeless iframe load.
25 *
26 * @since 0.1.0
27 */
28 function desktop_mode_enqueue_assets() {
29 if ( ! is_admin() ) {
30 return;
31 }
32
33 // Auto-enqueue the iframe bridge anywhere a desktop-mode user
34 // might land. The bundle self-bails when not inside an iframe
35 // (`window.parent === window`), so it's a no-op on the parent
36 // shell — but cheap insurance against the failure mode the
37 // developer hit: an internal admin navigation drops the
38 // `?desktop_mode_chromeless=1` flag, the chromeless inline bridge doesn't
39 // run, and `wp.desktop.iframe` silently disappears. With this
40 // auto-enqueue, the API is universally present for any same-
41 // origin admin page a desktop-mode user opens — chromeless or
42 // accidentally classic.
43 if ( desktop_mode_is_enabled() ) {
44 wp_enqueue_script( 'desktop-mode-iframe-bridge' );
45
46 // Block Editor cross-window drop receiver. Listens for
47 // `desktop-mode-drop` postMessages from the parent shell and
48 // inserts the matching block. Only enqueue inside the
49 // post-edit Block Editor screens — every other admin page
50 // would be paying for a bundle it never uses.
51 //
52 // `site-editor.php` (full-site editor) deliberately omitted:
53 // the FSE doesn't expose `wp.data.dispatch('core/block-editor')`
54 // until the user opens a template in the canvas iframe, so
55 // drops arriving before that point would silently time out
56 // after the receiver's 5 s `waitForEditor()` poll. Re-enable
57 // once we have a reliable readiness signal in that context.
58 global $hook_suffix;
59 if ( 'post.php' === $hook_suffix || 'post-new.php' === $hook_suffix ) {
60 wp_enqueue_script( 'desktop-mode-gutenberg-drop-receiver' );
61 }
62 }
63
64 // Chromeless requests (iframes) need chromeless styles and overrides.
65 if ( desktop_mode_is_chromeless_request() ) {
66 wp_enqueue_style( 'desktop-mode' );
67 wp_enqueue_style( 'desktop-mode-chromeless' );
68
69 /**
70 * Fires when chromeless styles are enqueued inside a desktop mode iframe.
71 *
72 * Plugin and theme authors can hook here to enqueue their own CSS
73 * overrides for legacy pages rendered in chromeless mode. Use the
74 * `.desktop-mode-chromeless` body class to scope your rules.
75 *
76 * @since 0.1.0
77 */
78 do_action( 'desktop_mode_chromeless_styles' );
79 return;
80 }
81
82 if ( ! desktop_mode_is_enabled() || desktop_mode_is_classic_request() ) {
83 return;
84 }
85
86 // CSS.
87 wp_enqueue_style( 'desktop-mode' );
88 wp_enqueue_style( 'desktop-mode-windows' );
89 wp_enqueue_style( 'desktop-mode-dock' );
90 wp_enqueue_style( 'desktop-mode-dock-peek' );
91 wp_enqueue_style( 'desktop-mode-ai-assistant' );
92 wp_enqueue_style( 'desktop-mode-bug-report' );
93 wp_enqueue_style( 'desktop-mode-files' );
94
95 // JS.
96 wp_enqueue_script( 'desktop-mode' );
97
98 // `wp_enqueue_command_palette_assets()` (WP 6.9+) enqueues the
99 // `wp-commands` store package, the `wp-core-commands` script that
100 // registers the WordPress-wide baseline (Add new post, Manage
101 // plugins, Switch theme, Browse patterns, …) AND — critically —
102 // the inline `wp.coreCommands.initializeCommandPalette( … )` call
103 // that actually populates the `core/commands` data store with the
104 // admin-menu commands. Without that inline init, the script loads
105 // but the store stays empty and `src/commands/shell-harvester.ts`
106 // finds nothing to publish.
107 //
108 // WP normally only calls this on screens that opt in to the native
109 // palette; the shell needs it on every admin URL it might wrap.
110 // `function_exists` guard for pre-6.9 sites — the harvester gracefully
111 // no-ops when the store is missing.
112 if ( function_exists( 'wp_enqueue_command_palette_assets' ) ) {
113 // `wp_enqueue_command_palette_assets()` calls
114 // `array_key_exists( $menu_slug, $submenu )` without guarding
115 // the global, so an unset `$submenu` (test contexts, edge-case
116 // admin requests where the menu wasn't built yet) blows up
117 // with a TypeError. Initialize defensively before calling.
118 global $menu, $submenu;
119 if ( ! isset( $submenu ) || ! is_array( $submenu ) ) {
120 $submenu = array();
121 }
122 if ( ! isset( $menu ) || ! is_array( $menu ) ) {
123 $menu = array();
124 }
125 wp_enqueue_command_palette_assets();
126
127 // Expose the same menu-commands array WP serializes into
128 // `wp.coreCommands.initializeCommandPalette(...)` on a window
129 // slot the shell harvester can read. Built in PHP from `$menu`
130 // / `$submenu` here (we already guarded that they're arrays
131 // above), then injected as a `before` inline on our own bundle
132 // — that runs synchronously before `desktop.min.js` boots the
133 // shell harvester, so the lookup is guaranteed populated by
134 // the time `src/commands/shell-harvester.ts` classifies any
135 // command. Decoupled from WP's command-palette mount timing
136 // (which fires from a core-registered hook we can't reorder).
137 $menu_map = desktop_mode_build_command_menu_map();
138 wp_add_inline_script(
139 'desktop-mode',
140 'window.__desktopModeMenuCommands = ' . wp_json_encode( $menu_map ) . ';',
141 'before'
142 );
143 }
144
145 // Pass configuration to JavaScript.
146 global $title, $pagenow, $parent_file, $menu;
147
148 $menu_icon = 'dashicons-admin-generic';
149 if ( ! empty( $parent_file ) && ! empty( $menu ) ) {
150 foreach ( $menu as $item ) {
151 if ( ! empty( $item[2] ) && $item[2] === $parent_file && ! empty( $item[6] ) ) {
152 $menu_icon = $item[6];
153 break;
154 }
155 }
156 }
157
158 // Build dock items from the admin menu. Core pages are ordered
159 // first (Dashboard, Posts, Plugins, Users, Settings, …), then
160 // plugin-contributed top-level routes. `desktop_mode_dock_placement`
161 // is the per-item filter escape hatch for hiding. Shared with the
162 // REST menu endpoint so live refreshes (post plugin-activation)
163 // produce the same ordering as the boot payload.
164 $menu_payload = desktop_mode_build_menu_payload();
165 $dock_items = $menu_payload['dockItems'];
166 $native_windows = isset( $menu_payload['nativeWindows'] )
167 ? $menu_payload['nativeWindows']
168 : array();
169 $server_widgets = isset( $menu_payload['serverWidgets'] )
170 ? $menu_payload['serverWidgets']
171 : array();
172 $server_wallpapers = isset( $menu_payload['serverWallpapers'] )
173 ? $menu_payload['serverWallpapers']
174 : array();
175 $server_command_scripts = isset( $menu_payload['serverCommandScripts'] )
176 ? $menu_payload['serverCommandScripts']
177 : array();
178 $server_commands = isset( $menu_payload['serverCommands'] )
179 ? $menu_payload['serverCommands']
180 : array();
181 $server_settings_tab_scripts = isset( $menu_payload['serverSettingsTabScripts'] )
182 ? $menu_payload['serverSettingsTabScripts']
183 : array();
184 $server_settings_tabs = isset( $menu_payload['serverSettingsTabs'] )
185 ? $menu_payload['serverSettingsTabs']
186 : array();
187 $server_dock_rail_renderer_scripts = isset( $menu_payload['serverDockRailRendererScripts'] )
188 ? $menu_payload['serverDockRailRendererScripts']
189 : array();
190 $server_titlebar_button_scripts = isset( $menu_payload['serverTitleBarButtonScripts'] )
191 ? $menu_payload['serverTitleBarButtonScripts']
192 : array();
193 $server_window_theme_scripts = isset( $menu_payload['serverWindowThemeScripts'] )
194 ? $menu_payload['serverWindowThemeScripts']
195 : array();
196 $server_window_themes = isset( $menu_payload['serverWindowThemes'] )
197 ? $menu_payload['serverWindowThemes']
198 : array();
199 $server_window_control_scripts = isset( $menu_payload['serverWindowControlScripts'] )
200 ? $menu_payload['serverWindowControlScripts']
201 : array();
202 $server_window_controls = isset( $menu_payload['serverWindowControls'] )
203 ? $menu_payload['serverWindowControls']
204 : array();
205 $server_window_slot_scripts = isset( $menu_payload['serverWindowSlotScripts'] )
206 ? $menu_payload['serverWindowSlotScripts']
207 : array();
208 $server_window_slots = isset( $menu_payload['serverWindowSlots'] )
209 ? $menu_payload['serverWindowSlots']
210 : array();
211 $server_window_chrome_scripts = isset( $menu_payload['serverWindowChromeScripts'] )
212 ? $menu_payload['serverWindowChromeScripts']
213 : array();
214 $server_window_chromes = isset( $menu_payload['serverWindowChromes'] )
215 ? $menu_payload['serverWindowChromes']
216 : array();
217 $server_window_notices = isset( $menu_payload['serverWindowNotices'] )
218 ? $menu_payload['serverWindowNotices']
219 : array();
220 $desktop_icons = isset( $menu_payload['desktopIcons'] )
221 ? $menu_payload['desktopIcons']
222 : array();
223
224 // Files-on-the-Desktop payload (Phase 0+1). Plugin-registered
225 // file types and openers ship as metadata only; the JS side
226 // holds the executable handlers and resolves on double-click.
227 $server_file_types = function_exists( 'desktop_mode_build_file_types_payload' )
228 ? desktop_mode_build_file_types_payload()
229 : array();
230 $server_file_openers = function_exists( 'desktop_mode_build_file_openers_payload' )
231 ? desktop_mode_build_file_openers_payload()
232 : array();
233 $user_file_associations = function_exists( 'desktop_mode_get_user_file_associations' )
234 ? desktop_mode_get_user_file_associations( get_current_user_id() )
235 : array();
236 $server_wallpaper_menu_items = function_exists( 'desktop_mode_build_wallpaper_menu_items' )
237 ? desktop_mode_build_wallpaper_menu_items()
238 : array();
239
240 /*
241 * OS-file drop config — what the browser drop manager will
242 * accept when the user drags a file from their native desktop
243 * onto any surface inside Desktop Mode (wallpaper, a folder,
244 * a window, or a chromeless iframe). The allowed-mimes list is
245 * the user-scoped `get_allowed_mime_types()` (already capability
246 * gated by WordPress); the size cap is `wp_max_upload_size()`.
247 *
248 * Both are filterable so plugins can narrow or widen the set —
249 * e.g. a media-only plugin can restrict drops to images, or a
250 * docs plugin can opt PDFs in for a specific role.
251 */
252 $drop_allowed_mimes_map = current_user_can( 'upload_files' )
253 ? get_allowed_mime_types( get_current_user_id() )
254 : array();
255 /**
256 * Filter the allowed-mime map used by the OS-file drop manager.
257 *
258 * @since 0.30.0
259 *
260 * @param array<string,string> $mimes_map `ext => mime-type` map (same shape `get_allowed_mime_types()` returns).
261 * @param int $user_id The current user id.
262 */
263 $drop_allowed_mimes_map = apply_filters( 'desktop_mode_drop_allowed_mimes', $drop_allowed_mimes_map, get_current_user_id() );
264 $drop_allowed_mimes_map = is_array( $drop_allowed_mimes_map ) ? $drop_allowed_mimes_map : array();
265 $drop_allowed_mimes = array_values( array_unique( array_values( $drop_allowed_mimes_map ) ) );
266
267 $drop_max_size = (int) wp_max_upload_size();
268 /**
269 * Filter the per-file size cap (in bytes) used by the OS-file
270 * drop manager. Returning `0` disables the client-side cap —
271 * the server still enforces its own.
272 *
273 * @since 0.30.0
274 *
275 * @param int $max_size Default `wp_max_upload_size()`.
276 * @param int $user_id The current user id.
277 */
278 $drop_max_size = (int) apply_filters( 'desktop_mode_drop_max_size', $drop_max_size, get_current_user_id() );
279
280 /**
281 * Filter the master OS-file drop enable gate. Lets plugins
282 * disable the drop manager by role / capability beyond the
283 * default `upload_files` check (e.g. only for admins, or
284 * only on specific multisite blogs).
285 *
286 * @since 0.30.0
287 *
288 * @param bool $enabled Default — `current_user_can( 'upload_files' )`.
289 * @param int $user_id The current user id.
290 */
291 $drop_enabled = (bool) apply_filters(
292 'desktop_mode_drop_enabled',
293 current_user_can( 'upload_files' ),
294 get_current_user_id()
295 );
296
297 $drop_config = array(
298 'enabled' => $drop_enabled,
299 'allowedMimes' => $drop_allowed_mimes,
300 'extToMime' => $drop_allowed_mimes_map,
301 'maxSize' => $drop_max_size,
302 );
303
304 // Lazy-bundle URL builder. Each lazy-loaded bundle (AI Assistant,
305 // About-scene, OS Settings panel, shell-overlays, window-system)
306 // is `<script>`-injected by the main bundle on demand — they don't
307 // go through `wp_register_script`, so they don't pick up WordPress's
308 // usual `?ver=<filemtime>` cache-buster. Without one, the browser
309 // happily serves a stale cached copy across plugin updates that
310 // don't bump `DESKTOP_MODE_VERSION`, and the main bundle's loader
311 // fires a `<script>`-loaded event for a file that's missing the
312 // fresh `window.desktopMode*` factory the new code expects.
313 //
314 // Mirror the `$built_version( … )` helper in `includes/assets.php`:
315 // prefer the on-disk mtime of the actual file, fall back to the
316 // plugin version when the file is missing (dev environments where
317 // the bundle hasn't been built yet).
318 $suffix = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
319 $lazy_bundle_url = static function ( $base ) use ( $suffix ) {
320 $path = DESKTOP_MODE_DIR . 'assets/js/' . $base . $suffix . '.js';
321 $ver = file_exists( $path )
322 ? (string) filemtime( $path )
323 : DESKTOP_MODE_VERSION;
324 return esc_url_raw(
325 DESKTOP_MODE_URL . 'assets/js/' . $base . $suffix . '.js?ver=' . $ver
326 );
327 };
328
329 // Build the current page URL from $pagenow + $_GET. Strip the portal
330 // markers so the derived window ID matches what the dock would produce
331 // for the same page — otherwise auto-opening the entry window and
332 // clicking the same dock icon would create a duplicate.
333 $current_query = $_GET; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
334 unset( $current_query[ DESKTOP_MODE_PORTAL_FLAG ], $current_query[ DESKTOP_MODE_PORTAL_INTENT_FLAG ] );
335 $current_page = admin_url( $pagenow ) . ( ! empty( $current_query ) ? '?' . http_build_query( $current_query ) : '' );
336
337 $from_portal = ! empty( $_GET[ DESKTOP_MODE_PORTAL_FLAG ] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
338 $from_portal_intent = ! empty( $_GET[ DESKTOP_MODE_PORTAL_INTENT_FLAG ] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
339
340 /**
341 * Filters the desktop shell configuration passed to JavaScript.
342 *
343 * @since 0.1.0
344 *
345 * @param array $config {
346 * Desktop shell configuration.
347 *
348 * @type string $currentPage The current admin page URL.
349 * @type string $currentTitle The current page title.
350 * @type string $currentIcon Dashicon class for the current page.
351 * @type string $adminUrl The base admin URL.
352 * @type string $colorScheme The active admin color scheme.
353 * @type array $dockItems Dock items derived from the admin menu. Core WordPress pages (Dashboard, Posts, Plugins, Users, Settings, CPTs…) are ordered first; plugin-contributed top-level routes (admin.php?page=*) follow. Items hidden via `desktop_mode_dock_placement` are omitted.
354 * @type array $nativeWindows Server-declared native windows (via `desktop_mode_register_window`). Shell registers + syncs tiles based on this list — activation/deactivation is a diff without shell reload.
355 * @type array $serverWidgets Server-declared right-column widgets (via `desktop_mode_register_widget`). Shell syncs the widget registry + dynamically loads plugin scripts so widgets appear in the picker without a shell reload.
356 * @type array $serverWallpapers Server-declared wallpapers (via `desktop_mode_register_wallpaper`). Same lifecycle — shell loads the plugin's JS, reads the full `WallpaperDef` from `window.desktopModeWallpapers[id]`, and registers / unregisters as plugins activate / deactivate.
357 * @type array $serverCommandScripts Script handles opted-in via `desktop_mode_register_command_script`. Shell injects each URL on activation so commands registered by `wp.desktop.registerCommand` appear in the palette live. Deactivation unregisters any commands whose `owner` matches the departing handle.
358 * @type array $serverCommands Server-declared command metadata (via `desktop_mode_register_command`). Advisory today — reserved for future pre-registration shims.
359 * @type array $serverSettingsTabScripts Script handles opted-in via `desktop_mode_register_settings_tab_script`. Shell injects each URL on activation so tabs registered by `wp.desktop.registerSettingsTab` appear in the OS Settings window live. Deactivation unregisters tabs attributable to the departing handle.
360 * @type array $serverSettingsTabs Server-declared settings-tab metadata (via `desktop_mode_register_settings_tab`). Enables live unregistration on plugin deactivation without requiring JS to set `owner`.
361 * @type array $desktopIcons Server-declared desktop icons (via `desktop_mode_register_icon`). Rendered on the wallpaper as clickable shortcut tiles.
362 * @type array $accentColors Swatch list for the OS Settings accent picker. Filterable via `desktop_mode_accent_colors`.
363 * @type array $toastTypes Toast-notification type map. Filterable via `desktop_mode_toast_types`.
364 * @type string $defaultWallpaper Wallpaper slug applied on first boot. Filterable via `desktop_mode_default_wallpaper`.
365 * @type array $session Saved session (windows, focused, updated).
366 * @type string $sessionUrl REST endpoint for saving the session.
367 * @type string $mediaUrl REST endpoint for media uploads (wp/v2/media).
368 * @type string $restUrl REST API root from rest_url(), safe for pretty and plain permalink installs.
369 * @type string $defaultWindowUrl REST endpoint for saving the default-window preference.
370 * @type array $defaultWindow { enabled: bool, url: string } — current default-window preference.
371 * @type bool $canUpload Whether the user holds the `upload_files` capability.
372 * @type string $pluginUrl Plugin base URL (no trailing slash). Used by the shell to locate vendor assets and by plugins to build asset URLs.
373 * @type string $pluginVersion Plugin semver string. Surfaced in the OS Settings → About tab; plugins can read it to gate features by version.
374 * @type string $restNonce Nonce for the session REST endpoint.
375 * @type string $portalUrl Canonical `/desktop-mode/` URL.
376 * @type bool $fromPortal Whether the shell was reached via the portal.
377 * @type bool $fromPortalIntent Whether the portal redirect resolved from an explicit `?target=…` (user navigation intent) rather than the session's focused window or the default-window fallback. Distinguishes a bare `/desktop-mode/` visit from a portal-redirected admin-bar click so the shell can honour the URL the user actually asked for.
378 * @type array $seenIntros Slugs of one-time intro dialogs the user has dismissed (e.g. `['posts']`). Native windows gate their first-open intro on this list.
379 * @type string $seenIntrosUrl REST endpoint for the seen-intros surface — POST `/seen` to mark, DELETE the base to reset.
380 * @type array $stickyNotes { available: bool } — whether the Gutenberg Guidelines experiment (the `wp_guideline` CPT + `wp_guideline_type` taxonomy) is registered. The shell skips booting the sticky-notes layer when false, avoiding the REST probes that 404 without the experiment. See `desktop_mode_sticky_notes_is_available()`.
381 * }
382 */
383 $config = apply_filters(
384 'desktop_mode_shell_config',
385 array(
386 'currentPage' => esc_url( $current_page ),
387 'currentTitle' => wp_strip_all_tags( $title ),
388 'currentIcon' => sanitize_html_class( $menu_icon ),
389 'adminUrl' => esc_url( admin_url() ),
390 'colorScheme' => sanitize_html_class( get_user_option( 'admin_color' ), 'fresh' ),
391 'dockItems' => $dock_items,
392 'nativeWindows' => $native_windows,
393 'serverWidgets' => $server_widgets,
394 'serverWallpapers' => $server_wallpapers,
395 'serverCommandScripts' => $server_command_scripts,
396 'serverCommands' => $server_commands,
397 'serverSettingsTabScripts' => $server_settings_tab_scripts,
398 'serverSettingsTabs' => $server_settings_tabs,
399 'serverDockRailRendererScripts' => $server_dock_rail_renderer_scripts,
400 'serverTitleBarButtonScripts' => $server_titlebar_button_scripts,
401 'serverWindowThemeScripts' => $server_window_theme_scripts,
402 'serverWindowThemes' => $server_window_themes,
403 'serverWindowControlScripts' => $server_window_control_scripts,
404 'serverWindowControls' => $server_window_controls,
405 'serverWindowSlotScripts' => $server_window_slot_scripts,
406 'serverWindowSlots' => $server_window_slots,
407 'serverWindowChromeScripts' => $server_window_chrome_scripts,
408 'serverWindowChromes' => $server_window_chromes,
409 'serverWindowNotices' => $server_window_notices,
410 'desktopIcons' => $desktop_icons,
411 'serverFileTypes' => $server_file_types,
412 'serverFileOpeners' => $server_file_openers,
413 'userFileAssociations' => $user_file_associations,
414 'filesUrl' => esc_url_raw( rest_url( 'desktop-mode/v1/files' ) ),
415 'serverWallpaperMenuItems' => $server_wallpaper_menu_items,
416 'accentColors' => desktop_mode_get_accent_colors(),
417 'toastTypes' => desktop_mode_get_toast_types(),
418 'defaultWallpaper' => desktop_mode_get_default_wallpaper(),
419 'session' => desktop_mode_get_session( get_current_user_id() ),
420 'sessionUrl' => esc_url_raw( rest_url( 'desktop-mode/v1/session' ) ),
421 'restUrl' => esc_url_raw( rest_url() ),
422 'mediaUrl' => esc_url_raw( rest_url( 'wp/v2/media' ) ),
423 'dropConfig' => $drop_config,
424 'defaultWindowUrl' => esc_url_raw( rest_url( 'desktop-mode/v1/default-window' ) ),
425 'defaultWindow' => desktop_mode_get_default_window( get_current_user_id() ),
426 'canUpload' => current_user_can( 'upload_files' ),
427 'pluginUrl' => esc_url_raw( untrailingslashit( DESKTOP_MODE_URL ) ),
428 'pluginVersion' => DESKTOP_MODE_VERSION,
429 'iframeBridgeUrl' => $lazy_bundle_url( 'iframe-bridge' ),
430 // URL of the AI Assistant lazy bundle. The main bundle
431 // ships a stub matching the public `wp.desktop.ai` API; the
432 // stub `<script>`-injects this URL the first time the user
433 // opens the assistant. Picking `.js` vs `.min.js` here keeps
434 // the SCRIPT_DEBUG gate server-side, matching iframeBridgeUrl.
435 'aiAssistantBundleUrl' => $lazy_bundle_url( 'ai-assistant' ),
436 // URL of the About-scene lazy bundle. The OS Settings →
437 // About tab loads this on first mount; ~25 kB PixiJS
438 // particle scene that would otherwise ship in the main
439 // bundle for every shell load.
440 'aboutSceneBundleUrl' => $lazy_bundle_url( 'about-scene' ),
441 // URL of the OS Settings panel lazy bundle. Injected by
442 // the main bundle's `OsSettings.renderPanel()` stub on
443 // the user's first Settings open. Holds every section
444 // renderer + the `<wpd-*>` components only the panel
445 // uses, so nothing about Settings ships in
446 // `desktop.min.js` for users who never open it.
447 'osSettingsPanelBundleUrl' => $lazy_bundle_url( 'os-settings-panel' ),
448 // URL of the shell-overlays lazy bundle. Pre-loaded by
449 // the main bundle after first paint so action-triggered
450 // overlays (toast, confirm dialog, context menus) feel
451 // instant the first time they fire.
452 'shellOverlaysBundleUrl' => $lazy_bundle_url( 'shell-overlays' ),
453 // URL of the lazy window-system bundle (Stage 11).
454 // Holds the `Window` class and its DOM / pointer / tab /
455 // chrome helpers — the single largest module in the pre-
456 // 0.8.4 main bundle. Loaded on first `windowManager.open()`
457 // / `openNew()` call (both async since 0.8.4); pre-loaded
458 // by the shell after first paint when no session is being
459 // restored and no `openCurrentPage` will fire.
460 'windowSystemBundleUrl' => $lazy_bundle_url( 'window-system' ),
461 'restNonce' => wp_create_nonce( 'wp_rest' ),
462 'osSettings' => desktop_mode_get_os_settings( get_current_user_id() ),
463 'osSettingsUrl' => esc_url_raw( rest_url( 'desktop-mode/v1/os-settings' ) ),
464 'seenIntros' => desktop_mode_get_seen_intros( get_current_user_id() ),
465 'seenIntrosUrl' => esc_url_raw( rest_url( 'desktop-mode/v1/intros' ) ),
466 // Sticky notes ride on Gutenberg's Guidelines experiment
467 // (the `wp_guideline` CPT + `wp_guideline_type` taxonomy).
468 // When that experiment isn't active the `wp/v2/guidelines`
469 // + `wp/v2/wp_guideline_type` probes 404 — harmless but
470 // noisy — so the shell skips booting the layer entirely.
471 'stickyNotes' => array(
472 'available' => desktop_mode_sticky_notes_is_available(),
473 ),
474 'aiSearchUrl' => esc_url_raw( rest_url( 'desktop-mode/v1/ai/search' ) ),
475 'aiSearchStreamUrl' => esc_url_raw( add_query_arg( 'action', 'desktop_mode_ai_search_stream', admin_url( 'admin-ajax.php' ) ) ),
476 'aiPlatformSettings' => current_user_can( 'manage_options' ) ? desktop_mode_ai_get_platform_settings() : null,
477 'aiPlatformSettingsUrl' => esc_url_raw( rest_url( 'desktop-mode/v1/ai/platform-settings' ) ),
478 'aiProviders' => desktop_mode_ai_get_providers_for_config(),
479 'extendedOptions' => current_user_can( 'manage_options' ) ? desktop_mode_get_extended_options() : null,
480 'extendedOptionsUrl' => esc_url_raw( rest_url( 'desktop-mode/v1/extended-options' ) ),
481 // Comments-window AI moderation toggle — surfaced at the
482 // shell level so the OS Settings → Features tab can render
483 // the toggle without depending on the Comments window
484 // being registered for this user. URL is the same
485 // endpoint the comments-window config exposes; state is
486 // `null` for non-admins (the UI hides the row entirely).
487 'commentsAiUrl' => esc_url_raw( rest_url( 'desktop-mode/v1/comments/ai-settings' ) ),
488 'commentsAi' => current_user_can( 'manage_options' )
489 ? array(
490 'enabled' => function_exists( 'desktop_mode_comments_ai_is_enabled' )
491 ? desktop_mode_comments_ai_is_enabled()
492 : false,
493 'providerConfigured' => function_exists( 'desktop_mode_comments_ai_provider_configured' )
494 ? desktop_mode_comments_ai_provider_configured()
495 : false,
496 )
497 : null,
498 'currentUserIsAdmin' => current_user_can( 'manage_options' ),
499 'portalUrl' => esc_url( desktop_mode_portal_url() ),
500 'fromPortal' => $from_portal,
501 'fromPortalIntent' => $from_portal_intent,
502 'pwa' => array(
503 'manifestUrl' => esc_url_raw( desktop_mode_pwa_manifest_url() ),
504 'swUrl' => esc_url_raw( desktop_mode_pwa_sw_url() ),
505 'stateUrl' => esc_url_raw( rest_url( 'desktop-mode/v1/pwa-state' ) ),
506 'state' => desktop_mode_pwa_get_user_state( get_current_user_id() ),
507 // Mirrors the manifest's `name` field — used by the
508 // install pill so the button reads "Install <site>"
509 // rather than "Install <current page>" (which would
510 // be misleading: we install the whole site as an
511 // app, not the dashboard window the user happens to
512 // be viewing).
513 'appName' => get_bloginfo( 'name' ),
514 // Operators set the `desktop_mode_pwa_force_replace_sw`
515 // filter to `true` when another root-scope service
516 // worker on the origin is blocking desktop-mode
517 // installability (foreign-SW guard in
518 // `src/pwa/sw-register.ts`). Default `false` preserves
519 // the polite behaviour where we yield to existing PWAs.
520 'forceReplaceSw' => desktop_mode_pwa_force_replace_sw(),
521 ),
522 )
523 );
524
525 wp_localize_script( 'desktop-mode', 'desktopModeConfig', $config );
526
527 /**
528 * Fires when desktop mode assets are enqueued.
529 *
530 * @since 0.1.0
531 */
532 do_action( 'desktop_mode_mode_init' );
533 }
534 add_action( 'admin_enqueue_scripts', 'desktop_mode_enqueue_assets' );
535
536 /**
537 * Emits `<link rel="preload">` hints for the shell's critical-path
538 * assets so the browser starts fetching them as soon as it parses
539 * the document `<head>`.
540 *
541 * Without this, the browser doesn't discover the main `desktop.min.js`
542 * bundle URL until it parses the footer `<script>` tag — typically
543 * ~1 RTT after the rest of the page has started loading. For a 464 KB
544 * bundle on a midrange phone that's a measurable FCP delay; on a
545 * slow connection it dominates first paint entirely.
546 *
547 * Hooked at `admin_print_styles @ 1` so the preload tags land in
548 * `<head>` BEFORE the regular `<link rel="stylesheet">` tags (which
549 * default to priority 10) and well before the footer `<script>`
550 * tag. The `wp_resource_hints` filter is frontend-only (`wp_head`-
551 * driven) and isn't invoked in admin context, so we emit our own
552 * tags.
553 *
554 * Four targets by default, split across two relationship types:
555 * - `desktop[.min].js` (preload) — the shell bundle (biggest win),
556 * consumed by the footer `<script>` on this very load.
557 * - `desktop.css` (preload) — shell base CSS, needed for first
558 * paint. Its registered handle is `filemtime`-stamped so the
559 * stylesheet URL matches this hint exactly (a `?ver=` mismatch makes
560 * the browser treat the preload as unused).
561 * - `window-system[.min].js` (prefetch) — lazy bundle `<script>`-
562 * injected by the main bundle on the first `open()`.
563 * - `shell-overlays[.min].js` (prefetch) — lazy bundle injected on the
564 * first toast / dialog / context-menu.
565 *
566 * The lazy bundles use `prefetch` rather than `preload`: they're loaded
567 * later (often beyond the ~3s window Chrome allows a `preload` before it
568 * warns "preloaded but not used in time"), so `prefetch` keeps the early
569 * low-priority cache fill without the must-use-now contract.
570 *
571 * Plugins can extend the hint list via the `desktop_mode_preload_hints`
572 * filter — e.g. a settings tab whose bundle the user opens on every
573 * visit can opt its own URL into the preload phase.
574 *
575 * Same-origin resources only — no `crossorigin` attribute. CDN hosts
576 * that serve `wp-content/plugins/` from a different origin should
577 * supply absolute URLs through the filter; in that case the consumer
578 * is responsible for the `crossorigin` semantics.
579 *
580 * @since 0.8.9
581 */
582 function desktop_mode_print_preload_hints() {
583 if (
584 ! is_admin()
585 || ! desktop_mode_is_enabled()
586 || desktop_mode_is_chromeless_request()
587 || desktop_mode_is_classic_request()
588 ) {
589 return;
590 }
591
592 $suffix = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
593
594 $build_url = static function ( $relative ) {
595 $path = DESKTOP_MODE_DIR . $relative;
596 $ver = file_exists( $path ) ? (string) filemtime( $path ) : DESKTOP_MODE_VERSION;
597 return DESKTOP_MODE_URL . $relative . '?ver=' . $ver;
598 };
599
600 $hints = array(
601 // Critical path — consumed on this very page load (the footer
602 // `<script>` and the shell stylesheet), so `preload` is correct.
603 array(
604 'href' => $build_url( 'assets/js/desktop' . $suffix . '.js' ),
605 'as' => 'script',
606 'rel' => 'preload',
607 ),
608 array(
609 'href' => $build_url( 'assets/css/desktop.css' ),
610 'as' => 'style',
611 'rel' => 'preload',
612 ),
613 // Lazy bundles — `<script>`-injected by the main bundle after
614 // first paint (window-system on the first `open()`, shell-overlays
615 // on the first toast / dialog / context-menu). They are frequently
616 // NOT requested within the ~3s window Chrome allows a `preload`,
617 // which produced "resource was preloaded but not used in time"
618 // warnings. `prefetch` is the right hint: same early, low-priority
619 // fetch into the cache, but no must-use-now contract — so the
620 // injected `<script src>` is served from cache with no warning.
621 array(
622 'href' => $build_url( 'assets/js/window-system' . $suffix . '.js' ),
623 'as' => 'script',
624 'rel' => 'prefetch',
625 ),
626 array(
627 'href' => $build_url( 'assets/js/shell-overlays' . $suffix . '.js' ),
628 'as' => 'script',
629 'rel' => 'prefetch',
630 ),
631 );
632
633 /**
634 * Filters the list of resource preload hints emitted in `<head>`.
635 *
636 * Each entry is a `{ 'href' => string, 'as' => string,
637 * 'rel' => 'preload'|'prefetch' }` array rendered as
638 * `<link rel="<rel>" as="<as>" href="<href>">`. `rel` is optional and
639 * defaults to `preload`; any value other than `prefetch` is coerced
640 * back to `preload`. Unrecognized entries are silently skipped — keep
641 * the contract permissive so a misconfigured plugin can't tank first
642 * paint.
643 *
644 * @since 0.8.9
645 * @since 0.11.0 Entries may carry a `rel` key (`preload` | `prefetch`).
646 *
647 * @param array $hints Default hints (main bundle + base CSS as
648 * `preload`; window-system + shell-overlays as
649 * `prefetch`).
650 */
651 $hints = apply_filters( 'desktop_mode_preload_hints', $hints );
652
653 if ( ! is_array( $hints ) ) {
654 return;
655 }
656
657 foreach ( $hints as $hint ) {
658 if ( ! is_array( $hint ) ) {
659 continue;
660 }
661 $href = isset( $hint['href'] ) ? (string) $hint['href'] : '';
662 $as = isset( $hint['as'] ) ? (string) $hint['as'] : '';
663 if ( '' === $href || '' === $as ) {
664 continue;
665 }
666 // `preload` (critical, used on this load) vs `prefetch` (lazy,
667 // used on a later interaction). Anything else falls back to
668 // `preload` so a typo can't emit an invalid relationship.
669 $rel = isset( $hint['rel'] ) ? (string) $hint['rel'] : 'preload';
670 if ( 'prefetch' !== $rel ) {
671 $rel = 'preload';
672 }
673 printf(
674 '<link rel="%s" as="%s" href="%s" />' . "\n",
675 esc_attr( $rel ),
676 esc_attr( $as ),
677 esc_url( $href )
678 );
679 }
680 }
681 add_action( 'admin_print_styles', 'desktop_mode_print_preload_hints', 1 );
682
683 /**
684 * Defers loading of non-critical desktop-mode stylesheets so they
685 * don't block first paint.
686 *
687 * Three stylesheets in the default enqueue list are only needed
688 * after a user interaction — `dock-peek` (mouseover a dock tile),
689 * `ai-assistant` (Cmd+K palette), `bug-report` (Report-a-bug
690 * window). With the normal `<link rel="stylesheet">` tag they sit
691 * on the critical path and the browser blocks first paint waiting
692 * for them, even though nothing on screen needs them yet.
693 *
694 * The well-known mitigation is the `media="print" onload="…"`
695 * pattern:
696 *
697 * <link rel="stylesheet" media="print"
698 * onload="this.media='all'; this.onload=null" href="…">
699 * <noscript><link rel="stylesheet" href="…"></noscript>
700 *
701 * `media="print"` makes the browser treat the sheet as
702 * non-applicable to the current display, so it downloads with
703 * low priority and doesn't block render. The `onload` handler
704 * swaps `media` to the original value once the bytes arrive
705 * (within ms of page load), making the styles take effect long
706 * before the user clicks anything that needs them. The
707 * `<noscript>` fallback restores critical-path behavior for JS-off
708 * browsers, so accessibility isn't degraded.
709 *
710 * Filterable via `desktop_mode_deferred_styles` so plugins can opt
711 * their own non-critical stylesheets in (or pull a built-in out).
712 * Chromeless iframes are skipped — their CSS pipeline is separate.
713 *
714 * @since 0.8.9
715 *
716 * @param string $html The original <link> tag HTML.
717 * @param string $handle The stylesheet handle WP is printing.
718 * @param string $href The full URL of the stylesheet.
719 * @param string $media The media attribute value WP resolved.
720 * @return string Possibly-rewritten tag.
721 */
722 function desktop_mode_defer_non_critical_styles( $html, $handle, $href, $media ) {
723 // Cheap gates first — `style_loader_tag` fires once per enqueued
724 // stylesheet on EVERY admin page (frontend doesn't go through
725 // this filter, but admin does, including pages where desktop mode
726 // is disabled). The deferred handles only ship when desktop mode
727 // is active, so the in_array check below would always miss on
728 // classic-only admin pages — but the `apply_filters` call still
729 // builds an array and walks subscribers per stylesheet. Short-
730 // circuit on the cheap helper checks (`is_admin` / enabled /
731 // chromeless) so non-desktop-mode users pay nothing.
732 if ( ! desktop_mode_is_enabled() ) {
733 return $html;
734 }
735 if ( desktop_mode_is_chromeless_request() ) {
736 return $html;
737 }
738
739 /**
740 * Filters the list of stylesheet handles that should be loaded
741 * deferred via the media-print-onload pattern. Plugins can add
742 * their own non-critical stylesheets here, or pull a built-in
743 * out (e.g. a plugin that surfaces the AI assistant on every
744 * page might want to keep its CSS critical-path).
745 *
746 * @since 0.8.9
747 *
748 * @param string[] $handles Default deferred handles.
749 */
750 $deferred = apply_filters(
751 'desktop_mode_deferred_styles',
752 array(
753 'desktop-mode-dock-peek',
754 'desktop-mode-ai-assistant',
755 'desktop-mode-bug-report',
756 )
757 );
758
759 if ( ! in_array( $handle, (array) $deferred, true ) ) {
760 return $html;
761 }
762
763 $resolved_media = $media ? $media : 'all';
764 $id = $handle . '-css';
765
766 // Two contexts, two escapers for the same `$resolved_media` value:
767 //
768 // - `%3$s` lands inside a JS string literal inside the HTML
769 // `onload="…"` attribute (`this.media='%3$s'`). `esc_attr`
770 // escapes `"` and `&` but NOT single quotes, so a media
771 // value containing `'` would break out of the JS string.
772 // `esc_js` is the correct escaper for "string literal inside
773 // an event-handler attribute" — escapes single quotes, double
774 // quotes, backslashes, newlines. Today `$resolved_media`
775 // comes from `wp_enqueue_style()`'s `$media` parameter (always
776 // a CSS media type / query produced by WordPress core), so
777 // this is pure defense-in-depth, but the cost is one extra
778 // function call.
779 //
780 // - `%4$s` lands inside an HTML attribute in the `<noscript>`
781 // fallback (`media='%4$s'`). That's standard `esc_attr`.
782 //
783 // phpcs:disable WordPress.WP.EnqueuedResources.NonEnqueuedStylesheet -- This filter rewrites a tag WordPress is in the process of emitting for an already-registered+enqueued stylesheet handle; the linter doesn't trace the `style_loader_tag` filter context, so the raw <link rel="stylesheet"> output is a false-positive.
784 $markup = sprintf(
785 '<link rel=\'stylesheet\' id=\'%1$s\' href=\'%2$s\' media=\'print\' onload="this.media=\'%3$s\'; this.onload=null;" />' . "\n" .
786 '<noscript><link rel=\'stylesheet\' id=\'%1$s-noscript\' href=\'%2$s\' media=\'%4$s\' /></noscript>' . "\n",
787 esc_attr( $id ),
788 esc_url( $href ),
789 esc_js( $resolved_media ),
790 esc_attr( $resolved_media )
791 );
792 // phpcs:enable WordPress.WP.EnqueuedResources.NonEnqueuedStylesheet
793
794 return $markup;
795 }
796 add_filter( 'style_loader_tag', 'desktop_mode_defer_non_critical_styles', 10, 4 );
797
798 /**
799 * Build the admin-menu command map (name → URL) and expose it on
800 * `window.__desktopModeMenuCommands`. The shell command harvester
801 * (`src/commands/shell-harvester.ts`) reads this slot to resolve URLs
802 * for "Go to: …" commands whose JS callbacks
803 * (`document.location = menuCommand.url`) close over a variable URL
804 * we can't extract from source. Without this map those commands
805 * either get skipped (no URL recoverable) or — if the location
806 * shadow misses — navigate the SHELL out of desktop mode.
807 *
808 * Mirrors what WordPress core's `wp_enqueue_command_palette_assets()`
809 * builds for `wp.coreCommands.initializeCommandPalette(...)`. We
810 * duplicate the logic here (instead of monkey-patching the JS init
811 * which is timing-sensitive — WP registers its hook during core load,
812 * so it always emits its inline before any plugin-added inline on the
813 * same handle) and ship the result through `wp_add_inline_script` on
814 * our own bundle handle. That decouples us entirely from WP's command-
815 * palette mount timing.
816 *
817 * @since 0.8.4
818 *
819 * @global array $menu
820 * @global array $submenu
821 * @return array<int, array{label:string, url:string, name:string}>
822 */
823 function desktop_mode_build_command_menu_map() {
824 global $menu, $submenu;
825 if ( ! is_array( $menu ) ) {
826 return array();
827 }
828 $out = array();
829
830 $extract_root_text = static function ( $label ) {
831 if ( '' === $label || ! is_string( $label ) ) {
832 return '';
833 }
834 if ( class_exists( 'WP_HTML_Tag_Processor' ) ) {
835 $processor = new WP_HTML_Tag_Processor( $label );
836 $text = '';
837 $depth = 0;
838 while ( $processor->next_token() ) {
839 $token_type = $processor->get_token_type();
840 if ( '#text' === $token_type && 0 === $depth ) {
841 $text .= $processor->get_modifiable_text();
842 }
843 if ( '#tag' === $token_type ) {
844 if ( $processor->is_tag_closer() ) {
845 if ( $depth > 0 ) {
846 --$depth;
847 }
848 continue;
849 }
850 $name = $processor->get_tag();
851 if ( $name && ! ( class_exists( 'WP_HTML_Processor' ) && WP_HTML_Processor::is_void( $name ) ) ) {
852 ++$depth;
853 }
854 }
855 }
856 return trim( $text );
857 }
858 return trim( wp_strip_all_tags( $label ) );
859 };
860
861 foreach ( $menu as $menu_item ) {
862 if ( empty( $menu_item[0] ) || ! is_string( $menu_item[0] ) ) {
863 continue;
864 }
865 if ( ! empty( $menu_item[1] ) && ! current_user_can( $menu_item[1] ) ) {
866 continue;
867 }
868 $menu_label = $extract_root_text( $menu_item[0] );
869 $menu_slug = $menu_item[2];
870 $menu_url = '';
871 if ( preg_match( '/\.php($|\?)/', $menu_slug ) || wp_http_validate_url( $menu_slug ) ) {
872 $menu_url = $menu_slug;
873 } elseif ( ! empty( menu_page_url( $menu_slug, false ) ) ) {
874 $menu_url = menu_page_url( $menu_slug, false );
875 }
876 if ( '' !== $menu_url ) {
877 $out[] = array(
878 'label' => $menu_label,
879 'url' => $menu_url,
880 'name' => $menu_slug,
881 );
882 }
883 if ( ! empty( $submenu ) && is_array( $submenu ) && array_key_exists( $menu_slug, $submenu ) ) {
884 foreach ( $submenu[ $menu_slug ] as $submenu_item ) {
885 if ( empty( $submenu_item[0] ) ) {
886 continue;
887 }
888 if ( ! empty( $submenu_item[1] ) && ! current_user_can( $submenu_item[1] ) ) {
889 continue;
890 }
891 $submenu_label = $extract_root_text( $submenu_item[0] );
892 $submenu_slug = $submenu_item[2];
893 $submenu_url = '';
894 if ( preg_match( '/\.php($|\?)/', $submenu_slug ) || wp_http_validate_url( $submenu_slug ) ) {
895 $submenu_url = $submenu_slug;
896 } elseif ( ! empty( menu_page_url( $submenu_slug, false ) ) ) {
897 $submenu_url = menu_page_url( $submenu_slug, false );
898 }
899 if ( '' === $submenu_url ) {
900 continue;
901 }
902 $out[] = array(
903 'label' => sprintf(
904 /* translators: 1: parent menu label, 2: submenu label */
905 __( '%1$s > %2$s', 'desktop-mode' ),
906 $menu_label,
907 $submenu_label
908 ),
909 'url' => $submenu_url,
910 'name' => $menu_slug . '-' . $submenu_item[2],
911 );
912 }
913 }
914 }
915 return $out;
916 }
917