Von Grund auf: Eine vollständige Anleitung zur Entwicklung von WordPress-Plugins und ein Austausch über Best Practices

Grundlagen der WordPress-Plugin-Entwicklung und Einrichtung der Entwicklungsumgebung

Der Kern der WordPress-Plugin-Entwicklung besteht darin, die Funktionen von WordPress zu erweitern – und all das beginnt mit einer gut strukturierten Entwicklungsumgebung. Ein Plugin ist im Grunde genommen eine oder mehrere PHP-Dateien, die im Installationsverzeichnis von WordPress abgelegt werden./wp-content/plugins/Im Ordner befinden sich die Plugins. Jedes Plugin muss eine Hauptdatei haben, deren Kommentarblock am Anfang die “Identifikationsinformation” des Plugins darstellt. Diese Informationen dienen dazu, dem WordPress-System die grundlegenden Eigenschaften des Plugins mitzuteilen.

Eine typische Kommentarzeile am Anfang eines Plugins sieht wie folgt aus:

<?php
/**
 * Plugin Name: 我的第一个WordPress插件
 * Plugin URI:  https://example.com/my-first-plugin
 * Description: 这是一个用于演示的简单插件。
 * Version:     1.0.0
 * Author:      开发者名称
 * Author URI:  https://example.com
 * License:     GPL v2 or later
 * Text Domain: my-first-plugin
 */

Diese Anmerkung ist von entscheidender Bedeutung, da sie es dem Plugin ermöglicht, auf der “Plugins”-Verwaltungsseite im WordPress-Backend angezeigt zu werden.Text DomainZur Internationalisierung verwendet – um die anschließenden Übersetzungsarbeiten vorzubereiten.

Empfohlene Lektüre Kompletter Leitfaden für die Entwicklung von WordPress-Plugins: Ein praktischer Tutorial von Grundlagen bis zur Veröffentlichung im Live-Betrieb。

Konfiguration der lokalen Entwicklungsumgebung

Bevor Sie mit dem Codieren beginnen, ist es eine effiziente und sichere Option, eine lokale Entwicklungsumgebung einzurichten. Es wird empfohlen, Tools wie XAMPP, MAMP, Local by Flywheel oder Docker zu verwenden, um einen lokalen Server mit Apache/Nginx, MySQL und PHP aufzubauen. Stellen Sie sicher, dass Ihre PHP-Version den Anforderungen der aktuellen, verbreiteten WordPress-Version entspricht (in der Regel wird PHP 7.4 oder eine höhere Version empfohlen). Darüber hinaus…wp-config.phpÖffnen Sie es auf dem Computer.WP_DEBUGMuster helfen dabei, Fehler während des Entwicklungsprozesses schnell zu erkennen und zu beheben.

UltaHost – WordPress-Hosting-Anbieter

30-tägige Geld-zurück-Garantie, unbegrenztes Bandbreiten- und Datenbankvolumen, kostenlose DDoS-Schutzmaßnahmen sowie ein Rabatt von 501 auf 4 Terabyte bei einer Kaufdauer von 3 Jahren.

Zugangsseite

define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true ); // 将错误日志保存到 /wp-content/debug.log
define( 'WP_DEBUG_DISPLAY', false ); // 不在页面上显示错误信息

Die Kernarchitektur der Plugins sowie das Hook-Mechanismus

Das Verständnis des Hook-Mechanismus in WordPress ist die Grundlage für die Entwicklung von Plugins. Hooks ermöglichen es Ihren Plugins, zu bestimmten Zeitpunkten in den Kernprozess von WordPress eingebunden zu werden, um benutzerdefinierten Code auszuführen. Es gibt hauptsächlich zwei Arten von Hooks: Actions und Filters.

Action Hooks und Filter Hooks

