Dokładny analiz: Od zera poznaj esencję i praktyczne aspekty rozwoju pluginów dla WordPress

Podstawowy skład wtyczki (pluginu) dla WordPressa:

Standardowy plugin dla WordPressu, którego istotą jest element znajdujący się w… /wp-content/plugins/ Niezależna foldera znajdująca się w katalogu. W tej folderze musi znajdować się co najmniej jedna główna plika PHP, w której w komentarzach na początku pliki zawarte są metadane pluginu – to jest podstawa dla identyfikacji pluginu przez WordPress.

Komentarze umieszczone na początku pliku pluginu są niezbyt ważne. Są używane w określonym formacie, by powiedzieć systemowi WordPress informacje o nazwie pluginu, opisie, wersji, autorze itd. Typowy komentarz na początku pliku pluginu wygląda następnie:

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

Ten kod musi zostać umieszczony na początku głównego pliku pluginu.Plugin Name To pola obowiązkowe; wszystkie inne są opcjonalne. Gdy WordPress skanuje katalog pluginów, to właśnie na podstawie tych informacji tworzy listę pluginów na interfejsie administracyjnym.

Polecamy lekturę. Rozwój pluginów dla WordPress – od początków do mistrzostwa: pokazujemy ci, jak stworzyć swój pierwszy własny plugin.。

Poza głównym plikiem, dobrze zaprojektowany plugin zawiera zwykle inne pliki i katalogi, np. te przeznaczone do przechowywania zasobów w formacie JavaScript i CSS. assets folder, przeznaczony do tłumaczeń languages folder, przeznaczony do zawierania plików z klasami includes Papki, a także pliki szablonów używane do prezentacji na stronie frontowej to elementy kluczowe w budowaniu dobrze zorganizowanej struktury katalogów. Dobra struktura katalogów stanowi podstawę dla łatwej konserwacji i rozszerzalności pluginów.

UltaHost – hostingu dla stron WordPress

Gwarancja zwrotu pieniędzy w ciągu 30 dni, nieograniczony przepustowość sieci i dostęp do bazy danych, bezpłatna ochrona przed atakami typu DDoS. Promocja: 50% przy zakupie na 3 lata.

strona dostępu

Zrozumienie kluczowych mechanizmów WordPressa: „hooki”

Podstawa filozofii rozwoju pluginów dla WordPress jest związana z “hakami (hooks) i nawrotnymi wywołaniami (callbacks)”. Haki umożliwiają programistom włączenie swojego własnego kodu w określone momenty wykonywania kodu podstawowego WordPress, co daje im możliwość modyfikacji lub rozszerzenia standardowych funkcji bez konieczności bezpośredniego edycji źródłowych plików. Dzięki temu kod podstawowy pozostaje czysty, a aktualizacje pluginów są bezpieczne.

Hakówki są głównie podzielone na dwa typy: hakówki akcyjne (action hooks) i hakówki filtracyjne (filter hooks).

Używanie aktywnych haczków (action hooks)

Aktywnie działające „haki” (ang. action hooks) są wykonywane w momencie wystąpienia określonych zdarzeń, np. publikacji artykułu, załadowania strony zarządzania lub logowania użytkownika. Nie wymagają powrotu żadnych wartości i są przeznaczone głównie do wykonywania określonych operacji. Programiści często korzystają z nich w swoich aplikacjach. add_action() Funkcja umożliwia przypisanie user-definowanej funkcji (zwanej funkcją callback) do określonego „haka akcji” (action hook).

Na przykład, jeśli chcemy automatycznie dodawać oświadczenie o prawach autorskich na końcu każdego artykułu, możemy to zrobić za pomocą odpowiednich narzędzi lub skryptów. the_content Ten „hook” do działań (chociaż często jest używany jako filtr, to tu pokazuje się pojęcie samej akcji). Szczególnym przykładem jest wykonywanie jakiegoś procederu podczas inicjalizacji WordPress.

Polecamy lekturę. Rozwój pluginów dla WordPress – od początków do mistrzostwa: pokazujemy ci, jak stworzyć własną, unikalną funkcję.。

function myplugin_setup() {
    // 初始化插件，例如创建数据库表
}
add_action( 'init', 'myplugin_setup' );

W powyższym kodzie jest zaznaczony moment, w którym WordPress wykona dane działanie. init Podczas wykonywania tego działania będą jednocześnie uruchomione wszystkie zdefiniowane przez nas elementy (programy, procesy itd.). myplugin_setup Funkcja.

Używanie filtrów hooków

