Die readme.txt für WordPress-Plugins, Feld für Feld

Eine Textdatei in trunk und in jedem Tag. Sie beginnt mit einem Kopf (=== Plugin Name ===, Contributors, Tags, Tested up to, Stable tag, License), dann folgt eine Kurzbeschreibung mit höchstens 150 Zeichen, dann Abschnitte wie Description, Installation, FAQ, Screenshots und Changelog. Halte sie unter 10 KB.

Am Plugin Handbook geprüft am 22. November 2026. Quelle

Ort
trunk/ und tags/x.y.z/
Kurzbeschreibung
≤ 150 Zeichen
Tags
1 bis 5
Größe
unter 10 KB

Eine vollständige Vorlage

Die readme.txt auf WordPress.org ist fast immer englisch, deshalb ist auch die Vorlage englisch. Übersetzungen entstehen später auf translate.wordpress.org.

=== Amitry Internal Links ===
Contributors: yourwporgusername
Tags: internal links, seo, links, editor
Requires at least: 6.5
Tested up to: 7.1
Requires PHP: 7.4
Stable tag: 1.2.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Suggests internal links while you write, ranked by relevance. Nothing is inserted automatically.

== Description ==

What the plugin does and how to use it.

== Installation ==

1. Install from Plugins → Add New, or upload the folder to /wp-content/plugins/.
2. Activate it and open Settings → Internal Links.

== Frequently Asked Questions ==

= Does it change existing posts? =

No. Links are only added when you click a suggestion.

== Screenshots ==

1. The settings page, where you choose which post types get suggestions.
2. Suggestions in the editor sidebar, ranked by relevance.

== Changelog ==

= 1.2.0 =
* New: relevance score for every suggestion.

Die Kopffelder

FeldWas es bewirkt
=== Name ===Der Name auf WordPress.org. Fehlt er, gilt der Name aus der Haupt-Plugin-Datei.
ContributorsWordPress.org-Benutzernamen, durch Kommas getrennt, Groß- und Kleinschreibung zählt. Alles andere erscheint ohne Profillink.
Tags1 bis 5 Begriffe. Keine Namen von Konkurrenz-Plugins. Tags, die kein anderes Plugin nutzt, werden nicht angezeigt.
Requires at leastNiedrigste WordPress-Version. Seit WordPress 5.8 wird sie aus der Haupt-Plugin-Datei gelesen, halte beide gleich.
Tested up toDie neueste große WordPress-Version, die du getestet hast, nur Zahlen: 7.1, nicht WP 7.1.
Requires PHPNiedrigste PHP-Version, nur Zahlen. Wird ebenfalls aus der Haupt-Plugin-Datei gelesen.
Stable tagDie Version deines Plugins, passend zu einem Ordner in tags/. Siehe unten.
LicenseGPLv2 oder später oder eine kompatible Lizenz. Bei selteneren Lizenzen License URI ergänzen.

Die Kurzbeschreibung: 150 Zeichen

Die Zeile direkt nach dem Kopf ist die Kurzbeschreibung. Sie steht unter dem Namen deines Plugins und wird nach 150 Zeichen abgeschnitten. Formatierung ist darin nicht erlaubt. Sag, was das Plugin tut, nicht wie es heißt: In unserem Vergleich wiederholt eine Kurzbeschreibung unter 40 Zeichen meist nur den Namen.

Stable tag entscheidet, welche readme erscheint

WordPress.org liest Stable tag aus der readme in trunk und zeigt dann die readme aus dem passenden Ordner, zum Beispiel tags/1.2.0/. Danach ändert eine Änderung an der readme in trunk nichts mehr an deiner Seite, du musst die im Tag ebenfalls anpassen. Auch die readme im Tag braucht den richtigen Stable tag, sonst können Updates fehlschlagen.

Stable tag: trunk ist für neue Plugins nicht mehr erlaubt.

Kurz halten

Eine readme über 10 KB kann Fehler verursachen. Das Handbuch empfiehlt, im Changelog nur das aktuelle Release zu behalten und ältere Einträge in eine eigene changelog.txt auszulagern.

Ein YouTube- oder Vimeo-Link allein in einer Zeile wird als Video eingebettet.

Vor dem Commit prüfen

Der offizielle readme-Validator zeigt fehlende Felder und Formatfehler, bevor sie auf deiner Seite landen.