class.wpcom-json-api-render-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 13.0.2

jetpack / json-endpoints / class.wpcom-json-api-render-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-render-endpoint.php

168 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	/**
4	* These are helpers for the shortcode and embed render endpoints.
5	*/
6	abstract class WPCOM_JSON_API_Render_Endpoint extends WPCOM_JSON_API_Endpoint {
7	/**
8	* Figure out what scripts and styles to load.
9	* props to o2's o2_Read_API::poll() function for inspiration.
10	*
11	* In short we figure out what scripts load for a "normal" page load by executing wp_head and wp_footer
12	* then we render the embed/shortcode (to both get our result, and to have the shortcode files enqueue their resources)
13	* then we load wp_head and wp_footer again to see what new resources were added
14	* finally we find out the url to the source file and any extra info (like media or init js)
15	*
16	* @param mixed $callback - the function callback.
17	* @param mixed $callback_arg - the callback arguments.
18	*
19	* @return array
20	*/
21	public function process_render( $callback, $callback_arg ) {
22	global $wp_scripts, $wp_styles;
23
24	if ( false === defined( 'STYLESHEETPATH' ) ) {
25	wp_templating_constants();
26	}
27
28	// initial scripts & styles (to subtract)
29	ob_start();
30	wp_head();
31	wp_footer();
32	ob_end_clean();
33	$initial_scripts = $wp_scripts->done;
34	$initial_styles = $wp_styles->done;
35
36	// actually render the shortcode, get the result, and do the resource loading again so we can subtract..
37	ob_start();
38	wp_head();
39	ob_end_clean();
40	$result = call_user_func( $callback, $callback_arg );
41	ob_start();
42	wp_footer();
43	ob_end_clean();
44
45	// find the difference (the new resource files)
46	$loaded_scripts = array_diff( $wp_scripts->done, $initial_scripts );
47	$loaded_styles = array_diff( $wp_styles->done, $initial_styles );
48	return array(
49	'result' => $result,
50	'loaded_scripts' => $loaded_scripts,
51	'loaded_styles' => $loaded_styles,
52	);
53	}
54
55	/**
56	* Takes the list of styles and scripts and adds them to the JSON response.
57	*
58	* @param array $return - what was returned.
59	* @param array $loaded_scripts - the loaded scripts.
60	* @param array $loaded_styles - the loaded styles.
61	*
62	* @return array
63	*/
64	public function add_assets( $return, $loaded_scripts, $loaded_styles ) {
65	global $wp_scripts, $wp_styles;
66	// scripts first, just cuz
67	if ( $loaded_scripts !== array() ) {
68	$scripts = array();
69	foreach ( $loaded_scripts as $handle ) {
70	if ( ! isset( $wp_scripts->registered[ $handle ] ) ) {
71	continue;
72	}
73
74	$src = $wp_scripts->registered[ $handle ]->src;
75
76	// attach version and an extra query parameters
77	$ver = $this->get_version( $wp_scripts->registered[ $handle ]->ver, $wp_scripts->default_version );
78	if ( isset( $wp_scripts->args[ $handle ] ) ) {
79	$ver = $ver ? $ver . '&' . $wp_scripts->args[ $handle ] : $wp_scripts->args[ $handle ];
80	}
81	$src = add_query_arg( 'ver', $ver, $src );
82
83	// add to an aray so we can return all this info
84	$scripts[ $handle ] = array(
85	'src' => $src,
86	);
87	$extra = $wp_scripts->print_extra_script( $handle, false );
88	if ( ! empty( $extra ) ) {
89	$scripts[ $handle ]['extra'] = $extra;
90	}
91	}
92	$return['scripts'] = $scripts;
93	}
94	// now styles
95	if ( $loaded_styles !== array() ) {
96	$styles = array();
97	foreach ( $loaded_styles as $handle ) {
98	if ( ! isset( $wp_styles->registered[ $handle ] ) ) {
99	continue;
100	}
101
102	$src = $wp_styles->registered[ $handle ]->src;
103
104	// attach version and an extra query parameters
105	$ver = $this->get_version( $wp_styles->registered[ $handle ]->ver, $wp_styles->default_version );
106	if ( isset( $wp_styles->args[ $handle ] ) ) {
107	$ver = $ver ? $ver . '&' . $wp_styles->args[ $handle ] : $wp_styles->args[ $handle ];
108	}
109	$src = add_query_arg( 'ver', $ver, $src );
110
111	// is there a special media (print, screen, etc) for this? if not, default to 'all'
112	$media = 'all';
113	if ( isset( $wp_styles->registered[ $handle ]->args ) ) {
114	$media = esc_attr( $wp_styles->registered[ $handle ]->args );
115	}
116
117	// add to an array so we can return all this info
118	$styles[ $handle ] = array(
119	'src' => $src,
120	'media' => $media,
121	);
122	}
123
124	$return['styles'] = $styles;
125	}
126
127	return $return;
128	}
129
130	/**
131	* Returns the 'version' string set by the shortcode so different versions of scripts/styles can be loaded.
132	*
133	* @param string $this_scripts_version - this scripts version.
134	* @param string $default_version - the default version.
135	*
136	* @return string
137	*/
138	public function get_version( $this_scripts_version, $default_version ) {
139	if ( null === $this_scripts_version ) {
140	$ver = '';
141	} else {
142	$ver = $this_scripts_version ? $this_scripts_version : $default_version;
143	}
144	return $ver;
145	}
146
147	/**
148	* Given a shortcode, process and return the result.
149	*
150	* @param string $shortcode - the shortcode.
151	*/
152	public function do_shortcode( $shortcode ) {
153	return do_shortcode( $shortcode );
154	}
155
156	/**
157	* Given a one-line embed URL, process and return the result.
158	*
159	* @param string $embed_url - the embed URL.
160	*
161	* @return string\|false
162	*/
163	public function do_embed( $embed_url ) {
164	global $wp_embed;
165	return $wp_embed->shortcode( array(), $embed_url );
166	}
167	}
168