Hooki filtrów służą do modyfikacji danych. Przyjmują jedną zmienne i zwracają zmienioną wartość tej zmiennej. Programiści ich wykorzystują w swoich aplikacjach. add_filter() Funkcja służy do montowania własnych funkcji filtracji. To najczęściej używany sposób modyfikacji treści artykułów, nagłówków, linków oraz innych danych.

Patrząc na powyżej przykład, aby dodać informacje o prawach autorskich do treści artykułu, bardziej poprawnym sposobem jest użycie standardowych formatów i zasad stosowanych w tej branży. the_content Filtr:

hosting.com Hosting współdzielony

Wysoka wydajność dzięki procesorom AMD EPYC, pamięci masowej NVMe SSD i LiteSpeed, wewnętrzne wsparcie ekspertów 24/7, zaawansowane środki bezpieczeństwa, w tym SSL, brute force, ochrona przed złośliwym oprogramowaniem i DDoS, oszczędność do 73%

strona dostępu

function myplugin_add_copyright( $content ) {
    if ( is_single() ) {
        $content .= '<p>Tekst ten jest chroniony prawem autorskim i należy do naszej strony internetowej. Przed jego reprodukcją konieczne jest podanie źródła.</p>';
    }
    return $content;
}
add_filter( 'the_content', 'myplugin_add_copyright' );

W tym przykładzie funkcja… myplugin_add_copyright Przyjmuj oryginał. $content Zmienna zawiera dodatkowy tekst w formie HTML, po czym zmieniony tekst jest powrócony. WordPress użyje tego powrotu wartości zamiast oryginalnego tekstu do wyświetlenia.

Stworzenie strony do zarządzania pluginami

Wiele wtyczek wymaga dostępnych w panelu administracyjnym WordPress opcji konfiguracji, co wymaga stworzenia odpowiednich stron zarządzania. WordPress oferuje szereg funkcji do dodawania elementów menu głównego lub podmenu.

Dodać element menu najwyższego poziomu

Użyj add_menu_page() Funkcja umożliwia stworzenie niezależnego menu na poziomie najwyższego poziomu w tle aplikacji dla dodatków (pluginów). Funkcja wymaga kilku parametrów, w tym nagłówka strony, nagłówka menu, upoważnienia (praw), nazwy menu, funkcji wywoływanej w odpowiedzi na dane akcje (callback function) itd.

Polecamy lekturę. Przewodnik po rozwoju pluginów dla WordPressa: jak stworzyć swoje pierwsze rozszerzenie funkcjonalne od zera。

Poniżej znajduje się przykład kodu, który służy do tworzenia prostej strony zarządzania na najwyższym poziomie:

function myplugin_add_admin_menu() {
    add_menu_page(
        '我的插件设置',          // 页面标题
        '我的插件',              // 菜单标题
        'manage_options',       // 所需权限（管理员）
        'myplugin-settings',    // 菜单别名（URL中的slug）
        'myplugin_settings_page', // 用于输出页面内容的回调函数
        'dashicons-admin-generic', // 图标（使用Dashicons）
        80                      // 菜单位置
    );
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );

// 定义输出页面内容的回调函数
function myplugin_settings_page() {
    ?>
    <div class="wrap">
        <h1>Ustawienia mojej wtyczki.</h1>
        <form method="post" action="/pl/options.php/" data-trp-original-action="options.php">
            <?php
            settings_fields( 'myplugin_settings_group' );
            do_settings_sections( 'myplugin-settings' );
            submit_button();
            ?>
        <input type="hidden" name="trp-form-language" value="pl"/></form>
    </div>
    &lt;?php
}

Ten kod najpierw… add_action Dodaj funkcję do montażu menu. admin_menu „Hak” – gdy menu jest ładowane w tle, wtedy zostanie wykonywane określone działanie. myplugin_add_admin_menuZarejestruj nowy najwyższy menu o nazwie “Moje dodatki”. Po kliknięciu na to menu WordPress wywoła odpowiednie działanie. myplugin_settings_page Funkcja jest używana do renderowania zawartości strony.

Hosting współdzielony InterServer

Hosting współdzielony $2.50 USD miesięcznie, pierwszy miesiąc $0.1 USD kod promocyjny tryinterserver, 461 skryptów aplikacji w chmurze, instalacja jednym kliknięciem.

strona dostępu

Ustawienie przechowywania pola i opcji

Nie wystarczy tylko „obudowy” strony – musimy na niej stworzyć pola formularza oraz bezpiecznie przechowywać wprowadzone przez użytkownika dane. API Settings w WordPress jest właśnie stworzone z myślą o tym celu; umożliwia automatyzację procesów weryfikacji danych, ich przechowywania oraz generowania bezpiecznych tokenów (nonce).

