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

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

jetpack / json-endpoints Last commit date

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

87 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	new WPCOM_JSON_API_Render_Shortcode_Endpoint(
4	array(
5	'description' => 'Get a rendered shortcode for a site. Note: The current user must have publishing access.',
6	'group' => 'sites',
7	'stat' => 'shortcodes:render',
8	'method' => 'GET',
9	'path' => '/sites/%s/shortcodes/render',
10	'path_labels' => array(
11	'$site' => '(int\|string) Site ID or domain',
12	),
13	'query_parameters' => array(
14	'shortcode' => '(string) The query-string encoded shortcode string to render. Required. Only accepts one at a time.',
15	),
16	'response_format' => array(
17	'shortcode' => '(string) The shortcode that was passed in for rendering.',
18	'result' => '(html) The rendered HTML result of the shortcode.',
19	'scripts' => '(array) An array of JavaScript files needed to render the shortcode. Returned in the format of <code>{ "script-slug" : { "src": "http://example.com/file.js", "extra" : "" } }</code> where extra contains any neccessary extra JS for initializing the source file and src contains the script to load. Omitted if no scripts are neccessary.',
20	'styles' => '(array) An array of CSS files needed to render the shortcode. Returned in the format of <code>{ "style-slug" : { "src": "http://example.com/file.css", "media" : "all" } }</code>. Omitted if no styles are neccessary.',
21	),
22	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/shortcodes/render?shortcode=%5Bgallery%20ids%3D%22729%2C732%2C731%2C720%22%5D',
23	'example_request_data' => array(
24	'headers' => array(
25	'authorization' => 'Bearer YOUR_API_TOKEN',
26	),
27	),
28	)
29	);
30
31	/**
32	* Render shortcode endpoint class.
33	*
34	* /sites/%s/shortcodes/render -> $blog_id
35	*/
36	class WPCOM_JSON_API_Render_Shortcode_Endpoint extends WPCOM_JSON_API_Render_Endpoint {
37	/**
38	* The API callback.
39	*
40	* @param string $path - the path.
41	* @param int $blog_id - the blog ID.
42	*
43	* @return array\|WP_Error
44	*/
45	public function callback( $path = '', $blog_id = 0 ) {
46	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
47	if ( is_wp_error( $blog_id ) ) {
48	return $blog_id;
49	}
50
51	if ( ! current_user_can( 'edit_posts' ) ) {
52	return new WP_Error( 'unauthorized', 'Your token must have permission to post on this blog.', 403 );
53	}
54
55	$args = $this->query_args();
56	$shortcode = trim( $args['shortcode'] );
57
58	// Quick validation - shortcodes should always be enclosed in brackets []
59	if ( ! wp_startswith( $shortcode, '[' ) \|\| ! wp_endswith( $shortcode, ']' ) ) {
60	return new WP_Error( 'invalid_shortcode', 'The shortcode parameter must begin and end with square brackets.', 400 );
61	}
62
63	// Make sure only one shortcode is being rendered at a time
64	$pattern = get_shortcode_regex();
65	preg_match_all( "/$pattern/s", $shortcode, $matches );
66	if ( is_countable( $matches[0] ) && count( $matches[0] ) > 1 ) {
67	return new WP_Error( 'invalid_shortcode', 'Only one shortcode can be rendered at a time.', 400 );
68	}
69
70	$render = $this->process_render( array( $this, 'do_shortcode' ), $shortcode );
71
72	// if nothing happened, then the shortcode does not exist.
73	if ( $shortcode === $render['result'] ) {
74	return new WP_Error( 'invalid_shortcode', 'The requested shortcode does not exist.', 400 );
75	}
76
77	// our output for this endpoint..
78	$return = array();
79	$return['shortcode'] = $shortcode;
80	$return['result'] = $render['result'];
81
82	$return = $this->add_assets( $return, $render['loaded_scripts'], $render['loaded_styles'] );
83
84	return $return;
85	}
86	}
87