REST-APIeasy-svg-pro/v1/styles/colours

easy-svg-pro/v1/styles/colours

Liest die Farben, mit denen ein Icon zeichnet, oder ordnet jede davon einer Theme-Farbe zu.

REST-Endpunkt · Easy SVG Pro · Status: Intern · Definiert in includes/styles/styles.php

Intern: nicht Teil der zugesicherten öffentlichen Schnittstelle. Kann sich ohne Ankündigung ändern.

Verwendung

GET | POST /wp-json/easy-svg-pro/v1/styles/colours

Beispiel

curl -X GET "https://example.com/wp-json/easy-svg-pro/v1/styles/colours?icon=acme/logo" \
	-H "X-WP-Nonce: $NONCE" -b "$COOKIES"

curl -X POST "https://example.com/wp-json/easy-svg-pro/v1/styles/colours" \
	-H "X-WP-Nonce: $NONCE" -b "$COOKIES" \
	-H "Content-Type: application/json" \
	-d '{"icon": "acme/logo", "colours": {"#0a2540": "primary"}}'

Beschreibung

GET liefert die verschiedenen Hex-Farben für fill und stroke aus dem ungestylten Markup des Icons. POST speichert eine Farbzuordnung für ein Icon: Schlüssel sind Hex-Farben aus der Zeichnung, Werte ein Paletten-Slug oder ein Hex-Wert; ungültige Paare fallen weg und das Icon behält seine Vorlage. Beide antworten mit 400 easy_svg_pro_no_icon, wenn die Referenz kein collection/slug ist.

Parameter

query
iconstring
Required

Die Icon-Referenz als collection/slug. Bei GET ein Query-Parameter, bei POST ein Body-Feld.

body
coloursobject

Nur POST: Zuordnung einer gezeichneten Hex-Farbe zu einem Paletten-Slug oder Hex-Wert. Nicht im Routen-Schema deklariert, wird aus dem JSON-Body gelesen.

Rückgabewert

returnobject

GET: {icon, colours: ['#rrggbb']}. POST: die kompletten Stil-Einstellungen, gleiche Form wie GET /styles.

Antwort

{
  "icon": "acme/logo",
  "colours": [
    "#0a2540",
    "#ffcc00"
  ]
}

Siehe auch