Mulai dari Nol: Memahami Langkah-Langkah Inti dan Praktik Terbaik dalam Pengembangan Plugin WordPress

Mulai dari Nol: Memahami Langkah-Langkah Inti dan Praktik Terbaik dalam Pengembangan Plugin WordPress

Pengembangan plugin untuk WordPress merupakan cara yang efektif untuk memperluas fungsi sebuah situs web WordPress. Dengan membuat plugin khusus, pengembang dapat menambahkan fitur-fitur unik ke situs web tersebut tanpa perlu mengubah kode inti (core code) WordPress. Hal ini tidak hanya meningkatkan fleksibilitas situs web, tetapi juga memastikan bahwa fitur-fitur tersebut tetap berjalan dengan aman dan stabil saat ada pembaruan pada kode inti WordPress. Sebuah plugin WordPress yang terstruktur dengan baik mengikuti struktur direktori yang tertentu, standar pengkodean yang berlaku, serta API (Application Programming Interface) dari WordPress.

Artikel ini akan memandu Anda melalui seluruh proses dari membuat file plugin pertama hingga merilis plugin tersebut dengan aman, mencakup konsep-konsep inti, alat-alat, dan praktik terbaik yang perlu Anda ketahui selama proses pengembangan.

推荐阅读 Panduan Lengkap untuk Mengembangkan Plugin WordPress: Membangun Fitur Ekstensi WordPress Berkualitas Tinggi dari Nol Hingga Satu.。

Lingkungan pengembangan dan struktur dasar.

Sebelum menulis kode apa pun, sangat penting untuk membangun lingkungan pengembangan yang sesuai. Disarankan untuk menggunakan alat pengembangan lokal seperti Local by Flywheel, XAMPP, atau MAMP, yang dapat dengan cepat mengkonfigurasi lingkungan yang mencakup PHP, MySQL, dan server web. Selain itu, editor kode (seperti VS Code atau PhpStorm) serta alat debugging (seperti Query Monitor atau Debug Bar) juga sangat diperlukan.

UltaHost – Hosting untuk WordPress

Jaminan pengembalian uang dalam 30 hari, bandwidth dan basis data yang tidak terbatas, perlindungan DDoS gratis, diskon 50% untuk pembelian selama 3 tahun (dari harga normal: 50%).

halaman akses

Buatlah file plugin pertamamu.

Bentuk paling dasar dari sebuah plugin WordPress adalah sebuah file yang berada di dalam folder /wp-content/plugins/. /wp-content/plugins/ File-file PHP yang terdapat dalam direktori tersebut. Bagian awal (header) dari file utama plugin harus mencakup komentar informasi plugin yang standar; ini merupakan dasar bagi WordPress untuk mengenali dan mengelola plugin tersebut.

Buatlah sesuatu yang bernama… my-first-plugin.php File tersebut, lalu masukkan konten berikut:

<?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
 */

Simpan berkas ini ke… /wp-content/plugins/my-first-plugin/ Masukkan folder tersebut ke dalam direktori yang sesuai, lalu masuk ke halaman “Plugin” di panel administrasi WordPress. Di sana, Anda akan dapat melihat dan mengaktifkan plugin tersebut. Meskipun plugin ini belum memiliki fungsi apa pun untuk saat ini, strukturnya sudah selesai dibangun.

Direktori Plugin dan Organisasi File

Seiring dengan penambahan fitur, sebuah file tunggal akan menjadi sulit untuk dikelola (dipertahankan dalam kondisi yang baik). Direktori plugin yang terstruktur dengan baik biasanya mencakup bagian-bagian berikut:
* 主插件文件：plugin-name.php
* includes/ Daftar Isi: Berisi file-file kelas atau fungsi yang mewakili fitur-fitur inti dari aplikasi.
* admin/ Daftar Isi: Berisi kode terkait backend, file CSS, dan file JavaScript.
* public/ Daftar Isi: Berisi kode, CSS, dan JavaScript yang terkait dengan antarmuka pengguna (frontend).
* assets/ Daftar Isi: Berisi file gambar, file skema tata letak (style sheet), dan file skrip (script).
* languages/ Daftar Isi: Berisi file-file terjemahan internasional (.pot, .po, .mo).
* uninstall.php File: Opsi yang digunakan untuk membersihkan basis data ketika plugin dihapus.

