Entwickler-Referenz für Easy SVG Pro
Worauf du in Easy SVG Pro aufbauen kannst: Hooks, Register-Funktion, Twig-Helfer, WP-CLI, Lizenz-Konstante, und wie Funktionen eingeschaltet werden.
API-Status
Live-Verfügbarkeit der Updates-, Downloads-, Composer- und Account-APIs. Schau hier zuerst, wenn ein Update oder eine Composer-Installation scheitert.
Easy SVG Pro ist die Agentur-Schicht über dem kostenlosen Easy SVG Support: unbegrenzt viele Icon-Sammlungen, Icon-Sets, Theme- und Ordner-Quellen, Pakete, WP-CLI, der SVG-Cleaner und Integrationen mit Page Buildern und Feld-Plugins. Für Entwickler gibt es eine kleine Zahl zugesagter Einstiegspunkte und eine größere Zahl interner, über die du lesen kannst, auf die du aber nicht aufbauen solltest. Diese Seite erklärt, was was ist, wie Lizenz und Funktionsschalter entscheiden, was läuft, und wie du die Referenzseiten liest.
Worauf du aufbauen kannst
Hooks
Zwölf Filter und eine Action: Icon-Quellen, Icon-Block, Presets, Import-Grenzen, Konfigurator und Icon-Sets.
Register-Funktion
easy_svg_register_icon_collection() fügt eine Sammlung aus einem Theme, Plugin oder Snippet hinzu.
Twig-Helfer
easy_svg_icon(), der Filter easy_svg_icon und easy_svg_icon_exists() für Timber-Themes.
WP-CLI
Sieben Befehle unter wp easy-svg icons und wp easy-svg pack für CI, Deploys und Pakete.
Lizenz-Konstante
EASY_SVG_PRO_LICENSE_KEY in der wp-config.php aktiviert eine Seite, ohne dass jemand den Schlüssel eintippt.
Interne Flächen
Die REST-Routen unter easy-svg-pro/v1, die Abilities, Optionen und Meta. Dokumentiert, nicht zugesagt.
Was zugesagt bleibt
Die readme des Plugins hat einen Abschnitt "For developers: the hooks", und die WP-CLI-Befehle stehen in ihrer Beschreibung. Dieser Linie folgt die Referenz.
| Status | Was dazugehört | Was es für dich heißt |
|---|---|---|
| Stabil | Die Hooks aus der readme, easy_svg_register_icon_collection(), die drei Twig-Helfer, die sieben WP-CLI-Befehle und EASY_SVG_PRO_LICENSE_KEY | Namen und Verhalten bleiben. Bau darauf auf. |
| Intern | Alles andere: die REST-Routen, die Abilities, die übrigen Filter (easy_svg_pro_parse_manifest, easy_svg_pro_collection_icons, die Quellen-Grenzen), Optionen, Post-Meta, die Speicherung der Funktionsschalter und jede Funktion im Namespace | Dokumentiert, damit du das Plugin verstehst. Kann sich in jedem Release ändern. |
Über eine Familie sagt die readme es ausdrücklich: Die Funktionen in includes/core/integration.php (die integration_- und icon_field_-Funktionen) gibt es, zugesagt sind sie nicht.
Interne Funktionen liegen im Namespace UWP\EasySvgPro. Eine Umbenennung wirft in deinem Code keinen Fehler: function_exists() wird einfach false, und deine Funktion hört still auf. Nimm die stabilen Einstiegspunkte, und wenn du doch eine interne Funktion brauchst, prüf sie jedes Mal.
Lizenz und Funktionsschalter
Zwei Dinge entscheiden, ob es eine Pro-Fläche gibt: Die Seite ist mit einer Lizenz aktiviert, und die Funktion ist eingeschaltet.
Die Lizenz. Aktiviere die Seite unter Icons → Lizenz, mit deinem UnleashWP-Konto oder einem Lizenzschlüssel. Ohne aktive Lizenz bleiben die Pro-Funktionen aus.
Die Funktionsschalter. Jede Pro-Funktion ist standardmäßig aus, auch auf einer lizenzierten Seite, und wird unter Icons → Funktionen eingeschaltet. Bereinigen und Härten sind kein Schalter, sie laufen immer.
Die Schalter, die entscheiden, ob es eine Entwickler-Fläche gibt:
| Schalter (Icons → Funktionen) | Schlüssel | Was er für Entwickler einschaltet |
|---|---|---|
| Theme- und Ordner-Quellen | sources | assets/icons, Drop-in-Ordner, easy_svg_register_icon_collection() und die Quellen-Filter |
| Mehrere Sammlungen | collections | Die Übergabe der Sammlungen an den Core-Icon-Block, easy_svg_pro_registered_icon |
| Icon-Set-Editor | editor | Den Post-Type easy_svg_set, Sets als Sammlungen, die Set-Routen, die Weiterleitung der Set-Seite |
| WP-CLI | cli | Jeden Unterbefehl von wp easy-svg |
| Abilities für KI-Agenten | abilities | Die vier Abilities (die Set-Abilities brauchen zusätzlich den Icon-Set-Editor) |
| Timber / Twig | twig | Die drei Twig-Helfer |
| Vorgefertigte Icon-Sets | presets | Den Preset-Katalog und seine zwei Filter |
| Icon-Verlauf | history | Revisionen für Sets, eingehängt an easy_svg_pro_set_icons_written |
Der Konfigurator und seine Filter (easy_svg_pro_dangerous_tags, easy_svg_pro_dangerous_attrs) brauchen nur die Lizenz, keinen Schalter. Die Import-Grenzen gelten auf jedem Importweg, egal welcher Schalter ihn geöffnet hat. EASY_SVG_PRO_LICENSE_KEY und der Tab Lizenz funktionieren auf Seiten ohne Lizenz, denn so kommt eine Seite zu ihrer Lizenz.
Eine zugesagte Funktion, die dir sagt, ob ein Schalter an ist, gibt es nicht. Schreib Code, der sich zurücknimmt: Prüf mit function_exists(), was du aufrufst, und behandle ein leeres Icon oder eine leere Liste als "hier nicht verfügbar".
Voraussetzungen
| Braucht | Version |
|---|---|
| WordPress | 6.6 oder neuer |
| PHP | 8.2 oder neuer |
| Easy SVG Support | 4.3 oder neuer, Umbenennen in der kostenlosen Bibliothek und Stile im Icon-Block brauchen 5.3.3 |
| Core-Icon-Block mit Pro-Sammlungen | WordPress 7.1 (die Icon-Registry) |
| Abilities | WordPress 6.9 (die Abilities API) |
| Timber-Helfer | Timber 1 (getestet mit 1.23.1) oder Timber 2 |
Wann was läuft
Die meisten Pro-Flächen werden auf init verdrahtet. Hängt dein Code von ihnen ab, zählt die Reihenfolge.
| Hook und Priorität | Was passiert |
|---|---|
plugins_loaded | Pro startet, ist die Seite nicht aktiviert, erscheint ein Hinweis |
init 8 | Der Post-Type easy_svg_set wird registriert (Icon-Set-Editor) |
init 9 | Veröffentlichte Sets, der Theme-Ordner und Drop-in-Ordner füllen die Sammlungs-Registry |
init 10 | Die kostenlose Bibliothek registriert sich, ruf hier easy_svg_register_icon_collection() auf |
init 11 | Die Registry geht an den Core-Icon-Block (easy_svg_pro_registered_icon läuft) |
init 20 | Icon-Verlauf, Block Bindings und Patterns |
timber/twig | Die Twig-Helfer kommen dazu |
wp_abilities_api_init | Die Abilities werden registriert |
So liest du eine Referenzseite
Jede handgeschriebene Seite hat dieselben Abschnitte in derselben Reihenfolge:
- Kopfzeile: die Art (Filter, Action, Funktion, Twig-Funktion, WP-CLI-Befehl, Konstante), das Produkt und der Status.
- Eine kurze, einfache Einleitung.
- Verwendung: die genaue Signatur oder Synopsis, und wo sie angewendet wird.
- Wann du es brauchst: echte Situationen, und wann du besser etwas anderes nimmst.
- Parameter: was jedes Argument enthält.
- Rückgabewert: was dein Callback zurückgeben muss, oder was der Befehl ausgibt und mit welchem Exit-Code er endet.
- Standardwert: der Wert, wenn niemand etwas ändert.
- Beispiele: ein einfacher Fall, ein realistischer Agentur-Fall und ein defensiver, der zuerst prüft, ob das Plugin da ist.
- So funktioniert es: was der Code wirklich macht, in welcher Reihenfolge, hinter welcher Lizenz und welchem Schalter, und was gecacht wird.
- Stolperfallen: Fehler direkt aus dem Code, Sicherheitshinweise in roten Kästen.
- Siehe auch: die Nachbarn und passende Tutorials.
Seiten für interne Einträge werden aus dem Code erzeugt und sind kürzer. Sie sagen dir, was es gibt, nicht, dass es bleibt.
Tutorials
Icons aus einem Theme oder Plugin ausliefern
Theme-Ordner, Drop-ins, manifest.json und die Register-Funktion.
Mit WP-CLI automatisieren
Icons in der CI prüfen, Pakete zwischen Seiten bewegen, Deploys kontrollieren.
REST-API
Die internen Routen des Panels, mit Anmeldung und Freischaltung.
Abilities für KI-Agenten
Einen Agenten sicher Icons auflisten, hinzufügen und entfernen lassen.
Timber und Twig
Icons in Twig zeichnen und Templates absichern.
Auf Set-Änderungen reagieren
Eine Action für jedes Speichern, dazu Sperren und Revisionen.
Alle stabilen Einträge
Quellen und Sammlungen
easy_svg_pro_source_dirs: die Drop-in-Ordner, die als Sammlungen gescannt werden.easy_svg_pro_theme_collection_slug: der Slug des eigenen Icon-Ordners des Themes.easy_svg_register_icon_collection(): registriert eine Sammlung aus einem Ordner oder einem Array.
Icon-Block
easy_svg_pro_registered_icon: das Markup eines Icons auf dem Weg in den Core-Icon-Block.
Presets
Import
easy_svg_pro_import_max_entries: Einträge, die aus einem ZIP gelesen werden.easy_svg_pro_import_max_total_bytes: Bytes, die insgesamt aus einem ZIP gelesen werden.easy_svg_pro_import_font_max_bytes: die größte SVG-Font, die ein Set-Import liest.
Konfigurator
easy_svg_pro_dangerous_tags: Element-Namen, die der Konfigurator ablehnt.easy_svg_pro_dangerous_attrs: Attribut-Namen, die der Konfigurator ablehnt.
Sets
easy_svg_pro_set_screen_redirect: ob die Set-Seite ans Raster der Bibliothek übergibt.easy_svg_pro_set_write_context: ob ein Request die Set-Sperre nimmt.easy_svg_pro_set_icons_written: feuert nach jedem Speichern der Icons eines Sets.
Twig
easy_svg_icon(): zeichnet ein Icon in einem Twig-Template.easy_svg_icon(Filter): dasselbe als Twig-Filter.easy_svg_icon_exists(): prüft, ob ein Icon gerendert wird.
Konstanten
EASY_SVG_PRO_LICENSE_KEY: der Lizenzschlüssel aus derwp-config.php.
WP-CLI
wp easy-svg icons list: jede Sammlung mit Anzahl, Herkunft und Problemen.wp easy-svg icons problems: jede Datei, die ein Ordner nicht verwenden konnte, und warum.wp easy-svg icons validate: prüft einen Ordner mit SVGs, ohne zu importieren.wp easy-svg icons import: kopiert einen Ordner in eine Drop-in-Sammlung.wp easy-svg pack list: jede Sammlung, die sich exportieren lässt.wp easy-svg pack export: schreibt eine Sammlung als Paket-ZIP.wp easy-svg pack import: liest ein Paket-ZIP als neues Icon-Set ein.