Easy SVG Entwickler-Referenz

Easy SVG Support bereinigt jedes SVG, bevor WordPress es speichert, und verwaltet eine Bibliothek mit deinen eigenen Icons für den Icon-Block. Dazu kommt eine kleine, bewusst gewählte Auswahl an Hooks, Funktionen und JavaScript-Einstiegen für Themes, Website-Plugins und Add-ons. Auf dieser Seite siehst du, was es gibt, was versprochen bleibt und wie du die Referenzseiten liest.

Worauf du aufbauen kannst

Kurz zusammengefasst:

• Hooks. Jeder Hook hat einen festen, ausgeschriebenen Namen. Die Sanitizer-Filter (esw_svg_allowed_tags, esw_svg_allowed_attributes, esw_svg_remove_remote_references) behalten ihr älteres Präfix esw_, weil viele Websites sie schon nutzen. Alles Neuere beginnt mit easy_svg_.
• Funktionen. easy_svg_sanitizer(), easy_svg_icon(), easy_svg_rename_icon() und easy_svg_update_icon_markup().
• Shortcode. [easy_svg_icon name="easy-svg/heart"] mit den optionalen Angaben class und label, gibt dasselbe Markup aus wie easy_svg_icon().
• Icon-Block. Ist die Icon-Bibliothek eingeschaltet und hat WordPress seine Icon-Registry (ab 7.1), wird jedes gespeicherte Icon in der Sammlung easy-svg für den Icon-Block registriert.
• JavaScript. Auf dem Icons-Bildschirm bietet window.EasySvgPanel die Einträge registerTab(), registerCollections() und api.
• REST. Das Panel spricht mit easy-svg/v1/settings und easy-svg/v1/library (mit add, media, rename, replace und delete). Jede Route verlangt die Berechtigung manage_options. Diese Routen sind intern: Sie dienen dem Panel und gehören nicht zum Versprechen unten. Das REST-API-Tutorial zeigt, wie du sie trotzdem sinnvoll nutzt.

Was versprochen bleibt

Die readme des Plugins zieht eine klare Grenze, und diese Referenz folgt ihr:

• Stabil ist, was die readme für Entwickler nennt: die Hooks in ihren FAQ, die Funktionen oben, die drei Versionskonstanten, der Shortcode, die Icon-Block-Sammlung und die Einträge der Panel-Registry. Sie behalten Namen und Verhalten, und wenn sich ihre Form ändert, ändert sich eine Versionskonstante mit.
• Intern ist alles andere: Hilfsfunktionen, die Klassen esw_svg_tags und esw_svg_attributes, das globale $sanitizer, Optionen, Transients, die REST-Routen und weitere JavaScript-Eigenschaften. Laut readme darf alles andere umbenannt oder entfernt werden. Interne Seiten sind dokumentiert, damit du das Plugin verstehst, und tragen jeweils einen Hinweis.

Versionskonstanten und Funktionserkennung

Vergleiche mit diesen Zahlen, nie mit der Plugin-Version. Jede ändert sich nur, wenn sich ihre eigene Schnittstelle ändert, und ob es einen Filter gibt, kannst du nicht abfragen. Die Konstanten sind also das einzige verlässliche Signal.

Alle drei werden definiert, wenn easy-svg.php lädt, egal welche Funktionen eingeschaltet sind. Ein Plugin, das vor Easy SVG lädt, sieht sie noch nicht. Prüf deshalb auf plugins_loaded oder später:

function myaddon_boot() {
	if ( ! defined( 'EASY_SVG_API' ) ) {
		return; // Easy SVG Support ist nicht aktiv.
	}

	if ( defined( 'EASY_SVG_ICONS_API' ) && EASY_SVG_ICONS_API >= 3 ) {
		require_once __DIR__ . '/includes/icon-repair.php';
	}

	if ( defined( 'EASY_SVG_PANEL_API' ) && EASY_SVG_PANEL_API >= 3 ) {
		add_action( 'easy_svg_panel_enqueue', 'myaddon_enqueue_panel_bundle' );
	}
}
add_action( 'plugins_loaded', 'myaddon_boot' );

In JavaScript liest du auf dem Icons-Bildschirm window.EasySvgPanel.api. Dort steht dieselbe Zahl wie in EASY_SVG_PANEL_API.