Najpierw musimy zarejestrować opcję ustawień, blok konfiguracji oraz konkretne pola:

function myplugin_settings_init() {
    // 1. 注册一个设置选项到数据库
    register_setting( 'myplugin_settings_group', 'myplugin_options' );

// 2. 在页面内添加一个设置区块
    add_settings_section(
        'myplugin_section_main',
        '主要设置',
        null,
        'myplugin-settings'
    );

// 3. 在区块内添加一个具体的字段
    add_settings_field(
        'myplugin_field_text',
        '示例文本输入',
        'myplugin_field_text_render', // 渲染字段HTML的回调函数
        'myplugin-settings',
        'myplugin_section_main'
    );
}
add_action( 'admin_init', 'myplugin_settings_init' );

// 定义字段的HTML输出
function myplugin_field_text_render() {
    $options = get_option( 'myplugin_options' );
    $value = $options['text_field'] ?? '';
    ?>
    <input type='text' name='myplugin_options[text_field]' value='<?php echo esc_attr( $value ); ?>'>
    <?php
}

Za pomocą tego API po wysłaniu formularza dane są automatycznie zapisywane. wp_options W tabeli nazwa to… myplugin_options W zapisach (seriowanych obiektach typu array) programiści mogą korzystać z dostępnych informacji. get_option( ‘myplugin_options’ ) Zabezpieczony sposób uzyskania tych wartości może być realizowany na stronie klienta (frontend) lub na serwerze (backend).

Bezpieczeństwo wtyczek oraz najlepsze praktyki ich stosowania

Aby stworzyć popularny plugin, bezpieczeństwo i jakość kodu są kluczowymi aspektami, na które nie można zaniedbać. Dodróżowanie najlepszych praktyk pozwoli maksymalnie zmniejszyć ryzyko wystąpienia typowych błędów oraz poprawić jakość użytkowniczego doświadczenia.

Weryfikacja danych, escape oraz ich przygotowanie (czyli usunięcie niepotrzebnych znaków i ulepszenie ich formatu)

Wszelkie dane pochodzące od użytkowników lub z zewnętrznych źródeł są niepoważne. Przed wyświetleniem ich w przeglądarcu (na stronie frontowej) konieczne jest ich uwzględnienie („escape”) w celu zapobiegania atakom typu XSS. Podczas zapisywania danych do bazy danych (na stronie back-end) należy je uprzątnić i sprawdzić.

WordPress oferuje wiele pomocniczych funkcji. W przypadku treści wyświetlanych w formacie HTML można z nich skorzystać… esc_html(), esc_attr(), esc_url() Funkcje typu „wait” są przydatne do wykonywania operacji oczekiwania na określony czas. Jeśli wynik tej operacji ma być przechowany w zmiennej w JavaScript, należy użyć odpowiednich konstrukcji. wp_json_encode()Podczas operacji z bazą danych zawsze należy używać… $wpdb->prepare() Wykonuj zapytania parametryzowane lub używaj narzędzi takich jak… sanitize_text_field(), intval() Funkcje typu „wait” są używane do przygotowania wejściowych danych.

// 不安全的做法
echo $_GET['user_input'];

// 安全的做法：输出到HTML内容
echo esc_html( $_GET['user_input'] );

// 安全的做法：用于HTML属性
$url = esc_url( $_GET['url'] );
echo "<a href='/pl/$url/'>link (na stronie internetowej)</a>";

// 安全的做法：清理后存入数据库
$clean_title = sanitize_text_field( $_POST['title'] );
update_post_meta( $post_id, ‘title’, $clean_title );

Przygotowanie do internacionalizacji i lokalizacji

Aby plugin był dostępny dla użytkowników z całego świata, konieczne jest przygotowanie go do obsługi różnych języków (internacjonalizacja). To oznacza, że żadne teksty skierowane do użytkowników nie powinny być zawarte w kodzie w postaci stałych tekstów („hardcoded”), lecz muszą być umieszczone w zasobach przeznaczonych do tłumaczeń i wykorzystywane za pomocą odpowiednich funkcji.

WordPress korzysta z frameworku GNU gettext. W kodzie programu jest to wyraźnie widoczne. __() Przetłumacz i zwróć ciąg znaków, używając _e() Przekaż tekst do tłumaczenia i wyślij go bezpośrednio jako wynik. Dodatkowo, konieczne jest definiowanie tych informacji w komentarzu na początku pliku z pluginem. Text DomainI użyć tego podczas ładowania wtyczki. load_plugin_textdomain() Funkcja do ładowania plików tłumaczeniowych.