推荐阅读 Panduan Lengkap Pengembangan Plugin WordPress: Dari Dasar hingga Penerapan Praktis。

Core Development Concepts and Technologies

Inti dari pengembangan plugin WordPress terletak pada pemahaman dan penerapan yang mahir terhadap API (Application Programming Interface) yang disediakan oleh WordPress, yang mencakup Action Hooks, Filter Hooks, dan Shortcodes.

Menguasai penggunaan action hook

Action hooks memungkinkan Anda untuk “menyisipkan” kode Anda sendiri pada titik waktu tertentu saat WordPress dijalankan. Gunakanlah fitur ini dengan bijak. add_action() Fungsi tersebut dapat memungkinkan Anda untuk “menggantungkan” fungsi kustom Anda pada sebuah “hook” (titik akses tertentu dalam sistem).

Sebagai contoh, kode di bawah ini menambahkan sebuah tag meta khusus di bagian atas setiap halaman:

hosting.com hosting bersama

Kinerja tinggi, dilengkapi dengan CPU AMD EPYC, penyimpanan SSD NVMe, dan LiteSpeed, dukungan internal ahli 24 jam sehari, langkah-langkah keamanan canggih termasuk SSL, brute force, malware, dan perlindungan DDoS, menghemat hingga 731 TB/bulan.

halaman akses

function myplugin_add_custom_meta() {
    echo '<meta name="my-custom-meta" content="value">';
}
add_action( 'wp_head', 'myplugin_add_custom_meta' );

Contoh lain yang sering digunakan adalah melakukan beberapa operasi inisialisasi saat plugin diaktifkan, seperti membuat tabel dalam basis data. Untuk ini, diperlukan untuk “menggantungkan” (mounting) fungsi-fungsi yang terkait ke sistem yang berjalan. register_activation_hook Di atas kait itu.

Menggunakan filter untuk memodifikasi konten

Filter hooks digunakan untuk memodifikasi data yang sedang diproses oleh WordPress. Anda dapat menggunakannya… add_filter() Fungsi digunakan untuk mengubah teks konten, nilai opsi, dan sebagainya. Fungsi filter harus memiliki nilai kembalian (return value).

Contoh berikut akan secara otomatis menambahkan sebuah teks kustom di akhir isi artikel:

推荐阅读 Panduan Lengkap Pengembangan Plugin WordPress: Membangun Plugin Fungsional Pertama Anda Dari Nol。

function myplugin_modify_post_content( $content ) {
    if ( is_single() ) {
        $custom_text = '<p><em>Terima kasih telah membaca artikel ini!</em></p>';
        $content .= $custom_text;
    }
    return $content;
}
add_filter( 'the_content', 'myplugin_modify_post_content' );

Membuat dan Mengelola Kode Singkat

Kode singkat memungkinkan pengguna untuk dengan mudah memasukkan konten dinamis yang dihasilkan oleh plugin ke dalam artikel, halaman, atau alat bantu (toolkit). add_shortcode() Fungsi dapat mendaftarkan kode singkat yang baru.

Daftarkan sebuah nama yang disebut… [greeting] Ini adalah kode singkat yang dapat menampilkan ucapan selamat berbeda-beda berdasarkan waktu:

Hosting bersama InterServer.

Hosting bersama seharga $2,50 USD per bulan, diskon $0,1 USD untuk bulan pertama dengan kode promo tryinterserver, serta 461 skrip aplikasi cloud yang dapat diinstal dengan sekali klik.

halaman akses

