WP Kernel API v0.3.0

---

WP Kernel API / core/src / interpolatePath

Function: interpolatePath()

function interpolatePath(path, params): string;

Interpolate dynamic segments in a REST path

Replaces :paramName patterns with values from the params object. Throws DeveloperError if required params are missing.

Parameters

path

string

REST path with :param placeholders

params

PathParams = {}

Parameter values to interpolate

Returns

string

Interpolated path

Throws

DeveloperError if required params are missing

Example

interpolatePath('/my-plugin/v1/things/:id', { id: 123 })
// => '/my-plugin/v1/things/123'

interpolatePath('/my-plugin/v1/things/:id', {}) // throws DeveloperError