| 1 |
<?php |
| 2 |
/** |
| 3 |
* Page: guidelines (wp-admin integrated) |
| 4 |
* Auto-generated by build process. |
| 5 |
* Do not edit this file manually. |
| 6 |
* |
| 7 |
* This version integrates with the standard WordPress admin interface, |
| 8 |
* keeping the wp-admin sidebar and scripts/styles intact. |
| 9 |
* |
| 10 |
* @package gutenberg |
| 11 |
*/ |
| 12 |
|
| 13 |
// Global storage for guidelines routes and menu items |
| 14 |
global $gutenberg_guidelines_wp_admin_routes, $gutenberg_guidelines_wp_admin_menu_items; |
| 15 |
$gutenberg_guidelines_wp_admin_routes = array(); |
| 16 |
$gutenberg_guidelines_wp_admin_menu_items = array(); |
| 17 |
|
| 18 |
/** |
| 19 |
* Register a route for the guidelines-wp-admin page. |
| 20 |
* |
| 21 |
* @param string $path Route path (e.g., '/types/$type/edit/$id'). |
| 22 |
* @param string|null $content_module Script module ID for content (stage/inspector). |
| 23 |
* @param string|null $route_module Script module ID for route lifecycle hooks. |
| 24 |
*/ |
| 25 |
function gutenberg_register_guidelines_wp_admin_route( $path, $content_module = null, $route_module = null ) { |
| 26 |
global $gutenberg_guidelines_wp_admin_routes; |
| 27 |
|
| 28 |
$route = array( 'path' => $path ); |
| 29 |
if ( ! empty( $content_module ) ) { |
| 30 |
$route['content_module'] = $content_module; |
| 31 |
} |
| 32 |
if ( ! empty( $route_module ) ) { |
| 33 |
$route['route_module'] = $route_module; |
| 34 |
} |
| 35 |
|
| 36 |
$gutenberg_guidelines_wp_admin_routes[] = $route; |
| 37 |
} |
| 38 |
|
| 39 |
/** |
| 40 |
* Register a menu item for the guidelines-wp-admin page. |
| 41 |
* Note: Menu items are registered but not displayed in single-page mode. |
| 42 |
* |
| 43 |
* @param string $id Menu item ID. |
| 44 |
* @param string $label Display label. |
| 45 |
* @param string $to Route path to navigate to. |
| 46 |
* @param string $parent_id Optional. Parent menu item ID. |
| 47 |
*/ |
| 48 |
function gutenberg_register_guidelines_wp_admin_menu_item( $id, $label, $to, $parent_id = '' ) { |
| 49 |
global $gutenberg_guidelines_wp_admin_menu_items; |
| 50 |
|
| 51 |
$menu_item = array( |
| 52 |
'id' => $id, |
| 53 |
'label' => $label, |
| 54 |
'to' => $to, |
| 55 |
); |
| 56 |
|
| 57 |
if ( ! empty( $parent_id ) ) { |
| 58 |
$menu_item['parent'] = $parent_id; |
| 59 |
} |
| 60 |
|
| 61 |
$gutenberg_guidelines_wp_admin_menu_items[] = $menu_item; |
| 62 |
} |
| 63 |
|
| 64 |
/** |
| 65 |
* Get all registered routes for the guidelines-wp-admin page. |
| 66 |
* |
| 67 |
* @return array Array of route objects. |
| 68 |
*/ |
| 69 |
function gutenberg_get_guidelines_wp_admin_routes() { |
| 70 |
global $gutenberg_guidelines_wp_admin_routes; |
| 71 |
return $gutenberg_guidelines_wp_admin_routes ?? array(); |
| 72 |
} |
| 73 |
|
| 74 |
/** |
| 75 |
* Get all registered menu items for the guidelines-wp-admin page. |
| 76 |
* |
| 77 |
* @return array Array of menu item objects. |
| 78 |
*/ |
| 79 |
function gutenberg_get_guidelines_wp_admin_menu_items() { |
| 80 |
global $gutenberg_guidelines_wp_admin_menu_items; |
| 81 |
return $gutenberg_guidelines_wp_admin_menu_items ?? array(); |
| 82 |
} |
| 83 |
|
| 84 |
/** |
| 85 |
* Preload REST API data for the guidelines-wp-admin page. |
| 86 |
* Automatically called during page rendering. |
| 87 |
*/ |
| 88 |
function gutenberg_guidelines_wp_admin_preload_data() { |
| 89 |
// Define paths to preload - same for all pages |
| 90 |
// Please also change packages/core-data/src/entities.js when changing this. |
| 91 |
$preload_paths = array( |
| 92 |
'/?_fields=description,gmt_offset,home,image_sizes,image_size_threshold,name,site_icon,site_icon_url,site_logo,timezone_string,url,page_for_posts,page_on_front,show_on_front', |
| 93 |
array( '/wp/v2/settings', 'OPTIONS' ), |
| 94 |
); |
| 95 |
|
| 96 |
// Use rest_preload_api_request to gather the preloaded data |
| 97 |
$preload_data = array_reduce( |
| 98 |
$preload_paths, |
| 99 |
'rest_preload_api_request', |
| 100 |
array() |
| 101 |
); |
| 102 |
|
| 103 |
// Register the preloading middleware with wp-api-fetch |
| 104 |
wp_add_inline_script( |
| 105 |
'wp-api-fetch', |
| 106 |
sprintf( |
| 107 |
'wp.apiFetch.use( wp.apiFetch.createPreloadingMiddleware( %s ) );', |
| 108 |
wp_json_encode( $preload_data ) |
| 109 |
), |
| 110 |
'after' |
| 111 |
); |
| 112 |
} |
| 113 |
|
| 114 |
/** |
| 115 |
* Enqueue scripts and styles for the guidelines-wp-admin page. |
| 116 |
* Hooked to admin_enqueue_scripts. |
| 117 |
* |
| 118 |
* @param string $hook_suffix The current admin page. |
| 119 |
*/ |
| 120 |
function gutenberg_guidelines_wp_admin_enqueue_scripts( $hook_suffix ) { |
| 121 |
// Check all possible ways this page can be accessed: |
| 122 |
// 1. Menu page via admin.php?page=guidelines-wp-admin (plugin) |
| 123 |
// 2. Direct file via guidelines.php (Core) - screen ID will be 'guidelines' |
| 124 |
$current_screen = get_current_screen(); |
| 125 |
$is_our_page = ( |
| 126 |
( isset( $_GET['page'] ) && 'guidelines-wp-admin' === $_GET['page'] ) || // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
| 127 |
( $current_screen && 'guidelines' === $current_screen->id ) |
| 128 |
); |
| 129 |
|
| 130 |
if ( ! $is_our_page ) { |
| 131 |
return; |
| 132 |
} |
| 133 |
|
| 134 |
// Load build constants |
| 135 |
$build_constants = require __DIR__ . '/../../constants.php'; |
| 136 |
|
| 137 |
/** |
| 138 |
* Fires when the guidelines admin page is initialized so extensions can register routes and menu items. |
| 139 |
*/ |
| 140 |
do_action( 'guidelines-wp-admin_init' ); |
| 141 |
|
| 142 |
// Preload REST API data |
| 143 |
gutenberg_guidelines_wp_admin_preload_data(); |
| 144 |
|
| 145 |
// Get all registered routes |
| 146 |
$routes = gutenberg_get_guidelines_wp_admin_routes(); |
| 147 |
|
| 148 |
// Get boot module asset file for dependencies |
| 149 |
$asset_file = __DIR__ . '/../../modules/boot/index.min.asset.php'; |
| 150 |
if ( file_exists( $asset_file ) ) { |
| 151 |
$asset = require $asset_file; |
| 152 |
|
| 153 |
// This script serves two purposes: |
| 154 |
// 1. It ensures all the globals that are made available to the modules are loaded. |
| 155 |
// 2. It initializes the boot module as an inline script. |
| 156 |
wp_register_script( 'guidelines-wp-admin-prerequisites', '', $asset['dependencies'], $asset['version'], true ); |
| 157 |
|
| 158 |
/* |
| 159 |
* Add inline script to initialize the app using initSinglePage (no menuItems). |
| 160 |
* The dynamic import is deferred until DOMContentLoaded so that all classic |
| 161 |
* script dependencies of @wordpress/boot (wp-private-apis, wp-components, |
| 162 |
* wp-theme, etc.) have finished parsing and executing before the boot module |
| 163 |
* evaluates. Otherwise, a modulepreloaded @wordpress/boot can win the race |
| 164 |
* against the classic-script-printing pass on fast CDN-fronted hosts in |
| 165 |
* Chrome, evaluating before wp.theme.privateApis is defined and throwing |
| 166 |
* "Cannot unlock an undefined object". See <https://core.trac.wordpress.org/ticket/65103>. |
| 167 |
*/ |
| 168 |
$init_js_function = <<<'JS' |
| 169 |
( mountId, routes ) => { |
| 170 |
const run = async () => { |
| 171 |
const mod = await import( "@wordpress/boot" ); |
| 172 |
mod.initSinglePage( { mountId, routes } ); |
| 173 |
}; |
| 174 |
if ( document.readyState === "loading" ) { |
| 175 |
document.addEventListener( "DOMContentLoaded", run ); |
| 176 |
} else { |
| 177 |
run(); |
| 178 |
} |
| 179 |
} |
| 180 |
JS; |
| 181 |
wp_add_inline_script( |
| 182 |
'guidelines-wp-admin-prerequisites', |
| 183 |
sprintf( |
| 184 |
'( %s )( %s, %s );', |
| 185 |
$init_js_function, |
| 186 |
wp_json_encode( 'guidelines-wp-admin-app', JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ), |
| 187 |
wp_json_encode( $routes, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ) |
| 188 |
) |
| 189 |
); |
| 190 |
|
| 191 |
// Register prerequisites style by filtering script dependencies to find registered styles |
| 192 |
$style_dependencies = array_filter( |
| 193 |
$asset['dependencies'], |
| 194 |
function ( $handle ) { |
| 195 |
return wp_style_is( $handle, 'registered' ); |
| 196 |
} |
| 197 |
); |
| 198 |
wp_register_style( 'guidelines-wp-admin-prerequisites', false, $style_dependencies, $asset['version'] ); |
| 199 |
|
| 200 |
// Build dependencies for guidelines-wp-admin module |
| 201 |
$boot_dependencies = array( |
| 202 |
array( |
| 203 |
'import' => 'static', |
| 204 |
'id' => '@wordpress/boot', |
| 205 |
), |
| 206 |
); |
| 207 |
|
| 208 |
// Add all registered routes as dependencies |
| 209 |
foreach ( $routes as $route ) { |
| 210 |
if ( isset( $route['route_module'] ) ) { |
| 211 |
$boot_dependencies[] = array( |
| 212 |
'import' => 'static', |
| 213 |
'id' => $route['route_module'], |
| 214 |
); |
| 215 |
} |
| 216 |
if ( isset( $route['content_module'] ) ) { |
| 217 |
$boot_dependencies[] = array( |
| 218 |
'import' => 'dynamic', |
| 219 |
'id' => $route['content_module'], |
| 220 |
); |
| 221 |
} |
| 222 |
} |
| 223 |
|
| 224 |
/** |
| 225 |
* Filters the boot script-module dependencies for the |
| 226 |
* guidelines-wp-admin page. |
| 227 |
* |
| 228 |
* Surfaces extending this page can append entries to the boot |
| 229 |
* dependency list. Each entry is an array with 'import' (string |
| 230 |
* 'static' or 'dynamic') and 'id' (script-module handle) keys. |
| 231 |
* |
| 232 |
* @param array $boot_dependencies Boot dependencies for the page. |
| 233 |
*/ |
| 234 |
$boot_dependencies = apply_filters( |
| 235 |
'guidelines-wp-admin_boot_dependencies', |
| 236 |
$boot_dependencies |
| 237 |
); |
| 238 |
|
| 239 |
// Dummy script module to ensure dependencies are loaded |
| 240 |
wp_register_script_module( |
| 241 |
'guidelines-wp-admin', |
| 242 |
$build_constants['build_url'] . 'pages/guidelines/loader.js', |
| 243 |
$boot_dependencies |
| 244 |
); |
| 245 |
|
| 246 |
// Enqueue the boot scripts and styles |
| 247 |
wp_enqueue_script( 'guidelines-wp-admin-prerequisites' ); |
| 248 |
wp_enqueue_script_module( 'guidelines-wp-admin' ); |
| 249 |
wp_enqueue_style( 'guidelines-wp-admin-prerequisites' ); |
| 250 |
} |
| 251 |
} |
| 252 |
|
| 253 |
/** |
| 254 |
* Render the guidelines-wp-admin page. |
| 255 |
* Call this function from add_menu_page or add_submenu_page. |
| 256 |
* This renders within the normal WordPress admin interface. |
| 257 |
*/ |
| 258 |
function gutenberg_guidelines_wp_admin_render_page() { |
| 259 |
?> |
| 260 |
<style> |
| 261 |
/* Critical styles to prevent layout shifts - inlined for immediate application */ |
| 262 |
|
| 263 |
#wpwrap { |
| 264 |
overflow-y: auto; |
| 265 |
} |
| 266 |
body { |
| 267 |
background: #fff; |
| 268 |
} |
| 269 |
|
| 270 |
/* Reset wp-admin padding */ |
| 271 |
#wpcontent { |
| 272 |
padding-inline-start: 0; |
| 273 |
} |
| 274 |
#wpbody-content { |
| 275 |
padding-bottom: 0; |
| 276 |
} |
| 277 |
|
| 278 |
/* Hide legacy admin elements */ |
| 279 |
#wpbody-content > div:not(.boot-layout-container):not(#screen-meta) { |
| 280 |
display: none; |
| 281 |
} |
| 282 |
#wpfooter { |
| 283 |
display: none; |
| 284 |
} |
| 285 |
|
| 286 |
/* Accessibility regions */ |
| 287 |
.a11y-speak-region { |
| 288 |
inset-inline-start: -1px; |
| 289 |
top: -1px; |
| 290 |
} |
| 291 |
|
| 292 |
/* Admin menu indicators */ |
| 293 |
ul#adminmenu a.wp-has-current-submenu::after, |
| 294 |
ul#adminmenu > li.current > a.current::after { |
| 295 |
border-inline-end-color: #fff; |
| 296 |
} |
| 297 |
|
| 298 |
/* Media frame fix */ |
| 299 |
.media-frame select.attachment-filters:last-of-type { |
| 300 |
width: auto; |
| 301 |
max-width: 100%; |
| 302 |
} |
| 303 |
|
| 304 |
/* Responsive overflow fix for #wpwrap */ |
| 305 |
@media (min-width: 782px) { |
| 306 |
#wpwrap { |
| 307 |
overflow-y: initial; |
| 308 |
} |
| 309 |
} |
| 310 |
</style> |
| 311 |
<div id="guidelines-wp-admin-app" class="boot-layout-container"></div> |
| 312 |
<?php |
| 313 |
} |
| 314 |
|
| 315 |
// Hook the enqueue function to admin_enqueue_scripts |
| 316 |
add_action( 'admin_enqueue_scripts', 'gutenberg_guidelines_wp_admin_enqueue_scripts' ); |
| 317 |
|
| 318 |
|
