jetpack / jetpack_vendor / automattic / jetpack-premium-analytics / src / widget-modules.php

widget-modules.php in Jetpack – WP Security, Backup, Speed, & Growth 16.3-a.5, at jetpack_vendor/automattic/jetpack-premium-analytics/src/widget-modules.php

119 lines 3.5 KB

Raw Download Zip

1	<?php
2	/**
3	* Dashboard widget modules: REST exposure + import-map wiring.
4	*
5	* Reads get_available_widget_types() and exposes it two ways: the `/wpcom/v2/widget-modules`
6	* REST list, and the page import map, for dynamic `import()`.
7	*
8	* @package automattic/jetpack-premium-analytics
9	*/
10
11	namespace Automattic\Jetpack\PremiumAnalytics;
12
13	require_once __DIR__ . '/rest-namespace.php';
14
15	/**
16	* Register the `/wpcom/v2/widget-modules` REST route.
17	*
18	* @return void
19	*/
20	function register_widget_modules_rest_route() {
21	register_rest_route(
22	DASHBOARD_REST_NAMESPACE,
23	'/widget-modules',
24	array(
25	'methods' => \WP_REST_Server::READABLE,
26	'callback' => __NAMESPACE__ . '\\get_widget_modules_response',
27	'permission_callback' => array( Capabilities::class, 'current_user_can_view_analytics' ),
28	)
29	);
30	}
31
32	/**
33	* Load the widget type API and the build manifest, once, ahead of the registry's first read.
34	*
35	* Deferred to the registry's only two readers rather than run at boot: on Simple this file's
36	* registration runs on every WPCOM public-api request, and most never read the registry. The
37	* registry hydrates itself on that read, from the registration action.
38	*
39	* @return void
40	*/
41	function ensure_widget_registry_ready() {
42	static $ready = false;
43	if ( $ready ) {
44	return;
45	}
46	$ready = true;
47
48	require_once __DIR__ . '/widget-types.php';
49	require_once __DIR__ . '/widget-availability.php';
50
51	// REST does not load the admin build, so this require is the manifest's only route in
52	// (WOOA7S-1804). Drop it and every widget renders "Widget is no longer available" (#49961).
53	$widgets_manifest = Analytics::widget_manifest_path();
54	if ( file_exists( $widgets_manifest ) ) {
55	require_once $widgets_manifest;
56	}
57	}
58
59	/**
60	* Build the REST response: one record per available widget type.
61	*
62	* @return \WP_REST_Response
63	*/
64	function get_widget_modules_response() {
65	ensure_widget_registry_ready();
66
67	$records = array();
68
69	foreach ( get_available_widget_types() as $widget_type ) {
70	$records[] = array(
71	'name' => $widget_type->name,
72	'render_module' => $widget_type->render_module,
73	'widget_module' => $widget_type->widget_module,
74	'presentation' => $widget_type->presentation,
75	'category' => $widget_type->category,
76	'title' => $widget_type->title,
77	'description' => $widget_type->description,
78	'help' => $widget_type->help,
79	'icon' => $widget_type->icon,
80	'actions' => $widget_type->actions,
81	'keywords' => $widget_type->keywords,
82	'textdomain' => $widget_type->textdomain,
83	'i18n_manifest' => $widget_type->i18n_manifest,
84	);
85	}
86
87	return rest_ensure_response( $records );
88	}
89
90	/**
91	* Add available widget modules to the page import map as dynamic dependencies,
92	* so the client can `import()` them on demand.
93	*
94	* @param array $boot_dependencies Boot dependencies for the page.
95	* @return array Updated boot dependencies.
96	*/
97	function add_widget_modules_to_boot_deps( $boot_dependencies ) {
98	ensure_widget_registry_ready();
99
100	foreach ( get_available_widget_types() as $widget_type ) {
101	if ( ! empty( $widget_type->render_module ) ) {
102	$boot_dependencies[] = array(
103	'import' => 'dynamic',
104	'id' => $widget_type->render_module,
105	);
106	}
107
108	if ( ! empty( $widget_type->widget_module ) ) {
109	$boot_dependencies[] = array(
110	'import' => 'dynamic',
111	'id' => $widget_type->widget_module,
112	);
113	}
114	}
115
116	return $boot_dependencies;
117	}
118	add_filter( 'jetpack-premium-analytics-wp-admin_boot_dependencies', __NAMESPACE__ . '\\add_widget_modules_to_boot_deps' );
119