PluginProbe
Gutenberg / 23.3.1
Gutenberg v23.3.1
23.9.1 23.9.0 23.8.0 23.7.2 23.7.1 23.7.0 23.6.1 23.6.2 23.6.0 23.5.3 23.5.2 23.5.1 23.5.0 23.4.0 23.3.2 23.3.1 23.3.0 23.2.0 23.2.1 23.2.2 23.1.1 23.1.0 23.0.1 12.6.0 7.4.0 All 402 releases
gutenberg / build / pages / experiments / page-wp-admin.php

page-wp-admin.php in Gutenberg 23.3.1, at build/pages/experiments/page-wp-admin.php

318 lines 9.5 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * Page: experiments (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 experiments routes and menu items
14 global $gutenberg_experiments_wp_admin_routes, $gutenberg_experiments_wp_admin_menu_items;
15 $gutenberg_experiments_wp_admin_routes = array();
16 $gutenberg_experiments_wp_admin_menu_items = array();
17
18 /**
19 * Register a route for the experiments-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_experiments_wp_admin_route( $path, $content_module = null, $route_module = null ) {
26 global $gutenberg_experiments_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_experiments_wp_admin_routes[] = $route;
37 }
38
39 /**
40 * Register a menu item for the experiments-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_experiments_wp_admin_menu_item( $id, $label, $to, $parent_id = '' ) {
49 global $gutenberg_experiments_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_experiments_wp_admin_menu_items[] = $menu_item;
62 }
63
64 /**
65 * Get all registered routes for the experiments-wp-admin page.
66 *
67 * @return array Array of route objects.
68 */
69 function gutenberg_get_experiments_wp_admin_routes() {
70 global $gutenberg_experiments_wp_admin_routes;
71 return $gutenberg_experiments_wp_admin_routes ?? array();
72 }
73
74 /**
75 * Get all registered menu items for the experiments-wp-admin page.
76 *
77 * @return array Array of menu item objects.
78 */
79 function gutenberg_get_experiments_wp_admin_menu_items() {
80 global $gutenberg_experiments_wp_admin_menu_items;
81 return $gutenberg_experiments_wp_admin_menu_items ?? array();
82 }
83
84 /**
85 * Preload REST API data for the experiments-wp-admin page.
86 * Automatically called during page rendering.
87 */
88 function gutenberg_experiments_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 experiments-wp-admin page.
116 * Hooked to admin_enqueue_scripts.
117 *
118 * @param string $hook_suffix The current admin page.
119 */
120 function gutenberg_experiments_wp_admin_enqueue_scripts( $hook_suffix ) {
121 // Check all possible ways this page can be accessed:
122 // 1. Menu page via admin.php?page=experiments-wp-admin (plugin)
123 // 2. Direct file via experiments.php (Core) - screen ID will be 'experiments'
124 $current_screen = get_current_screen();
125 $is_our_page = (
126 ( isset( $_GET['page'] ) && 'experiments-wp-admin' === $_GET['page'] ) || // phpcs:ignore WordPress.Security.NonceVerification.Recommended
127 ( $current_screen && 'experiments' === $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 // Fire init action for extensions to register routes and menu items
138 do_action( 'experiments-wp-admin_init' );
139
140 // Preload REST API data
141 gutenberg_experiments_wp_admin_preload_data();
142
143 // Get all registered routes
144 $routes = gutenberg_get_experiments_wp_admin_routes();
145
146 // Get boot module asset file for dependencies
147 $asset_file = __DIR__ . '/../../modules/boot/index.min.asset.php';
148 if ( file_exists( $asset_file ) ) {
149 $asset = require $asset_file;
150
151 // This script serves two purposes:
152 // 1. It ensures all the globals that are made available to the modules are loaded.
153 // 2. It initializes the boot module as an inline script.
154 wp_register_script( 'experiments-wp-admin-prerequisites', '', $asset['dependencies'], $asset['version'], true );
155
156 /*
157 * Add inline script to initialize the app using initSinglePage (no menuItems).
158 * The dynamic import is deferred until DOMContentLoaded so that all classic
159 * script dependencies of @wordpress/boot (wp-private-apis, wp-components,
160 * wp-theme, etc.) have finished parsing and executing before the boot module
161 * evaluates. Otherwise, a modulepreloaded @wordpress/boot can win the race
162 * against the classic-script-printing pass on fast CDN-fronted hosts in
163 * Chrome, evaluating before wp.theme.privateApis is defined and throwing
164 * "Cannot unlock an undefined object". See <https://core.trac.wordpress.org/ticket/65103>.
165 */
166 $init_js_function = <<<'JS'
167 ( mountId, routes ) => {
168 const run = async () => {
169 const mod = await import( "@wordpress/boot" );
170 mod.initSinglePage( { mountId, routes } );
171 };
172 if ( document.readyState === "loading" ) {
173 document.addEventListener( "DOMContentLoaded", run );
174 } else {
175 run();
176 }
177 }
178 JS;
179 wp_add_inline_script(
180 'experiments-wp-admin-prerequisites',
181 sprintf(
182 '( %s )( %s, %s );',
183 $init_js_function,
184 wp_json_encode( 'experiments-wp-admin-app', JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ),
185 wp_json_encode( $routes, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES )
186 )
187 );
188
189 // Register prerequisites style by filtering script dependencies to find registered styles
190 $style_dependencies = array_filter(
191 $asset['dependencies'],
192 function ( $handle ) {
193 return wp_style_is( $handle, 'registered' );
194 }
195 );
196 wp_register_style( 'experiments-wp-admin-prerequisites', false, $style_dependencies, $asset['version'] );
197
198 // Build dependencies for experiments-wp-admin module
199 $boot_dependencies = array(
200 array(
201 'import' => 'static',
202 'id' => '@wordpress/boot',
203 ),
204 );
205
206 // Add all registered routes as dependencies
207 foreach ( $routes as $route ) {
208 if ( isset( $route['route_module'] ) ) {
209 $boot_dependencies[] = array(
210 'import' => 'static',
211 'id' => $route['route_module'],
212 );
213 }
214 if ( isset( $route['content_module'] ) ) {
215 $boot_dependencies[] = array(
216 'import' => 'dynamic',
217 'id' => $route['content_module'],
218 );
219 }
220 }
221
222 /**
223 * Filters the boot script-module dependencies for the
224 * experiments-wp-admin page.
225 *
226 * Surfaces extending this page can append entries to the boot
227 * dependency list. Each entry is an array with 'import' (string
228 * 'static' or 'dynamic') and 'id' (script-module handle) keys.
229 *
230 * @param array $boot_dependencies Boot dependencies for the page.
231 */
232 $boot_dependencies = apply_filters(
233 'experiments-wp-admin_boot_dependencies',
234 $boot_dependencies
235 );
236
237 // Dummy script module to ensure dependencies are loaded
238 wp_register_script_module(
239 'experiments-wp-admin',
240 $build_constants['build_url'] . 'pages/experiments/loader.js',
241 $boot_dependencies
242 );
243
244 // Enqueue the boot scripts and styles
245 wp_enqueue_script( 'experiments-wp-admin-prerequisites' );
246 wp_enqueue_script_module( 'experiments-wp-admin' );
247 wp_enqueue_style( 'experiments-wp-admin-prerequisites' );
248 }
249 }
250
251 /**
252 * Render the experiments-wp-admin page.
253 * Call this function from add_menu_page or add_submenu_page.
254 * This renders within the normal WordPress admin interface.
255 */
256 function gutenberg_experiments_wp_admin_render_page() {
257 ?>
258 <style>
259 /* Critical styles to prevent layout shifts - inlined for immediate application */
260
261 /* Background colors */
262 #wpwrap {
263 background: var(--wpds-color-fg-content-neutral, #1e1e1e);
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="experiments-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_experiments_wp_admin_enqueue_scripts' );
317
318