Documentation

Namespace: api

wp. api

Source:

Namespaces

collections
models
utils
views

Members

<static> loadPromise

Construct the default endpoints and add to an endpoints collection.
Source:

<static> WPApiBaseCollection

Contains basic collection functionality such as pagination.
Source:

<static> WPApiBaseModel

Backbone base model for all models.
Source:

Methods

<static> getCollectionByRoute(route)

Determine collection based on API route.
Parameters:
Name Type Description
route string The API route.
Source:
Returns:

<static> getModelByRoute(route)

Determine model based on API route.
Parameters:
Name Type Description
route string The API route.
Source:
Returns:

<static> init( [args])

Initialize the wp-api, optionally passing the API root.
Parameters:
Name Type Argument Description
args object <optional>
Properties
Name Type Argument Description
nonce string <optional>
 The nonce. Optional, defaults to wpApiSettings.nonce.
apiRoot string <optional>
 The api root. Optional, defaults to wpApiSettings.root.
versionString string <optional>
 The version string. Optional, defaults to wpApiSettings.root.
schema object <optional>
 The schema. Optional, will be fetched from API if not provided.
Source:

Namespace: api

wp. api

Source:

Namespaces

collections
models
utils
views

Members

<static> loadPromise

Construct the default endpoints and add to an endpoints collection.
Source:

<static> WPApiBaseCollection

Contains basic collection functionality such as pagination.
Source:

<static> WPApiBaseModel

Backbone base model for all models.
Source:

Methods

<static> getCollectionByRoute(route)

Determine collection based on API route.
Parameters:
Name Type Description
route string The API route.
Source:
Returns:

<static> getModelByRoute(route)

Determine model based on API route.
Parameters:
Name Type Description
route string The API route.
Source:
Returns:

<static> init( [args])

Initialize the wp-api, optionally passing the API root.
Parameters:
Name Type Argument Description
args object <optional>
Properties
Name Type Argument Description
nonce string <optional>
 The nonce. Optional, defaults to wpApiSettings.nonce.
apiRoot string <optional>
 The api root. Optional, defaults to wpApiSettings.root.
versionString string <optional>
 The version string. Optional, defaults to wpApiSettings.root.
schema object <optional>
 The schema. Optional, will be fetched from API if not provided.
Source:

Namespace: api

wp. api

Source:

Namespaces

collections
models
utils
views

Members

<static> loadPromise

Construct the default endpoints and add to an endpoints collection.
Source:

<static> WPApiBaseCollection

Contains basic collection functionality such as pagination.
Source:

<static> WPApiBaseModel

Backbone base model for all models.
Source:

Methods

<static> getCollectionByRoute(route)

Determine collection based on API route.
Parameters:
Name Type Description
route string The API route.
Source:
Returns:

<static> getModelByRoute(route)

Determine model based on API route.
Parameters:
Name Type Description
route string The API route.
Source:
Returns:

<static> init( [args])

Initialize the wp-api, optionally passing the API root.
Parameters:
Name Type Argument Description
args object <optional>
Properties
Name Type Argument Description
nonce string <optional>
 The nonce. Optional, defaults to wpApiSettings.nonce.
apiRoot string <optional>
 The api root. Optional, defaults to wpApiSettings.root.
versionString string <optional>
 The version string. Optional, defaults to wpApiSettings.root.
schema object <optional>
 The schema. Optional, will be fetched from API if not provided.
Source: