REST
2 weeks ago
Reports
2 weeks ago
Sync
2 weeks ago
class-analytics.php
2 weeks ago
class-capabilities.php
2 weeks ago
class-connection-configuration.php
2 weeks ago
class-dashboard-section-registry.php
2 weeks ago
class-dashboard-section.php
2 weeks ago
class-dashboard-support-routes.php
2 weeks ago
class-jetpack-stats-tracker.php
2 weeks ago
class-notices.php
2 weeks ago
class-widget-type-registry.php
2 weeks ago
class-widget-type.php
2 weeks ago
class-woocommerce-analytics-tracker.php
2 weeks ago
csv-exports.php
2 weeks ago
dashboard-grammar.php
2 weeks ago
dashboard-layout.php
2 weeks ago
dashboard-sections.php
2 weeks ago
rest-namespace.php
2 weeks ago
widget-availability.php
2 weeks ago
widget-i18n.json
2 weeks ago
widget-modules.php
2 weeks ago
widget-type-support.php
2 weeks ago
widget-types.php
2 weeks ago
widget-modules.php
125 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Dashboard widget modules: REST exposure + import-map wiring. |
| 4 | * |
| 5 | * Reads get_available_widget_types() (the registry filtered by |
| 6 | * widget-availability.php) and exposes it two ways: the |
| 7 | * `/wpcom/v2/widget-modules` REST list, and the page import map, where each |
| 8 | * widget's render and metadata modules are registered for dynamic `import()`. |
| 9 | * |
| 10 | * @package automattic/jetpack-premium-analytics |
| 11 | */ |
| 12 | |
| 13 | namespace Automattic\Jetpack\PremiumAnalytics; |
| 14 | |
| 15 | require_once __DIR__ . '/rest-namespace.php'; |
| 16 | |
| 17 | /** |
| 18 | * Register the `/wpcom/v2/widget-modules` REST route. |
| 19 | * |
| 20 | * @return void |
| 21 | */ |
| 22 | function register_widget_modules_rest_route() { |
| 23 | register_rest_route( |
| 24 | DASHBOARD_REST_NAMESPACE, |
| 25 | '/widget-modules', |
| 26 | array( |
| 27 | 'methods' => \WP_REST_Server::READABLE, |
| 28 | 'callback' => __NAMESPACE__ . '\\get_widget_modules_response', |
| 29 | 'permission_callback' => array( Capabilities::class, 'current_user_can_view_analytics' ), |
| 30 | ) |
| 31 | ); |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * Load and hydrate the widget type registry, once. |
| 36 | * |
| 37 | * Deferred to here (the registry's only two readers) instead of running |
| 38 | * unconditionally at boot: this package boots on every request to a site |
| 39 | * that has it active, and on WPCOM Simple this file's registration runs on |
| 40 | * every public-api request across all of WPCOM, not just ones that touch |
| 41 | * Premium Analytics. Most such requests never read the registry at all, so |
| 42 | * parsing the widget manifest and hydrating it eagerly was wasted work. |
| 43 | * |
| 44 | * @return void |
| 45 | */ |
| 46 | function ensure_widget_registry_ready() { |
| 47 | static $ready = false; |
| 48 | if ( $ready ) { |
| 49 | return; |
| 50 | } |
| 51 | $ready = true; |
| 52 | |
| 53 | require_once __DIR__ . '/widget-types.php'; |
| 54 | require_once __DIR__ . '/widget-availability.php'; |
| 55 | |
| 56 | // Manifest register_widget_types() reads; absent without a JS build. |
| 57 | $widgets_manifest = __DIR__ . '/../build/widgets.php'; |
| 58 | if ( file_exists( $widgets_manifest ) ) { |
| 59 | require_once $widgets_manifest; |
| 60 | } |
| 61 | |
| 62 | bootstrap_widget_types(); |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * Build the REST response: one record per available widget type. |
| 67 | * |
| 68 | * @return \WP_REST_Response |
| 69 | */ |
| 70 | function get_widget_modules_response() { |
| 71 | ensure_widget_registry_ready(); |
| 72 | |
| 73 | $records = array(); |
| 74 | |
| 75 | foreach ( get_available_widget_types() as $widget_type ) { |
| 76 | $records[] = array( |
| 77 | 'name' => $widget_type->name, |
| 78 | 'render_module' => $widget_type->render_module, |
| 79 | 'widget_module' => $widget_type->widget_module, |
| 80 | 'presentation' => $widget_type->presentation, |
| 81 | 'category' => $widget_type->category, |
| 82 | 'title' => $widget_type->title, |
| 83 | 'description' => $widget_type->description, |
| 84 | 'help' => $widget_type->help, |
| 85 | 'keywords' => $widget_type->keywords, |
| 86 | ); |
| 87 | } |
| 88 | |
| 89 | return rest_ensure_response( $records ); |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Add available widget modules to the page import map as dynamic dependencies, |
| 94 | * so the client can `import()` them on demand. |
| 95 | * |
| 96 | * @param array $boot_dependencies Boot dependencies for the page. |
| 97 | * @return array Updated boot dependencies. |
| 98 | */ |
| 99 | function add_widget_modules_to_boot_deps( $boot_dependencies ) { |
| 100 | ensure_widget_registry_ready(); |
| 101 | |
| 102 | foreach ( get_available_widget_types() as $widget_type ) { |
| 103 | if ( ! empty( $widget_type->render_module ) ) { |
| 104 | $boot_dependencies[] = array( |
| 105 | 'import' => 'dynamic', |
| 106 | 'id' => $widget_type->render_module, |
| 107 | ); |
| 108 | } |
| 109 | |
| 110 | if ( ! empty( $widget_type->widget_module ) ) { |
| 111 | $boot_dependencies[] = array( |
| 112 | 'import' => 'dynamic', |
| 113 | 'id' => $widget_type->widget_module, |
| 114 | ); |
| 115 | } |
| 116 | } |
| 117 | |
| 118 | return $boot_dependencies; |
| 119 | } |
| 120 | // The full-page interceptor (page.php) renders via the `{page-id}` filter; the |
| 121 | // in-admin variant (page-wp-admin.php) uses the `{page-id}-wp-admin` filter. Hook |
| 122 | // both so the widget modules land in the import map regardless of which renders. |
| 123 | add_filter( 'jetpack-premium-analytics_boot_dependencies', __NAMESPACE__ . '\\add_widget_modules_to_boot_deps' ); |
| 124 | add_filter( 'jetpack-premium-analytics-wp-admin_boot_dependencies', __NAMESPACE__ . '\\add_widget_modules_to_boot_deps' ); |
| 125 |