function myplugin_greeting_shortcode( $atts ) {
    $hour = date( 'G' );
    $greeting = ( $hour 'Selamat pagi!' : ( ($hour) < 18 ) ? '下午好！' : '晚上好！' );
    return &#039;<div class="greeting">'`. esc_html($greeting)`.'</div>'php
add_shortcode('greeting', 'myplugin_greeting_shortcode');

Keamanan Plugin dan Manajemen Data

Mengembangkan plugin yang aman merupakan langkah pertama dalam melindungi situs web dan data pengguna. Hal ini mencakup validasi input, pengolahan output (misalnya dengan mekanisme escaping), pemeriksaan hak akses, serta penanganan data secara aman.

Mengimplementasikan validasi data dan proses pengelolaan karakter (escaping)

Jangan pernah mempercayai input apa pun dari pengguna. Sebelum data disimpan ke dalam basis data atau ditampilkan di browser, data tersebut harus diverifikasi dan di-escapasi terlebih dahulu.

• Verifikasi: Menggunakan sanitize_text_field(), sanitize_email(), intval() Fungsi-fungsi seperti ini digunakan untuk membersihkan input dari pengguna.
• Escape: Saat mengeluarkan data ke HTML, JavaScript, atau URL, gunakan fungsi escape yang sesuai, seperti esc_html(), esc_js(), esc_url()。

Misalnya, cara yang aman untuk memproses dan menampilkan nama pengguna yang dikirim melalui formulir:

$user_input = $_POST['username'] ?? ''; // 使用空合并运算符提供默认值
$clean_username = sanitize_text_field( $user_input );
echo '你好，' . esc_html( $clean_username );

Menggunakan WordPress Option API

Untuk pengaturan sederhana yang perlu disimpan (seperti tombol on/off, teks, dll.), Anda sebaiknya menggunakan WordPress Option API. API ini menyediakan fitur yang memungkinkan Anda untuk mengelola dan menyimpan pengaturan tersebut dengan mudah dalam basis data WordPress. add_option(), get_option(), update_option() 和 delete_option() Fungsi-fungsi seperti ini memungkinkan penyimpanan data dengan aman. wp_options Di dalam tabel.

Buat pengaturan untuk sebuah plugin dan ambilnya:

// 保存一个选项
update_option( 'myplugin_setting_color', '#336699' );

// 获取一个选项，如果不存在则使用默认值
$color = get_option( 'myplugin_setting_color', '#000000' );

Membuat tabel basis data khusus

Ketika sebuah plugin memerlukan penyimpanan data relasional yang kompleks, mungkin diperlukan untuk membuat tabel basis data khusus (custom database tables). Proses ini biasanya dilakukan saat plugin diaktifkan, dan harus mengikuti konvensi struktur basis data WordPress.

在 my-first-plugin.php Di dalam kode tersebut, tambahkan fungsi untuk membuat tabel ke dalam hook yang digunakan untuk mengaktifkan plugin.

function myplugin_create_custom_table() {
    global $wpdb;
    $table_name = $wpdb->prefix . 'myplugin_items'; // 使用 $wpdb->prefix 确保表前缀正确
    $charset_collate = $wpdb->get_charset_collate();

    $sql = "CREATE TABLE IF NOT EXISTS $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        name varchar(100) NOT NULL,
        created_at datetime DEFAULT CURRENT_TIMESTAMP NOT NULL,
        PRIMARY KEY (id)
    ) $charset_collate;";

    require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
    dbDelta( $sql );
}
register_activation_hook( __FILE__, 'myplugin_create_custom_table' );

Membangun antarmuka manajemen backend untuk plugin

Membuat halaman pengaturan backend yang intuitif untuk plugin Anda merupakan kunci untuk menyediakan pengalaman pengguna yang baik. WordPress menyediakan berbagai API untuk mempermudah proses pembuatan menu manajemen, halaman pengaturan, dan formulir.

Tambahkan menu manajemen dan sub-menu.

