GET /sites/$site/headers/$theme_slug

Get the custom header options for a site with a particular theme.

Resource Information


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

Method Parameters

Parameter	Type	Description
$site	(int\|string)	Site ID or domain.
$theme_slug	(string)	The slug of the theme.

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.

Response Parameters

Parameter	Type	Description
random_default	(bool)	True if the random_default setting is set.
random_uploaded	(bool)	True if the random_uploaded setting is set.
text_color	(string)	The header text color.
url	(string)	The url of the current header image if one is set (does not include default).
width	(int)	The width of the current header image if one is set.
height	(int)	The height of the current header image if one is set.
defaults	(string)	url: (string) The url of the default header image if one exists. text_color: (string) The default header text color. header_text: (bool) True if the header_text default setting is set. random_default: (bool) True if the random_default setting is the default.

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/2916284/headers/twentyeleven'

<?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/2916284/headers/twentyeleven',
	false,
	$context
);
$response = json_decode( $response );
?>