Action Hooks ermöglichen es Ihnen, Code auszuführen, wenn ein bestimmtes Ereignis stattfindet. Zum Beispiel können Sie eine Benachrichtigungsmail senden, nachdem ein Artikel veröffentlicht wurde, oder Protokolle erstellen, wenn ein Benutzer sich anmeldet.add_action()Eine Funktion, die deine eigene Funktion an einen bestimmten Aktionshooker registriert.

function myplugin_send_notification( $post_id ) {
    // 当文章发布时，执行发送通知的逻辑
    wp_mail( '[email protected]', '新文章已发布', '文章ID：' . $post_id );
}
// 将 myplugin_send_notification 函数挂载到 ‘publish_post’ 这个动作钩子上
add_action( 'publish_post', 'myplugin_send_notification' );

Filter Hooks ermöglichen es Ihnen, die während des Prozesses übergebenen Daten zu ändern. Zum Beispiel können Sie die Anzeige des Artikelinhalts anpassen oder den Rückgabewert einer Funktion verändern.add_filter()Eine Funktion zur Registrierung von Filtern.

function myplugin_modify_content( $content ) {
    // 在文章内容的末尾追加一段自定义文本
    $custom_text = '<p><em>Vielen Dank fürs Lesen! Dieser Artikel wurde durch mein Plugin hinzugefügt.</em></p>';
    return $content . $custom_text;
}
// 将 myplugin_modify_content 函数挂载到 ‘the_content’ 这个过滤器钩子上
add_filter( 'the_content', 'myplugin_modify_content' );

Erstellen Sie die Hauptklasse des Plugins.

Obwohl einfache Plugins nur aus einigen Funktionen bestehen können, wird dringend die objektorientierte Programmierung (OOP) empfohlen, um die Modularität und Wartbarkeit des Codes zu verbessern sowie Namenskonflikte zu vermeiden. Die Funktionen des Plugins sollten in einer Hauptklasse zusammengefasst werden. Dies ist die beste Praxis bei der Entwicklung moderner WordPress-Plugins.

Empfohlene Lektüre Einführung in die WordPress-Theme-Entwicklung: Erstellen Sie Ihr erstes Theme von Grund auf.。

class My_First_Plugin {
    public function __construct() {
        // 在构造函数中挂载所有的钩子
        add_action( 'init', array( $this, 'register_shortcode' ) );
        add_action( 'admin_menu', array( $this, 'add_admin_page' ) );
    }

public function register_shortcode() {
        add_shortcode( 'greeting', array( $this, 'render_greeting' ) );
    }

public function render_greeting( $atts ) {
        return '<h3>Hallo, WordPress!</h3>';
    }

public function add_admin_page() {
        add_menu_page(
            '我的插件设置',
            '我的插件',
            'manage_options',
            'my-plugin-settings',
            array( $this, 'render_admin_page' )
        );
    }

public function render_admin_page() {
        echo '<div class="wrap"><h2>Die Einstellungsseite des Plugins</h2><p>Hier ist die Verwaltungsoberfläche.</p></div>';
    }
}
// 初始化插件
new My_First_Plugin();

Erstellen einer Verwaltungsoberfläche und von Shortcodes

Ein voll funktionsfähiges Plugin benötigt in der Regel die Interaktion mit den Nutzern – dies beinhaltet die Bereitstellung von Backend-Einstellungsseiten für Webadministratoren sowie einfache Möglichkeiten, die Funktionen des Plugins von Seiten der Inhaltsersteller aus aufzurufen.

Erstellen einer Seite für die Konfiguration der Backend-Einstellungen

WordPress bietet eine umfangreiche API zur Erstellung von Menüseiten und Untermenüseiten im Backend.add_menu_page()、add_submenu_page()Auf der Einstellungsseite können Sie die WordPress-Settings-API (Settings API) verwenden, um Optionen sicher zu registrieren, zu verifizieren und zu speichern – das ist effizienter als eine manuelle Verarbeitung.$_POSTDie Daten müssen viel sicherer und zuverlässiger sein.