So liest du eine Referenzseite

Jede Seite hat dieselben Abschnitte in derselben Reihenfolge:

1. Kopfzeile: die Art (Filter, Action, Funktion, Shortcode, Block, Konstante, JavaScript), das Produkt und der Status.
2. Verwendung: die genaue Signatur oder Definition.
3. Wann du es brauchst: echte Situationen, und wann du besser zu etwas anderem greifst.
4. Parameter: was jedes Argument enthält und welche Werte erlaubt sind.
5. Rückgabewert: was dein Callback oder die Funktion zurückgeben muss, oder was die Konstante enthält.
6. Standardwert: der Wert, wenn niemand etwas ändert.
7. Beispiele: ein einfacher Fall, ein realistischer und ein defensiver, der zuerst prüft, ob das Plugin da ist.
8. So funktioniert es: was der Code wirklich tut, in welcher Reihenfolge und auf welchen WordPress-Hooks.
9. Stolperfallen: Fehler, die sich aus dem Code ergeben, dazu Sicherheitshinweise, wo sie wichtig sind.
10. Siehe auch: die benachbarten Einträge.

Der Status ist entweder Stabil (gehört zum Versprechen oben) oder Intern (kann sich ohne Ankündigung ändern).

Die Gruppen ordnen die Referenz nach Thema:

Tutorials

Alle stabilen Einträge

Sanitizer

• esw_svg_allowed_tags: filtert die SVG-Elementnamen, die der Sanitizer behält.
• esw_svg_allowed_attributes: filtert die SVG-Attributnamen, die der Sanitizer behält.
• esw_svg_remove_remote_references: entscheidet, ob Verweise auf andere Hosts entfernt werden.
• easy_svg_sanitizer(): liefert einen Sanitizer, der genau so eingestellt ist wie der der Website.

Uploads and limits

• easy_svg_max_bytes: das größte SVG in Bytes, das das Plugin liest.
• easy_svg_max_mb_ceiling: die höchste Größe, die Admins in den Einstellungen wählen können.
• easy_svg_max_php_tags: wie viele Verarbeitungsanweisungen eine Datei enthalten darf.
• easy_svg_max_use_tags: wie viele use-Elemente eine Datei enthalten darf.

Multisite

• easy_svg_respect_network_filetypes: ob die erlaubten Dateitypen des Netzwerks SVG fernhalten können.

Icons

• easy_svg_icon(): liefert ein gespeichertes Icon als Inline-SVG.
• easy_svg_icon: die Shortcode-Variante von easy_svg_icon().
• easy_svg_icon_markup: filtert das Markup eines Icons auf dem Weg aus easy_svg_icon() und dem Shortcode.
• easy_svg_registrable_icons: filtert die ganze Bibliothek, bevor sie beim Icon-Block ankommt.
• easy_svg_rename_icon(): ändert den sichtbaren Namen eines Icons und behält den Slug.
• easy_svg_update_icon_markup(): ersetzt die Zeichnung eines Icons, durch Sanitizer und Upload-Grenzen.

Blocks

• easy-svg: die Icon-Sammlung, die für den Icon-Block registriert wird.

Icons panel

• easy_svg_panel_enqueue: feuert, wenn das Panel-Skript eingereiht wird, damit deins danach lädt.
• easy_svg_panel_menu_tabs: welche Tabs einen eigenen Menüeintrag bekommen und welche Berechtigung jeder braucht.
• window.EasySvgPanel: die Erweiterungs-Registry des Panels.
• window.EasySvgPanel.registerTab: fügt einen Tab mit eigener Render-Funktion hinzu.
• window.EasySvgPanel.registerCollections: zeigt die Icon-Sammlungen eines Add-ons im Tab Icon-Bibliothek.
• window.EasySvgPanel.api: die Vertragsstufe des Panels in JavaScript.

Admin

• easy_svg_pro_url: die Adresse hinter dem Link Easy SVG Pro kaufen auf der Plugin-Seite.

Constants

• EASY_SVG_API: Version des Sanitizer-Vertrags.
• EASY_SVG_PANEL_API: Version des Icons-Panel-Vertrags.
• EASY_SVG_ICONS_API: Version des Icon-Vertrags.