Gunakan add_menu_page() 和 add_submenu_page() Fungsi tersebut dapat digunakan untuk menambahkan menu item ke sidebar di sisi belakang (backend) WordPress untuk plugin Anda.

Tambahkan menu utama “My Plugins” dan sub-menu “Settings” ke dalam kode berikut:

function myplugin_add_admin_menu() {
    // 添加顶级菜单
    add_menu_page(
        '我的插件设置',          // 页面标题
        '我的插件',             // 菜单标题
        'manage_options',       // 所需权限
        'myplugin-dashboard',   // 菜单 Slug
        'myplugin_dashboard_page', // 回调函数，用于输出页面内容
        'dashicons-admin-generic', // 图标
        30                      // 菜单位置
    );

    // 添加子菜单
    add_submenu_page(
        'myplugin-dashboard',   // 父菜单 Slug
        '插件设置',             // 页面标题
        '设置',                 // 菜单标题
        'manage_options',       // 权限
        'myplugin-settings',    // 子菜单 Slug
        'myplugin_settings_page' // 回调函数
    );
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );

// 定义“仪表盘”页面的回调函数
function myplugin_dashboard_page() {
    echo '<div class="wrap"><h1>My Plugin Dashboard</h1></div>';
}

// 定义“设置”页面的回调函数
function myplugin_settings_page() {
    echo '<div class="wrap"><h1>Pengaturan plugin saya</h1></div>';
}

API untuk Pengaturan Integrasi (Integration Settings API) untuk Membangun Formulir

Pengaturan API WordPress menyediakan cara yang aman dan terstandarisasi untuk membuat, memverifikasi, dan menyimpan pengaturan formulir. Proses ini melibatkan pendaftaran pengaturan, penambahan area pengaturan, serta bidang-bidang yang digunakan dalam formulir.

Berikut adalah contoh sederhana untuk membuat halaman pengaturan yang berisi sebuah bidang teks:

function myplugin_settings_init() {
    // 注册一个新的设置项 “myplugin_settings”
    register_setting( 'myplugin_settings_group', 'myplugin_settings' );

    // 添加一个新的设置区域
    add_settings_section(
        'myplugin_section_basic',
        '基础设置',
        null, // 区域描述的回调函数，这里不需要
        'myplugin-settings' // 页面 Slug
    );

    // 在区域内添加一个字段
    add_settings_field(
        'myplugin_field_api_key',
        'API 密钥',
        'myplugin_field_api_key_callback', // 渲染字段 HTML 的回调函数
        'myplugin-settings',
        'myplugin_section_basic'
    );
}
add_action( 'admin_init', 'myplugin_settings_init' );

// 字段的回调函数
function myplugin_field_api_key_callback() {
    $options = get_option( 'myplugin_settings' );
    $value = $options['api_key'] ?? '';
    echo '<input type="text" name="myplugin_settings[api_key]" value="' . esc_attr( $value ) . '" class="regular-text">';
}

// 修改之前的设置页面回调函数，以输出表单
function myplugin_settings_page() {
    ?&gt;
    <div class="wrap">
        <h1>Pengaturan plugin saya</h1>
        <form action="/id/options.php/" method="post" 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="id"/></form>
    </div>
    \n&lt;?php
}

Menyimpulkan.

Pengembangan plugin WordPress dimulai dengan memahami struktur dasarnya, kemudian secara bertahap mempelajari API inti dan aspek keamanannya, hingga akhirnya membuat antarmuka pengguna yang lengkap. Kuncinya adalah mengikuti standar pemrograman dan praktik terbaik WordPress, seperti penggunaan hook yang tepat, penanganan data yang aman, serta pemanfaatan API opsi dan pengaturan yang sudah tersedia. Prosesnya dimulai dengan membuat file komentar di bagian awal plugin yang sederhana, lalu secara bertahap menambahkan fungsi-fungsi seperti aksi (actions), filter, dan kode singkat (shortcodes), hingga mengelola basis data dan antarmuka administrasi (backend). Setiap langkah dalam proses ini didasarkan pada kerangka kerja WordPress yang kuat dan stabil. Dengan belajar dan mempraktikkan langkah-langkah ini secara sistematis, Anda akan mampu mengembangkan plugin WordPress yang memiliki fungsi yang lengkap, aman, dan mudah dikelola, sehingga dapat berkontribusi pada ekosistem WordPress yang luas di seluruh dunia.