// 定义可翻译的字符串
$greeting = __( ‘Hello, World!', ‘my-first-plugin’ );
_e( ‘Settings saved successfully!', ‘my-first-plugin’ );

// 在插件初始化时加载翻译
function myplugin_load_textdomain() {
    load_plugin_textdomain( ‘my-first-plugin’, false, dirname( plugin_basename( __FILE__ ) ) . ‘/languages/’ );
}
add_action( ‘init’, ‘myplugin_load_textdomain’ );

Programiści potrzebują narzędzi takich jak Poedit, aby tworzyć… .pot Pliki szablonów, które umożliwiają tłumaczom tworzenie tekstów w różnych językach. .po I po skompilowaniu. .mo Pliki językowe gotowe do użycia powinny być umieszczone w folderze pluginu. /languages/ W folderze znajduje się kluczowy element, który umożliwi pluginowi wejście na międzynarodowy rynek.

Podsumowanie.

Rozwoj pluginów dla WordPress polega na przekształceniu kreatywnych idei w funkcjonalne rozwiązania, a kluczowym elementem w tym procesie jest zrozumienie i skuteczne wykorzystanie systemu hooków. Počynaj od stworzenia głównego pliku z poprawnymi komentarzami w nagłówku, potem włącz się do procesu wykonywania za pomocą hooków akcji oraz modyfikuj wyników obliczeń za pomocą hooków filtrów. Można bezpiecznie i standardowo tworzyć interfejsy administracyjne za pomocą API Settings dostępnego w WordPress. Dodatkowo, stosowanie surowych zasad bezpieczeństwa (weryfikacja, escapeowanie, czyszczenie danych) oraz standardów internacjonalizacji jest konieczne, aby plugin stał się dojrzałym, stabilnym i szeroko używanym rozwiązaniem. Pamiętaj, że dobry plugin nie tylko musi mieć potężne funkcje, ale także musi być bezpieczny, wydajny i łatwy w obsłudze przez użytkowników z całego świata.

FAQ – najczęściej zadawane pytania.

Jakie minimum liczby plików wymaga plugin?

Aby stworzyć dodatek (plugin) do WordPress, wystarczy co najmniej jednego pliku w formacie PHP. Ten plik musi zawierać poprawne komentarze umożliwiające identyfikację dodatku w systemie WordPress, a po jego umieszczeniu w odpowiednim miejscu w strukturze plików witryny internetowej dodatek będzie dostępny do używania. /wp-content/plugins/ Można umieścić plik w katalogu (bezpośrednio lub w podkatalogu), a WordPress go wykryje i aktywuje.

Jak debugować kod mojego pluginu?

Zaleca się to zrobić w środowisku rozwoju. wp-config.php Włącz tryb debugowania WordPressa w pliku. WP_DEBUG Konstanta ustawiona jest na… trueW tym samym czasie można ustawić… WP_DEBUG_LOG 为 trueZarejestruj informacje o błędzie. /wp-content/debug.log Nie należy wyświetlać plików bezpośrednio na stronie internetowej. Ponadto istotne jest korzystanie z narzędzi dewelopera w przeglądarzu do oglądania konsoli oraz informacji o żądanch sieciowych (network requests).

Gdzie powinny znajdować się opcje dodatkowych modułów (plug-inów)?

Dla prostych ustawień par kluczy–wartości mocnie zaleca się używać API Options w WordPress. add_option(), update_option(), get_option() Funkcja wykona odpowiednie operacje, a dane są bezpiecznie przechowywane. wp_options W tabelach bazy danych. W przypadku dużych ilości strukturalizowanych danych można zastanowić się nad stworzeniem własnych tabel bazy danych, ale to wymaga bardziej złożonego zarządzania ich życiem cyklicznym (tworzenie podczas instalacji, usuwanie po dezinstalacji).

Jak zrobić, aby mój plugin był kompatybilny z większą liczbą wersji WordPress?

Podczas rozwoju unikaj używania zbyt nowoczesnych funkcji, które są dostępne tylko w wyższych wersjach WordPress. Jeśli chcesz zastosować jakąś nowszą funkcję, sprawdź jej działanie wcześniej, zanim ją użyjesz. function_exists() Przeprowadź sprawdzenie i zaproponuj elegancki plan awaryjnego działania („degradacji”) w przypadku problemów z pluginem. readme.txt W dokumencie jest jasno zaznaczona najniższa wersja WordPressu, dla której testy zostały przeprowadzone z pozytywnym wynikiem. Regularne testy na różnych wersjach WordPressu to najlepszy sposób na zapewnienie kompatybilności.