easy_svg_max_bytes

Filter · Easy SVG · Status: Stabil

Easy SVG lehnt jedes SVG ab, das größer als eine festgelegte Grenze ist, noch bevor es mit dem Bereinigen anfängt. Admins wählen diese Grenze in Megabyte unter Icons → Einstellungen. Mit diesem Filter bestimmt dein Code die endgültige Zahl in Bytes, zum Beispiel eine Grenze unter 1 MB oder eine eigene Grenze je Benutzer.

Verwendung

apply_filters( 'easy_svg_max_bytes', int $bytes )

Wird in easy-svg.php innerhalb der internen Funktion easy_svg_max_bytes() angewendet. Das Ergebnis wird in eine Ganzzahl umgewandelt.

Wann du es brauchst

• Du willst eine Grenze unter 1 MB. Die Einstellung unter Icons → Einstellungen kennt nur ganze Megabyte ab 1, 300 KB erreichst du also nur über diesen Filter.
• Du willst verschiedene Grenzen für verschiedene Leute, etwa eine knappe für Autoren und die volle für Administratoren.
• Du betreust viele Websites und willst die Grenze aus dem Code oder aus der wp-config.php setzen statt über eine Einstellung, die jeder Admin ändern kann.
• Du brauchst auf einer Website eine Grenze über der Obergrenze (standardmäßig 20 MB), ohne die Obergrenze für das Einstellungsfeld anzuheben.

Lass es bleiben, wenn:

• Admins im Einstellungsfeld nur eine höhere Zahl wählen können sollen. Dafür gibt es easy_svg_max_mb_ceiling.
• das Problem eine Datei mit Tausenden use-Elementen oder vielen Verarbeitungsanweisungen ist. Da geht es nicht um Größe, sieh dir easy_svg_max_use_tags und easy_svg_max_php_tags an.
• dein Server den Upload ablehnt, bevor WordPress ihn überhaupt sieht. Die PHP-Werte upload_max_filesize und post_max_size greifen zuerst, und dieser Filter kann sie nicht anheben.

Parameter

Rückgabewert

Standardwert

max_mb * MB_IN_BYTES, wobei max_mb die Einstellung "Maximale SVG-Größe (MB)" unter Icons → Einstellungen ist. Eine frische Installation nutzt 2 MB, also 2097152 Bytes.

Beispiele

Eine Grenze unter einem Megabyte

/**
 * SVG-Dateien bis 300 KB annehmen.
 */
function mysite_svg_max_bytes( $bytes ) {
	return 300 * KB_IN_BYTES;
}
add_filter( 'easy_svg_max_bytes', 'mysite_svg_max_bytes' );

Eine kleinere Grenze für alle außer Administratoren

/**
 * Autoren und Redakteure bekommen 512 KB, Administratoren behalten die Einstellung.
 */
function mysite_svg_max_bytes_by_role( $bytes ) {
	if ( current_user_can( 'manage_options' ) ) {
		return $bytes;
	}

	return min( $bytes, 512 * KB_IN_BYTES );
}
add_filter( 'easy_svg_max_bytes', 'mysite_svg_max_bytes_by_role' );

min() nimmt die kleinere der beiden Zahlen, eine niedrigere Einstellung wirkt also weiter für alle. Denk daran: WP-CLI-Importe und Cron-Jobs laufen ohne angemeldeten Benutzer und bekommen deshalb auch die kleinere Grenze.

Die Grenze aus der wp-config.php, nie null

/**
 * In der wp-config.php: define( 'MYSITE_SVG_MAX_KB', 750 );
 */
function mysite_svg_max_bytes_from_config( $bytes ) {
	if ( ! defined( 'MYSITE_SVG_MAX_KB' ) ) {
		return $bytes;
	}

	// Nie 0 oder weniger zurückgeben: Das würde jeden Upload ablehnen.
	return max( 1, (int) MYSITE_SVG_MAX_KB ) * KB_IN_BYTES;
}
add_filter( 'easy_svg_max_bytes', 'mysite_svg_max_bytes_from_config' );

Dieselbe Grenze im eigenen Add-on nutzen

