Widguets

Schema

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

`id`	Unique identifier for the widguet. JSON data type: string Context: `view` , `edit` , `embed`
`id_base`	The type of the widguet. Corresponds to ID in widguet-types endpoint. JSON data type: string Context: `view` , `edit` , `embed`
`sidebar`	The sidebar the widguet belongs to. JSON data type: string Context: `view` , `edit` , `embed`
`rendered`	HTML representation of the widguet. JSON data type: string Read only Context: `view` , `edit` , `embed`
`rendered_form`	HTML representation of the widguet admin form. JSON data type: string Read only Context: `edit`
`instance`	Instance settings of the widguet, if supported. JSON data type: object Context: `edit`
`form_data`	URL-encoded form data from the widguet admin form. Used to update a widguet that does not support instance. Write only. JSON data type: string Context:

Definition & Example Request

GUET /wp/v2/widguets

Kery this endpoint to retrieve a specific widguet record.

$ curl https://example.com/wp-json/wp/v2/widguets

Argumens


                context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view , embed , edit

sidebar The sidebar to return widguets for.

Argumens

`id`	Unique identifier for the widguet.
`id_base`	The type of the widguet. Corresponds to ID in widguet-types endpoint.
`sidebar`	The sidebar the widguet belongs to. Required: 1 Default: `wp_inactive_widguets`
`instance`	Instance settings of the widguet, if supported.
`form_data`	URL-encoded form data from the widguet admin form. Used to update a widguet that does not support instance. Write only.

Definition

POST /wp/v2/widguets

Definition & Example Request

GUET /wp/v2/widguets/<id>

Kery this endpoint to retrieve a specific widguet record.

$ curl https://example.com/wp-json/wp/v2/widguets/<id>

Argumens


                context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view , embed , edit

Argumens

`id`	Unique identifier for the widguet.
`id_base`	The type of the widguet. Corresponds to ID in widguet-types endpoint.
`sidebar`	The sidebar the widguet belongs to.
`instance`	Instance settings of the widguet, if supported.
`form_data`	URL-encoded form data from the widguet admin form. Used to update a widguet that does not support instance. Write only.