| @@ -54,8 +54,16 @@ | ||
| 54 | 54 | if ( ! empty( $item[1] ) && ! current_user_can( $item[1] ) ) { |
| 55 | 55 | continue; |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | + // Skip menus something took out of the classic sidebar. A dock | |
| 59 | + // that shows what wp-admin hides isn't a faithful mirror of the | |
| 60 | + // menu, and on WordPress.com it double-renders every entry | |
| 61 | + // Jetpack replaced with a Calypso link. | |
| 62 | + if ( openstation_menu_item_is_hidden( $item ) ) { | |
| 63 | + continue; | |
| 64 | + } | |
| 65 | + | |
| 58 | 66 | $title = openstation_menu_item_title( $item[0] ); |
| 59 | 67 | |
| 60 | 68 | // Extract badge count from the title HTML. |
| 61 | 69 | $badge = 0; |
| @@ -83,9 +91,21 @@ | ||
| 83 | 91 | |
| 84 | 92 | // Determine the icon. Menu entries can set `$item[6]` to anything |
| 85 | 93 | // — a dashicon class, a remote URL, a data:URI, 'none', or 'div' |
| 86 | 94 | // — so normalize before we serialize it for the shell JS. |
| 87 | - $icon = openstation_sanitize_dock_icon( $item[6] ?? '' ); | |
| 95 | + // | |
| 96 | + // A blanked value falls back to whatever the row carried before | |
| 97 | + // anything on `admin_menu` rewrote it, which is how plugin | |
| 98 | + // artwork survives Jetpack's SVG-to-stylesheet move on | |
| 99 | + // WordPress.com — see `openstation_snapshot_menu_icons()`. | |
| 100 | + $raw_icon = (string) ( $item[6] ?? '' ); | |
| 101 | + if ( '' === $raw_icon || 'none' === $raw_icon || 'div' === $raw_icon ) { | |
| 102 | + $snapshot = openstation_menu_icon_snapshot(); | |
| 103 | + if ( isset( $snapshot[ $item[2] ] ) ) { | |
| 104 | + $raw_icon = $snapshot[ $item[2] ]; | |
| 105 | + } | |
| 106 | + } | |
| 107 | + $icon = openstation_sanitize_dock_icon( $raw_icon ); | |
| 88 | 108 | |
| 89 | 109 | // Build the full URL for the menu item. |
| 90 | 110 | // |
| 91 | 111 | // `$parent_url` is the slug-derived URL (`admin.php?page=<slug>` |
| @@ -93,11 +113,20 @@ | ||
| 93 | 113 | // reference value the self-link strip below compares against. |
| 94 | 114 | // The effective `$url` we ship to the shell can be rewritten |
| 95 | 115 | // further down to the first visible submenu's URL — see the |
| 96 | 116 | // note after the loop. |
| 97 | - $parent_url = openstation_menu_item_url( $item[2] ); | |
| 98 | - $url = $parent_url; | |
| 117 | + $parent_url = openstation_menu_item_url( $item[2] ); | |
| 118 | + $parent_external = openstation_menu_item_is_external( $parent_url ); | |
| 99 | 119 | |
| 120 | + // A menu owned by a regular plugin is allowed to keep off-site | |
| 121 | + // children — a docs or support link under a plugin's own menu is | |
| 122 | + // a normal thing to ship, and the flyout marks it as leaving the | |
| 123 | + // site. Everything else drops them: a Core menu whose child was | |
| 124 | + // repointed off-site (WordPress.com does this to Appearance → | |
| 125 | + // Themes) gets its wp-admin original back instead, below. | |
| 126 | + $plugin_file = openstation_resolve_menu_plugin_file( $item[2] ); | |
| 127 | + $allow_external_subs = null !== $plugin_file && ! $parent_external; | |
| 128 | + | |
| 100 | 129 | // Build submenu items. |
| 101 | 130 | // |
| 102 | 131 | // WordPress auto-prepends a self-link entry to every parent |
| 103 | 132 | // menu's `$submenu[$slug]` (the first child shares the parent's |
| @@ -113,10 +142,18 @@ | ||
| 113 | 142 | // |
| 114 | 143 | // Detection by URL (post-`openstation_menu_item_url()` normalize) |
| 115 | 144 | // rather than slug equality covers plugins that register a child |
| 116 | 145 | // at a different slug pointing at the parent's URL. |
| 117 | - $sub_items = array(); | |
| 118 | - $first_visible_sub_url = null; | |
| 146 | + // | |
| 147 | + // Two passes, because the second decision depends on the first: | |
| 148 | + // a `hide-if-js` row is normally noise, but when it is the | |
| 149 | + // wp-admin original of an off-site row we just dropped, it is | |
| 150 | + // the route back to the page Core intended. The original takes | |
| 151 | + // the replacement's place in the list, so the menu reads the way | |
| 152 | + // it would have if nothing had swapped the row out. | |
| 153 | + $rows = array(); | |
| 154 | + $restore_slots = array(); | |
| 155 | + $dropped_off_site = 0; | |
| 119 | 156 | if ( ! empty( $submenu[ $item[2] ] ) ) { |
| 120 | 157 | foreach ( $submenu[ $item[2] ] as $sub_item ) { |
| 121 | 158 | if ( ! empty( $sub_item[1] ) && ! current_user_can( $sub_item[1] ) ) { |
| 122 | 159 | continue; |
| @@ -126,41 +163,208 @@ | ||
| 126 | 163 | // class; the semantics are "shown by default; hide only |
| 127 | 164 | // when `<body class=\"no-customize-support\">`". The |
| 128 | 165 | // Customizer is supported inside chromeless iframes, so |
| 129 | 166 | // these entries belong in the dock. |
| 130 | - $sub_url = openstation_menu_item_url( $sub_item[2] ); | |
| 131 | - // Capture the first capability-passing submenu URL so | |
| 132 | - // we can use it as the parent's effective URL below | |
| 133 | - // (mirrors `wp-admin/menu-header.php`). Captured BEFORE | |
| 134 | - // the self-link strip so plugins whose first submenu IS | |
| 135 | - // the auto-prepended self-link land on the parent URL | |
| 136 | - // (a no-op rewrite — preserves existing behavior). | |
| 137 | - if ( null === $first_visible_sub_url ) { | |
| 138 | - $first_visible_sub_url = $sub_url; | |
| 167 | + $sub_url = openstation_menu_item_url( $sub_item[2] ); | |
| 168 | + $sub_external = openstation_menu_item_is_external( $sub_url ); | |
| 169 | + | |
| 170 | + if ( $sub_external && ! $allow_external_subs ) { | |
| 171 | + ++$dropped_off_site; | |
| 172 | + // Leave a slot behind, in case the wp-admin row this | |
| 173 | + // entry displaced is still in the list. | |
| 174 | + $dropped_title = openstation_menu_item_title( $sub_item[0] ); | |
| 175 | + if ( '' !== $dropped_title && ! isset( $restore_slots[ $dropped_title ] ) ) { | |
| 176 | + $rows[] = array( 'restore' => $dropped_title ); | |
| 177 | + $restore_slots[ $dropped_title ] = count( $rows ) - 1; | |
| 178 | + } | |
| 179 | + continue; | |
| 139 | 180 | } |
| 140 | - // Self-link strip — `$sub_url === $parent_url` covers | |
| 141 | - // WP's auto-prepended entry AND any plugin-registered | |
| 142 | - // alias that happens to land on the parent URL. | |
| 143 | - if ( $sub_url === $parent_url ) { | |
| 144 | - continue; | |
| 181 | + | |
| 182 | + $rows[] = array( | |
| 183 | + 'raw_title' => $sub_item[0], | |
| 184 | + 'slug' => (string) $sub_item[2], | |
| 185 | + 'url' => $sub_url, | |
| 186 | + 'external' => $sub_external, | |
| 187 | + 'hidden' => openstation_menu_item_is_hidden( $sub_item ), | |
| 188 | + ); | |
| 189 | + } | |
| 190 | + } | |
| 191 | + | |
| 192 | + // Second pass. A hidden row moves into the slot its replacement | |
| 193 | + // left; one whose replacement was the top-level slug itself | |
| 194 | + // stays where it is (there is no slot — the menu row is not part | |
| 195 | + // of this list). Every other hidden row, and every slot nothing | |
| 196 | + // claimed, drops out. | |
| 197 | + $restored = array(); | |
| 198 | + $keep = array_fill( 0, count( $rows ), true ); | |
| 199 | + foreach ( $rows as $i => $row ) { | |
| 200 | + if ( isset( $row['restore'] ) || ! $row['hidden'] ) { | |
| 201 | + continue; | |
| 202 | + } | |
| 203 | + $keep[ $i ] = false; | |
| 204 | + $row_title = openstation_menu_item_title( $row['raw_title'] ); | |
| 205 | + if ( '' === $row_title || isset( $restored[ $row_title ] ) ) { | |
| 206 | + continue; | |
| 207 | + } | |
| 208 | + if ( isset( $restore_slots[ $row_title ] ) ) { | |
| 209 | + $rows[ $restore_slots[ $row_title ] ] = $row; | |
| 210 | + $restored[ $row_title ] = true; | |
| 211 | + } elseif ( $parent_external && $row_title === $title ) { | |
| 212 | + // The menu's own row, hidden in place. WordPress builds | |
| 213 | + // a parent's self-link by copying the menu row's first | |
| 214 | + // four fields, so its label is the menu's label, which | |
| 215 | + // is what makes the comparison hold. | |
| 216 | + $keep[ $i ] = true; | |
| 217 | + $restored[ $row_title ] = true; | |
| 218 | + } | |
| 219 | + } | |
| 220 | + | |
| 221 | + // Last resort for a menu whose own slug points off-site: if | |
| 222 | + // nothing on-site survived, take the first hidden on-site row | |
| 223 | + // rather than lose the menu. The label comparison above is the | |
| 224 | + // precise answer and covers the ordinary case, but it breaks the | |
| 225 | + // moment a host relabels the menu row without relabelling the | |
| 226 | + // self-link it already generated. Showing a row someone hid | |
| 227 | + // beats dropping a working menu off the dock. | |
| 228 | + if ( $parent_external ) { | |
| 229 | + $has_on_site = false; | |
| 230 | + foreach ( $rows as $i => $row ) { | |
| 231 | + if ( ! isset( $row['restore'] ) && $keep[ $i ] && ! $row['external'] ) { | |
| 232 | + $has_on_site = true; | |
| 233 | + break; | |
| 145 | 234 | } |
| 146 | - // Skip entries with no resolvable title. Plugins (e.g. | |
| 147 | - // WooCommerce's `wc-addons` Extensions row) register | |
| 148 | - // `menu_title => null` to hide a row from classic admin's | |
| 149 | - // left menu while keeping the page reachable. Without | |
| 150 | - // this guard the dock renders an empty, label-less tab | |
| 151 | - // that visually duplicates a sibling entry. | |
| 152 | - $sub_title = openstation_menu_item_title( $sub_item[0] ); | |
| 153 | - if ( '' === $sub_title ) { | |
| 154 | - continue; | |
| 235 | + } | |
| 236 | + if ( ! $has_on_site ) { | |
| 237 | + foreach ( $rows as $i => $row ) { | |
| 238 | + if ( isset( $row['restore'] ) || ! $row['hidden'] || $row['external'] ) { | |
| 239 | + continue; | |
| 240 | + } | |
| 241 | + $keep[ $i ] = true; | |
| 242 | + break; | |
| 155 | 243 | } |
| 156 | - $sub_items[] = array( | |
| 157 | - 'title' => $sub_title, | |
| 158 | - 'url' => $sub_url, | |
| 159 | - ); | |
| 160 | 244 | } |
| 161 | 245 | } |
| 162 | 246 | |
| 247 | + $kept_rows = array(); | |
| 248 | + foreach ( $rows as $i => $row ) { | |
| 249 | + if ( isset( $row['restore'] ) || ! $keep[ $i ] ) { | |
| 250 | + continue; | |
| 251 | + } | |
| 252 | + $kept_rows[] = $row; | |
| 253 | + } | |
| 254 | + $rows = $kept_rows; | |
| 255 | + | |
| 256 | + // When the top-level slug itself points off-site, the menu's | |
| 257 | + // identity is now whichever child survived — adopt it before the | |
| 258 | + // self-link strip runs, so a restored original collapses into | |
| 259 | + // `selfLabel` instead of becoming a child that duplicates its | |
| 260 | + // own parent. | |
| 261 | + // | |
| 262 | + // Identity travels with it. Everything below keys off the menu's | |
| 263 | + // slug — whether it's a Core menu, whether a plugin owns it, | |
| 264 | + // whether it opens more than one window, and which slug the | |
| 265 | + // `openstation_dock_item` filter is told about. Left on the | |
| 266 | + // off-site slug, a rescued Plugins tile reads as a plugin menu | |
| 267 | + // owned by whoever registered the replacement, sorts to the far | |
| 268 | + // end of the dock, and offers to deactivate them. | |
| 269 | + $identity_slug = (string) $item[2]; | |
| 270 | + if ( $parent_external ) { | |
| 271 | + foreach ( $rows as $row ) { | |
| 272 | + if ( ! $row['external'] ) { | |
| 273 | + $parent_url = $row['url']; | |
| 274 | + $identity_slug = $row['slug']; | |
| 275 | + break; | |
| 276 | + } | |
| 277 | + } | |
| 278 | + } | |
| 279 | + | |
| 280 | + // A menu that only ever pointed at its children, and whose | |
| 281 | + // children we just took away. Checked only for menus the | |
| 282 | + // off-site rule actually touched, so a menu registering its page | |
| 283 | + // hook in some way we don't recognise is left exactly as it was. | |
| 284 | + $parent_is_container = $dropped_off_site > 0 | |
| 285 | + && ! $parent_external | |
| 286 | + && ! openstation_menu_slug_has_page( $item[2] ); | |
| 287 | + | |
| 288 | + $url = $parent_url; | |
| 289 | + $sub_items = array(); | |
| 290 | + $first_visible_sub_url = null; | |
| 291 | + $has_self_link = false; | |
| 292 | + $self_label = ''; | |
| 293 | + foreach ( $rows as $row ) { | |
| 294 | + $sub_url = $row['url']; | |
| 295 | + if ( $parent_is_container && $sub_url === $parent_url ) { | |
| 296 | + // A row pointing back at a menu with no page is a dead | |
| 297 | + // end, not a way back — it can't name the menu and it | |
| 298 | + // can't stand in for it. | |
| 299 | + continue; | |
| 300 | + } | |
| 301 | + // Capture the first capability-passing submenu URL so | |
| 302 | + // we can use it as the parent's effective URL below | |
| 303 | + // (mirrors `wp-admin/menu-header.php`). Captured BEFORE | |
| 304 | + // the self-link strip so plugins whose first submenu IS | |
| 305 | + // the auto-prepended self-link land on the parent URL | |
| 306 | + // (a no-op rewrite — preserves existing behavior). Never | |
| 307 | + // an off-site child, which would take the whole tile with | |
| 308 | + // it when the final external check runs. | |
| 309 | + if ( null === $first_visible_sub_url && ! $row['external'] ) { | |
| 310 | + $first_visible_sub_url = $sub_url; | |
| 311 | + } | |
| 312 | + // Self-link strip — `$sub_url === $parent_url` covers | |
| 313 | + // WP's auto-prepended entry AND any plugin-registered | |
| 314 | + // alias that happens to land on the parent URL. | |
| 315 | + if ( $sub_url === $parent_url ) { | |
| 316 | + $has_self_link = true; | |
| 317 | + // Keep its LABEL, though. The stripped entry is a | |
| 318 | + // real row in wp-admin's own menu ("All Posts", | |
| 319 | + // "All Pages"), and the constellation flyout lists | |
| 320 | + // it as the first thing the menu opens — a list of | |
| 321 | + // a menu's pages that omits its main page reads as | |
| 322 | + // a bug. | |
| 323 | + // | |
| 324 | + // Carried separately rather than left in `submenu` | |
| 325 | + // because `submenu` has two other consumers that | |
| 326 | + // need it to mean "distinct child links only": the | |
| 327 | + // in-window tab strip, which would grow a duplicate | |
| 328 | + // first tab, and the right-click popover, which is | |
| 329 | + // suppressed on `length === 0`. | |
| 330 | + // | |
| 331 | + // First one only — a plugin can register several | |
| 332 | + // aliases onto the parent URL, and the canonical | |
| 333 | + // self-link is the one WordPress prepends. | |
| 334 | + if ( '' === $self_label ) { | |
| 335 | + $self_label = openstation_menu_item_title( $row['raw_title'] ); | |
| 336 | + } | |
| 337 | + continue; | |
| 338 | + } | |
| 339 | + // Skip entries with no resolvable title. Plugins (e.g. | |
| 340 | + // WooCommerce's `wc-addons` Extensions row) register | |
| 341 | + // `menu_title => null` to hide a row from classic admin's | |
| 342 | + // left menu while keeping the page reachable. Without | |
| 343 | + // this guard the dock renders an empty, label-less tab | |
| 344 | + // that visually duplicates a sibling entry. | |
| 345 | + $sub_title = openstation_menu_item_title( $row['raw_title'] ); | |
| 346 | + if ( '' === $sub_title ) { | |
| 347 | + continue; | |
| 348 | + } | |
| 349 | + $sub_entry = array( | |
| 350 | + 'title' => $sub_title, | |
| 351 | + 'url' => $sub_url, | |
| 352 | + ); | |
| 353 | + if ( $row['external'] ) { | |
| 354 | + // Consumers that route a URL into a window skip these; | |
| 355 | + // the ones that can hand a link to the browser mark | |
| 356 | + // them as leaving the site. | |
| 357 | + // | |
| 358 | + // `offSite` rather than `external`: the window's tab | |
| 359 | + // strip already calls plugin-opened sub-iframe tabs | |
| 360 | + // "external" (`data-kind="external"`), and that is a | |
| 361 | + // different thing entirely. | |
| 362 | + $sub_entry['offSite'] = true; | |
| 363 | + } | |
| 364 | + $sub_items[] = $sub_entry; | |
| 365 | + } | |
| 366 | + | |
| 163 | 367 | // Mirror `wp-admin/menu-header.php`: when a parent menu has any |
| 164 | 368 | // visible submenu, classic admin rewrites the parent's |
| 165 | 369 | // clickable URL to the first submenu's URL. Plugins like |
| 166 | 370 | // WooCommerce rely on this — their top-level slug |
| @@ -168,12 +372,35 @@ | ||
| 168 | 372 | // directly. The real landing page is the first submenu |
| 169 | 373 | // (`?page=wc-admin` for WC). Without this rewrite the dock |
| 170 | 374 | // icon points users at a broken URL that classic admin would |
| 171 | 375 | // never have linked to. |
| 172 | - if ( null !== $first_visible_sub_url ) { | |
| 376 | + // | |
| 377 | + // A menu that registered a self-link has a working page of its | |
| 378 | + // own and keeps it, wherever in the list that link sits. Only | |
| 379 | + // the WooCommerce shape — no self-link at all — needs a child to | |
| 380 | + // stand in. Position matters here because a restored wp-admin | |
| 381 | + // row inherits the slot its off-site replacement held, which on | |
| 382 | + // WordPress.com puts `plugin-install.php` first under Plugins. | |
| 383 | + if ( null !== $first_visible_sub_url && ! $has_self_link ) { | |
| 173 | 384 | $url = $first_visible_sub_url; |
| 174 | 385 | } |
| 175 | 386 | |
| 387 | + // Nothing on this menu resolves to a page we can open. Hosts | |
| 388 | + // that link their own control panel from the admin menu | |
| 389 | + // (WordPress.com's My Home, Theme Showcase, Hosting) land here, | |
| 390 | + // and so does a Core menu whose slug was repointed off-site with | |
| 391 | + // no wp-admin child left to fall back to. | |
| 392 | + if ( openstation_menu_item_is_external( $url ) ) { | |
| 393 | + continue; | |
| 394 | + } | |
| 395 | + | |
| 396 | + // A container menu with nothing left to stand in for it. Its | |
| 397 | + // URL resolves to core's "Cannot load <slug>." page, which is a | |
| 398 | + // worse tile than no tile. | |
| 399 | + if ( $parent_is_container && $url === $parent_url ) { | |
| 400 | + continue; | |
| 401 | + } | |
| 402 | + | |
| 176 | 403 | $dock_item = array( |
| 177 | 404 | 'id' => sanitize_key( $item[5] ?? $item[2] ), |
| 178 | 405 | 'title' => $title, |
| 179 | 406 | 'icon' => $icon, |
| @@ -179,12 +406,19 @@ | ||
| 179 | 406 | 'icon' => $icon, |
| 180 | 407 | 'url' => $url, |
| 181 | 408 | 'badge' => $badge, |
| 182 | 409 | 'submenu' => $sub_items, |
| 183 | - 'multi' => openstation_dock_item_is_multi( $item[2] ), | |
| 184 | - 'placement' => openstation_dock_placement( $item[2] ), | |
| 185 | - 'isCore' => openstation_is_core_menu_slug( $item[2] ), | |
| 186 | - 'pluginFile' => openstation_resolve_menu_plugin_file( $item[2] ), | |
| 410 | + // Label of the stripped self-link ("All Posts"), for | |
| 411 | + // surfaces that list a menu's pages and want its main page | |
| 412 | + // named the way wp-admin names it. Empty when the menu had | |
| 413 | + // no self-link to strip. | |
| 414 | + 'selfLabel' => $self_label, | |
| 415 | + 'multi' => openstation_dock_item_is_multi( $identity_slug ), | |
| 416 | + 'placement' => openstation_dock_placement( $identity_slug ), | |
| 417 | + 'isCore' => openstation_is_core_menu_slug( $identity_slug ), | |
| 418 | + 'pluginFile' => $identity_slug === (string) $item[2] | |
| 419 | + ? $plugin_file | |
| 420 | + : openstation_resolve_menu_plugin_file( $identity_slug ), | |
| 187 | 421 | 'pluginName' => null, |
| 188 | 422 | ); |
| 189 | 423 | if ( $dock_item['pluginFile'] ) { |
| 190 | 424 | $dock_item['pluginName'] = openstation_plugin_display_name( $dock_item['pluginFile'] ); |
| @@ -195,9 +429,9 @@ | ||
| 195 | 429 | * |
| 196 | 430 | * @param array $dock_item The dock item data. |
| 197 | 431 | * @param string $menu_slug The menu slug. |
| 198 | 432 | */ |
| 199 | - $dock_item = apply_filters( 'openstation_dock_item', $dock_item, $item[2] ); | |
| 433 | + $dock_item = apply_filters( 'openstation_dock_item', $dock_item, $identity_slug ); | |
| 200 | 434 | |
| 201 | 435 | $items[] = $dock_item; |
| 202 | 436 | } |
| 203 | 437 | |
| @@ -209,8 +443,177 @@ | ||
| 209 | 443 | return apply_filters( 'openstation_dock_items', $items ); |
| 210 | 444 | } |
| 211 | 445 | |
| 212 | 446 | /** |
| 447 | + * Whether a resolved menu URL points at a host other than this site's. | |
| 448 | + * | |
| 449 | + * OpenStation opens admin pages inside iframes, and an off-site URL | |
| 450 | + * cannot load in one — the remote origin's `X-Frame-Options` / | |
| 451 | + * `frame-ancestors` header refuses it. Hosts that extend the admin | |
| 452 | + * menu with links to their own control panel (WordPress.com registers | |
| 453 | + * My Home, Theme Showcase, Hosting and friends as `wordpress.com` | |
| 454 | + * URLs) would therefore fill the dock with tiles that can only ever | |
| 455 | + * escape to a browser tab, which breaks the shell's navigation model. | |
| 456 | + * Those entries are dropped from the payload instead. | |
| 457 | + * | |
| 458 | + * The menu's own admin (`openstation_menu_admin_url()`), `admin_url()` | |
| 459 | + * and `home_url()` hosts all count as ours: a site can run its admin on | |
| 460 | + * a different domain than its front end, and the network admin lives on | |
| 461 | + * the network's own. | |
| 462 | + * | |
| 463 | + * @param string $url Absolute URL, as returned by `openstation_menu_item_url()`. | |
| 464 | + * @return bool True when the URL is off-site. | |
| 465 | + */ | |
| 466 | +function openstation_menu_item_is_external( $url ) { | |
| 467 | + $host = wp_parse_url( (string) $url, PHP_URL_HOST ); | |
| 468 | + $external = false; | |
| 469 | + | |
| 470 | + if ( $host ) { | |
| 471 | + $ours = array(); | |
| 472 | + foreach ( array( openstation_menu_admin_url(), admin_url(), home_url() ) as $known ) { | |
| 473 | + $known_host = wp_parse_url( $known, PHP_URL_HOST ); | |
| 474 | + if ( $known_host ) { | |
| 475 | + $ours[] = strtolower( $known_host ); | |
| 476 | + } | |
| 477 | + } | |
| 478 | + $external = ! in_array( strtolower( $host ), $ours, true ); | |
| 479 | + } | |
| 480 | + | |
| 481 | + /** | |
| 482 | + * Filters whether an admin-menu URL counts as off-site. | |
| 483 | + * | |
| 484 | + * @param bool $external Whether the URL points off-site. | |
| 485 | + * @param string $url The resolved menu URL. | |
| 486 | + */ | |
| 487 | + return (bool) apply_filters( 'openstation_menu_item_is_external', $external, $url ); | |
| 488 | +} | |
| 489 | + | |
| 490 | +/** | |
| 491 | + * Whether a `$menu` / `$submenu` row carries the `hide-if-js` class. | |
| 492 | + * | |
| 493 | + * Core never sets it on a menu row, so it reads as "some other code | |
| 494 | + * took this entry out of the sidebar". Jetpack's admin-menu | |
| 495 | + * customisation on WordPress.com uses it heavily: rather than replace | |
| 496 | + * a Core entry with its wordpress.com counterpart, it marks the | |
| 497 | + * original `hide-if-js` and appends a duplicate pointing at Calypso. | |
| 498 | + * Honouring the class is what keeps those pairs from rendering twice | |
| 499 | + * in the dock. | |
| 500 | + * | |
| 501 | + * @param array $item A `$menu` or `$submenu` row. | |
| 502 | + * @return bool True when the row is hidden from the classic sidebar. | |
| 503 | + */ | |
| 504 | +function openstation_menu_item_is_hidden( $item ) { | |
| 505 | + return ! empty( $item[4] ) && false !== strpos( (string) $item[4], 'hide-if-js' ); | |
| 506 | +} | |
| 507 | + | |
| 508 | +/** | |
| 509 | + * Whether a top-level menu slug has a page of its own behind it. | |
| 510 | + * | |
| 511 | + * `add_menu_page()` accepts a `null` callback, which registers a menu | |
| 512 | + * that is nothing but a container for its children — WordPress links | |
| 513 | + * such a parent to its first submenu and `admin.php` refuses the slug | |
| 514 | + * directly with "Cannot load <slug>." WordPress.com's Upgrades menu is | |
| 515 | + * one: `paid-upgrades.php` has no callback and no self-link, and every | |
| 516 | + * child is a wordpress.com URL. Drop the children and the tile is left | |
| 517 | + * pointing at core's error page. | |
| 518 | + * | |
| 519 | + * Two ways a slug earns a page: it names a real file under `wp-admin/`, | |
| 520 | + * or something is listening on its page hook — the same `has_action()` | |
| 521 | + * test `get_plugin_page_hook()` makes before `admin.php` gives up. | |
| 522 | + * Anything we can't answer counts as a page, so an unusual registration | |
| 523 | + * costs a menu nothing. | |
| 524 | + * | |
| 525 | + * @param string $slug The menu slug from `$menu[$i][2]`. | |
| 526 | + * @return bool False only when the slug is provably a container. | |
| 527 | + */ | |
| 528 | +function openstation_menu_slug_has_page( $slug ) { | |
| 529 | + if ( openstation_is_admin_file_slug( $slug ) ) { | |
| 530 | + return true; | |
| 531 | + } | |
| 532 | + | |
| 533 | + if ( ! function_exists( 'get_plugin_page_hookname' ) ) { | |
| 534 | + return true; | |
| 535 | + } | |
| 536 | + | |
| 537 | + $hookname = get_plugin_page_hookname( $slug, '' ); | |
| 538 | + if ( empty( $hookname ) ) { | |
| 539 | + return true; | |
| 540 | + } | |
| 541 | + | |
| 542 | + return has_action( $hookname ); | |
| 543 | +} | |
| 544 | + | |
| 545 | +/** | |
| 546 | + * Lazy accessor for the pre-rewrite menu icon snapshot: `slug → icon`. | |
| 547 | + * | |
| 548 | + * Populated by {@see openstation_snapshot_menu_icons()}. | |
| 549 | + * | |
| 550 | + * @return array<string,string> | |
| 551 | + */ | |
| 552 | +function &openstation_menu_icon_snapshot() { | |
| 553 | + static $map = null; | |
| 554 | + if ( null === $map ) { | |
| 555 | + $map = array(); | |
| 556 | + } | |
| 557 | + return $map; | |
| 558 | +} | |
| 559 | + | |
| 560 | +/** | |
| 561 | + * Record the first real icon each menu row is seen wearing. | |
| 562 | + * | |
| 563 | + * A menu row's icon is not final when it is registered. Anything on | |
| 564 | + * `admin_menu` can rewrite `$menu[ $i ][6]`, and the rewrite that hurts | |
| 565 | + * is to `'none'` — the row keeps its picture in the sidebar, painted | |
| 566 | + * from a stylesheet instead, and the menu array stops carrying it. The | |
| 567 | + * dock reads the array, so those menus arrived wearing a generic gear. | |
| 568 | + * Jetpack's `override_svg_icons()` does this to every SVG-data-URI icon | |
| 569 | + * on WordPress.com, which is where it was found, but nothing about the | |
| 570 | + * move is specific to that host. | |
| 571 | + * | |
| 572 | + * Rather than sit at one priority chosen to undercut one known rewriter, | |
| 573 | + * sample repeatedly and **never overwrite**: the map keeps the earliest | |
| 574 | + * real icon each slug had, whenever it appeared and whoever blanked it | |
| 575 | + * afterwards. Write-once is safe because the map is only ever consulted | |
| 576 | + * as a fallback — a menu that genuinely changes its icon still ships the | |
| 577 | + * live value. | |
| 578 | + * | |
| 579 | + * A slug that had no real icon at any sample point is simply absent, and | |
| 580 | + * the caller lands on the generic fallback it would have had anyway. | |
| 581 | + */ | |
| 582 | +function openstation_snapshot_menu_icons() { | |
| 583 | + global $menu; | |
| 584 | + | |
| 585 | + if ( ! is_array( $menu ) ) { | |
| 586 | + return; | |
| 587 | + } | |
| 588 | + | |
| 589 | + $map = &openstation_menu_icon_snapshot(); | |
| 590 | + | |
| 591 | + foreach ( $menu as $item ) { | |
| 592 | + if ( empty( $item[2] ) || empty( $item[6] ) ) { | |
| 593 | + continue; | |
| 594 | + } | |
| 595 | + $slug = (string) $item[2]; | |
| 596 | + if ( isset( $map[ $slug ] ) ) { | |
| 597 | + continue; | |
| 598 | + } | |
| 599 | + $icon = (string) $item[6]; | |
| 600 | + if ( 'none' === $icon || 'div' === $icon ) { | |
| 601 | + continue; | |
| 602 | + } | |
| 603 | + $map[ $slug ] = $icon; | |
| 604 | + } | |
| 605 | +} | |
| 606 | +// Spread across the hook rather than parked just below any one | |
| 607 | +// rewriter: registrations and rewrites both happen at arbitrary | |
| 608 | +// priorities, and only a sample taken before a given rewrite can see | |
| 609 | +// what it overwrote. | |
| 610 | +foreach ( array( 11, 100, 1000, 99998, PHP_INT_MAX ) as $openstation_icon_snapshot_priority ) { | |
| 611 | + add_action( 'admin_menu', 'openstation_snapshot_menu_icons', $openstation_icon_snapshot_priority ); | |
| 612 | +} | |
| 613 | +unset( $openstation_icon_snapshot_priority ); | |
| 614 | + | |
| 615 | +/** | |
| 213 | 616 | * Sanitizes a dock icon value for safe injection into the shell JS. |
| 214 | 617 | * |
| 215 | 618 | * Menu items can set their icon to one of: |
| 216 | 619 | * |
| @@ -416,8 +819,19 @@ | ||
| 416 | 819 | 'link-manager.php', // Link manager (legacy) |
| 417 | 820 | 'update-core.php', // Dashboard > Updates |
| 418 | 821 | ); |
| 419 | 822 | |
| 823 | + // The two top-level network menus the site admin has no filename | |
| 824 | + // for: without them, Sites and Settings sat in the apps zone while | |
| 825 | + // Dashboard, Users, Themes and Plugins — whose filenames the site | |
| 826 | + // admin shares — grouped correctly. Gated on the context, since | |
| 827 | + // `settings.php` is plausible enough as a plugin's own top-level | |
| 828 | + // slug that claiming it everywhere would misfile it. | |
| 829 | + if ( is_network_admin() ) { | |
| 830 | + $core_files[] = 'sites.php'; | |
| 831 | + $core_files[] = 'settings.php'; | |
| 832 | + } | |
| 833 | + | |
| 420 | 834 | return in_array( $base, $core_files, true ); |
| 421 | 835 | } |
| 422 | 836 | |
| 423 | 837 | /** |
| @@ -1182,11 +1596,16 @@ | ||
| 1182 | 1596 | } |
| 1183 | 1597 | |
| 1184 | 1598 | $dock = array_merge( $core, $plugin ); |
| 1185 | 1599 | |
| 1600 | + // One collector call feeds both halves: the slim entry list and | |
| 1601 | + // the handle-keyed script data the shell joins them with. | |
| 1602 | + $native_windows = openstation_collect_native_windows_payload(); | |
| 1603 | + | |
| 1186 | 1604 | $payload = array( |
| 1187 | - 'dockItems' => $dock, | |
| 1188 | - 'nativeWindows' => openstation_build_native_windows_payload(), | |
| 1605 | + 'dockItems' => $dock, | |
| 1606 | + 'nativeWindows' => $native_windows['windows'], | |
| 1607 | + 'nativeWindowScriptData' => $native_windows['scriptData'], | |
| 1189 | 1608 | ); |
| 1190 | 1609 | |
| 1191 | 1610 | // Optional per-surface payload builders — each module ships a |
| 1192 | 1611 | // zero-arg `openstation_build_*_payload()`; modules that aren't |
| @@ -1244,8 +1663,15 @@ | ||
| 1244 | 1663 | 'url' => network_admin_url( 'update-core.php' ), |
| 1245 | 1664 | ); |
| 1246 | 1665 | } |
| 1247 | 1666 | |
| 1667 | + // The site switcher's rows: on a network, the instances this shell | |
| 1668 | + // may switch to (`openstation_multisite_payload()`), null elsewhere. | |
| 1669 | + // The Network app spends a menu refresh after every action that | |
| 1670 | + // changes them (add, remove, join, leave, sync), so the row above | |
| 1671 | + // overview's desktop tiles follows the registry without a reload. | |
| 1672 | + $payload['multisite'] = openstation_multisite_payload(); | |
| 1673 | + | |
| 1248 | 1674 | // A cheap structural fingerprint of the admin menu the shell uses to |
| 1249 | 1675 | // decide whether a live refresh is warranted. Shipped in every full |
| 1250 | 1676 | // payload so the shell can seed / update its last-known signature |
| 1251 | 1677 | // without recomputing it client-side (which would risk drift from |
| @@ -1328,8 +1754,153 @@ | ||
| 1328 | 1754 | return md5( implode( "\n", $parts ) ); |
| 1329 | 1755 | } |
| 1330 | 1756 | |
| 1331 | 1757 | /** |
| 1758 | + * A handle's dependency closure, in load order. | |
| 1759 | + * | |
| 1760 | + * Post-order depth-first: a handle is emitted only after everything it | |
| 1761 | + * declares, which is the order `WP_Scripts::do_item()` would have | |
| 1762 | + * printed them in. A handle is marked visited *before* its own | |
| 1763 | + * dependencies are walked, so a dependency cycle unwinds instead of | |
| 1764 | + * recursing forever, and an unregistered handle is skipped rather than | |
| 1765 | + * being fatal — it contributes nothing and stops nothing. | |
| 1766 | + * | |
| 1767 | + * **Deliberately not `WP_Dependencies::all_deps()`.** Three reasons, | |
| 1768 | + * each of which has bitten this codebase: | |
| 1769 | + * | |
| 1770 | + * 1. `WP_Scripts::all_deps()` applies `print_scripts_array` to its | |
| 1771 | + * result whenever `$recursion` is falsy. That filter is where the | |
| 1772 | + * chromeless palette trim and the asset guard live, so resolving a | |
| 1773 | + * payload through it would run a print-time trim across a dependency | |
| 1774 | + * list and let the guard splice this plugin's own bundles into it. | |
| 1775 | + * Called from inside one of those filters it is an infinite loop. | |
| 1776 | + * | |
| 1777 | + * 2. Passing `$recursion = true` silences that filter but changes the | |
| 1778 | + * contract: the first handle that fails aborts the entire call | |
| 1779 | + * (`return false`), abandoning every handle after it in the list. The | |
| 1780 | + * caller is left with a `$to_do` that is a truncated prefix of the real | |
| 1781 | + * closure and indistinguishable from a complete one — a silent, partial | |
| 1782 | + * answer conditional on unrelated registrations elsewhere on the page. | |
| 1783 | + * A lazily-delivered bundle resolved that way loses packages it | |
| 1784 | + * declared and throws on an undefined global at mount, which is the | |
| 1785 | + * exact bug this whole mechanism exists to prevent. | |
| 1786 | + * | |
| 1787 | + * 3. `all_deps()` reports missing dependencies through | |
| 1788 | + * `_doing_it_wrong()`. This is read-only analysis; the real print pass | |
| 1789 | + * raises those anyway, and raising them twice turns someone else's | |
| 1790 | + * pre-existing warning into our noise. | |
| 1791 | + * | |
| 1792 | + * O(V+E) over the graph, allocates one set, and clones nothing. | |
| 1793 | + * | |
| 1794 | + * @param WP_Dependencies $dependencies The scripts or styles registry. | |
| 1795 | + * @param string[] $handles Roots to walk. | |
| 1796 | + * @return string[] Registered handles, dependencies before dependents. | |
| 1797 | + */ | |
| 1798 | +function openstation_script_dependency_closure( $dependencies, $handles ) { | |
| 1799 | + $seen = array(); | |
| 1800 | + $out = array(); | |
| 1801 | + openstation_collect_script_dependency_closure( $dependencies, (array) $handles, $seen, $out ); | |
| 1802 | + | |
| 1803 | + return $out; | |
| 1804 | +} | |
| 1805 | + | |
| 1806 | +/** | |
| 1807 | + * Recursive half of {@see openstation_script_dependency_closure()}. | |
| 1808 | + * | |
| 1809 | + * @param WP_Dependencies $dependencies The scripts or styles registry. | |
| 1810 | + * @param string[] $handles Handles to walk. | |
| 1811 | + * @param array $seen Handle => true, by reference. | |
| 1812 | + * @param string[] $out Ordered result, by reference. | |
| 1813 | + */ | |
| 1814 | +function openstation_collect_script_dependency_closure( $dependencies, $handles, &$seen, &$out ) { | |
| 1815 | + foreach ( (array) $handles as $handle ) { | |
| 1816 | + if ( isset( $seen[ $handle ] ) ) { | |
| 1817 | + continue; | |
| 1818 | + } | |
| 1819 | + // Marked BEFORE recursing, so a cycle meets itself as visited | |
| 1820 | + // and unwinds rather than recursing forever. | |
| 1821 | + $seen[ $handle ] = true; | |
| 1822 | + if ( ! isset( $dependencies->registered[ $handle ] ) ) { | |
| 1823 | + continue; | |
| 1824 | + } | |
| 1825 | + openstation_collect_script_dependency_closure( | |
| 1826 | + $dependencies, | |
| 1827 | + $dependencies->registered[ $handle ]->deps, | |
| 1828 | + $seen, | |
| 1829 | + $out | |
| 1830 | + ); | |
| 1831 | + $out[] = $handle; | |
| 1832 | + } | |
| 1833 | +} | |
| 1834 | + | |
| 1835 | +/** | |
| 1836 | + * Resolve a handle's dependency closure, in load order. | |
| 1837 | + * | |
| 1838 | + * **Why a lazily-delivered handle needs this at all.** WordPress | |
| 1839 | + * normally resolves a script's dependencies when it enqueues it — the | |
| 1840 | + * packages a bundle declares are on the page before its own body runs. | |
| 1841 | + * A handle that is only ever delivered lazily never goes through that: | |
| 1842 | + * `loadVendorScript()` injects one URL, and a bundle declaring | |
| 1843 | + * `wp-api-fetch` found `wp.apiFetch` undefined at mount. | |
| 1844 | + * | |
| 1845 | + * That used to work by accident. Core's ⌘K palette was enqueued on | |
| 1846 | + * every admin page and its closure is the whole Gutenberg runtime, so | |
| 1847 | + * `wp.apiFetch`, `wp.element` and friends happened to be globals. | |
| 1848 | + * Deferring the palette took the accident away and left the contract | |
| 1849 | + * exposed — see `docs/migration-wp-package-globals.md`. | |
| 1850 | + * | |
| 1851 | + * The closure comes from {@see openstation_script_dependency_closure()} | |
| 1852 | + * rather than `WP_Dependencies::all_deps()`; that function's docblock | |
| 1853 | + * records why, and the short version is that `all_deps()` answers a | |
| 1854 | + * question like this one with a silently truncated list. The handle | |
| 1855 | + * itself is excluded — the caller loads it separately, after these. | |
| 1856 | + * | |
| 1857 | + * @param string $handle Script handle. | |
| 1858 | + * @return array<int,array<string,mixed>> Ordered dependency payloads. | |
| 1859 | + */ | |
| 1860 | +function openstation_resolve_script_dependencies( $handle ) { | |
| 1861 | + $handle = (string) $handle; | |
| 1862 | + $wp_scripts = wp_scripts(); | |
| 1863 | + if ( '' === $handle || ! $wp_scripts || ! isset( $wp_scripts->registered[ $handle ] ) ) { | |
| 1864 | + return array(); | |
| 1865 | + } | |
| 1866 | + $deps = $wp_scripts->registered[ $handle ]->deps; | |
| 1867 | + if ( empty( $deps ) ) { | |
| 1868 | + return array(); | |
| 1869 | + } | |
| 1870 | + | |
| 1871 | + $out = array(); | |
| 1872 | + foreach ( openstation_script_dependency_closure( $wp_scripts, $deps ) as $dep_handle ) { | |
| 1873 | + if ( $dep_handle === $handle ) { | |
| 1874 | + continue; | |
| 1875 | + } | |
| 1876 | + $payload = openstation_resolve_script_payload( $dep_handle ); | |
| 1877 | + // An alias (no `src`) stays in the list when it carries inline | |
| 1878 | + // data — that data is the whole reason it was declared, and a | |
| 1879 | + // plugin's config blob commonly rides one. Nothing to fetch | |
| 1880 | + // AND nothing to run is the only thing dropped. | |
| 1881 | + if ( '' === $payload['url'] | |
| 1882 | + && empty( $payload['before'] ) | |
| 1883 | + && empty( $payload['after'] ) | |
| 1884 | + && empty( $payload['l10n'] ) ) { | |
| 1885 | + continue; | |
| 1886 | + } | |
| 1887 | + // The handle rides along because the shell needs it to decide | |
| 1888 | + // whether the page already has this package. A URL is not | |
| 1889 | + // enough: with Core's script concatenation on — the wp-admin | |
| 1890 | + // default — every package below `wp-includes/js/` is served | |
| 1891 | + // from one `load-scripts.php` blob and has no `<script src>` | |
| 1892 | + // of its own to match against. Re-running `wp-hooks` because | |
| 1893 | + // we could not see it replaces `window.wp.hooks`, and every | |
| 1894 | + // subscriber registered at boot goes deaf. See | |
| 1895 | + // `src/script-presence.ts`. | |
| 1896 | + $payload['handle'] = (string) $dep_handle; | |
| 1897 | + $out[] = $payload; | |
| 1898 | + } | |
| 1899 | + return $out; | |
| 1900 | +} | |
| 1901 | + | |
| 1902 | +/** | |
| 1332 | 1903 | * Resolve a registered WP script handle into the full payload the |
| 1333 | 1904 | * shell needs to lazy-load it without going through `wp_print_scripts()`. |
| 1334 | 1905 | * |
| 1335 | 1906 | * Returns: |
| @@ -1353,10 +1924,14 @@ | ||
| 1353 | 1924 | * around the lazy `<script src>` in the same order |
| 1354 | 1925 | * `WP_Scripts::do_item()` would have used. |
| 1355 | 1926 | * |
| 1356 | 1927 | * Returns an empty payload (`array( 'url' => '' )`) when the handle |
| 1357 | - * is unregistered or has no source — callers treat that as "no | |
| 1358 | - * script to load." | |
| 1928 | + * is unregistered. A registered handle with no source — an alias | |
| 1929 | + * carrying only inline data — also comes back with an empty `url`, | |
| 1930 | + * but its `before` / `after` / `l10n` are kept: callers that load a | |
| 1931 | + * bundle treat an empty `url` as "nothing to fetch", and the | |
| 1932 | + * dependency walk ({@see openstation_resolve_script_dependencies()}) | |
| 1933 | + * still replays what the alias would have printed. | |
| 1359 | 1934 | * |
| 1360 | 1935 | * Shared between `openstation_register_window()` and |
| 1361 | 1936 | * `openstation_register_widget()` (and every other registration that |
| 1362 | 1937 | * relies on lazy script loading in the shell) because all of them |
| @@ -1384,20 +1959,31 @@ | ||
| 1384 | 1959 | return $empty; |
| 1385 | 1960 | } |
| 1386 | 1961 | $registered = $wp_scripts->registered[ $handle ]; |
| 1387 | 1962 | $src = is_string( $registered->src ) ? $registered->src : ''; |
| 1388 | - if ( '' === $src ) { | |
| 1389 | - return $empty; | |
| 1390 | - } | |
| 1391 | 1963 | |
| 1392 | - // Normalize relative paths + attach cache-bust ver. | |
| 1393 | - $resolved = $src; | |
| 1394 | - if ( 0 === strpos( $resolved, '/' ) && 0 !== strpos( $resolved, '//' ) ) { | |
| 1395 | - $resolved = site_url( $resolved ); | |
| 1964 | + // A handle with no `src` is an ALIAS — WordPress's supported way | |
| 1965 | + // to ship inline-only JavaScript (`wp_register_script( $h, false )` | |
| 1966 | + // plus `wp_add_inline_script()`), and a common home for a plugin's | |
| 1967 | + // config blob: registering it as a *dependency* of every bundle is | |
| 1968 | + // what guarantees the config runs first, whatever the enqueue | |
| 1969 | + // order. `WP_Scripts::do_item()` prints an alias's localized data | |
| 1970 | + // and its before/after snippets and returns before the `<script | |
| 1971 | + // src>` it does not have. The payload mirrors that: `url` stays | |
| 1972 | + // empty (there is nothing to fetch) and the inline data is kept, | |
| 1973 | + // so a dependency walk can replay it. Translations are not: Core | |
| 1974 | + // only prints those for a handle it printed a tag for. | |
| 1975 | + $resolved = ''; | |
| 1976 | + if ( '' !== $src ) { | |
| 1977 | + // Normalize relative paths + attach cache-bust ver. | |
| 1978 | + $resolved = $src; | |
| 1979 | + if ( 0 === strpos( $resolved, '/' ) && 0 !== strpos( $resolved, '//' ) ) { | |
| 1980 | + $resolved = site_url( $resolved ); | |
| 1981 | + } | |
| 1982 | + if ( ! empty( $registered->ver ) ) { | |
| 1983 | + $resolved = add_query_arg( 'ver', $registered->ver, $resolved ); | |
| 1984 | + } | |
| 1396 | 1985 | } |
| 1397 | - if ( ! empty( $registered->ver ) ) { | |
| 1398 | - $resolved = add_query_arg( 'ver', $registered->ver, $resolved ); | |
| 1399 | - } | |
| 1400 | 1986 | |
| 1401 | 1987 | // Harvest `extra` data the lazy-load path would otherwise drop. |
| 1402 | 1988 | $before = array(); |
| 1403 | 1989 | $after = array(); |
| @@ -1432,9 +2018,9 @@ | ||
| 1432 | 2018 | // `wp.i18n.setLocaleData( JSON, 'domain' )` snippet that the print |
| 1433 | 2019 | // pipeline emits before the script body. `print_translations( |
| 1434 | 2020 | // $handle, false )` returns the snippet without echoing. |
| 1435 | 2021 | $translations = ''; |
| 1436 | - if ( method_exists( $wp_scripts, 'print_translations' ) ) { | |
| 2022 | + if ( '' !== $resolved && method_exists( $wp_scripts, 'print_translations' ) ) { | |
| 1437 | 2023 | $captured = $wp_scripts->print_translations( $handle, false ); |
| 1438 | 2024 | if ( is_string( $captured ) ) { |
| 1439 | 2025 | $translations = $captured; |
| 1440 | 2026 | } |
| @@ -1521,8 +2107,192 @@ | ||
| 1521 | 2107 | ); |
| 1522 | 2108 | } |
| 1523 | 2109 | |
| 1524 | 2110 | /** |
| 2111 | + * Build the deferred command-palette asset manifest. | |
| 2112 | + * | |
| 2113 | + * `wp_enqueue_command_palette_assets()` (WP 6.9+) enqueues | |
| 2114 | + * `wp-commands` + `wp-core-commands` and attaches the inline | |
| 2115 | + * `wp.coreCommands.initializeCommandPalette( … )` call that seeds the | |
| 2116 | + * `core/commands` store. Its transitive dependency chain is the whole | |
| 2117 | + * Gutenberg runtime — `wp-block-editor`, `wp-components`, React, | |
| 2118 | + * `wp-core-data`, some forty bundles, ~800 KB gzipped — which the | |
| 2119 | + * shell used to pay on EVERY boot so that the ⌘K palette's baseline | |
| 2120 | + * commands existed if the user ever opened it. | |
| 2121 | + * | |
| 2122 | + * This builder lets Core do exactly what it would have done — the | |
| 2123 | + * menu-command serialization and the inline init included — then | |
| 2124 | + * UNWINDS the enqueue: it snapshots the script/style queues, calls | |
| 2125 | + * the Core function, diffs out the roots it added, restores the | |
| 2126 | + * queues so nothing prints at boot, and resolves the full ordered | |
| 2127 | + * dependency chain on CLONES (the live `$to_do` is never touched). | |
| 2128 | + * Each handle in the chain is harvested into the same | |
| 2129 | + * url/before/after/l10n/translations shape the native-window lazy | |
| 2130 | + * loader uses, and the shell replays the list — in order — the first | |
| 2131 | + * time the palette is invoked (`src/commands/palette-assets.ts`). | |
| 2132 | + * | |
| 2133 | + * Handles with no `src` (pure aggregators) are kept whenever they | |
| 2134 | + * carry inline data; dropping them would lose middleware and locale | |
| 2135 | + * setup the chain depends on. Handles the boot page already printed | |
| 2136 | + * are skipped client-side, by handle as well as by path so that a | |
| 2137 | + * package Core concatenated into `load-scripts.php` is recognized | |
| 2138 | + * (`src/script-presence.ts`) — the manifest deliberately lists them | |
| 2139 | + * anyway, because which ones those are differs per site and per | |
| 2140 | + * screen. Each entry therefore carries its `handle`, and that is | |
| 2141 | + * load-bearing rather than informational. | |
| 2142 | + * | |
| 2143 | + * Returns `null` on pre-6.9 sites (no Core palette to defer). | |
| 2144 | + * | |
| 2145 | + * @return array{scripts:array<int,array<string,mixed>>,styles:array<int,array<string,mixed>>}|null | |
| 2146 | + */ | |
| 2147 | +function openstation_build_command_palette_assets_payload() { | |
| 2148 | + if ( ! function_exists( 'wp_enqueue_command_palette_assets' ) ) { | |
| 2149 | + return null; | |
| 2150 | + } | |
| 2151 | + $scripts = wp_scripts(); | |
| 2152 | + $styles = wp_styles(); | |
| 2153 | + if ( ! $scripts || ! $styles ) { | |
| 2154 | + return null; | |
| 2155 | + } | |
| 2156 | + | |
| 2157 | + // `wp_enqueue_command_palette_assets()` reads `$submenu` without | |
| 2158 | + // guarding the global — initialize defensively (test contexts, | |
| 2159 | + // edge-case admin requests where the menu wasn't built yet). | |
| 2160 | + global $menu, $submenu; | |
| 2161 | + // phpcs:disable WordPress.WP.GlobalVariablesOverride.Prohibited -- initializing an unset global to its documented empty shape, not replacing a built menu. | |
| 2162 | + if ( ! isset( $submenu ) || ! is_array( $submenu ) ) { | |
| 2163 | + $submenu = array(); | |
| 2164 | + } | |
| 2165 | + if ( ! isset( $menu ) || ! is_array( $menu ) ) { | |
| 2166 | + $menu = array(); | |
| 2167 | + } | |
| 2168 | + // phpcs:enable WordPress.WP.GlobalVariablesOverride.Prohibited | |
| 2169 | + | |
| 2170 | + $script_queue_before = $scripts->queue; | |
| 2171 | + $style_queue_before = $styles->queue; | |
| 2172 | + | |
| 2173 | + wp_enqueue_command_palette_assets(); | |
| 2174 | + | |
| 2175 | + $script_roots = array_values( array_diff( $scripts->queue, $script_queue_before ) ); | |
| 2176 | + $style_roots = array_values( array_diff( $styles->queue, $style_queue_before ) ); | |
| 2177 | + | |
| 2178 | + // Unwind: the boot page must not print any of it. The inline init | |
| 2179 | + // stays attached to the `wp-core-commands` HANDLE — that is the | |
| 2180 | + // point: the harvest below captures it, and if some other screen | |
| 2181 | + // legitimately enqueues the handle, it prints as Core intended. | |
| 2182 | + $scripts->queue = $script_queue_before; | |
| 2183 | + $styles->queue = $style_queue_before; | |
| 2184 | + | |
| 2185 | + $out = array( | |
| 2186 | + 'scripts' => array(), | |
| 2187 | + 'styles' => array(), | |
| 2188 | + ); | |
| 2189 | + | |
| 2190 | + // Ordered dependency chains, resolved on clones so the request's | |
| 2191 | + // real `$to_do` / `$done` state is untouched. | |
| 2192 | + $script_probe = clone $scripts; | |
| 2193 | + $script_probe->to_do = array(); | |
| 2194 | + $script_probe->done = array(); | |
| 2195 | + $script_probe->all_deps( $script_roots ); | |
| 2196 | + foreach ( $script_probe->to_do as $handle ) { | |
| 2197 | + $payload = openstation_resolve_script_payload( $handle ); | |
| 2198 | + // A src-less aggregator is kept only for its inline data — the | |
| 2199 | + // resolver harvests that for an alias — and dropped when it | |
| 2200 | + // carries none. | |
| 2201 | + if ( '' === $payload['url'] | |
| 2202 | + && empty( $payload['before'] ) | |
| 2203 | + && empty( $payload['after'] ) | |
| 2204 | + && empty( $payload['l10n'] ) ) { | |
| 2205 | + continue; | |
| 2206 | + } | |
| 2207 | + // Core's `initializeCommandPalette( {…} )` inline embeds the | |
| 2208 | + // serialized admin-menu command list — ~20 KB that the boot | |
| 2209 | + // page ALREADY carries as `window.__openStationMenuCommands` | |
| 2210 | + // (the shell harvester's lookup, attached as a `before` | |
| 2211 | + // inline on the main bundle, and the richer of the two: its | |
| 2212 | + // URL derivation routes legacy file-path slugs through | |
| 2213 | + // `menu_page_url()` where Core's regex takes them literally). | |
| 2214 | + // Ship the list once: strip Core's embedded copy and | |
| 2215 | + // synthesize the same call against the global, which is | |
| 2216 | + // guaranteed present long before the manifest replays — it | |
| 2217 | + // prints at boot, the replay waits for the first ⌘K. | |
| 2218 | + if ( 'wp-core-commands' === $handle ) { | |
| 2219 | + foreach ( array( 'before', 'after' ) as $position ) { | |
| 2220 | + $payload[ $position ] = array_values( | |
| 2221 | + array_filter( | |
| 2222 | + $payload[ $position ], | |
| 2223 | + static function ( $snippet ) { | |
| 2224 | + return false === strpos( (string) $snippet, 'initializeCommandPalette(' ); | |
| 2225 | + } | |
| 2226 | + ) | |
| 2227 | + ); | |
| 2228 | + } | |
| 2229 | + $payload['after'][] = sprintf( | |
| 2230 | + 'wp.coreCommands.initializeCommandPalette({"is_network_admin":%s,"menu_commands":window.__openStationMenuCommands||[]});', | |
| 2231 | + is_network_admin() ? 'true' : 'false' | |
| 2232 | + ); | |
| 2233 | + } | |
| 2234 | + | |
| 2235 | + $out['scripts'][] = array( | |
| 2236 | + 'handle' => (string) $handle, | |
| 2237 | + 'url' => $payload['url'], | |
| 2238 | + 'before' => $payload['before'], | |
| 2239 | + 'after' => $payload['after'], | |
| 2240 | + 'l10n' => $payload['l10n'], | |
| 2241 | + 'translations' => $payload['translations'], | |
| 2242 | + ); | |
| 2243 | + } | |
| 2244 | + | |
| 2245 | + $style_probe = clone $styles; | |
| 2246 | + $style_probe->to_do = array(); | |
| 2247 | + $style_probe->done = array(); | |
| 2248 | + $style_probe->all_deps( $style_roots ); | |
| 2249 | + foreach ( $style_probe->to_do as $handle ) { | |
| 2250 | + $style_payload = openstation_resolve_style_payload( $handle ); | |
| 2251 | + if ( '' === $style_payload['url'] ) { | |
| 2252 | + continue; | |
| 2253 | + } | |
| 2254 | + $out['styles'][] = array( | |
| 2255 | + 'handle' => (string) $handle, | |
| 2256 | + 'url' => $style_payload['url'], | |
| 2257 | + 'inline' => $style_payload['inline'], | |
| 2258 | + ); | |
| 2259 | + } | |
| 2260 | + | |
| 2261 | + return $out; | |
| 2262 | +} | |
| 2263 | + | |
| 2264 | +/** | |
| 2265 | + * Resolve a list of style handles into the `deferredStyles` config | |
| 2266 | + * map: handle → `array( 'url' => …, 'inline' => string[] )`. | |
| 2267 | + * | |
| 2268 | + * For shell surfaces that render on demand but are NOT native | |
| 2269 | + * windows — the Preferences panel, the AI assistant, the bug-report | |
| 2270 | + * window — so the `styles` companion mechanism can't carry their | |
| 2271 | + * CSS. The shell reads this map off `openStationConfig.deferredStyles` | |
| 2272 | + * and injects each sheet the first time its surface opens | |
| 2273 | + * (`ensureDeferredStyle()` in `src/deferred-styles.ts`). | |
| 2274 | + * | |
| 2275 | + * Handles that resolve to nothing (never registered) are dropped, so | |
| 2276 | + * the client map only ever holds injectable entries. | |
| 2277 | + * | |
| 2278 | + * @param string[] $handles Registered style handles. | |
| 2279 | + * @return array<string, array{url:string, inline:string[]}> | |
| 2280 | + */ | |
| 2281 | +function openstation_build_deferred_styles( $handles ) { | |
| 2282 | + $out = array(); | |
| 2283 | + foreach ( (array) $handles as $handle ) { | |
| 2284 | + $handle = (string) $handle; | |
| 2285 | + $payload = openstation_resolve_style_payload( $handle ); | |
| 2286 | + if ( '' === $payload['url'] ) { | |
| 2287 | + continue; | |
| 2288 | + } | |
| 2289 | + $out[ $handle ] = $payload; | |
| 2290 | + } | |
| 2291 | + return $out; | |
| 2292 | +} | |
| 2293 | + | |
| 2294 | +/** | |
| 1525 | 2295 | * Fire a `_doing_it_wrong()` notice exactly once per handle per |
| 1526 | 2296 | * request. Shared by every `openstation_build_desktop_*_scripts_payload()` |
| 1527 | 2297 | * caller — payload builders run on every shell-config rebuild |
| 1528 | 2298 | * (multiple times per page load via REST + admin-bar refresh + |
| @@ -1551,9 +2321,9 @@ | ||
| 1551 | 2321 | _doing_it_wrong( |
| 1552 | 2322 | esc_html( $function_name ), |
| 1553 | 2323 | sprintf( |
| 1554 | 2324 | /* translators: 1: kind ("Command"/"Settings-tab"/"Title-bar button"), 2: handle. */ |
| 1555 | - esc_html__( '%1$s script handle "%2$s" is not registered with WordPress (no `wp_register_script` call found). The script will not load.', 'desktop-mode' ), | |
| 2325 | + esc_html__( '%1$s script handle "%2$s" could not be resolved: no `wp_register_script( \'%2$s\', … )` call had run by the time the shell harvested its payload. Register the handle on `admin_enqueue_scripts` at priority 5 or earlier — the harvest itself runs at priority 10, and a handle registered alongside it may or may not exist yet depending on plugin load order. Until then the script will not load.', 'desktop-mode' ), | |
| 1556 | 2326 | esc_html( $kind ), |
| 1557 | 2327 | esc_html( $handle ) |
| 1558 | 2328 | ), |
| 1559 | 2329 | '0.8.1' |
| @@ -1595,28 +2365,153 @@ | ||
| 1595 | 2365 | openstation_warn_unresolvable_script_handle( '', '', '__flush__' ); |
| 1596 | 2366 | } |
| 1597 | 2367 | |
| 1598 | 2368 | /** |
| 1599 | - * Serialize the server-declared native-window registry into the | |
| 1600 | - * payload shape the shell consumes. For each entry registered via | |
| 1601 | - * `openstation_register_window()`, we capture: the window's | |
| 1602 | - * metadata (id/title/icon/placement/dimensions/autofocus), the | |
| 1603 | - * rendered template HTML (by running the template callback into an | |
| 1604 | - * output buffer), and the URL of the enqueued script handle (so | |
| 1605 | - * mid-session activations can load the plugin's JS dynamically | |
| 1606 | - * without a full shell reload). | |
| 2369 | + * Collect the native-window payload: slim per-window entries plus a | |
| 2370 | + * handle-keyed script-data map. | |
| 1607 | 2371 | * |
| 1608 | - * @return array[] | |
| 2372 | + * For each entry registered via `openstation_register_window()` the | |
| 2373 | + * `windows` list captures the window's metadata | |
| 2374 | + * (id/title/icon/placement/dimensions/autofocus), the rendered | |
| 2375 | + * template HTML, and the HANDLE NAMES of its script, companions and | |
| 2376 | + * tab scripts. The resolved data those handles stand for — URL plus | |
| 2377 | + * harvested `wp_localize_script` / `wp_add_inline_script` / | |
| 2378 | + * translations, see `openstation_resolve_script_payload()` — lives | |
| 2379 | + * ONCE per handle in `scriptData`, and the shell joins the two on | |
| 2380 | + * receipt (`hydrateServerEntries()` in `src/native-windows.ts`). | |
| 2381 | + * Each loadable handle's entry also names its dependency closure in | |
| 2382 | + * `deps` (ordered handles, every one of them a key of the same map) | |
| 2383 | + * so the lazy loader can bring a bundle's declared packages — and | |
| 2384 | + * a src-less alias carrying its config — into the tab before it. | |
| 2385 | + * | |
| 2386 | + * The split exists because script data is a property of the HANDLE, | |
| 2387 | + * not of the window: every App Framework window rides | |
| 2388 | + * `openstation-app-runtime`, and inlining each entry's resolved copy | |
| 2389 | + * serialized the same localize blobs and the same shared config set | |
| 2390 | + * four times over — `scriptL10n` alone was ~100 KB of the boot | |
| 2391 | + * payload, most of it repetition. The synthesized | |
| 2392 | + * `openStationWindowConfig[ id ]` assignments group by handle for | |
| 2393 | + * the same reason they used to ride every sharing entry: the shell | |
| 2394 | + * fetches a URL once, and a bundle can serve one window from inside | |
| 2395 | + * another (the Users window mounts the Profile form, which reads the | |
| 2396 | + * user-edit config), so whichever entry loads the bundle must | |
| 2397 | + * deliver the whole handle's config set. | |
| 2398 | + * | |
| 2399 | + * Style data stays inline on the entries — it never had a | |
| 2400 | + * duplication problem worth a second map ( companion styles across | |
| 2401 | + * the whole registry total ~2 KB ). | |
| 2402 | + * | |
| 2403 | + * @return array{windows:array[],scriptData:array<string,array{url:string,before:string[],after:string[],l10n:string[],translations:string,deps:string[]}>} | |
| 1609 | 2404 | */ |
| 1610 | -function openstation_build_native_windows_payload() { | |
| 2405 | +function openstation_collect_native_windows_payload() { | |
| 2406 | + $empty = array( | |
| 2407 | + 'windows' => array(), | |
| 2408 | + 'scriptData' => array(), | |
| 2409 | + ); | |
| 1611 | 2410 | if ( ! function_exists( 'openstation_native_window_registry' ) ) { |
| 1612 | - return array(); | |
| 2411 | + return $empty; | |
| 1613 | 2412 | } |
| 2413 | + | |
| 1614 | 2414 | $registry = openstation_native_window_registry(); |
| 1615 | 2415 | if ( ! is_array( $registry ) ) { |
| 1616 | - return array(); | |
| 2416 | + return $empty; | |
| 1617 | 2417 | } |
| 1618 | 2418 | |
| 2419 | + // A window says which admin offers it (`admin` in its registration: | |
| 2420 | + // `site`, `network` or `any`). Every native window OpenStation | |
| 2421 | + // ships is site-scoped, reading the current site's REST API, so in | |
| 2422 | + // the network admin a `users.php` tile meaning "everyone on the | |
| 2423 | + // network" would open one site's user list; those stay off the | |
| 2424 | + // network shell. A window that declares `network` (the Network app) | |
| 2425 | + // is offered there and nowhere else. | |
| 2426 | + // | |
| 2427 | + // Dropping the site windows there is also what disarms the | |
| 2428 | + // client-side URL remaps: they match on the tail of a pathname | |
| 2429 | + // (`endsWith( '/users.php' )`) and the network admin serves | |
| 2430 | + // same-named files one directory down, but with nothing registered | |
| 2431 | + // `openById()` finds no window and the remap falls through to the | |
| 2432 | + // iframe. | |
| 2433 | + $registry = array_filter( $registry, 'openstation_native_window_offered_here' ); | |
| 2434 | + | |
| 2435 | + $script_data = array(); | |
| 2436 | + | |
| 2437 | + // Handles resolved as a bundle to LOAD (a window's script, a | |
| 2438 | + // companion, a tab) and what that visit answered — the handle, or | |
| 2439 | + // '' for nothing to load — as opposed to reached only as | |
| 2440 | + // somebody's dependency. A handle can be both — resolved as a | |
| 2441 | + // dependency first, then named as a window's own script — and | |
| 2442 | + // only the bundle visit computes its own closure. | |
| 2443 | + $resolved_as_bundle = array(); | |
| 2444 | + | |
| 2445 | + // Resolve a handle into the map, once. Returns the handle when it | |
| 2446 | + // resolved to something loadable, '' when it did not (never | |
| 2447 | + // registered, no src) — the same silent drop the inline shape | |
| 2448 | + // applied to companions and tab scripts. | |
| 2449 | + // | |
| 2450 | + // The handle's dependency closure rides along as `deps`: an | |
| 2451 | + // ordered handle list, each of which lands in the same map. A | |
| 2452 | + // bundle delivered lazily never goes through WordPress's own | |
| 2453 | + // dependency resolution — the loader injects one URL — so a | |
| 2454 | + // window declaring `wp-api-fetch` found `wp.apiFetch` undefined, | |
| 2455 | + // and one whose config rides a src-less alias handle (a common | |
| 2456 | + // shape: `wp_register_script( $h, false )` plus | |
| 2457 | + // `wp_add_inline_script()`, declared as the bundle's dependency | |
| 2458 | + // so it always runs first) booted with no config at all. Anything | |
| 2459 | + // the document already ran is skipped on the client, so a page | |
| 2460 | + // that carried the packages anyway pays nothing. | |
| 2461 | + $collect_handle = static function ( $handle ) use ( &$script_data, &$resolved_as_bundle ) { | |
| 2462 | + $handle = (string) $handle; | |
| 2463 | + if ( '' === $handle ) { | |
| 2464 | + return ''; | |
| 2465 | + } | |
| 2466 | + if ( isset( $resolved_as_bundle[ $handle ] ) ) { | |
| 2467 | + return $resolved_as_bundle[ $handle ]; | |
| 2468 | + } | |
| 2469 | + $payload = isset( $script_data[ $handle ] ) | |
| 2470 | + ? $script_data[ $handle ] | |
| 2471 | + : openstation_resolve_script_payload( $handle ); | |
| 2472 | + if ( '' === $payload['url'] ) { | |
| 2473 | + $resolved_as_bundle[ $handle ] = ''; | |
| 2474 | + return ''; | |
| 2475 | + } | |
| 2476 | + $resolved_as_bundle[ $handle ] = $handle; | |
| 2477 | + $deps = array(); | |
| 2478 | + foreach ( openstation_resolve_script_dependencies( $handle ) as $dep ) { | |
| 2479 | + $dep_handle = (string) $dep['handle']; | |
| 2480 | + unset( $dep['handle'] ); | |
| 2481 | + if ( ! isset( $script_data[ $dep_handle ] ) ) { | |
| 2482 | + $dep['deps'] = array(); | |
| 2483 | + $script_data[ $dep_handle ] = $dep; | |
| 2484 | + } | |
| 2485 | + $deps[] = $dep_handle; | |
| 2486 | + } | |
| 2487 | + $payload['deps'] = $deps; | |
| 2488 | + $script_data[ $handle ] = $payload; | |
| 2489 | + return $handle; | |
| 2490 | + }; | |
| 2491 | + | |
| 2492 | + // Synthesized `openStationWindowConfig[ id ]` assignments, grouped | |
| 2493 | + // by script handle (see the function docblock). Collected first so | |
| 2494 | + // they can be appended to each handle's map entry exactly once, | |
| 2495 | + // after its own harvested data — the same order the print pipeline | |
| 2496 | + // would have used. | |
| 2497 | + $config_snippets_by_handle = array(); | |
| 2498 | + foreach ( $registry as $entry ) { | |
| 2499 | + $handle = isset( $entry['script'] ) ? (string) $entry['script'] : ''; | |
| 2500 | + if ( '' === $handle || ! is_callable( $entry['template'] ) ) { | |
| 2501 | + continue; | |
| 2502 | + } | |
| 2503 | + $window_config = openstation_filter_native_window_config( $entry ); | |
| 2504 | + if ( empty( $window_config ) ) { | |
| 2505 | + continue; | |
| 2506 | + } | |
| 2507 | + $config_snippets_by_handle[ $handle ][ $entry['id'] ] = sprintf( | |
| 2508 | + 'window.openStationWindowConfig=window.openStationWindowConfig||{};window.openStationWindowConfig[%s]=%s;', | |
| 2509 | + wp_json_encode( $entry['id'] ), | |
| 2510 | + wp_json_encode( $window_config ) | |
| 2511 | + ); | |
| 2512 | + } | |
| 2513 | + | |
| 1619 | 2514 | $out = array(); |
| 1620 | 2515 | foreach ( $registry as $entry ) { |
| 1621 | 2516 | if ( ! is_callable( $entry['template'] ) ) { |
| 1622 | 2517 | continue; |
| @@ -1629,17 +2524,37 @@ | ||
| 1629 | 2524 | // `<template>` at mid-session plugin activation without a |
| 1630 | 2525 | // reload. |
| 1631 | 2526 | $template_html = openstation_build_native_window_template_html( $entry ); |
| 1632 | 2527 | |
| 1633 | - // Resolve script handle → full payload (URL + harvested | |
| 1634 | - // `extra` data) so the shell can inject a `<script>` tag | |
| 1635 | - // dynamically on mid-session activation WITHOUT dropping | |
| 1636 | - // `wp_localize_script` / `wp_add_inline_script` data the way | |
| 1637 | - // the bare `<script src>` lazy-load path would. See | |
| 1638 | - // `openstation_resolve_script_payload()` for shape. | |
| 1639 | - $script_handle = isset( $entry['script'] ) ? (string) $entry['script'] : ''; | |
| 1640 | - $script_payload = openstation_resolve_script_payload( $script_handle ); | |
| 2528 | + // `$collect_handle()` answers "is there a bundle to fetch?", and | |
| 2529 | + // returns '' when the handle resolves to no URL — a src-less | |
| 2530 | + // alias handle registered only to carry `preload_script` or | |
| 2531 | + // inline data, for instance. That is the right answer for | |
| 2532 | + // `scriptHandle`, which names something to load. It is the | |
| 2533 | + // wrong answer for `ownerHandle`, which names WHO the window | |
| 2534 | + // belongs to: attribution does not depend on whether the owner | |
| 2535 | + // happens to ship a file. Shipping '' there broke the | |
| 2536 | + // documented "always populated" contract and blanked | |
| 2537 | + // `wp.os.debug.window()`. | |
| 2538 | + $declared_script = isset( $entry['script'] ) ? (string) $entry['script'] : ''; | |
| 2539 | + $script_handle = $collect_handle( $declared_script ); | |
| 2540 | + $owner_handle = '' !== $script_handle ? $script_handle : $declared_script; | |
| 1641 | 2541 | |
| 2542 | + // Companion handles (`scripts` arg) — bundles that extend the | |
| 2543 | + // window from outside it and must be in the tab before its | |
| 2544 | + // render callback paints. Kept as an ordered handle list; the | |
| 2545 | + // shell loads them in declared order ahead of the window's | |
| 2546 | + // own script, resolving each through `scriptData`. | |
| 2547 | + $companion_scripts = array(); | |
| 2548 | + if ( ! empty( $entry['scripts'] ) && is_array( $entry['scripts'] ) ) { | |
| 2549 | + foreach ( $entry['scripts'] as $companion_handle ) { | |
| 2550 | + $companion_handle = $collect_handle( $companion_handle ); | |
| 2551 | + if ( '' !== $companion_handle ) { | |
| 2552 | + $companion_scripts[] = $companion_handle; | |
| 2553 | + } | |
| 2554 | + } | |
| 2555 | + } | |
| 2556 | + | |
| 1642 | 2557 | // Resolve the optional style handle alongside the script so the |
| 1643 | 2558 | // shell's lazy-loader can inject a `<link rel="stylesheet">` |
| 1644 | 2559 | // (and any `wp_add_inline_style()` blobs) on mid-session |
| 1645 | 2560 | // activation. Empty payload when no handle was declared OR the |
| @@ -1646,75 +2561,123 @@ | ||
| 1646 | 2561 | // handle isn't registered — both treated as "no styles to load." |
| 1647 | 2562 | $style_handle = isset( $entry['style'] ) ? (string) $entry['style'] : ''; |
| 1648 | 2563 | $style_payload = openstation_resolve_style_payload( $style_handle ); |
| 1649 | 2564 | |
| 1650 | - // `config` arg on `openstation_register_window()` — discoverable | |
| 1651 | - // alternative to `wp_localize_script`. We synthesize a localize | |
| 1652 | - // snippet so it lands through the same delivery path as native | |
| 1653 | - // `wp_localize_script`. The bundle reads | |
| 1654 | - // `window.openStationWindowConfig[id]` (or via | |
| 1655 | - // `wp.os.getWindowConfig(id)`). | |
| 1656 | - if ( ! empty( $entry['config'] ) && is_array( $entry['config'] ) ) { | |
| 1657 | - $script_payload['l10n'][] = sprintf( | |
| 1658 | - 'window.openStationWindowConfig=window.openStationWindowConfig||{};window.openStationWindowConfig[%s]=%s;', | |
| 1659 | - wp_json_encode( $entry['id'] ), | |
| 1660 | - wp_json_encode( $entry['config'] ) | |
| 1661 | - ); | |
| 2565 | + // Companion style handles (`styles` arg) — stylesheets the | |
| 2566 | + // shell injects on the window's FIRST OPEN, after the window's | |
| 2567 | + // own style, in declared order. The styles-side mirror of | |
| 2568 | + // `companionScripts`, with different timing on purpose: the | |
| 2569 | + // window's own `style` lands when the window registers so a | |
| 2570 | + // mid-session activation paints, but a companion exists to be | |
| 2571 | + // deferred — it costs nothing until the window is actually | |
| 2572 | + // shown. Unregistered handles drop, same as script companions. | |
| 2573 | + $companion_styles = array(); | |
| 2574 | + if ( ! empty( $entry['styles'] ) && is_array( $entry['styles'] ) ) { | |
| 2575 | + foreach ( $entry['styles'] as $companion_style_handle ) { | |
| 2576 | + $companion_style_handle = (string) $companion_style_handle; | |
| 2577 | + $companion_style_payload = openstation_resolve_style_payload( $companion_style_handle ); | |
| 2578 | + if ( '' === $companion_style_payload['url'] ) { | |
| 2579 | + continue; | |
| 2580 | + } | |
| 2581 | + $companion_styles[] = array( | |
| 2582 | + 'styleUrl' => $companion_style_payload['url'], | |
| 2583 | + 'styleHandle' => $companion_style_handle, | |
| 2584 | + 'styleInline' => $companion_style_payload['inline'], | |
| 2585 | + ); | |
| 2586 | + } | |
| 1662 | 2587 | } |
| 1663 | 2588 | |
| 1664 | - // Tab metadata (label + extra script payloads) ships alongside | |
| 1665 | - // the template so the shell can render a picker UI or load | |
| 1666 | - // additional tab scripts when a tab's activation is late. | |
| 2589 | + // Tab metadata ships alongside the template so the shell can | |
| 2590 | + // render a picker UI, and each tab's script handle joins the | |
| 2591 | + // map so a late tab activation can still load its bundle. | |
| 1667 | 2592 | $tab_descriptors = array(); |
| 1668 | 2593 | if ( function_exists( 'openstation_get_native_window_tabs' ) ) { |
| 1669 | 2594 | foreach ( openstation_get_native_window_tabs( $entry['id'] ) as $tab ) { |
| 1670 | - // The resolver returns the empty payload shape itself | |
| 1671 | - // for an empty handle — no need to hand-write it here. | |
| 1672 | - $tab_payload = openstation_resolve_script_payload( $tab['script'] ); | |
| 1673 | 2595 | $tab_descriptors[] = array( |
| 1674 | - 'value' => $tab['value'], | |
| 1675 | - 'label' => $tab['label'], | |
| 1676 | - 'isMain' => $tab['is_main'], | |
| 1677 | - 'scriptUrl' => $tab_payload['url'], | |
| 1678 | - 'scriptHandle' => $tab['script'], | |
| 1679 | - 'scriptBefore' => $tab_payload['before'], | |
| 1680 | - 'scriptAfter' => $tab_payload['after'], | |
| 1681 | - 'scriptL10n' => $tab_payload['l10n'], | |
| 1682 | - 'scriptTranslations' => $tab_payload['translations'], | |
| 2596 | + 'value' => $tab['value'], | |
| 2597 | + 'label' => $tab['label'], | |
| 2598 | + 'isMain' => $tab['is_main'], | |
| 2599 | + 'scriptHandle' => $collect_handle( $tab['script'] ), | |
| 1683 | 2600 | ); |
| 1684 | 2601 | } |
| 1685 | 2602 | } |
| 1686 | 2603 | |
| 1687 | 2604 | $out[] = array( |
| 1688 | - 'id' => $entry['id'], | |
| 1689 | - 'title' => $entry['title'], | |
| 1690 | - 'icon' => $entry['icon'], | |
| 1691 | - 'placement' => $entry['placement'], | |
| 1692 | - 'width' => $entry['width'], | |
| 1693 | - 'height' => $entry['height'], | |
| 1694 | - 'minWidth' => $entry['min_width'], | |
| 1695 | - 'minHeight' => $entry['min_height'], | |
| 1696 | - 'autofocus' => $entry['autofocus'], | |
| 1697 | - 'templateId' => 'os-native-window-' . $entry['id'], | |
| 1698 | - 'templateHtml' => $template_html, | |
| 1699 | - 'scriptUrl' => $script_payload['url'], | |
| 1700 | - 'scriptHandle' => $script_handle, | |
| 1701 | - 'ownerHandle' => $script_handle, | |
| 1702 | - 'scriptBefore' => $script_payload['before'], | |
| 1703 | - 'scriptAfter' => $script_payload['after'], | |
| 1704 | - 'scriptL10n' => $script_payload['l10n'], | |
| 1705 | - 'scriptTranslations' => $script_payload['translations'], | |
| 1706 | - 'styleUrl' => $style_payload['url'], | |
| 1707 | - 'styleHandle' => $style_handle, | |
| 1708 | - 'styleInline' => $style_payload['inline'], | |
| 1709 | - 'tabs' => $tab_descriptors, | |
| 2605 | + 'id' => $entry['id'], | |
| 2606 | + 'title' => $entry['title'], | |
| 2607 | + 'icon' => $entry['icon'], | |
| 2608 | + 'placement' => $entry['placement'], | |
| 2609 | + // `'app'` or `'control'` — the navigation kind, which | |
| 2610 | + // decides the launcher's default placement and its dock | |
| 2611 | + // zone. See `src/nav/defaults.ts`. | |
| 2612 | + 'navKind' => isset( $entry['nav_kind'] ) ? $entry['nav_kind'] : 'app', | |
| 2613 | + // Sort key among system tiles. Absent / 0 puts a plugin's | |
| 2614 | + // launcher ahead of the shell's own trailing cluster. | |
| 2615 | + 'dockOrder' => isset( $entry['dock_order'] ) ? (int) $entry['dock_order'] : 0, | |
| 2616 | + 'placeable' => ! empty( $entry['placeable'] ), | |
| 2617 | + 'width' => $entry['width'], | |
| 2618 | + 'height' => $entry['height'], | |
| 2619 | + 'minWidth' => $entry['min_width'], | |
| 2620 | + 'minHeight' => $entry['min_height'], | |
| 2621 | + 'autofocus' => $entry['autofocus'], | |
| 2622 | + 'templateId' => 'os-native-window-' . $entry['id'], | |
| 2623 | + 'templateHtml' => $template_html, | |
| 2624 | + 'scriptHandle' => $script_handle, | |
| 2625 | + 'ownerHandle' => $owner_handle, | |
| 2626 | + 'companionScripts' => $companion_scripts, | |
| 2627 | + // Whether the shell loads the bundle at boot rather than on | |
| 2628 | + // first open. Off by default: a window's script is dead | |
| 2629 | + // weight on every admin page until the window is actually | |
| 2630 | + // opened. | |
| 2631 | + 'preloadScript' => ! empty( $entry['preload_script'] ), | |
| 2632 | + 'styleUrl' => $style_payload['url'], | |
| 2633 | + 'styleHandle' => $style_handle, | |
| 2634 | + 'styleInline' => $style_payload['inline'], | |
| 2635 | + 'companionStyles' => $companion_styles, | |
| 2636 | + 'tabs' => $tab_descriptors, | |
| 1710 | 2637 | ); |
| 1711 | 2638 | } |
| 1712 | 2639 | |
| 1713 | - return $out; | |
| 2640 | + // Append each handle's synthesized config set to its map entry — | |
| 2641 | + // once, after the handle's own harvested data. The snippets land | |
| 2642 | + // in REGISTRY-ITERATION order for every consumer of the handle; | |
| 2643 | + // the old per-entry shape put each window's own config first, an | |
| 2644 | + // ordering nothing could observe (each snippet assigns a distinct | |
| 2645 | + // `openStationWindowConfig[ id ]` key and none reads another), so | |
| 2646 | + // it is deliberately not preserved. Configs for handles that | |
| 2647 | + // resolved to nothing are undeliverable and drop, exactly as they | |
| 2648 | + // always did. | |
| 2649 | + foreach ( $config_snippets_by_handle as $handle => $snippets ) { | |
| 2650 | + if ( ! isset( $script_data[ $handle ] ) ) { | |
| 2651 | + continue; | |
| 2652 | + } | |
| 2653 | + foreach ( $snippets as $snippet ) { | |
| 2654 | + $script_data[ $handle ]['l10n'][] = $snippet; | |
| 2655 | + } | |
| 2656 | + } | |
| 2657 | + | |
| 2658 | + return array( | |
| 2659 | + 'windows' => $out, | |
| 2660 | + 'scriptData' => $script_data, | |
| 2661 | + ); | |
| 1714 | 2662 | } |
| 1715 | 2663 | |
| 1716 | 2664 | /** |
| 2665 | + * The `windows` half of {@see openstation_collect_native_windows_payload()}. | |
| 2666 | + * | |
| 2667 | + * Kept as the historical entry point — tests and older call sites | |
| 2668 | + * ask for the entry list alone. Anything that also needs the | |
| 2669 | + * script-data map (everything that actually LOADS a bundle) should | |
| 2670 | + * call the collector and take both halves from one build. | |
| 2671 | + * | |
| 2672 | + * @return array[] | |
| 2673 | + */ | |
| 2674 | +function openstation_build_native_windows_payload() { | |
| 2675 | + $bundle = openstation_collect_native_windows_payload(); | |
| 2676 | + return $bundle['windows']; | |
| 2677 | +} | |
| 2678 | + | |
| 2679 | +/** | |
| 1717 | 2680 | * Cleans a `$menu` / `$submenu` title for display. |
| 1718 | 2681 | * |
| 1719 | 2682 | * Strips badge spans first (`<span class="update-plugins count-3">`), |
| 1720 | 2683 | * then any remaining markup. An empty result means the entry has no |
| @@ -1772,13 +2735,45 @@ | ||
| 1772 | 2735 | return file_exists( ABSPATH . 'wp-admin/' . $file ); |
| 1773 | 2736 | } |
| 1774 | 2737 | |
| 1775 | 2738 | /** |
| 2739 | + * The admin URL a menu slug resolves against. | |
| 2740 | + * | |
| 2741 | + * Follows the admin the request is in: the network admin's own URL there, | |
| 2742 | + * because its globals carry network slugs (`sites.php`, `settings.php`) | |
| 2743 | + * that exist only under `wp-admin/network/`, and the site admin's | |
| 2744 | + * everywhere else. | |
| 2745 | + * | |
| 2746 | + * The same answer `self_admin_url()` gives, without its filter. That | |
| 2747 | + * filter receives the path, so a host can use it to send one screen | |
| 2748 | + * somewhere else, and WordPress.com points `plugin-install.php` at its own | |
| 2749 | + * installer. Resolved through it, the wp-admin original of a menu row the | |
| 2750 | + * host replaced reads as off-site, and the dock drops it along with the | |
| 2751 | + * replacement, which is how Plugins > Add Plugin disappears there. | |
| 2752 | + * | |
| 2753 | + * @param string $path Optional. Path relative to the admin URL. | |
| 2754 | + * @return string Absolute admin URL. | |
| 2755 | + */ | |
| 2756 | +function openstation_menu_admin_url( $path = '' ) { | |
| 2757 | + if ( is_network_admin() ) { | |
| 2758 | + return network_admin_url( $path ); | |
| 2759 | + } | |
| 2760 | + if ( is_user_admin() ) { | |
| 2761 | + return user_admin_url( $path ); | |
| 2762 | + } | |
| 2763 | + return admin_url( $path ); | |
| 2764 | +} | |
| 2765 | + | |
| 2766 | +/** | |
| 1776 | 2767 | * Converts a menu item slug to a full admin URL. |
| 1777 | 2768 | * |
| 2769 | + * Resolution goes through {@see openstation_menu_admin_url()}, which | |
| 2770 | + * follows the admin the request is in without passing through the | |
| 2771 | + * filterable `self_admin_url()`. | |
| 2772 | + * | |
| 1778 | 2773 | * Handles three slug shapes: |
| 1779 | 2774 | * 1. Direct file references (`edit.php`, `upload.php`) — passed |
| 1780 | - * through `admin_url()` as-is. | |
| 2775 | + * through `openstation_menu_admin_url()` as-is. | |
| 1781 | 2776 | * 2. Plain plugin page slugs (`my-plugin`) — routed through |
| 1782 | 2777 | * `admin.php?page=<slug>` with the slug `rawurlencode()`d. |
| 1783 | 2778 | * 3. Plugin page slugs that embed extra query parameters |
| 1784 | 2779 | * (`wc-admin&path=/customers`) — split on the first `&`, the |
| @@ -1839,9 +2834,9 @@ | ||
| 1839 | 2834 | if ( |
| 1840 | 2835 | false !== strpos( $slug, '.php' ) && |
| 1841 | 2836 | ( ! isset( $_parent_pages[ $slug ] ) || openstation_is_admin_file_slug( $slug ) ) |
| 1842 | 2837 | ) { |
| 1843 | - return esc_url_raw( admin_url( $slug ) ); | |
| 2838 | + return esc_url_raw( openstation_menu_admin_url( $slug ) ); | |
| 1844 | 2839 | } |
| 1845 | 2840 | |
| 1846 | 2841 | // Plugin page slug with embedded query parameters |
| 1847 | 2842 | // (e.g., 'wc-admin&path=/customers'). Split the page slug from |
| @@ -1881,9 +2876,9 @@ | ||
| 1881 | 2876 | $host = add_query_arg( 'page', $slug, $parent_slug ); |
| 1882 | 2877 | } |
| 1883 | 2878 | } |
| 1884 | 2879 | |
| 1885 | - $url = admin_url( $host ); | |
| 2880 | + $url = openstation_menu_admin_url( $host ); | |
| 1886 | 2881 | if ( ! empty( $extra_args ) ) { |
| 1887 | 2882 | $url = add_query_arg( $extra_args, $url ); |
| 1888 | 2883 | } |
| 1889 | 2884 | return esc_url_raw( $url ); |