public function add_admin_page() {
    add_options_page(
        '我的插件选项',          // 页面标题
        '我的插件',             // 菜单标题
        'manage_options',       // 权限要求
        'my-plugin-options',    // 菜单slug
        array( $this, 'options_page_html' ) // 回调函数，用于输出页面HTML
    );
    // 注册设置、节和字段
    add_action( 'admin_init', array( $this, 'register_settings' ) );
}

public function register_settings() {
    register_setting( 'myplugin_options_group', 'myplugin_option_name' );
    add_settings_section( 'myplugin_section_id', '主要设置', null, 'my-plugin-options' );
    add_settings_field( 'myplugin_field_id', '示例字段', array( $this, 'field_html' ), 'my-plugin-options', 'myplugin_section_id' );
}

public function field_html() {
    $option = get_option( 'myplugin_option_name' );
    echo '<input type="text" name="myplugin_option_name" value="' . esc_attr( $option ) . '" />';
}

public function options_page_html() {
    if ( ! current_user_can( 'manage_options' ) ) return;
    ?&gt;
    <div class="wrap">
        <h1>\n</h1>
        <form action="/de/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            settings_fields( 'myplugin_options_group' );
            do_settings_sections( 'my-plugin-options' );
            submit_button();
            ?>
        <input type="hidden" name="trp-form-language" value="de"/></form>
    </div>
    &lt;?php
}

Implementierung der Shortcode-Funktion

