PluginProbe
OpenStation: Desktop Windows, Dock & Virtual Desktops for WP Admin / 0.8.7
OpenStation: Desktop Windows, Dock & Virtual Desktops for WP Admin v0.8.7
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 / readme.txt

readme.txt in OpenStation: Desktop Windows, Dock & Virtual Desktops for WP Admin 0.8.7, at readme.txt

230 lines 13.4 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 === Desktop Mode ===
2 Contributors: automattic, allterraindeveloper, epeicher
3 Tags: desktop, admin, ui, productivity, ai
4 Requires at least: 6.0
5 Tested up to: 7.0
6 Requires PHP: 7.4
7 Stable tag: 0.8.7
8 License: GPLv2 or later
9 License URI: https://www.gnu.org/licenses/gpl-2.0.html
10
11 Reimagines the WordPress admin as a desktop OS with draggable windows and a dock. Per-user opt-in. By Automattic.
12
13 == Description ==
14
15 Desktop Mode renders /wp-admin as a desktop operating system. Admin screens open as draggable, resizable, minimizable windows on a desktop, with a left-edge dock built from the admin menu. The classic admin stays untouched for everyone else, and deactivating the plugin restores vanilla Core exactly.
16
17 Built and maintained by [Automattic](https://automattic.com) — the company behind WordPress.com, Jetpack, WooCommerce, and Tumblr. Zero Core patches: every feature is wired through public WordPress hooks.
18
19 = Highlights =
20
21 * **Per-user opt-in.** An admin-bar toggle flips a user-meta flag; nobody else sees any change.
22 * **Window system.** Iframe windows load admin pages chromelessly. Native windows render directly in the parent DOM via a public registration API. Both share drag, resize, minimize, maximize, fullscreen, and detach-to-new-tab.
23 * **Dock + taskbar.** Left-edge dock for core menus; bottom macOS-style pill taskbar for plugin menus. Letter-badge icon fallback for plugins without icon art.
24 * **Virtual desktops ("Spaces").** Multiple desktops per user, each with its own window set. Overview grid surfaces the Spaces switcher and thumbnails.
25 * **Arrange & snap.** Cascade, Tile, Overview, Snap-to-grid. Plugins contribute custom entries.
26 * **Wallpaper & widget registries.** Server- and client-side registration. CSS presets plus canvas (WebGL/2D) wallpapers with collision-aware surface data for snow/rain/physics effects.
27 * **Desktop icons.** Wallpaper-layer shortcuts that open native windows or admin URLs.
28 * **AI Copilot (optional).** Cmd+K palette backed by an agentic loop with built-in search tools. Disabled until you supply an API key. See "External services" below.
29 * **Slash commands & palettes.** Public registration APIs for plugin authors.
30 * **Cross-frame drag bridge.** Media-library attachments drag across iframe boundaries.
31 * **Session persistence.** Window stack (including desktops, focus, state) restored across reloads.
32 * **i18n.** Full gettext coverage across PHP and TypeScript; Spanish translation shipped.
33
34 = For plugin authors =
35
36 Desktop Mode is built to be extended. Every significant behavior is hookable — add a desktop icon, register a dock item, gate desktop mode by role, react to window events, or register a native window, all from your own plugin with zero patches here.
37
38 Comprehensive PHP and JavaScript hook surface, plus stable `desktop_mode_register_*` functions for windows, widgets, wallpapers, icons, window tabs, commands, settings tabs, and AI tools. See the [developer docs on GitHub](https://github.com/WordPress/desktop-mode/tree/trunk/docs).
39
40 = External services =
41
42 This plugin's optional **AI Copilot** sends data to **OpenAI** (`https://api.openai.com/v1/responses`) when, and only when, an administrator configures an OpenAI API key in **Settings → AI**. With no key configured, no external requests are made.
43
44 When the AI Copilot is enabled and a user invokes it (via Cmd+K or the slash-command palette):
45
46 * **What is sent:** the user's prompt, the conversation history for the active session, the chosen model identifier (e.g. `gpt-4o-mini`), and tool-call metadata. The plugin's built-in tools (`search_posts`, `search_pages`, `search_comments`) may include excerpts of the matching posts/pages/comments in tool results, which are then sent back to OpenAI as part of the agentic loop.
47 * **When it is sent:** on user-initiated AI requests, and (if enabled) on `save_post`, term-save, and comment-save hooks for auto-analysis. Auto-analysis runs server-side as part of the post-save flow.
48 * **Why it is sent:** to obtain model completions and tool-call decisions that drive the AI Copilot.
49 * **Who provides the service:** OpenAI, L.L.C. — see the [OpenAI Terms of Use](https://openai.com/policies/row-terms-of-use/) and the [OpenAI Privacy Policy](https://openai.com/policies/row-privacy-policy/).
50
51 The AI Copilot's provider layer is also extensible: third-party plugins may register additional providers via `desktop_mode_register_ai_provider()`. Those providers may send data to other endpoints; review each plugin's own privacy disclosure separately.
52
53 No other external services are contacted by this plugin.
54
55 == Installation ==
56
57 1. Upload the plugin folder to `/wp-content/plugins/`, or install via **Plugins → Add New → Upload Plugin**.
58 2. Activate the plugin through the **Plugins** screen in WordPress.
59 3. Click the **desktop** icon in the admin bar's top-right corner. The admin reloads inside the desktop shell.
60 4. Click the same icon again at any time to return to the classic admin.
61
62 = Optional: enable the AI Copilot =
63
64 1. Open **Settings → AI** inside desktop mode.
65 2. Paste an OpenAI API key and pick a model.
66 3. Press **Cmd+K** (or **Ctrl+K**) anywhere in desktop mode to open the AI palette.
67
68 == Frequently Asked Questions ==
69
70 = Does this change anything for users who don't opt in? =
71
72 No. The classic admin is untouched until a user toggles desktop mode on for themselves. Deactivating the plugin restores vanilla Core exactly.
73
74 = Does the plugin require an external service to function? =
75
76 No. The desktop shell, windowing, dock, taskbar, virtual desktops, widgets, wallpapers, and all extension APIs work entirely on-site. The AI Copilot is the only feature that contacts an external service, and it is disabled until an administrator configures an API key. See "External services" in the description.
77
78 = Does it patch WordPress core? =
79
80 No. Every feature is wired through public WordPress actions and filters.
81
82 = How do I disable desktop mode for my user? =
83
84 Click the desktop icon in the admin bar a second time to flip the toggle off. The plugin can also be deactivated globally from the Plugins screen.
85
86 = Where is the developer documentation? =
87
88 In `docs/` inside the plugin, and on [GitHub](https://github.com/WordPress/desktop-mode/tree/trunk/docs). The hook reference, JavaScript reference, bridge protocol, and copy-paste examples all live there.
89
90 == Screenshots ==
91
92 1. The desktop shell — wallpaper, dock, taskbar, and a window with the admin loaded inside it.
93 2. Multiple windows open across virtual desktops (Spaces).
94 3. The AI Copilot Cmd+K palette in action.
95 4. Custom wallpapers and widgets registered by a plugin.
96 5. The Arrange menu — Cascade, Tile, Overview, Snap to grid.
97
98 == Credits ==
99
100 Desktop Mode is brought to you by [Automattic](https://automattic.com). The plugin is open source under GPLv2-or-later; contributions are welcome on [GitHub](https://github.com/WordPress/desktop-mode).
101
102 = Third-party libraries =
103
104 The plugin bundles the following third-party JavaScript library, loaded on demand only when a feature that needs it is in use:
105
106 * **[PixiJS](https://pixijs.com/)** (MIT License) — used by the interactive **OS Settings → About** scene, the **Content Graph** window, and built-in canvas wallpapers (e.g. the animated WordPress logo). PixiJS is loaded from the plugin's own `assets/vendor/` directory; no CDN requests are made.
107
108 == Changelog ==
109
110 = 0.8.7 =
111 * Bump Tested up to WordPress 7.0
112 * Fix plugins window stale-nonce 'Cookie check failed' on long-running sessions
113 * Fix plugin .zip drop routing to Media Library uploader
114 * Add server-side search to entity list views
115 * Rename Browse tab to Add Plugin
116 * Drag and drop improvements
117
118 = 0.8.6 =
119 * Light indicators for native-window-target dock icons
120 * Additional fixes and polish
121 * Add compatibility layer for Divi script dependencies and tests
122 * Show plugin icons
123 * Open off-site menu items in a new browser tab
124
125 = 0.8.6-rc1 =
126 * Tag cloud & category mindmap: search, clustering, server cache
127 * Drag & Drop from local desktop
128 * Implement loading skeletons and staggered animations for file tiles
129 * Arrow-key shortcuts + Overview-from-Show-Desktop fix
130 * Shortcuts popover, dock-style tooltips, reorder
131 * Add Featured Plugins View and Ribbon Component
132 * Add "Automatic Updates" column and related functionality to Plugins window
133 * Add window notices feature with persistent dismissal and server sync
134 * Polish four framework surfaces for plugin authors
135 * Disable focus on other window actions
136 * Add Media section to "My WordPress" + uniform preview-pane hook surface
137 * Refactor My WordPress to use `<wpd-tile>` + add post status ribbons
138 * Allow deactivating plugins in CMO desktop & dock
139 * OS-file drop — progress UI, live refresh, cancel cleanup, CMO
140 * Group-by selector + click-to-deselect + focused-icon centering
141 * Test against PHP 8.3 and 8.4
142 * Enhance minimize/restore behavior to preserve pre-minimize state and add cross-state transition tests
143
144 = 0.8.5 =
145 * Shared folders, heartbeat widget, and heartbeat-pipeline hardening
146 * Recycle Bin: show item type badges inline next to title
147 * Plugins window: expandable rows with rich plugin details
148 * Remember native window size across opens
149 * Fix blank plugin icons in the Plugins window
150 * Restore "Show desktop on wallpaper click" as an opt-in setting
151 * Fix plugin update refresh, dock badge, and stuck-row failures
152 * Trash bin polish: URL badge, live placement badge, no media auto-trash
153 * Throw on empty REST body to avoid TypeError after self-replace
154 * Hide Media filter tab when MEDIA_TRASH is off
155 * Sequence openCurrentPage after restoreSession to avoid duplicate windows
156 * Fix window refresh issue on new sessions
157
158 = 0.8.4 =
159 * Faster Desktop Mode, main bundle cut by 59 %
160 * "Edit Post" from the front-end admin bar opens nothing
161 * Cross-page admin-link clicks: state, destructive actions, referer hint
162 * Warn loudly when a `<wpd-*>` tag is used without being imported
163 * Support re-uploading existing plugins, add post-install Activate panel
164 * Restore the full WordPress command palette inside Cmd+K
165
166 = 0.8.3 =
167 * Feat comments as native windows
168 * Chrome <111 titlebars + duplicate-placement REST 500s
169 * SW navigation interception caused window-in-window after core update
170 * Open each post as its own window from the Posts window
171 * Fix Users window data + live-refresh, plus per-window REST clients
172 * Session-expiry cascade + Plugins window sync
173 * Narrow scope to /wp-admin/ and throttle SW reloads
174 * Plugins window: real updates, not just a phantom badge
175 * Support plain permalinks for REST URL construction
176 * Hide registered icons from desktop instead of trashing
177
178 = 0.8.2 =
179 * Many fixes and new features
180 * Add unit test to ensure bridge script skips core AJAX update buttons
181 * Native Plugins window + `<wpd-card>`
182 * Appearance window polish + dock-peek fixes
183 * Fix upload theme
184 * Implement favicon resolver and associated tests for desktop mode
185 * Auto-inject X-WP-Nonce for REST API requests
186 * Enhance user management functionality in WordPress REST API
187 * Fix user role updates
188 * Fix plugin native issues
189 * Enhance color scheme preview functionality by adding shell scheme flipping
190 * Fix rearrange icons out of desktop
191 * Open each post in its own window
192 * Add item visibility and dock order settings
193 * Add first-run welcome dialog for Desktop Mode
194 * Fix dock management
195 * Refetch desktop placements on Recycle Bin restore
196
197 = 0.8.1 =
198 * Framework rework and stability improvements — significant internals refactor, smoother window lifecycle, and more reliable bridging between iframe and native windows.
199 * Drag and drop reworked end-to-end: calmer pointer behavior, more accurate hit-testing, and reliable handoff across windows.
200 * Posts, Pages, and Users now open as native desktop windows — direct DOM rendering inside the shell instead of an iframe, faster open, instant interaction, and UI tailored to the windowing model.
201 * New Content Graph tool — an interactive map of how your content links together. Pan, zoom, and focus a node to explore its neighborhood.
202 * Cross-page admin link routing in the chromeless bridge so links across the admin stay inside the desktop shell.
203 * Many bug fixes across the admin bar, Fullscreen toggle, resize handles over iframes, real-time icon refresh on plugin activation, and the PWA shell.
204
205 = 0.5.1 =
206 * Code editor and framework improvements.
207 * Enhanced AI provider integration: third-party providers may register through `desktop_mode_register_ai_provider()`.
208 * Title-bar button registry with icon painting for plugin authors.
209 * OS Settings tabs are now extensible via `desktop_mode_register_settings_tab_script()` / `desktop_mode_register_settings_tab()`.
210 * AI Copilot extensibility: server-side tool registry (`desktop_mode_register_ai_tool()`) and client-side `wp.desktop.ai.ask()` programmatic entry point.
211 * UI component kit expansion (~25 `<wpd-*>` web components).
212 * Backtick hotkey to cycle window focus.
213 * Unified command palettes via the palette registry.
214 * OS Settings Help tab.
215
216 = 0.5.0 =
217 * Command registration APIs (`desktop_mode_register_command_script()` / `desktop_mode_register_command()`) with live install/activate refresh.
218 * Media-library enhancement enabled by default, with opt-out.
219 * Dock CSS selectors updated; overflow handling improved.
220
221 See the [GitHub releases page](https://github.com/WordPress/desktop-mode/releases) for the full history.
222
223 == Upgrade Notice ==
224
225 = 0.8.1 =
226 Framework and stability rework, reworked drag and drop, native Posts/Pages/Users windows, and a new Content Graph tool. Backwards-compatible.
227
228 = 0.5.1 =
229 Adds AI Copilot extensibility (server-side tools, multi-provider support) and a title-bar button registry. Backwards-compatible.
230