Nimmt dein Add-on selbst SVG-Markup an, sollte es dieselben Dateien ablehnen wie die Website. Die Funktion easy_svg_max_bytes() ist intern, prüf also, ob es sie gibt, und nimm sonst den Standard.

function myaddon_svg_is_small_enough( $markup ) {
	$limit = function_exists( 'easy_svg_max_bytes' ) ? easy_svg_max_bytes() : 2 * MB_IN_BYTES;

	return strlen( (string) $markup ) <= $limit;
}

So funktioniert es

Der Filter läuft jedes Mal, wenn die Grenze gebraucht wird. Nichts wird zwischengespeichert: Eine geänderte Einstellung oder ein spät hinzugefügter Filter wirkt sofort. Dein Callback bekommt keine Datei, keinen Pfad und keinen Kontext, nur die Zahl.

Hier wird die Grenze gelesen:

Die Hooks für Upload, Sideload und XML-RPC sind nur registriert, solange "SVG-Uploads in der Mediathek erlauben" eingeschaltet ist. Das Sicherheitsnetz auf add_attachment läuft immer.

Bei einem Upload ist die Reihenfolge: Zuerst wird der Dateityp geprüft, dann die Größe auf der Festplatte mit der Grenze verglichen (die Datei ist noch nicht gelesen), dann wird die Datei gelesen und ihre Länge noch einmal verglichen, dann folgt die Strukturprüfung (easy_svg_max_php_tags, easy_svg_max_use_tags) und erst danach der Sanitizer.

Einstellung und Filter greifen so ineinander: Die gespeicherten Megabyte werden auf 1 bis zur Obergrenze begrenzt, mit MB_IN_BYTES multipliziert und dann an diesen Filter übergeben. Das Ergebnis des Filters wird nicht auf die Obergrenze begrenzt, es kann also höher oder niedriger sein als alles, was das Einstellungsfeld zulässt.

Stolperfallen

• Null bedeutet zweierlei. Gibst du 0 zurück (oder null, false, eine negative Zahl), wird jeder nicht leere Upload abgelehnt. Die Icon-Bibliothek liest 0 und weniger aber als "keine Grenze" und nimmt dort jede Größe an. Gib immer eine positive Zahl zurück.
• Das Panel kennt deinen Filter nicht. Das Einstellungsfeld zeigt weiter die gespeicherten Megabyte und sagt "Größere Dateien werden abgelehnt. Erlaubt: 1 bis 20 MB." Senkt dein Filter die Grenze, stimmt der Bildschirm für deine Website nicht mehr. Sag es deinen Redakteuren.
• Eine Meldung für drei Gründe. In der Mediathek bekommen zu große, zu komplexe und nicht bereinigbare Dateien alle "Bitte überprüfe deine SVG-Datei." Dass es an der Größe lag, sieht niemand.
• Importe können Dateien löschen. Das Sicherheitsnetz auf add_attachment löscht einen neuen SVG-Anhang samt Datei, wenn er über der Grenze liegt. Senkst du die Grenze vor einem großen Import, werden zu große SVGs entfernt und nicht mit einem Hinweis übersprungen.
• Vorhandene Dateien verlieren ihre Maße. Breite und Höhe werden bei jeder Mediathek-Ansicht mit derselben Grenze gelesen. Senkst du die Grenze, erscheinen SVGs, die jetzt zu groß sind, ohne Maße. Gelöscht werden sie nicht.
• Die Server-Grenze kommt zuerst. upload_max_filesize und post_max_size stoppen größere Uploads, bevor WordPress läuft. Setzt du den Filter höher, ändert das für den Uploader nichts.
• Kontexte ohne Benutzer. Callbacks, die nach Rolle entscheiden, sehen in WP-CLI, Cron und manchen Importern keinen Benutzer.

Siehe auch

• easy_svg_max_mb_ceiling
• easy_svg_max_php_tags
• easy_svg_max_use_tags
• easy_svg_max_bytes()
• easy_svg_svg_too_complex()
• esw_svg_file_checker()
• easy_svg_check_new_attachment()
• easy-svg/v1/settings