Skip to content

Latest commit

 

History

History
255 lines (246 loc) · 6.3 KB

themes.md

File metadata and controls

255 lines (246 loc) · 6.3 KB


Themes

Schema

The schema defines all the fields that exist within a theme record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.

stylesheet
string

The theme's stylesheet. This uniquely identifies the theme.

Read only

Context:

template
string

The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's stylesheet.

Read only

Context:

author
object

The theme author.

Read only

Context:

author_uri
object

The website of the theme author.

Read only

Context:

description
object

A description of the theme.

Read only

Context:

name
object

The name of the theme.

Read only

Context:

requires_php
string

The minimum PHP version required for the theme to work.

Read only

Context:

requires_wp
string

The minimum WordPress version required for the theme to work.

Read only

Context:

screenshot
string, uri

The theme's screenshot URL.

Read only

Context:

tags
object

Tags indicating styles and features of the theme.

Read only

Context:

textdomain
string

The theme's text domain.

Read only

Context:

theme_supports
object

Features supported by this theme.

Read only

Context:

theme_uri
object

The URI of the theme's webpage.

Read only

Context:

version
string

The theme's current version.

Read only

Context:

</div>

List Themes

Query this endpoint to retrieve a collection of themes. The response you receive can be controlled and filtered using the URL query parameters below.

	<h3>Definition</h3>

	<code>GET /wp/v2/themes</code>

	<h3>Example Request</h3>

	<code>$ curl https://example.com/wp-json/wp/v2/themes</code>
</div>
<div class="secondary">
		<h3>Arguments</h3>
<table class="arguments">
				<tr>
			<td>
										<code>context</code><br />
								</td>
			<td>
										<p>Scope under which the request is made; determines fields present in response.</p>
																							</td>
		</tr>
				<tr>
			<td>
										<code>page</code><br />
								</td>
			<td>
										<p>Current page of the collection.</p>
																				<p class="default">
						Default: <code>1</code>
					</p>
													</td>
		</tr>
				<tr>
			<td>
										<code>per_page</code><br />
								</td>
			<td>
										<p>Maximum number of items to be returned in result set.</p>
																				<p class="default">
						Default: <code>10</code>
					</p>
													</td>
		</tr>
				<tr>
			<td>
										<code>search</code><br />
								</td>
			<td>
										<p>Limit results to those matching a string.</p>
																							</td>
		</tr>
				<tr>
			<td>
										<code>status</code><br />
								</td>
			<td>
										<p>Limit result set to themes assigned one or more statuses.</p>
															<p class="required">
						Required: active
					</p>
																		</td>
		</tr>
		</table>

</div>