FAQ - Pertanyaan yang Sering Diajukan.

Apa saja pengetahuan dasar yang diperlukan untuk mengembangkan plugin WordPress?

Untuk mengembangkan plugin WordPress, diperlukan pemahaman tentang bahasa pemrograman PHP, karena kode inti dari sebuah plugin ditulis menggunakan PHP. Selain itu, diperlukan pengetahuan dasar tentang HTML, CSS, dan JavaScript untuk membuat antarmuka pengguna (frontend) dan mekanisme interaksi yang efektif. Yang paling penting adalah memahami konsep-konsep dasar WordPress, seperti “hook” (Actions dan Filters), struktur pengulangan (The Loop), hierarki template, serta struktur basis data WordPress.

Bagaimana cara mendeteksi dan memperbaiki kesalahan (bug) pada plugin WordPress saya?

Pertama, di wp-config.php Aktifkan mode debug WordPress di dalam file tersebut. WP_DEBUG Konstanta diatur ke trueIni akan menampilkan kesalahan dan peringatan PHP di layar. Selanjutnya, Anda dapat menggunakan… error_log() Fungsi tersebut menulis informasi debug ke log kesalahan server. Selain itu, menginstal plugin debug profesional seperti Query Monitor memungkinkan Anda untuk melihat secara real-time informasi terperinci mengenai kueri database, eksekusi hook, pengunduhan skrip, dan lainnya, yang merupakan alat yang sangat penting dalam proses pengembangan.

Bagaimana cara plugin saya mendukung berbagai bahasa (internasionalisasi)?

WordPress menggunakan kerangka kerja teknologi GNU gettext untuk mendukung fitur internasionalisasi (i18n). Pertama-tama, dalam kode plugin, semua string yang perlu diterjemahkan harus ditandai dengan cara tertentu agar dapat diterjemahkan nanti. () 或 _e() Tunggu fungsi terjemahan menyelesaikan paket, dan untuk () Fungsi tersebut menentukan domain teks (Text Domain) yang akan didefinisikan di bagian awal plugin. Setelah itu, alat seperti Poedit digunakan untuk memindai kode sumber plugin, sehingga domain teks tersebut dapat dihasilkan (dibuat). .pot File template, dan berdasarkan ini dibuat versi dalam berbagai bahasa. .po Dan yang telah dikompilasi .mo File tersebut perlu diletakkan di dalam plugin. /languages/ Di dalam direktori tersebut. Akhirnya, gunakan… load_plugin_textdomain() Memuat dan menerjemahkan fungsi.

Bagaimana cara mengirimkan plugin saya ke direktori plugin resmi WordPress?

Sebelum mengirimkan plugin ke direktori resmi, pastikan bahwa plugin tersebut sepenuhnya memenuhi spesifikasi dan panduan pengembangan plugin yang ditetapkan oleh pihak pengelola. Anda perlu memiliki akun WordPress.org, lalu mengisi formulir di halaman pengiriman plugin. Tim pemeriksa akan memeriksa keamanan kode, lisensi (harus kompatibel dengan GPL), kualitas kode, dokumentasi, dan tingkat kompatibilitas plugin dengan sistem WordPress. Setelah lulus pemeriksaan, Anda akan mendapatkan alamat repositori SVN. Setelah mengirimkan kode melalui SVN, plugin tersebut akan ditampilkan di direktori resmi. Proses ini dapat memakan waktu beberapa minggu, dan terdapat standar pemeriksaan yang terperinci.