Shortcodes sind eine hervorragende Möglichkeit, es Nutzern zu ermöglichen, Plugin-Funktionen einfach in Artikeln oder Seiten einzubetten.add_shortcode()Die Funktion wird registriert, und ihre Callback-Funktion erhält die entsprechenden Attribute.$atts) sowie den Inhalt ($contentDie Parameter werden verwendet, um die letztendlich anzuzeigende Inhalte zu ermitteln und zurückzugeben.

hosting.com Shared Hosting

Hohe Leistung mit AMD EPYC-CPUs, NVMe-SSD-Speicher und LiteSpeed, fachkundiger Inhouse-Support rund um die Uhr, erweiterte Sicherheitsmaßnahmen einschließlich SSL, Brute-Force-, Malware- und DDoS-Schutz, Einsparungen von bis zu 73%

Zugangsseite

public function register_shortcodes() {
    add_shortcode( 'display_latest_posts', array( $this, 'render_latest_posts' ) );
}

public function render_latest_posts( $atts ) {
    // 设置默认属性，并使用 shortcode_atts 合并用户传入的属性
    $attributes = shortcode_atts( array(
        'count' => 5,
        'category' => '',
    ), $atts );

$args = array(
        'posts_per_page' => intval( $attributes['count'] ),
        'post_status' => 'publish',
    );
    if ( ! empty( $attributes['category'] ) ) {
        $args['category_name'] = sanitize_text_field( $attributes['category'] );
    }

$query = new WP_Query( $args );
    $output = '<ul>';
    while ( $query-&gt;have_posts() ) {
        $query-&gt;the_post();
        $output .= '<li><a href="/de/' . get_permalink() . '/">'. get_the_title() . '</a></li>';
    }
    wp_reset_postdata();
    $output .= '</ul>';
    return $output;
}

Plugin-Sicherheit, Leistung und Vorbereitung auf die Veröffentlichung

In der letzten Phase der Entwicklung müssen Sie sicherstellen, dass das Plugin sicher, effizient und einfach zu verteilen ist. Die Ignorierung dieser Aspekte kann zu Sicherheitslücken, einer Verlangsamung der Website oder einem schlechten Benutzererlebnis führen.

Sicherheit und Datenvalidierung

Jede Art von Daten, die von Benutzern oder externen Quellen stammt (z. B. URL-Parameter, Formulareingaben, Datenbanken), ist unzuverlässig. Es ist erforderlich, diese Daten mithilfe der von WordPress bereitgestellten Funktionen zu überprüfen, zu bereinigen und zu entschärfen (z. B. durch das Ausführen von Entschlüsselungs- oder Auswertungsvorgängen).
* 验证（Validation）：检查数据是否符合预期格式（如是否为邮箱、数字），使用is_email()、intval()usw.
* 清理（Sanitization）：在数据保存到数据库之前，移除其中不安全的字符，使用sanitize_text_field()、sanitize_email()、wp_kses_post()usw.
* 转义（Escaping）：在将数据输出到HTML、JavaScript或URL之前，对其进行编码，防止XSS攻击，使用esc_html()、esc_js()、esc_url()、esc_attr()usw.

Bei Datenbankoperationen ist es unerlässlich, die entsprechenden Werkzeuge und Methoden zu verwenden.$wpdbDie von der Klasse bereitgestellten Methoden werden genutzt.prepare()Parameterisierte Abfragen werden verwendet, um SQL-Injection-Angriffe zu verhindern.

Empfohlene Lektüre CDN-Beschleunigungsprinzipien und praktischer Leitfaden: Wie Sie das beste Content Delivery Network für Ihre Website auswählen。

Leistungsverbesserung und Wartung im Nachhinein

Die Leistung ist entscheidend für die Benutzererfahrung. Vermeiden Sie es, aufwendige Abfragen oder Verarbeitungen bei jedem Seitenladen durchzuführen. Für Daten, die sich nicht häufig ändern, verwenden Sie die WordPress-Transients-API zur Speicherung.

$data = get_transient( 'myplugin_expensive_data' );
if ( false === $data ) {
    $data = // ... 执行复杂的数据库查询或远程API调用 ...
    set_transient( 'myplugin_expensive_data', $data, HOUR_IN_SECONDS ); // 缓存1小时
}

Um Plugins mit Internationalisierungs- und Lokalisierungsunterstützung auszustatten, sollte man folgende Schritte beachten:__()、_e()Funktionen wie diese umschließen den gesamten für die Benutzer sichtbaren Text und verarbeiten ihn anschließend weiter.load_plugin_textdomain()Laden Sie die Sprachdateien. Gleichzeitig sollten Sie den Lebenszyklus der Plugins gut planen und die Aktivierungsprozesse implementieren.register_activation_hookDeaktivierenregister_deactivation_hook) sowie Deinstallation (register_uninstall_hookDie Verarbeitungslogik der „Hook-Funktionen“ dient zum Erstellen bzw. Löschen von Datenbanktabellen, zur Bereinigung von Optionen usw.

InterServer Shared Hosting

Shared Hosting $2.50 USD pro Monat, erster Monat $0.1 USD Promo-Code tryinterserver, 461 Cloud-Apps Skripte, ein Klick installieren.

Zugangsseite

Vorbereitung auf die Veröffentlichung: Dokumentation und Paketierung

Vor der Veröffentlichung erstellen Sie bitte eine detaillierte…readme.txtDie Dateien müssen den offiziellen WordPress-Standards entsprechen – dies umfasst die Beschreibung des Plugins, die Installationsanweisungen, häufig gestellte Fragen sowie die Aktualisierungsprotokolle. Dies ist die Einführungseite Ihres Plugins im WordPress-Plugin-Verzeichnis. Stellen Sie sicher, dass die Struktur Ihres Plugin-Verzeichnisses klar ist, dass nur die notwendigen Dateien enthalten sind, und dass das Verzeichnis in einem standardmäßigen ZIP-Format komprimiert wird.

Zusammenfassungen

Die Entwicklung von WordPress-Plugins ist ein Prozess, bei dem Ideen in funktionale Lösungen umgewandelt werden – und dies basiert auf einem tiefen Verständnis der Kernarchitektur von WordPress, insbesondere des Hook-Mechanismus. Die ersten Schritte zur Einführung in die Plugin-Entwicklung umfassen das Aufsetzen der Entwicklungsumgebung, das Schreiben der grundlegenden Plugin-Dateien sowie das Beherrschen der Verwendung von Aktionen und Filter-Hooks. Die Organisation des Codes mithilfe objektorientierter Programmierungsmethoden verbessert die Wartbarkeit des Projekts erheblich. Die Erstellung sicherer Backend-Benutzeroberflächen über die Settings-API sowie die Bereitstellung flexibler Frontend-Funktionen mittels Shortcodes bilden die Hauptverbindungswege zwischen den Plugins und den Nutzern. Um professionelle, zuverlässige und beliebte WordPress-Plugins zu entwickeln, sollten während des gesamten Entwicklungsprozesses stets die besten Praktiken in Bezug auf Sicherheit (Validierung, Reinigung, Entschlüsselung von Daten), Leistung (Caching, Optimierung von Abfragen) und Internationalisierung angewendet werden. Zudem sind umfassende Dokumentationen unerlässlich.

FAQ Häufig gestellte Fragen

Welche Programmiersprachen sind für die Entwicklung von WordPress-Plugins erforderlich?

Die Kernanforderungen sind ein fließendes Beherrschen von PHP, da WordPress selbst sowie seine Plugins und Themes in PHP programmiert sind. Außerdem ist ein grundlegendes Verständnis von HTML, CSS und JavaScript erforderlich, um die Benutzeroberflächen und die Interaktionslogik der Plugins zu erstellen. Sollten komplexe Datenbankoperationen erforderlich sein, sind auch grundlegende SQL-Kenntnisse notwendig.

Wie kann ich verhindern, dass die von mir entwickelte Erweiterung mit anderen Erweiterungen Konflikte verursacht?

Die Hauptmethode besteht darin, die Eindeutigkeit von Funktionsnamen, Klassennamen, Variablennamen und anderen Identifikatoren zu gewährleisten. Die beste Praxis ist die Anwendung objektorientierter Programmierung sowie die Verpackung aller Code-Elemente in eine Klasse. Für Funktionen und globale Variablen können eindeutige Präfixe verwendet werden – beispielsweise Abkürzungen oder Namen von Plugins als Präfixe.myplugin_function_nameoderMyPlugin_ClassName。

Warum wurde ein Menü im Hintergrund durch meinen Plugin hinzugefügt, aber auf der Seite angezeigt: “Sie haben nicht genügend Berechtigungen, um diese Seite zu accessieren”?

Das liegt daran, dass bei der Aufrufung…add_menu_page()Bei der Verwendung ähnlicher Funktionen wurde der Parameter „Capability“ (Berechtigungsfähigkeit) falsch eingestellt. Sie müssen sicherstellen, dass der dritte Parameter (die Berechtigung) von der aktuellen Benutzerrolle unterstützt wird. Für Einstellungsseiten, die nur für Administratoren zugänglich sind, wird in der Regel…‘manage_options’Sie können die Funktion im Callback-Funktion erneut verwenden.current_user_can( ‘manage_options’ )Eine Überprüfung durchführen.

Wie füge ich meiner Erweiterung die Unterstützung für Übersetzungen hinzu?

Zuerst muss die Einstellung in den Kommentaren am Anfang der Hauptdatei des Plugins korrekt vorgenommen werden.Text Domain(Zum Beispiel)my-pluginDann wird es verwendet.__( ‘Text’, ‘my-plugin’ )oder_e( ‘Text’, ‘my-plugin’ )Die Funktion umschließt alle zu übersetzenden Zeichenketten. Schließlich werden sie beim Initialisieren des Plugins (z. B.) verwendet…init(Während der Aktion) verwendenload_plugin_textdomain()Es gibt Funktionen, die dazu dienen, Sprachdateien zu laden. Sie können Werkzeuge wie Poedit verwenden, um solche Dateien zu erstellen..potTemplate-Dateien und.po/.moTranslate the file.