GET /sites/$site/shortcodes/render

Get a rendered shortcode for a site. Note: The current user must have publishing access.

Resource Information


Method	GET
URL	https://public-api.wordpress.com/rest/v1.1/sites/$site/shortcodes/render
Requires authentication?	Yes

Method Parameters

Parameter	Type	Description
$site	(int\|string)	Site ID or domain

Query Parameters

Parameter	Type	Description
context	(string)	display: (default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc.. edit: Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope	(bool)	false: (default) true: Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty	(bool)	false: (default) true: Output pretty JSON
meta	(string)	Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields	(string)	Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback	(string)	An optional JSONP callback function.
shortcode	(string)	The query-string encoded shortcode string to render. Required. Only accepts one at a time.

Response Parameters

Parameter	Type	Description
shortcode	(string)	The shortcode that was passed in for rendering.
result	(html)	The rendered HTML result of the shortcode.
scripts	(array)	An array of JavaScript files needed to render the shortcode. Returned in the format of `{ "script-slug" : { "src": "http://example.com/file.js", "extra" : "" } }` 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.
styles	(array)	An array of CSS files needed to render the shortcode. Returned in the format of `{ "style-slug" : { "src": "http://example.com/file.css", "media" : "all" } }`. Omitted if no styles are neccessary.

Resource Errors

This endpoint does not return any errors.

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 'https://public-api.wordpress.com/rest/v1/sites/82974409/shortcodes/render?shortcode=%5Bgallery%20ids%3D%22729%2C732%2C731%2C720%22%5D'

<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',
    ),
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1/sites/82974409/shortcodes/render?shortcode=%5Bgallery%20ids%3D%22729%2C732%2C731%2C720%22%5D',
	false,
	$context
);
$response = json_decode( $response );
?>