| @@ -1,20 +1,20 @@ | ||
| 1 | 1 | <?php |
| 2 | 2 | /** |
| 3 | - * Desktop Mode — Native windows registry. | |
| 3 | + * OpenStation — Native windows registry. | |
| 4 | 4 | * |
| 5 | 5 | * The largest of the five components.php registries — owns: |
| 6 | 6 | * |
| 7 | - * - `desktop_mode_register_window()` — plugin-author API | |
| 8 | - * - `desktop_mode_native_window_registry()` — internal store | |
| 9 | - * - `desktop_mode_native_window_allowed_html()` — wp_kses | |
| 7 | + * - `openstation_register_window()` — plugin-author API | |
| 8 | + * - `openstation_native_window_registry()` — internal store | |
| 9 | + * - `openstation_native_window_allowed_html()` — wp_kses | |
| 10 | 10 | * allowlist for `<template>` payloads |
| 11 | - * - `desktop_mode_build_native_window_template_html()` — | |
| 11 | + * - `openstation_build_native_window_template_html()` — | |
| 12 | 12 | * wraps the registered template callback in tabs markup |
| 13 | 13 | * when the window has multiple registered tabs |
| 14 | - * - `desktop_mode_enqueue_native_window_scripts()` — enqueue | |
| 14 | + * - `openstation_enqueue_native_window_scripts()` — enqueue | |
| 15 | 15 | * hook that ships every registered window's script handle |
| 16 | - * - `desktop_mode_render_native_window_templates()` — renders | |
| 16 | + * - `openstation_render_native_window_templates()` — renders | |
| 17 | 17 | * the `<template>` elements the shell clones |
| 18 | 18 | * |
| 19 | 19 | * Extracted from `components.php` during the architecture-0.8.1 |
| 20 | 20 | * PHP slicing (phase 6). The window-tabs registry that builds on |
| @@ -19,10 +19,9 @@ | ||
| 19 | 19 | * Extracted from `components.php` during the architecture-0.8.1 |
| 20 | 20 | * PHP slicing (phase 6). The window-tabs registry that builds on |
| 21 | 21 | * top of this lives in `includes/registries/window-tabs.php`. |
| 22 | 22 | * |
| 23 | - * @package Desktop_Mode | |
| 24 | - * @since 0.8.1 | |
| 23 | + * @package OpenStation | |
| 25 | 24 | */ |
| 26 | 25 | |
| 27 | 26 | defined( 'ABSPATH' ) || exit; |
| 28 | 27 | |
| @@ -32,17 +31,17 @@ | ||
| 32 | 31 | * Under the hood this: |
| 33 | 32 | * |
| 34 | 33 | * 1. Captures the $args and stores them on a module-level |
| 35 | 34 | * registry so the relevant admin_footer + enqueue hooks fire |
| 36 | - * only for the current user's desktop-mode shell. | |
| 35 | + * only for the current user's openstation shell. | |
| 37 | 36 | * 2. On `admin_footer` (shell-side only), emits |
| 38 | - * `<template id="desktop-mode-native-window-<id>">` wrapping the | |
| 37 | + * `<template id="os-native-window-<id>">` wrapping the | |
| 39 | 38 | * output of the `template` callback. Each registered window |
| 40 | 39 | * gets its own template element. |
| 41 | 40 | * 3. On `admin_enqueue_scripts` (shell-side), enqueues the |
| 42 | 41 | * caller's `script` handle if one was provided. The script |
| 43 | 42 | * registers a render callback at |
| 44 | - * `window.desktopModeNativeWindows[<id>]`. On every window open | |
| 43 | + * `window.openStationNativeWindows[<id>]`. On every window open | |
| 45 | 44 | * the shell clones the registered template into the body and |
| 46 | 45 | * then invokes the callback — render is enhancement: query |
| 47 | 46 | * the body for mount points your template declared, light |
| 48 | 47 | * them up. Without a `script` the cloned template IS the |
| @@ -47,12 +46,12 @@ | ||
| 47 | 46 | * the body for mount points your template declared, light |
| 48 | 47 | * them up. Without a `script` the cloned template IS the |
| 49 | 48 | * window; declarative-only plugins need zero JS. |
| 50 | 49 | * 4. Passes a localized config blob to the script |
| 51 | - * (`desktopModeNativeWindow_<id>`) carrying the window's | |
| 50 | + * (`openStationNativeWindow_<id>`) carrying the window's | |
| 52 | 51 | * `id`, `title`, `icon`, dimensions, and `placement`. The |
| 53 | - * script then calls `wp.desktop.registerSystemTile()` + | |
| 54 | - * `wp.desktop.registerWindow()` to wire up the dock tile | |
| 52 | + * script then calls `wp.os.registerSystemTile()` + | |
| 53 | + * `wp.os.registerWindow()` to wire up the dock tile | |
| 55 | 54 | * and the open-on-click behaviour. |
| 56 | 55 | * |
| 57 | 56 | * Plugins write the template callback + the render callback on |
| 58 | 57 | * the JS side; everything else is shell plumbing. Capability gate |
| @@ -61,17 +60,11 @@ | ||
| 61 | 60 | * |
| 62 | 61 | * Note on scope: the shell doesn't auto-open windows server-side |
| 63 | 62 | * — `registerWindow` declares availability, not presence. Users |
| 64 | 63 | * click the registered tile (or your plugin calls |
| 65 | - * `wp.desktop.windowManager.open()` programmatically) to surface | |
| 64 | + * `wp.os.windowManager.open()` programmatically) to surface | |
| 66 | 65 | * the window. |
| 67 | 66 | * |
| 68 | - * @since 0.8.1 | |
| 69 | - * @since 0.8.1 Returns `WP_Error` on validation failure instead of | |
| 70 | - * silent `false`. Legacy `if ( $result )` callers remain | |
| 71 | - * correct because `WP_Error` is truthy; new code should | |
| 72 | - * prefer `is_wp_error( $result )` for diagnostics. | |
| 73 | - * | |
| 74 | 67 | * @param string $id Doubles as window id + dock-tile id. Must |
| 75 | 68 | * be a kebab-case-ish slug. |
| 76 | 69 | * @param array $args { |
| 77 | 70 | * Window registration options. |
| @@ -79,9 +72,9 @@ | ||
| 79 | 72 | * @type string $title Window + tooltip title. Required. |
| 80 | 73 | * @type string $icon Dashicons class or URL. Required. |
| 81 | 74 | * @type callable $template Echoes the window body markup. |
| 82 | 75 | * Wrapped on `admin_footer` in a |
| 83 | - * `<template id="desktop-mode-native-window- | |
| 76 | + * `<template id="os-native-window- | |
| 84 | 77 | * <id>">`; cloned into the window |
| 85 | 78 | * body on every open. The render |
| 86 | 79 | * callback runs against the cloned |
| 87 | 80 | * body, so mount points declared in |
| @@ -91,8 +84,61 @@ | ||
| 91 | 84 | * owns the JS render callback. |
| 92 | 85 | * Optional — omit for a purely |
| 93 | 86 | * declarative window whose body is |
| 94 | 87 | * exactly the cloned template. |
| 88 | + * Loaded the first time the window | |
| 89 | + * opens, not at boot — see | |
| 90 | + * `$preload_script`. | |
| 91 | + * @type string[] $scripts Companion script handles loaded | |
| 92 | + * immediately before `$script`, in | |
| 93 | + * the order given. For a bundle that | |
| 94 | + * extends the window from outside it | |
| 95 | + * — subscribing to the window's own | |
| 96 | + * actions, contributing a section — | |
| 97 | + * and therefore has to be in the tab | |
| 98 | + * before the window's render callback | |
| 99 | + * paints. Declaring it here is what | |
| 100 | + * keeps it off the boot critical | |
| 101 | + * path: it travels with the window | |
| 102 | + * it extends. Default empty. | |
| 103 | + * @type string[] $styles Companion style handles injected on | |
| 104 | + * the window's first open, after the | |
| 105 | + * window's own `$style`, in the order | |
| 106 | + * given — so at equal specificity a | |
| 107 | + * companion's overrides win, the same | |
| 108 | + * source-order contract an enqueue | |
| 109 | + * dependency gives. The styles-side | |
| 110 | + * mirror of `$scripts`: a stylesheet | |
| 111 | + * that only paints surfaces inside | |
| 112 | + * this window is dead weight on every | |
| 113 | + * document that never shows it — | |
| 114 | + * declared here it costs nothing at | |
| 115 | + * boot and never reaches chromeless | |
| 116 | + * iframes at all. Unlike `$style` | |
| 117 | + * (injected when the window registers, | |
| 118 | + * so mid-session activations paint), | |
| 119 | + * companions wait for the first open; | |
| 120 | + * the deferral is the point. Default | |
| 121 | + * empty. | |
| 122 | + * @type bool $preload_script Load `$script` (and `$scripts`) at | |
| 123 | + * shell boot instead of on first | |
| 124 | + * open. Default false — a window's | |
| 125 | + * bundle is dead weight until the | |
| 126 | + * window opens, and the documented | |
| 127 | + * contract for it is "publish a | |
| 128 | + * render callback on | |
| 129 | + * `window.openStationNativeWindows[ | |
| 130 | + * <id> ]`", which the shell reads at | |
| 131 | + * open time. Opt in only when the | |
| 132 | + * bundle ALSO has a boot-time job | |
| 133 | + * that must run whether or not the | |
| 134 | + * user ever opens the window — a | |
| 135 | + * dock badge poller, a public API it | |
| 136 | + * installs on `wp.os`. Prefer | |
| 137 | + * splitting that job into an | |
| 138 | + * always-loaded bundle over paying | |
| 139 | + * the whole window's weight on every | |
| 140 | + * admin page. | |
| 95 | 141 | * @type int $width Initial width (px). Default 520. |
| 96 | 142 | * @type int $height Initial height (px). Default 400. |
| 97 | 143 | * @type int $min_width Minimum width (px). Default 280. |
| 98 | 144 | * @type int $min_height Minimum height (px). Default 220. |
| @@ -98,11 +144,51 @@ | ||
| 98 | 144 | * @type int $min_height Minimum height (px). Default 220. |
| 99 | 145 | * @type string $placement 'dock' | 'none'. Default 'dock'. |
| 100 | 146 | * 'none' skips the tile (plugin |
| 101 | 147 | * opens the window programmatically). |
| 148 | + * A PROPOSED default only: the user's | |
| 149 | + * OpenStation Preferences → Navigation | |
| 150 | + * pick wins, and so does a right-click | |
| 151 | + * "Keep in dock". | |
| 152 | + * @type string $admin 'site' | 'network' | 'any'. Default | |
| 153 | + * 'site': offered on every site's | |
| 154 | + * shell and never on the network | |
| 155 | + * admin's, which is right for a window | |
| 156 | + * that reads the current site's REST | |
| 157 | + * API. 'network' is the network | |
| 158 | + * admin's shell only; 'any' is both. | |
| 159 | + * @type string $nav_kind 'app' | 'control'. Default 'app'. | |
| 160 | + * What the window IS, which decides | |
| 161 | + * where its launcher defaults to (apps | |
| 162 | + * to the desktop, controls to the | |
| 163 | + * dock) and which dock zone it sits | |
| 164 | + * in. Plugins want 'app'; 'control' | |
| 165 | + * is for OpenStation's own | |
| 166 | + * affordances. | |
| 167 | + * @type int $dock_order Sort key among system tiles, | |
| 168 | + * ascending; ties keep registration | |
| 169 | + * order. Default 0, which places the | |
| 170 | + * tile ahead of the shell's own | |
| 171 | + * trailing cluster (Mio 10, Overview | |
| 172 | + * 20, System 30, Exit 35, Trash 40). | |
| 173 | + * Needed because registration order | |
| 174 | + * is not something a plugin controls: | |
| 175 | + * tiles land when their lazy script | |
| 176 | + * resolves. | |
| 177 | + * @type bool $placeable Whether the dock tile gets a row in | |
| 178 | + * OpenStation Preferences → Apps & | |
| 179 | + * Plugins, so the user can move it to | |
| 180 | + * the wallpaper or hide it. Defaults | |
| 181 | + * to the dock either way. Default | |
| 182 | + * false, because most tiles are | |
| 183 | + * load-bearing. Opt in for a window | |
| 184 | + * the user can reasonably do without. | |
| 185 | + * Only offer this on a window that | |
| 186 | + * registers no desktop icon: the icon | |
| 187 | + * already owns a row of its own. | |
| 102 | 188 | * @type string[] $capabilities User capabilities that gate the |
| 103 | 189 | * registration. ANY miss returns |
| 104 | - * `WP_Error desktop_mode_capability_denied`. | |
| 190 | + * `WP_Error openstation_capability_denied`. | |
| 105 | 191 | * @type bool|string $autofocus Passed verbatim to |
| 106 | 192 | * `NativeWindowDef.autofocus`. |
| 107 | 193 | * @type string $main_tab_label Label for the "main" tab that |
| 108 | 194 | * displays the window's own |
| @@ -108,9 +194,9 @@ | ||
| 108 | 194 | * displays the window's own |
| 109 | 195 | * `template` output. Only rendered |
| 110 | 196 | * when at least one additional |
| 111 | 197 | * tab is registered via |
| 112 | - * {@see desktop_mode_register_window_tab()}. | |
| 198 | + * {@see openstation_register_window_tab()}. | |
| 113 | 199 | * Defaults to the window's `title`. |
| 114 | 200 | * @type int $main_tab_padding Padding (in px) applied to the |
| 115 | 201 | * auto-generated tab-wrap around |
| 116 | 202 | * the window body. Only applies |
| @@ -117,15 +203,15 @@ | ||
| 117 | 203 | * when additional tabs are |
| 118 | 204 | * registered. Default 16. Pass 0 |
| 119 | 205 | * for edge-to-edge content. |
| 120 | 206 | * Filterable at runtime via |
| 121 | - * `desktop_mode_native_window_tab_wrap_padding`. | |
| 207 | + * `openstation_native_window_tab_wrap_padding`. | |
| 122 | 208 | * @type array $config Arbitrary serializable data to ship |
| 123 | 209 | * to the bundle alongside the script |
| 124 | 210 | * tag. Read in JS via |
| 125 | - * `wp.desktop.getWindowConfig( $id )` | |
| 211 | + * `wp.os.getWindowConfig( $id )` | |
| 126 | 212 | * (or directly at |
| 127 | - * `window.desktopModeWindowConfig[ $id ]`). | |
| 213 | + * `window.openStationWindowConfig[ $id ]`). | |
| 128 | 214 | * Recommended over `wp_localize_script` |
| 129 | 215 | * for native-window scripts because |
| 130 | 216 | * the lazy-load path bypasses |
| 131 | 217 | * `wp_print_scripts` — passing config |
| @@ -139,13 +225,13 @@ | ||
| 139 | 225 | * @return true|WP_Error `true` on success; `WP_Error` when any |
| 140 | 226 | * required arg is missing/invalid or a |
| 141 | 227 | * declared capability is unmet. |
| 142 | 228 | */ |
| 143 | -function desktop_mode_register_window( $id, $args = array() ) { | |
| 229 | +function openstation_register_window( $id, $args = array() ) { | |
| 144 | 230 | $id = sanitize_key( (string) $id ); |
| 145 | 231 | if ( '' === $id ) { |
| 146 | - return desktop_mode_registration_error( | |
| 147 | - 'desktop_mode_missing_id', | |
| 232 | + return openstation_registration_error( | |
| 233 | + 'openstation_missing_id', | |
| 148 | 234 | __( 'Native window id is required and must be a valid slug.', 'desktop-mode' ) |
| 149 | 235 | ); |
| 150 | 236 | } |
| 151 | 237 | |
| @@ -153,14 +239,17 @@ | ||
| 153 | 239 | 'title' => '', |
| 154 | 240 | 'icon' => 'dashicons-admin-generic', |
| 155 | 241 | 'template' => null, |
| 156 | 242 | 'script' => '', |
| 243 | + 'scripts' => array(), | |
| 244 | + 'styles' => array(), | |
| 245 | + 'preload_script' => false, | |
| 157 | 246 | // Optional WP style handle (registered with `wp_register_style()`). |
| 158 | 247 | // Resolved at payload-build time so the shell can lazy-inject a |
| 159 | 248 | // `<link rel="stylesheet">` when a peer plugin is activated |
| 160 | 249 | // mid-session — without this, the parent shell page already |
| 161 | 250 | // finished `wp_print_styles` and the plugin's CSS is missing |
| 162 | - // until F5. @since 0.8.1 | |
| 251 | + // until F5. | |
| 163 | 252 | 'style' => '', |
| 164 | 253 | 'width' => 520, |
| 165 | 254 | 'height' => 400, |
| 166 | 255 | 'min_width' => 280, |
| @@ -165,27 +254,40 @@ | ||
| 165 | 254 | 'height' => 400, |
| 166 | 255 | 'min_width' => 280, |
| 167 | 256 | 'min_height' => 220, |
| 168 | 257 | 'placement' => 'dock', |
| 258 | + 'admin' => 'site', | |
| 259 | + 'nav_kind' => 'app', | |
| 260 | + 'dock_order' => 0, | |
| 261 | + 'placeable' => false, | |
| 169 | 262 | 'capabilities' => array(), |
| 170 | 263 | 'autofocus' => false, |
| 171 | 264 | 'main_tab_label' => '', |
| 172 | 265 | 'main_tab_padding' => '', |
| 266 | + // Admin pages this window answers for, `array( id, page )` per | |
| 267 | + // entry. See `App::menu()` and `openstation_apps_menu_pages()`. | |
| 268 | + 'menu_pages' => array(), | |
| 173 | 269 | 'config' => array(), |
| 174 | 270 | ); |
| 175 | - $args = wp_parse_args( $args, $defaults ); | |
| 271 | + $args = wp_parse_args( $args, $defaults ); | |
| 272 | + if ( ! in_array( $args['admin'], array( 'site', 'network', 'any' ), true ) ) { | |
| 273 | + $args['admin'] = 'site'; | |
| 274 | + } | |
| 176 | 275 | |
| 177 | 276 | // Capability gate — ALL listed caps must match. Fail closed. |
| 178 | 277 | foreach ( (array) $args['capabilities'] as $cap ) { |
| 179 | 278 | if ( ! current_user_can( (string) $cap ) ) { |
| 180 | - return desktop_mode_registration_error( | |
| 181 | - 'desktop_mode_capability_denied', | |
| 279 | + return openstation_registration_error( | |
| 280 | + 'openstation_capability_denied', | |
| 182 | 281 | sprintf( |
| 183 | 282 | /* translators: %s: capability slug. */ |
| 184 | 283 | __( 'Current user lacks the %s capability required to register this native window.', 'desktop-mode' ), |
| 185 | 284 | (string) $cap |
| 186 | 285 | ), |
| 187 | - array( 'capability' => (string) $cap, 'id' => $id ) | |
| 286 | + array( | |
| 287 | + 'capability' => (string) $cap, | |
| 288 | + 'id' => $id, | |
| 289 | + ) | |
| 188 | 290 | ); |
| 189 | 291 | } |
| 190 | 292 | } |
| 191 | 293 | |
| @@ -190,17 +292,17 @@ | ||
| 190 | 292 | } |
| 191 | 293 | |
| 192 | 294 | // Required fields. |
| 193 | 295 | if ( '' === (string) $args['title'] ) { |
| 194 | - return desktop_mode_registration_error( | |
| 195 | - 'desktop_mode_missing_title', | |
| 296 | + return openstation_registration_error( | |
| 297 | + 'openstation_missing_title', | |
| 196 | 298 | __( 'Native window registration requires a non-empty `title`.', 'desktop-mode' ), |
| 197 | 299 | array( 'id' => $id ) |
| 198 | 300 | ); |
| 199 | 301 | } |
| 200 | 302 | if ( ! is_callable( $args['template'] ) ) { |
| 201 | - return desktop_mode_registration_error( | |
| 202 | - 'desktop_mode_invalid_template', | |
| 303 | + return openstation_registration_error( | |
| 304 | + 'openstation_invalid_template', | |
| 203 | 305 | __( 'Native window registration requires a callable `template` that echoes the template body.', 'desktop-mode' ), |
| 204 | 306 | array( 'id' => $id ) |
| 205 | 307 | ); |
| 206 | 308 | } |
| @@ -208,8 +310,17 @@ | ||
| 208 | 310 | $placement = in_array( $args['placement'], array( 'dock', 'none' ), true ) |
| 209 | 311 | ? $args['placement'] |
| 210 | 312 | : 'dock'; |
| 211 | 313 | |
| 314 | + // What the window IS, which is what decides where its launcher | |
| 315 | + // goes by default and which dock zone it sits in. `'app'` for an | |
| 316 | + // installed app (the default, and what every plugin wants); | |
| 317 | + // `'control'` for an OpenStation affordance — the Trash is the | |
| 318 | + // only shipped one. | |
| 319 | + $nav_kind = in_array( $args['nav_kind'], array( 'app', 'control' ), true ) | |
| 320 | + ? $args['nav_kind'] | |
| 321 | + : 'app'; | |
| 322 | + | |
| 212 | 323 | $entry = array( |
| 213 | 324 | 'id' => $id, |
| 214 | 325 | 'title' => (string) $args['title'], |
| 215 | 326 | 'icon' => (string) $args['icon'], |
| @@ -214,8 +325,32 @@ | ||
| 214 | 325 | 'title' => (string) $args['title'], |
| 215 | 326 | 'icon' => (string) $args['icon'], |
| 216 | 327 | 'template' => $args['template'], |
| 217 | 328 | 'script' => (string) $args['script'], |
| 329 | + // Companion handles, deduped and stripped of empties so the | |
| 330 | + // payload builder can resolve the list without re-checking. | |
| 331 | + 'scripts' => array_values( | |
| 332 | + array_unique( | |
| 333 | + array_filter( | |
| 334 | + array_map( 'strval', (array) $args['scripts'] ), | |
| 335 | + static function ( $handle ) { | |
| 336 | + return '' !== $handle; | |
| 337 | + } | |
| 338 | + ) | |
| 339 | + ) | |
| 340 | + ), | |
| 341 | + // Companion style handles, same dedupe/strip as `scripts`. | |
| 342 | + 'styles' => array_values( | |
| 343 | + array_unique( | |
| 344 | + array_filter( | |
| 345 | + array_map( 'strval', (array) $args['styles'] ), | |
| 346 | + static function ( $handle ) { | |
| 347 | + return '' !== $handle; | |
| 348 | + } | |
| 349 | + ) | |
| 350 | + ) | |
| 351 | + ), | |
| 352 | + 'preload_script' => (bool) $args['preload_script'], | |
| 218 | 353 | 'style' => (string) $args['style'], |
| 219 | 354 | 'width' => (int) $args['width'], |
| 220 | 355 | 'height' => (int) $args['height'], |
| 221 | 356 | 'min_width' => (int) $args['min_width'], |
| @@ -220,20 +355,33 @@ | ||
| 220 | 355 | 'height' => (int) $args['height'], |
| 221 | 356 | 'min_width' => (int) $args['min_width'], |
| 222 | 357 | 'min_height' => (int) $args['min_height'], |
| 223 | 358 | 'placement' => $placement, |
| 359 | + 'nav_kind' => $nav_kind, | |
| 360 | + // Which admin's shell offers it; see the `admin` arg. | |
| 361 | + 'admin' => $args['admin'], | |
| 362 | + // Sort key among system tiles, ascending. `0` (the default) | |
| 363 | + // puts a plugin's tile ahead of the shell's own trailing | |
| 364 | + // cluster — Mio 10, Overview 20, System 30 — which is where a | |
| 365 | + // launcher belongs. Trash uses 40 to sit at the very end. | |
| 366 | + 'dock_order' => (int) $args['dock_order'], | |
| 367 | + 'placeable' => (bool) $args['placeable'], | |
| 224 | 368 | 'autofocus' => $args['autofocus'], |
| 225 | 369 | 'main_tab_label' => (string) $args['main_tab_label'], |
| 226 | - // Stored as-is (string or int). `desktop_mode_build_native_window_template_html` | |
| 370 | + // Stored as-is (string or int). `openstation_build_native_window_template_html` | |
| 227 | 371 | // coerces to int and falls back to 16 when absent. |
| 228 | 372 | 'main_tab_padding' => $args['main_tab_padding'], |
| 229 | 373 | // Bundle-bound config delivered through the same path as |
| 230 | 374 | // `wp_localize_script` `extra['data']` — see the `config` doc |
| 231 | - // in this function's `$args` block and `desktop_mode_resolve_script_payload()` | |
| 375 | + // in this function's `$args` block and `openstation_resolve_script_payload()` | |
| 232 | 376 | // for how it lands on the wire. |
| 377 | + // Admin pages this window answers for, `array( id, page )` per | |
| 378 | + // entry — dropped here once, which is why the shell saw an | |
| 379 | + // empty list and claimed none of them. | |
| 380 | + 'menu_pages' => is_array( $args['menu_pages'] ) ? array_values( $args['menu_pages'] ) : array(), | |
| 233 | 381 | 'config' => is_array( $args['config'] ) ? $args['config'] : array(), |
| 234 | 382 | ); |
| 235 | - desktop_mode_native_window_registry( $id, $entry ); | |
| 383 | + openstation_native_window_registry( $id, $entry ); | |
| 236 | 384 | |
| 237 | 385 | /** |
| 238 | 386 | * Fires after a native desktop window is successfully registered. |
| 239 | 387 | * |
| @@ -239,19 +387,17 @@ | ||
| 239 | 387 | * |
| 240 | 388 | * Lets plugins react to registrations made by other plugins — |
| 241 | 389 | * e.g. a widget that auto-opens when a given window registers, |
| 242 | 390 | * or analytics tracking of which windows the current install |
| 243 | - * exposes. Does NOT fire when `desktop_mode_register_window()` | |
| 391 | + * exposes. Does NOT fire when `openstation_register_window()` | |
| 244 | 392 | * returns a `WP_Error`. |
| 245 | 393 | * |
| 246 | - * @since 0.8.1 | |
| 247 | - * | |
| 248 | 394 | * @param string $id The window id. |
| 249 | 395 | * @param array $entry The stored registry entry (id, title, |
| 250 | 396 | * icon, template callback, script handle, |
| 251 | 397 | * size defaults, placement, autofocus). |
| 252 | 398 | */ |
| 253 | - do_action( 'desktop_mode_native_window_registered', $id, $entry ); | |
| 399 | + do_action( 'openstation_native_window_registered', $id, $entry ); | |
| 254 | 400 | |
| 255 | 401 | return true; |
| 256 | 402 | } |
| 257 | 403 | |
| @@ -256,14 +402,13 @@ | ||
| 256 | 402 | } |
| 257 | 403 | |
| 258 | 404 | /** |
| 259 | 405 | * Internal module-level registry for native windows registered |
| 260 | - * via {@see desktop_mode_register_window()}. Passing a second | |
| 406 | + * via {@see openstation_register_window()}. Passing a second | |
| 261 | 407 | * argument stores the entry; passing only the id returns the |
| 262 | 408 | * stored value (or null). Kept small and side-effect-free so |
| 263 | 409 | * tests can introspect. |
| 264 | 410 | * |
| 265 | - * @since 0.8.1 | |
| 266 | 411 | * @internal |
| 267 | 412 | * |
| 268 | 413 | * @param string $id Window id. |
| 269 | 414 | * @param array|null $entry Entry to store, or null to just read. |
| @@ -269,9 +414,9 @@ | ||
| 269 | 414 | * @param array|null $entry Entry to store, or null to just read. |
| 270 | 415 | * @return array|null Either the stored entry or the full registry |
| 271 | 416 | * (when id is empty). |
| 272 | 417 | */ |
| 273 | -function desktop_mode_native_window_registry( $id = '', $entry = null ) { | |
| 418 | +function openstation_native_window_registry( $id = '', $entry = null ) { | |
| 274 | 419 | static $store = array(); |
| 275 | 420 | |
| 276 | 421 | if ( '' === (string) $id ) { |
| 277 | 422 | return $store; |
| @@ -290,18 +435,16 @@ | ||
| 290 | 435 | * |
| 291 | 436 | * Templates are inert until JS clones them out of the `<template>` |
| 292 | 437 | * tag — but Plugin Check still requires escape-on-output. The list |
| 293 | 438 | * extends `wp_kses_allowed_html( 'post' )` with form controls, |
| 294 | - * `<wpd-*>` web components, and dashicon spans, plus permissive | |
| 295 | - * `data-*`, `aria-*`, and component-specific attributes. Plugins | |
| 439 | + * `<os-*>` web components, and dashicon spans, plus permissive | |
| 440 | + * `data-*`, common ARIA, and component-specific attributes. Plugins | |
| 296 | 441 | * registering their own native windows can extend the list via the |
| 297 | - * `desktop_mode_native_window_allowed_html` filter below. | |
| 442 | + * `openstation_native_window_allowed_html` filter below. | |
| 298 | 443 | * |
| 299 | - * @since 0.6.2 | |
| 300 | - * | |
| 301 | 444 | * @return array<string,array<string,bool>> |
| 302 | 445 | */ |
| 303 | -function desktop_mode_native_window_allowed_html() { | |
| 446 | +function openstation_native_window_allowed_html() { | |
| 304 | 447 | $base = wp_kses_allowed_html( 'post' ); |
| 305 | 448 | |
| 306 | 449 | $global_attrs = array( |
| 307 | 450 | 'id' => true, |
| @@ -317,11 +460,17 @@ | ||
| 317 | 460 | 'dir' => true, |
| 318 | 461 | 'draggable' => true, |
| 319 | 462 | 'contenteditable' => true, |
| 320 | 463 | 'data-*' => true, |
| 321 | - 'aria-*' => true, | |
| 464 | + // `wp_kses` only treats the `data-*` wildcard specially. ARIA | |
| 465 | + // attributes must be admitted by their exact names or they are | |
| 466 | + // silently stripped from native-window templates. | |
| 467 | + 'aria-label' => true, | |
| 468 | + 'aria-labelledby' => true, | |
| 469 | + 'aria-current' => true, | |
| 470 | + 'aria-hidden' => true, | |
| 322 | 471 | // `full-width` is a layout-level flag honoured by |
| 323 | - // `<wpd-form>` (and any future wpd-* container that opts in | |
| 472 | + // `<os-form>` (and any future os-* container that opts in | |
| 324 | 473 | // to row-spanning slotted children). Lives in the global |
| 325 | 474 | // allowlist so a plain `<div full-width>` wrapper isn't |
| 326 | 475 | // stripped by kses on its way through the template. |
| 327 | 476 | 'full-width' => true, |
| @@ -331,38 +480,38 @@ | ||
| 331 | 480 | $global_attrs, |
| 332 | 481 | array( |
| 333 | 482 | 'name' => true, |
| 334 | 483 | 'value' => true, |
| 335 | - 'placeholder' => true, | |
| 336 | - 'required' => true, | |
| 337 | - 'disabled' => true, | |
| 338 | - 'readonly' => true, | |
| 339 | - 'checked' => true, | |
| 340 | - 'selected' => true, | |
| 341 | - 'min' => true, | |
| 342 | - 'max' => true, | |
| 343 | - 'step' => true, | |
| 344 | - 'minlength' => true, | |
| 345 | - 'maxlength' => true, | |
| 346 | - 'pattern' => true, | |
| 484 | + 'placeholder' => true, | |
| 485 | + 'required' => true, | |
| 486 | + 'disabled' => true, | |
| 487 | + 'readonly' => true, | |
| 488 | + 'checked' => true, | |
| 489 | + 'selected' => true, | |
| 490 | + 'min' => true, | |
| 491 | + 'max' => true, | |
| 492 | + 'step' => true, | |
| 493 | + 'minlength' => true, | |
| 494 | + 'maxlength' => true, | |
| 495 | + 'pattern' => true, | |
| 347 | 496 | 'autocomplete' => true, |
| 348 | - 'autofocus' => true, | |
| 349 | - 'multiple' => true, | |
| 350 | - 'rows' => true, | |
| 351 | - 'cols' => true, | |
| 352 | - 'wrap' => true, | |
| 353 | - 'size' => true, | |
| 354 | - 'for' => true, | |
| 355 | - 'form' => true, | |
| 356 | - 'type' => true, | |
| 357 | - 'accept' => true, | |
| 358 | - 'list' => true, | |
| 359 | - 'src' => true, | |
| 360 | - 'href' => true, | |
| 361 | - 'target' => true, | |
| 362 | - 'rel' => true, | |
| 363 | - 'open' => true, | |
| 364 | - 'variant' => true, | |
| 497 | + 'autofocus' => true, | |
| 498 | + 'multiple' => true, | |
| 499 | + 'rows' => true, | |
| 500 | + 'cols' => true, | |
| 501 | + 'wrap' => true, | |
| 502 | + 'size' => true, | |
| 503 | + 'for' => true, | |
| 504 | + 'form' => true, | |
| 505 | + 'type' => true, | |
| 506 | + 'accept' => true, | |
| 507 | + 'list' => true, | |
| 508 | + 'src' => true, | |
| 509 | + 'href' => true, | |
| 510 | + 'target' => true, | |
| 511 | + 'rel' => true, | |
| 512 | + 'open' => true, | |
| 513 | + 'variant' => true, | |
| 365 | 514 | ) |
| 366 | 515 | ); |
| 367 | 516 | |
| 368 | 517 | $wpd_attrs = array_merge( |
| @@ -367,115 +516,218 @@ | ||
| 367 | 516 | |
| 368 | 517 | $wpd_attrs = array_merge( |
| 369 | 518 | $form_attrs, |
| 370 | 519 | array( |
| 371 | - 'gap' => true, | |
| 372 | - 'padding' => true, | |
| 373 | - 'align' => true, | |
| 374 | - 'justify' => true, | |
| 375 | - 'direction' => true, | |
| 376 | - 'wrap' => true, | |
| 377 | - 'inset' => true, | |
| 378 | - 'icon' => true, | |
| 379 | - 'tone' => true, | |
| 380 | - 'size' => true, | |
| 381 | - 'shape' => true, | |
| 382 | - 'badge' => true, | |
| 383 | - 'selectable' => true, | |
| 384 | - 'sticky-header' => true, | |
| 520 | + 'gap' => true, | |
| 521 | + 'padding' => true, | |
| 522 | + 'align' => true, | |
| 523 | + 'justify' => true, | |
| 524 | + 'direction' => true, | |
| 525 | + 'wrap' => true, | |
| 526 | + 'inset' => true, | |
| 527 | + 'icon' => true, | |
| 528 | + 'tone' => true, | |
| 529 | + 'size' => true, | |
| 530 | + 'shape' => true, | |
| 531 | + 'badge' => true, | |
| 532 | + 'selectable' => true, | |
| 533 | + 'sticky-header' => true, | |
| 385 | 534 | 'sticky-columns' => true, |
| 386 | - 'hover' => true, | |
| 387 | - 'striped' => true, | |
| 388 | - 'bordered' => true, | |
| 389 | - 'compact' => true, | |
| 390 | - 'loading' => true, | |
| 391 | - 'loading-rows' => true, | |
| 392 | - 'columns' => true, | |
| 393 | - 'rows' => true, | |
| 394 | - 'sortable' => true, | |
| 395 | - 'expandable' => true, | |
| 396 | - 'preset' => true, | |
| 397 | - 'label' => true, | |
| 398 | - 'description' => true, | |
| 399 | - 'orientation' => true, | |
| 400 | - 'level' => true, | |
| 401 | - 'collapsed' => true, | |
| 402 | - // `<wpd-form>` props + the `full-width` row span flag | |
| 535 | + 'hover' => true, | |
| 536 | + 'striped' => true, | |
| 537 | + 'bordered' => true, | |
| 538 | + 'compact' => true, | |
| 539 | + 'loading' => true, | |
| 540 | + 'loading-rows' => true, | |
| 541 | + 'empty' => true, | |
| 542 | + 'columns' => true, | |
| 543 | + 'rows' => true, | |
| 544 | + 'sortable' => true, | |
| 545 | + 'expandable' => true, | |
| 546 | + 'preset' => true, | |
| 547 | + 'label' => true, | |
| 548 | + 'heading' => true, | |
| 549 | + 'description' => true, | |
| 550 | + 'orientation' => true, | |
| 551 | + 'level' => true, | |
| 552 | + 'collapsed' => true, | |
| 553 | + // `<os-form>` props + the `full-width` row span flag | |
| 403 | 554 | // honoured by the form's slotted-child layout rule. |
| 404 | - 'submit-label' => true, | |
| 405 | - 'reset-label' => true, | |
| 406 | - 'busy' => true, | |
| 407 | - 'error' => true, | |
| 408 | - 'min-column' => true, | |
| 409 | - 'show-reset' => true, | |
| 410 | - 'reveal' => true, | |
| 411 | - 'full-width' => true, | |
| 555 | + 'submit-label' => true, | |
| 556 | + 'reset-label' => true, | |
| 557 | + 'busy' => true, | |
| 558 | + 'error' => true, | |
| 559 | + 'min-column' => true, | |
| 560 | + 'show-reset' => true, | |
| 561 | + 'reveal' => true, | |
| 562 | + 'full-width' => true, | |
| 412 | 563 | ) |
| 413 | 564 | ); |
| 414 | 565 | |
| 415 | 566 | // Built-in HTML elements the templates rely on. |
| 416 | 567 | $extra = array( |
| 417 | - 'form' => $form_attrs, | |
| 418 | - 'fieldset' => $form_attrs, | |
| 419 | - 'legend' => $global_attrs, | |
| 420 | - 'label' => $form_attrs, | |
| 421 | - 'input' => $form_attrs, | |
| 422 | - 'select' => $form_attrs, | |
| 423 | - 'option' => $form_attrs, | |
| 424 | - 'optgroup' => $form_attrs, | |
| 425 | - 'textarea' => $form_attrs, | |
| 426 | - 'button' => $form_attrs, | |
| 427 | - 'output' => $form_attrs, | |
| 428 | - 'datalist' => $global_attrs, | |
| 429 | - 'progress' => $form_attrs, | |
| 430 | - 'meter' => $form_attrs, | |
| 431 | - 'details' => $global_attrs, | |
| 432 | - 'summary' => $global_attrs, | |
| 433 | - 'dialog' => $global_attrs, | |
| 434 | - 'header' => $global_attrs, | |
| 435 | - 'footer' => $global_attrs, | |
| 436 | - 'main' => $global_attrs, | |
| 437 | - 'nav' => $global_attrs, | |
| 438 | - 'section' => $global_attrs, | |
| 439 | - 'article' => $global_attrs, | |
| 440 | - 'aside' => $global_attrs, | |
| 441 | - 'figure' => $global_attrs, | |
| 568 | + 'form' => $form_attrs, | |
| 569 | + 'fieldset' => $form_attrs, | |
| 570 | + 'legend' => $global_attrs, | |
| 571 | + 'label' => $form_attrs, | |
| 572 | + 'input' => $form_attrs, | |
| 573 | + 'select' => $form_attrs, | |
| 574 | + 'option' => $form_attrs, | |
| 575 | + 'optgroup' => $form_attrs, | |
| 576 | + 'textarea' => $form_attrs, | |
| 577 | + 'button' => $form_attrs, | |
| 578 | + 'output' => $form_attrs, | |
| 579 | + 'datalist' => $global_attrs, | |
| 580 | + 'progress' => $form_attrs, | |
| 581 | + 'meter' => $form_attrs, | |
| 582 | + 'details' => $global_attrs, | |
| 583 | + 'summary' => $global_attrs, | |
| 584 | + 'dialog' => $global_attrs, | |
| 585 | + 'header' => $global_attrs, | |
| 586 | + 'footer' => $global_attrs, | |
| 587 | + 'main' => $global_attrs, | |
| 588 | + 'nav' => $global_attrs, | |
| 589 | + 'section' => $global_attrs, | |
| 590 | + 'article' => $global_attrs, | |
| 591 | + 'aside' => $global_attrs, | |
| 592 | + 'figure' => $global_attrs, | |
| 442 | 593 | 'figcaption' => $global_attrs, |
| 443 | - 'time' => array_merge( $global_attrs, array( 'datetime' => true ) ), | |
| 444 | - 'mark' => $global_attrs, | |
| 445 | - 'small' => $global_attrs, | |
| 446 | - 'svg' => array_merge( $global_attrs, array( 'viewbox' => true, 'width' => true, 'height' => true, 'fill' => true, 'stroke' => true, 'xmlns' => true ) ), | |
| 447 | - 'path' => array( 'd' => true, 'fill' => true, 'stroke' => true, 'stroke-width' => true, 'stroke-linecap' => true, 'stroke-linejoin' => true, 'class' => true ), | |
| 448 | - 'g' => array( 'class' => true, 'transform' => true, 'fill' => true ), | |
| 449 | - 'circle' => array( 'cx' => true, 'cy' => true, 'r' => true, 'fill' => true, 'stroke' => true, 'class' => true ), | |
| 450 | - 'rect' => array( 'x' => true, 'y' => true, 'width' => true, 'height' => true, 'rx' => true, 'ry' => true, 'fill' => true, 'stroke' => true, 'class' => true ), | |
| 451 | - 'line' => array( 'x1' => true, 'y1' => true, 'x2' => true, 'y2' => true, 'stroke' => true, 'stroke-width' => true, 'class' => true ), | |
| 452 | - 'polyline' => array( 'points' => true, 'fill' => true, 'stroke' => true, 'class' => true ), | |
| 453 | - 'polygon' => array( 'points' => true, 'fill' => true, 'stroke' => true, 'class' => true ), | |
| 454 | - 'use' => array( 'href' => true, 'class' => true ), | |
| 594 | + 'time' => array_merge( $global_attrs, array( 'datetime' => true ) ), | |
| 595 | + 'mark' => $global_attrs, | |
| 596 | + 'small' => $global_attrs, | |
| 597 | + 'svg' => array_merge( | |
| 598 | + $global_attrs, | |
| 599 | + array( | |
| 600 | + 'viewbox' => true, | |
| 601 | + 'width' => true, | |
| 602 | + 'height' => true, | |
| 603 | + 'fill' => true, | |
| 604 | + 'stroke' => true, | |
| 605 | + 'xmlns' => true, | |
| 606 | + ) | |
| 607 | + ), | |
| 608 | + 'path' => array( | |
| 609 | + 'd' => true, | |
| 610 | + 'fill' => true, | |
| 611 | + 'stroke' => true, | |
| 612 | + 'stroke-width' => true, | |
| 613 | + 'stroke-linecap' => true, | |
| 614 | + 'stroke-linejoin' => true, | |
| 615 | + 'class' => true, | |
| 616 | + ), | |
| 617 | + 'g' => array( | |
| 618 | + 'class' => true, | |
| 619 | + 'transform' => true, | |
| 620 | + 'fill' => true, | |
| 621 | + ), | |
| 622 | + 'circle' => array( | |
| 623 | + 'cx' => true, | |
| 624 | + 'cy' => true, | |
| 625 | + 'r' => true, | |
| 626 | + 'fill' => true, | |
| 627 | + 'stroke' => true, | |
| 628 | + 'class' => true, | |
| 629 | + ), | |
| 630 | + 'rect' => array( | |
| 631 | + 'x' => true, | |
| 632 | + 'y' => true, | |
| 633 | + 'width' => true, | |
| 634 | + 'height' => true, | |
| 635 | + 'rx' => true, | |
| 636 | + 'ry' => true, | |
| 637 | + 'fill' => true, | |
| 638 | + 'stroke' => true, | |
| 639 | + 'class' => true, | |
| 640 | + ), | |
| 641 | + 'line' => array( | |
| 642 | + 'x1' => true, | |
| 643 | + 'y1' => true, | |
| 644 | + 'x2' => true, | |
| 645 | + 'y2' => true, | |
| 646 | + 'stroke' => true, | |
| 647 | + 'stroke-width' => true, | |
| 648 | + 'class' => true, | |
| 649 | + ), | |
| 650 | + 'polyline' => array( | |
| 651 | + 'points' => true, | |
| 652 | + 'fill' => true, | |
| 653 | + 'stroke' => true, | |
| 654 | + 'class' => true, | |
| 655 | + ), | |
| 656 | + 'polygon' => array( | |
| 657 | + 'points' => true, | |
| 658 | + 'fill' => true, | |
| 659 | + 'stroke' => true, | |
| 660 | + 'class' => true, | |
| 661 | + ), | |
| 662 | + 'use' => array( | |
| 663 | + 'href' => true, | |
| 664 | + 'class' => true, | |
| 665 | + ), | |
| 455 | 666 | ); |
| 456 | 667 | |
| 457 | - // `<wpd-*>` web components — every shipped tag plus a permissive | |
| 668 | + // `<os-*>` web components — every shipped tag plus a permissive | |
| 458 | 669 | // open door for new ones added by plugin templates. |
| 459 | 670 | $wpd_tags = array( |
| 460 | - 'wpd-stack', 'wpd-cluster', 'wpd-grid', 'wpd-spacer', 'wpd-divider', | |
| 461 | - 'wpd-tabs', 'wpd-tab', 'wpd-tabpanel', | |
| 462 | - 'wpd-segmented', 'wpd-segment', | |
| 463 | - 'wpd-button', 'wpd-icon-button', 'wpd-button-group', | |
| 464 | - 'wpd-text-field', 'wpd-textarea', 'wpd-search-field', | |
| 465 | - 'wpd-select', 'wpd-option', 'wpd-checkbox', 'wpd-checkbox-label', | |
| 466 | - 'wpd-radio', 'wpd-radio-group', 'wpd-form', | |
| 467 | - 'wpd-switch', 'wpd-slider', | |
| 468 | - 'wpd-table', 'wpd-table-column', 'wpd-table-row', 'wpd-table-cell', | |
| 469 | - 'wpd-card', 'wpd-list', 'wpd-list-item', | |
| 470 | - 'wpd-badge', 'wpd-pill', 'wpd-tag', 'wpd-chip', | |
| 471 | - 'wpd-spinner', 'wpd-skeleton', 'wpd-empty-state', | |
| 472 | - 'wpd-tooltip', 'wpd-popover', 'wpd-menu', 'wpd-menu-item', | |
| 473 | - 'wpd-modal', 'wpd-drawer', 'wpd-toast', | |
| 474 | - 'wpd-icon', 'wpd-avatar', 'wpd-heading', 'wpd-text', 'wpd-link', | |
| 475 | - 'wpd-banner', 'wpd-alert', 'wpd-callout', | |
| 476 | - 'wpd-form-row', 'wpd-form-section', 'wpd-help-text', | |
| 477 | - 'wpd-toolbar', 'wpd-toolbar-group', | |
| 671 | + 'os-stack', | |
| 672 | + 'os-cluster', | |
| 673 | + 'os-grid', | |
| 674 | + 'os-spacer', | |
| 675 | + 'os-divider', | |
| 676 | + 'os-tabs', | |
| 677 | + 'os-tab', | |
| 678 | + 'os-tabpanel', | |
| 679 | + 'os-segmented', | |
| 680 | + 'os-segment', | |
| 681 | + 'os-button', | |
| 682 | + 'os-icon-button', | |
| 683 | + 'os-button-group', | |
| 684 | + 'os-text-field', | |
| 685 | + 'os-textarea', | |
| 686 | + 'os-search-field', | |
| 687 | + 'os-select', | |
| 688 | + 'os-option', | |
| 689 | + 'os-checkbox', | |
| 690 | + 'os-checkbox-label', | |
| 691 | + 'os-radio', | |
| 692 | + 'os-radio-group', | |
| 693 | + 'os-form', | |
| 694 | + 'os-switch', | |
| 695 | + 'os-slider', | |
| 696 | + 'os-table', | |
| 697 | + 'os-table-column', | |
| 698 | + 'os-table-row', | |
| 699 | + 'os-table-cell', | |
| 700 | + 'os-card', | |
| 701 | + 'os-list', | |
| 702 | + 'os-list-item', | |
| 703 | + 'os-badge', | |
| 704 | + 'os-pill', | |
| 705 | + 'os-tag', | |
| 706 | + 'os-chip', | |
| 707 | + 'os-spinner', | |
| 708 | + 'os-skeleton', | |
| 709 | + 'os-empty-state', | |
| 710 | + 'os-tooltip', | |
| 711 | + 'os-popover', | |
| 712 | + 'os-menu', | |
| 713 | + 'os-menu-item', | |
| 714 | + 'os-modal', | |
| 715 | + 'os-drawer', | |
| 716 | + 'os-toast', | |
| 717 | + 'os-icon', | |
| 718 | + 'os-avatar', | |
| 719 | + 'os-heading', | |
| 720 | + 'os-text', | |
| 721 | + 'os-link', | |
| 722 | + 'os-banner', | |
| 723 | + 'os-alert', | |
| 724 | + 'os-callout', | |
| 725 | + 'os-form-row', | |
| 726 | + 'os-form-section', | |
| 727 | + 'os-help-text', | |
| 728 | + 'os-toolbar', | |
| 729 | + 'os-toolbar-group', | |
| 478 | 730 | ); |
| 479 | 731 | foreach ( $wpd_tags as $tag ) { |
| 480 | 732 | $extra[ $tag ] = $wpd_attrs; |
| 481 | 733 | } |
| @@ -482,9 +734,9 @@ | ||
| 482 | 734 | |
| 483 | 735 | $allowed = array_merge( $base, $extra ); |
| 484 | 736 | |
| 485 | 737 | // Promote the framework's global attrs (`slot`, `part`, |
| 486 | - // `full-width`, `data-*`, `aria-*`, …) to EVERY allowed tag — | |
| 738 | + // `full-width`, `data-*`, common ARIA, …) to EVERY allowed tag — | |
| 487 | 739 | // otherwise plain wrappers like `<div slot="header">` lose |
| 488 | 740 | // their `slot` attribute on the way through kses and get |
| 489 | 741 | // projected into the default slot instead of the named one. |
| 490 | 742 | // Caught by inspection when the Add User form's header |
| @@ -506,21 +758,19 @@ | ||
| 506 | 758 | * Plugins registering their own native windows can extend the |
| 507 | 759 | * list with custom tags or attributes if their templates need |
| 508 | 760 | * markup not covered here. |
| 509 | 761 | * |
| 510 | - * @since 0.6.2 | |
| 511 | - * | |
| 512 | 762 | * @param array $allowed wp_kses-shaped allowlist. |
| 513 | 763 | */ |
| 514 | - return (array) apply_filters( 'desktop_mode_native_window_allowed_html', $allowed ); | |
| 764 | + return (array) apply_filters( 'openstation_native_window_allowed_html', $allowed ); | |
| 515 | 765 | } |
| 516 | 766 | |
| 517 | 767 | /** |
| 518 | 768 | * Run `wp_kses` on a native-window template body with the framework |
| 519 | - * allowlist, **auto-extending the allowlist with every `<wpd-*>` tag | |
| 769 | + * allowlist, **auto-extending the allowlist with every `<os-*>` tag | |
| 520 | 770 | * the template actually uses.** |
| 521 | 771 | * |
| 522 | - * The pain this fixes: each shipped `<wpd-*>` component had to be | |
| 772 | + * The pain this fixes: each shipped `<os-*>` component had to be | |
| 523 | 773 | * manually added to the `$wpd_tags` list above, and the failure mode |
| 524 | 774 | * of forgetting it was silent — kses would strip the tag, the |
| 525 | 775 | * template would render as a sea of unparented children, and you'd |
| 526 | 776 | * spend an afternoon working out why "the form has no buttons." |
| @@ -525,29 +775,27 @@ | ||
| 525 | 775 | * template would render as a sea of unparented children, and you'd |
| 526 | 776 | * spend an afternoon working out why "the form has no buttons." |
| 527 | 777 | * |
| 528 | 778 | * Plugin authors registering a new component now only need to |
| 529 | - * `defineComponent('wpd-foo', WpdFoo)` on the JS side and use | |
| 530 | - * `<wpd-foo>` in their template — this helper finds the tag at | |
| 779 | + * `defineComponent('os-foo', OsFoo)` on the JS side and use | |
| 780 | + * `<os-foo>` in their template — this helper finds the tag at | |
| 531 | 781 | * render time, tags it onto the allowlist with the standard |
| 532 | 782 | * permissive attrs, and runs kses with the extended list. |
| 533 | 783 | * |
| 534 | 784 | * Every callsite in the framework that previously did the |
| 535 | - * `wp_kses( $html, desktop_mode_native_window_allowed_html() )` | |
| 785 | + * `wp_kses( $html, openstation_native_window_allowed_html() )` | |
| 536 | 786 | * dance can call this instead and get tag-discovery for free. |
| 537 | 787 | * |
| 538 | - * @since 0.8.1 | |
| 539 | - * | |
| 540 | 788 | * @param string $html Template HTML to sanitize. |
| 541 | 789 | * @return string Sanitized HTML. |
| 542 | 790 | */ |
| 543 | -function desktop_mode_kses_native_window_template( $html ) { | |
| 544 | - $allowed = desktop_mode_native_window_allowed_html(); | |
| 791 | +function openstation_kses_native_window_template( $html ) { | |
| 792 | + $allowed = openstation_native_window_allowed_html(); | |
| 545 | 793 | |
| 546 | - if ( preg_match_all( '/<(wpd-[a-z][a-z0-9-]*)\b/i', (string) $html, $matches ) ) { | |
| 547 | - $unique = array_unique( array_map( 'strtolower', $matches[1] ) ); | |
| 548 | - $wpd_attrs = isset( $allowed['wpd-button'] ) | |
| 549 | - ? $allowed['wpd-button'] | |
| 794 | + if ( preg_match_all( '/<(os-[a-z][a-z0-9-]*)\b/i', (string) $html, $matches ) ) { | |
| 795 | + $unique = array_unique( array_map( 'strtolower', $matches[1] ) ); | |
| 796 | + $wpd_attrs = isset( $allowed['os-button'] ) | |
| 797 | + ? $allowed['os-button'] | |
| 550 | 798 | : array(); |
| 551 | 799 | foreach ( $unique as $tag ) { |
| 552 | 800 | if ( ! isset( $allowed[ $tag ] ) ) { |
| 553 | 801 | $allowed[ $tag ] = $wpd_attrs; |
| @@ -560,11 +808,11 @@ | ||
| 560 | 808 | |
| 561 | 809 | /** |
| 562 | 810 | * Render a native window's template HTML to a string, wrapping |
| 563 | 811 | * with tabs when the window has at least one additional tab |
| 564 | - * registered. Shared by `desktop_mode_render_native_window_templates()` | |
| 812 | + * registered. Shared by `openstation_render_native_window_templates()` | |
| 565 | 813 | * (which emits the live `<template>` element) and |
| 566 | - * `desktop_mode_build_native_windows_payload()` (which captures the same | |
| 814 | + * `openstation_build_native_windows_payload()` (which captures the same | |
| 567 | 815 | * string for the shell config so mid-session activation can inject |
| 568 | 816 | * the template without a reload). |
| 569 | 817 | * |
| 570 | 818 | * Single-tab windows (no additional tabs registered) render the |
| @@ -570,19 +818,17 @@ | ||
| 570 | 818 | * Single-tab windows (no additional tabs registered) render the |
| 571 | 819 | * same flat body they always did — backwards-compatible with |
| 572 | 820 | * every existing caller. |
| 573 | 821 | * |
| 574 | - * @since 0.8.1 | |
| 575 | - * | |
| 576 | 822 | * @param array $entry Window registry entry. |
| 577 | 823 | * @return string Template body HTML (no outer `<template>` tag). |
| 578 | 824 | */ |
| 579 | -function desktop_mode_build_native_window_template_html( $entry ) { | |
| 825 | +function openstation_build_native_window_template_html( $entry ) { | |
| 580 | 826 | if ( ! is_array( $entry ) || ! is_callable( $entry['template'] ) ) { |
| 581 | 827 | return ''; |
| 582 | 828 | } |
| 583 | 829 | |
| 584 | - $tabs = desktop_mode_get_native_window_tabs( $entry['id'] ); | |
| 830 | + $tabs = openstation_get_native_window_tabs( $entry['id'] ); | |
| 585 | 831 | $has_extras = count( $tabs ) > 1; |
| 586 | 832 | |
| 587 | 833 | // Fast path — single-pane window, no wrapping. |
| 588 | 834 | if ( ! $has_extras ) { |
| @@ -590,21 +836,30 @@ | ||
| 590 | 836 | call_user_func( $entry['template'] ); |
| 591 | 837 | return (string) ob_get_clean(); |
| 592 | 838 | } |
| 593 | 839 | |
| 594 | - // Multi-tab window — wrap in <wpd-stack> + <wpd-tabs> + one | |
| 595 | - // <wpd-tabpanel> per tab. The default active tab is the main | |
| 596 | - // one (the window's own template). Plugin authors still get to | |
| 597 | - // declare their own tab-change side effects via the | |
| 598 | - // `wpd-tab-change` event bubbled by <wpd-tabs>. | |
| 840 | + // Multi-tab window — wrap in <os-stack> + one <os-tabpanel> per | |
| 841 | + // tab. The default active tab is the main one (the window's own | |
| 842 | + // template). | |
| 599 | 843 | // |
| 844 | + // The tab STRIP is deliberately absent from this markup. It is | |
| 845 | + // built by the shell in the window chrome, under the title bar, | |
| 846 | + // from the same tab metadata this function walks (the payload | |
| 847 | + // carries it as `tabs`). One tab strip per window, in one place, | |
| 848 | + // whether the window is an admin page in an iframe or a native | |
| 849 | + // window like this one. | |
| 850 | + // | |
| 851 | + // Plugin authors declare tab-change side effects by listening for | |
| 852 | + // `os-window-tab-change` on the window element; see | |
| 853 | + // docs/migration-window-tabs.md. | |
| 854 | + // | |
| 600 | 855 | // The wrap's padding is plugin-controllable two ways: |
| 601 | - // 1. `main_tab_padding` arg on `desktop_mode_register_window` — | |
| 602 | - // a per-window override. `0` opts into edge-to-edge | |
| 603 | - // content. | |
| 604 | - // 2. `desktop_mode_native_window_tab_wrap_padding` filter for | |
| 605 | - // late-bound overrides (e.g. a theme that wants every | |
| 606 | - // tabbed window to adopt a narrower inset). | |
| 856 | + // 1. `main_tab_padding` arg on `openstation_register_window` — | |
| 857 | + // a per-window override. `0` opts into edge-to-edge | |
| 858 | + // content. | |
| 859 | + // 2. `openstation_native_window_tab_wrap_padding` filter for | |
| 860 | + // late-bound overrides (e.g. a theme that wants every | |
| 861 | + // tabbed window to adopt a narrower inset). | |
| 607 | 862 | // Default stays 16px so existing plugins don't shift. |
| 608 | 863 | $default_padding = isset( $entry['main_tab_padding'] ) |
| 609 | 864 | && '' !== (string) $entry['main_tab_padding'] |
| 610 | 865 | ? (int) $entry['main_tab_padding'] |
| @@ -611,9 +866,9 @@ | ||
| 611 | 866 | : 16; |
| 612 | 867 | /** |
| 613 | 868 | * Filters the padding (in px) applied to the auto-generated |
| 614 | 869 | * tab wrap around a native window's template body. The shell |
| 615 | - * emits the wrap as `<wpd-stack padding="N">`; the CSS-as- | |
| 870 | + * emits the wrap as `<os-stack padding="N">`; the CSS-as- | |
| 616 | 871 | * attribute pipeline at the client translates that to |
| 617 | 872 | * `style.padding`. |
| 618 | 873 | * |
| 619 | 874 | * Return `0` for edge-to-edge content. Negative values are |
| @@ -618,15 +873,13 @@ | ||
| 618 | 873 | * |
| 619 | 874 | * Return `0` for edge-to-edge content. Negative values are |
| 620 | 875 | * clamped to 0. |
| 621 | 876 | * |
| 622 | - * @since 0.8.1 | |
| 623 | - * | |
| 624 | 877 | * @param int $padding Default padding in px. |
| 625 | 878 | * @param string $window_id The native window id. |
| 626 | 879 | */ |
| 627 | 880 | $padding = (int) apply_filters( |
| 628 | - 'desktop_mode_native_window_tab_wrap_padding', | |
| 881 | + 'openstation_native_window_tab_wrap_padding', | |
| 629 | 882 | $default_padding, |
| 630 | 883 | (string) $entry['id'] |
| 631 | 884 | ); |
| 632 | 885 | if ( $padding < 0 ) { |
| @@ -632,36 +885,25 @@ | ||
| 632 | 885 | if ( $padding < 0 ) { |
| 633 | 886 | $padding = 0; |
| 634 | 887 | } |
| 635 | 888 | |
| 636 | - $buffer = sprintf( | |
| 637 | - '<wpd-stack gap="12" padding="%d">', | |
| 889 | + $buffer = sprintf( | |
| 890 | + '<os-stack gap="12" padding="%d">', | |
| 638 | 891 | $padding |
| 639 | 892 | ); |
| 640 | - $buffer .= '<wpd-tabs value="' . esc_attr( DESKTOP_MODE_NATIVE_WINDOW_MAIN_TAB ) . '">'; | |
| 641 | - foreach ( $tabs as $tab ) { | |
| 642 | - $buffer .= sprintf( | |
| 643 | - '<wpd-tab value="%s">%s</wpd-tab>', | |
| 644 | - esc_attr( $tab['value'] ), | |
| 645 | - esc_html( $tab['label'] ) | |
| 646 | - ); | |
| 647 | - } | |
| 648 | - $buffer .= '</wpd-tabs>'; | |
| 649 | 893 | |
| 650 | 894 | // Stamp `hidden` on every non-active panel directly in the |
| 651 | - // emitted HTML. The client-side `<wpd-tabs>` syncs panel | |
| 652 | - // visibility on `value` changes, but its initial sync runs | |
| 653 | - // inside a microtask — and panel siblings may not have upgraded | |
| 654 | - // in time on first paint. Setting the attribute server-side | |
| 655 | - // makes first paint correct regardless of upgrade order; the JS | |
| 656 | - // keeps owning subsequent transitions. | |
| 895 | + // emitted HTML. The shell takes over panel visibility as soon as | |
| 896 | + // it declares the strip, but that happens after the template is | |
| 897 | + // in the body — setting the attribute server-side makes first | |
| 898 | + // paint correct rather than flashing every pane at once. | |
| 657 | 899 | foreach ( $tabs as $tab ) { |
| 658 | 900 | if ( ! is_callable( $tab['template'] ) ) { |
| 659 | 901 | continue; |
| 660 | 902 | } |
| 661 | - $is_active = DESKTOP_MODE_NATIVE_WINDOW_MAIN_TAB === $tab['value']; | |
| 903 | + $is_active = OPENSTATION_NATIVE_WINDOW_MAIN_TAB === $tab['value']; | |
| 662 | 904 | $buffer .= sprintf( |
| 663 | - '<wpd-tabpanel for="%s"%s>', | |
| 905 | + '<os-tabpanel for="%s"%s>', | |
| 664 | 906 | esc_attr( $tab['value'] ), |
| 665 | 907 | $is_active ? '' : ' hidden' |
| 666 | 908 | ); |
| 667 | 909 | ob_start(); |
| @@ -666,37 +908,99 @@ | ||
| 666 | 908 | ); |
| 667 | 909 | ob_start(); |
| 668 | 910 | call_user_func( $tab['template'] ); |
| 669 | 911 | $buffer .= (string) ob_get_clean(); |
| 670 | - $buffer .= '</wpd-tabpanel>'; | |
| 912 | + $buffer .= '</os-tabpanel>'; | |
| 671 | 913 | } |
| 672 | 914 | |
| 673 | - $buffer .= '</wpd-stack>'; | |
| 915 | + $buffer .= '</os-stack>'; | |
| 674 | 916 | return $buffer; |
| 675 | 917 | } |
| 676 | 918 | |
| 677 | 919 | /** |
| 678 | - * Enqueue every registered native window's script when the shell | |
| 679 | - * is active. Runs on `admin_enqueue_scripts` alongside the main | |
| 680 | - * shell enqueue so ordering (shell → plugin scripts) is | |
| 681 | - * deterministic. | |
| 920 | + * Run a native window's registered `config` through the | |
| 921 | + * `openstation_native_window_config` filter, normalized to an array. | |
| 682 | 922 | * |
| 683 | - * @since 0.8.1 | |
| 923 | + * Called at BOTH serialization points — the eager inline-script | |
| 924 | + * attach in `openstation_enqueue_native_window_scripts()` and the | |
| 925 | + * lazy `scriptL10n` synthesis in | |
| 926 | + * `openstation_build_native_windows_payload()` — so the filter sees | |
| 927 | + * every copy of the blob that can reach a browser. | |
| 928 | + * | |
| 929 | + * @param array $entry Registry entry (needs `id`; `config` optional). | |
| 930 | + * @return array Filtered config. Empty array when nothing to ship. | |
| 684 | 931 | */ |
| 685 | -function desktop_mode_enqueue_native_window_scripts() { | |
| 686 | - if ( ! desktop_mode_is_enabled() || desktop_mode_is_chromeless_request() || desktop_mode_is_classic_request() ) { | |
| 932 | +function openstation_filter_native_window_config( $entry ) { | |
| 933 | + $config = isset( $entry['config'] ) && is_array( $entry['config'] ) | |
| 934 | + ? $entry['config'] | |
| 935 | + : array(); | |
| 936 | + | |
| 937 | + /** | |
| 938 | + * Filter a native window's config blob at emit time. | |
| 939 | + * | |
| 940 | + * The registry snapshots `config` when `openstation_register_window()` | |
| 941 | + * runs — usually `init`. This filter runs when the blob is | |
| 942 | + * serialized for the browser (enqueue time on the eager path, | |
| 943 | + * payload-build time on the lazy path), so values that depend on | |
| 944 | + * hooks registered later in the bootstrap can be refreshed without | |
| 945 | + * moving the whole registration. The WP Explorer uses it to | |
| 946 | + * re-collect `previewActions` so plugins may add | |
| 947 | + * `openstation_my_wordpress_preview_actions` callbacks any time | |
| 948 | + * during a normal bootstrap, not just before `init` 99. | |
| 949 | + * | |
| 950 | + * Runs per request, after the current user is determined — | |
| 951 | + * capability-gated values are safe to compute here. | |
| 952 | + * | |
| 953 | + * **Status: Experimental** | |
| 954 | + * | |
| 955 | + * @param array $config Config blob as registered (empty array | |
| 956 | + * when the window registered none). | |
| 957 | + * @param string $window_id Native window id. | |
| 958 | + */ | |
| 959 | + $config = apply_filters( 'openstation_native_window_config', $config, (string) $entry['id'] ); | |
| 960 | + | |
| 961 | + return is_array( $config ) ? $config : array(); | |
| 962 | +} | |
| 963 | + | |
| 964 | +/** | |
| 965 | + * Attach every registered native window's script data, and enqueue | |
| 966 | + * the handful of bundles that asked to load at boot. | |
| 967 | + * | |
| 968 | + * **A native window's bundle is not enqueued here.** It loads the | |
| 969 | + * first time the window opens: the shell reads the render callback | |
| 970 | + * off `window.openStationNativeWindows[ <id> ]` at open time, so a | |
| 971 | + * bundle printed at boot is weight on every admin page the window is | |
| 972 | + * never opened from — and between WP Explorer, Posts, Plugins, | |
| 973 | + * Comments, the Recycle Bin, Content Graph, Games and the agent | |
| 974 | + * runner that came to well over a megabyte before a single window | |
| 975 | + * had been clicked. `preload_script` is the opt-out for a bundle | |
| 976 | + * with a genuine boot-time job. | |
| 977 | + * | |
| 978 | + * What still happens for EVERY window is the data attach: the | |
| 979 | + * localize blob and the `config` inline. Those hang off the | |
| 980 | + * REGISTERED handle whether or not it is enqueued, which is exactly | |
| 981 | + * how the lazy path gets them — `openstation_resolve_script_payload()` | |
| 982 | + * harvests both into the payload for the shell to replay around the | |
| 983 | + * script tag it injects. Hence priority 5: `openstation_enqueue_assets()` | |
| 984 | + * builds that payload at 10, and data attached after it would ship a | |
| 985 | + * bundle with no config. | |
| 986 | + */ | |
| 987 | +function openstation_enqueue_native_window_scripts() { | |
| 988 | + if ( ! openstation_is_shell_request() ) { | |
| 687 | 989 | return; |
| 688 | 990 | } |
| 689 | - $registry = desktop_mode_native_window_registry(); | |
| 991 | + $registry = openstation_native_window_registry(); | |
| 690 | 992 | if ( ! is_array( $registry ) ) { |
| 691 | 993 | return; |
| 692 | 994 | } |
| 693 | 995 | foreach ( $registry as $entry ) { |
| 694 | - // Enqueue per-tab scripts — each tab registration can carry | |
| 695 | - // its own script handle so a tab's JS module stays scoped to | |
| 696 | - // that tab. Main tab uses the window's own `script`; it's | |
| 697 | - // enqueued below alongside the localize call. | |
| 698 | - $tabs = desktop_mode_get_native_window_tabs( $entry['id'] ); | |
| 996 | + $preload = ! empty( $entry['preload_script'] ); | |
| 997 | + | |
| 998 | + // Per-tab scripts stay eager. The shell has no lazy path for | |
| 999 | + // them — a tab's script is not part of the window's own | |
| 1000 | + // bundle chain — so deferring here would simply break the | |
| 1001 | + // tab. The main tab uses the window's own `script`. | |
| 1002 | + $tabs = openstation_get_native_window_tabs( $entry['id'] ); | |
| 699 | 1003 | foreach ( $tabs as $tab ) { |
| 700 | 1004 | if ( $tab['is_main'] || empty( $tab['script'] ) ) { |
| 701 | 1005 | continue; |
| 702 | 1006 | } |
| @@ -705,25 +1009,38 @@ | ||
| 705 | 1009 | |
| 706 | 1010 | if ( empty( $entry['script'] ) ) { |
| 707 | 1011 | continue; |
| 708 | 1012 | } |
| 709 | - wp_enqueue_script( $entry['script'] ); | |
| 1013 | + if ( $preload ) { | |
| 1014 | + wp_enqueue_script( $entry['script'] ); | |
| 1015 | + foreach ( (array) $entry['scripts'] as $companion ) { | |
| 1016 | + wp_enqueue_script( $companion ); | |
| 1017 | + } | |
| 1018 | + // Preload means "everything at boot" — companion styles | |
| 1019 | + // ride along so the window paints styled on a preloaded | |
| 1020 | + // first open, same as its scripts are already parsed. | |
| 1021 | + if ( ! empty( $entry['styles'] ) ) { | |
| 1022 | + foreach ( (array) $entry['styles'] as $companion_style ) { | |
| 1023 | + wp_enqueue_style( $companion_style ); | |
| 1024 | + } | |
| 1025 | + } | |
| 1026 | + } | |
| 710 | 1027 | // Localize the config the JS side reads to register itself. |
| 711 | 1028 | wp_localize_script( |
| 712 | 1029 | $entry['script'], |
| 713 | - 'desktopModeNativeWindow_' . str_replace( '-', '_', $entry['id'] ), | |
| 1030 | + 'openStationNativeWindow_' . str_replace( '-', '_', $entry['id'] ), | |
| 714 | 1031 | array( |
| 715 | - 'id' => $entry['id'], | |
| 716 | - 'title' => $entry['title'], | |
| 717 | - 'icon' => $entry['icon'], | |
| 718 | - 'width' => $entry['width'], | |
| 719 | - 'height' => $entry['height'], | |
| 720 | - 'minWidth' => $entry['min_width'], | |
| 721 | - 'minHeight' => $entry['min_height'], | |
| 722 | - 'placement' => $entry['placement'], | |
| 723 | - 'autofocus' => $entry['autofocus'], | |
| 724 | - 'templateId' => 'desktop-mode-native-window-' . $entry['id'], | |
| 725 | - 'tabs' => array_map( | |
| 1032 | + 'id' => $entry['id'], | |
| 1033 | + 'title' => $entry['title'], | |
| 1034 | + 'icon' => $entry['icon'], | |
| 1035 | + 'width' => $entry['width'], | |
| 1036 | + 'height' => $entry['height'], | |
| 1037 | + 'minWidth' => $entry['min_width'], | |
| 1038 | + 'minHeight' => $entry['min_height'], | |
| 1039 | + 'placement' => $entry['placement'], | |
| 1040 | + 'autofocus' => $entry['autofocus'], | |
| 1041 | + 'templateId' => 'os-native-window-' . $entry['id'], | |
| 1042 | + 'tabs' => array_map( | |
| 726 | 1043 | static function ( $tab ) { |
| 727 | 1044 | return array( |
| 728 | 1045 | 'value' => $tab['value'], |
| 729 | 1046 | 'label' => $tab['label'], |
| @@ -734,23 +1051,26 @@ | ||
| 734 | 1051 | ), |
| 735 | 1052 | ) |
| 736 | 1053 | ); |
| 737 | 1054 | |
| 738 | - // Bundle-bound `config` (since 0.6.0). Ships through | |
| 739 | - // `wp_add_inline_script` `'before'` so it lands on the eager | |
| 740 | - // path the same way `wp_localize_script` does, AND through | |
| 741 | - // the lazy-load payload (see `desktop_mode_resolve_script_payload`) | |
| 742 | - // so the same data is available even when the script is | |
| 743 | - // dynamically injected mid-session. The bundle reads it via | |
| 744 | - // `wp.desktop.getWindowConfig( id )` or directly at | |
| 745 | - // `window.desktopModeWindowConfig[ id ]`. | |
| 746 | - if ( ! empty( $entry['config'] ) && is_array( $entry['config'] ) ) { | |
| 1055 | + // Bundle-bound `config`, for the eager print path only. | |
| 1056 | + // `openstation_build_native_windows_payload()` synthesizes the | |
| 1057 | + // same assignment into the payload's `scriptL10n`, which is | |
| 1058 | + // what delivers it on the lazy path — and it has to, because | |
| 1059 | + // that payload is also built inside chromeless iframes, where | |
| 1060 | + // this function returns early. Attaching here unconditionally | |
| 1061 | + // would mean a shell page shipped the identical assignment | |
| 1062 | + // twice: once as `before`, once as `l10n`. The bundle reads it | |
| 1063 | + // via `wp.os.getWindowConfig( id )` or directly at | |
| 1064 | + // `window.openStationWindowConfig[ id ]`. | |
| 1065 | + $config = openstation_filter_native_window_config( $entry ); | |
| 1066 | + if ( $preload && ! empty( $config ) ) { | |
| 747 | 1067 | wp_add_inline_script( |
| 748 | 1068 | $entry['script'], |
| 749 | 1069 | sprintf( |
| 750 | - 'window.desktopModeWindowConfig=window.desktopModeWindowConfig||{};window.desktopModeWindowConfig[%s]=%s;', | |
| 1070 | + 'window.openStationWindowConfig=window.openStationWindowConfig||{};window.openStationWindowConfig[%s]=%s;', | |
| 751 | 1071 | wp_json_encode( $entry['id'] ), |
| 752 | - wp_json_encode( $entry['config'] ) | |
| 1072 | + wp_json_encode( $config ) | |
| 753 | 1073 | ), |
| 754 | 1074 | 'before' |
| 755 | 1075 | ); |
| 756 | 1076 | } |
| @@ -755,23 +1075,21 @@ | ||
| 755 | 1075 | ); |
| 756 | 1076 | } |
| 757 | 1077 | } |
| 758 | 1078 | } |
| 759 | -add_action( 'admin_enqueue_scripts', 'desktop_mode_enqueue_native_window_scripts', 20 ); | |
| 1079 | +add_action( 'admin_enqueue_scripts', 'openstation_enqueue_native_window_scripts', 5 ); | |
| 760 | 1080 | |
| 761 | 1081 | /** |
| 762 | 1082 | * Emit a `<template>` tag for every registered native window on |
| 763 | 1083 | * `admin_footer` when the shell is active. The JS side resolves |
| 764 | - * these via `document.getElementById( `desktop-mode-native-window-${id}` )` | |
| 1084 | + * these via `document.getElementById( `os-native-window-${id}` )` | |
| 765 | 1085 | * and clones them into each opened window's body. |
| 766 | - * | |
| 767 | - * @since 0.8.1 | |
| 768 | 1086 | */ |
| 769 | -function desktop_mode_render_native_window_templates() { | |
| 770 | - if ( ! desktop_mode_is_enabled() || desktop_mode_is_chromeless_request() || desktop_mode_is_classic_request() ) { | |
| 1087 | +function openstation_render_native_window_templates() { | |
| 1088 | + if ( ! openstation_is_shell_request() ) { | |
| 771 | 1089 | return; |
| 772 | 1090 | } |
| 773 | - $registry = desktop_mode_native_window_registry(); | |
| 1091 | + $registry = openstation_native_window_registry(); | |
| 774 | 1092 | if ( ! is_array( $registry ) ) { |
| 775 | 1093 | return; |
| 776 | 1094 | } |
| 777 | 1095 | foreach ( $registry as $entry ) { |
| @@ -777,21 +1095,38 @@ | ||
| 777 | 1095 | foreach ( $registry as $entry ) { |
| 778 | 1096 | if ( ! is_callable( $entry['template'] ) ) { |
| 779 | 1097 | continue; |
| 780 | 1098 | } |
| 781 | - $html = desktop_mode_build_native_window_template_html( $entry ); | |
| 1099 | + $html = openstation_build_native_window_template_html( $entry ); | |
| 782 | 1100 | if ( '' === $html ) { |
| 783 | 1101 | continue; |
| 784 | 1102 | } |
| 785 | 1103 | printf( |
| 786 | - '<template id="desktop-mode-native-window-%s">', | |
| 1104 | + '<template id="os-native-window-%s">', | |
| 787 | 1105 | esc_attr( $entry['id'] ) |
| 788 | 1106 | ); |
| 789 | - // `desktop_mode_kses_native_window_template()` auto-extends | |
| 790 | - // the allowlist with any `<wpd-*>` tag the template carries | |
| 1107 | + // `openstation_kses_native_window_template()` auto-extends | |
| 1108 | + // the allowlist with any `<os-*>` tag the template carries | |
| 791 | 1109 | // — so plugin authors never have to remember to register |
| 792 | 1110 | // their custom component tags in the kses list. |
| 793 | - echo desktop_mode_kses_native_window_template( $html ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- helper kses-escapes. | |
| 1111 | + echo openstation_kses_native_window_template( $html ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- helper kses-escapes. | |
| 794 | 1112 | echo '</template>'; |
| 795 | 1113 | } |
| 796 | 1114 | } |
| 797 | -add_action( 'admin_footer', 'desktop_mode_render_native_window_templates', 20 ); | |
| 1115 | +add_action( 'admin_footer', 'openstation_render_native_window_templates', 20 ); | |
| 1116 | + | |
| 1117 | +/** | |
| 1118 | + * Whether a registered window is offered on the admin this request is | |
| 1119 | + * in: the network admin's shell offers `network` and `any` windows, | |
| 1120 | + * every site's shell offers `site` and `any`. See the `admin` arg of | |
| 1121 | + * {@see openstation_register_window()}. | |
| 1122 | + * | |
| 1123 | + * @param array<string,mixed> $entry Registry entry. | |
| 1124 | + * @return bool | |
| 1125 | + */ | |
| 1126 | +function openstation_native_window_offered_here( $entry ) { | |
| 1127 | + $admin = isset( $entry['admin'] ) ? (string) $entry['admin'] : 'site'; | |
| 1128 | + if ( 'any' === $admin ) { | |
| 1129 | + return true; | |
| 1130 | + } | |
| 1131 | + return is_network_admin() ? 'network' === $admin : 'site' === $admin; | |
| 1132 | +} | |
