REST APIeasy-svg-pro/v1/sets/{id}/icons/label

easy-svg-pro/v1/sets/{id}/icons/label

Changes one icon's display name inside a set, not its slug and not its drawing.

REST endpoint · Easy SVG Pro · Status: Internal · Defined in includes/core/rest.php

Internal: not part of the promised public surface. It may change without notice.

Usage

POST /wp-json/easy-svg-pro/v1/sets/{id}/icons/label

Example

curl -u admin:app-password -H 'Content-Type: application/json' -d '{"slug":"arrow","label":"Arrow right"}' https://example.com/wp-json/easy-svg-pro/v1/sets/42/icons/label

Description

Pages call icons by slug, so renaming the label breaks nothing. The same label again answers state unchanged without a write. 400 easy_svg_pro_icon_name for an empty label, 404 easy_svg_pro_no_icon when the slug is not in the set, 404 easy_svg_pro_no_set for an unknown set. Permission: Requires manage_options, an active licence and the editor feature (Icon set editor) switched on.

Permission: Requires manage_options, an active licence and the editor feature (Icon set editor) switched on.

Parameters

path
idinteger
Required

The icon set post id.

body
slugstring
Required

The icon, by its slug in the set.

body
labelstring
Required

Its new name.

Return value

returnWP_REST_Response|WP_Error

id, slug, label and state (renamed or unchanged).

Response

id, slug, label and state (renamed or unchanged).

{
  "id": 42,
  "slug": "arrow",
  "label": "Arrow right",
  "state": "renamed"
}
Was this page helpful?