WordPress Plugin Development Beginner’s Guide: Build Your First Custom Plugin from Scratch

WordPress plugins are the core of extending website functionality. They allow you to add new features in a modular manner, without having to modify the core code of WordPress itself. By developing your own plugins, you can create completely customized solutions that better meet specific needs, while ensuring compatibility with other themes and plugins. This guide will take you through the entire process of building a WordPress plugin with comprehensive functionality and a well-structured design.

The basic structure and conventions of WordPress plugins

A standard WordPress plugin must follow specific file structures and guidelines to ensure that it can be correctly recognized by the WordPress system, run securely, and be easy to maintain.

Create the main file of the plug-in

Every plugin must have a main PHP file, whose name usually matches the name of the plugin directory. The beginning of this file must contain a specific plugin information header comment, which WordPress uses to identify the plugin.

Recommended Reading In-depth Analysis of WordPress Plugin Development: From Beginner to Efficient Customization。

Create a file named within the plugin directory. my-first-plugin.php The file, and add the following header information:

UltaHost WordPress Hosting

30-day refund guarantee, unlimited bandwidth and database usage, free DDoS protection; purchase for 3 years and get a discount of 50%.

access page

<?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
 * Domain Path:       /languages
 */

Follow security best practices.

All plugin code should be included in the security checks to prevent direct access. Additionally, unique prefixes should be used to name all functions, classes, and constants to avoid conflicts with the theme or other plugins.

In the main plugin file, the security protection code should be added immediately after the header comments, and a unique prefix should be used (for example: mfp_Use that name to name your function:

// 防止直接访问文件
if ( ! defined( 'ABSPATH' ) ) {
    exit;
}

// 使用唯一前缀定义一个函数
function mfp_display_greeting() {
    echo '<p>Hello, welcome to use my first plugin!</p>';
}

Implement the core functions: actions and filters.

WordPress’s core extension mechanism relies on hooks, which are divided into Actions and Filters. Understanding and using them correctly is crucial for plugin development.

Use action hooks to add functionality.

Action hooks allow you to execute your own code at specific times or when certain events occur. For example, to add a piece of text at the bottom of a page, you can use action hooks. wp_footer Action.

Recommended Reading WordPress Plugin Development: Building Custom Function Plugins from Scratch。

Mount the previously defined function to… wp_footer On the hook:

// 将函数挂载到 wp_footer 动作钩子
add_action( 'wp_footer', 'mfp_display_greeting' );

In this way, when WordPress processes the footer section, it will invoke the relevant code or function. mfp_display_greeting Function: Outputs a greeting message.

Use the filter hook to modify the content.

Filter hooks are used to modify data. They receive a value, process it, and then return the modified result. For example, to change the default suffix of article titles, you can use a filter hook to achieve this. the_title Filters.

hosting.com Shared Hosting

High performance with AMD EPYC CPUs, NVMe SSD storage and LiteSpeed, 24/7, 24x7 expert in-house support, advanced security measures including SSL, brute force, malware and DDoS protection, savings of up to 73%

access page

Create a function to modify the article title and add it to the filter:

// 定义一个函数来修改文章标题
function mfp_modify_title( $title, $id = null ) {
    // 仅在前端修改非管理员页面的标题
    if ( ! is_admin() && in_the_loop() ) {
        $title .= ' - 来自我的插件';
    }
    return $title;
}
// 将函数挂载到 the_title 过滤器钩子，参数3是优先级，参数4是接受的参数个数
add_filter( 'the_title', 'mfp_modify_title', 10, 2 );

Build a plugin management interface

Most plugins require a backend settings page that allows website administrators to configure the plugin options. WordPress provides a rich API for creating standard management menus and forms.

Create a plugin settings page.

utilization add_menu_page() Or add_options_page() The function can add a management page for your plugin. Typically, this page is located under the “Settings” menu.

Recommended Reading Learn WordPress plugin development from scratch: principles, practices, and advanced techniques。

Create a function to register and manage the menu, and then mount it to... admin_menu Action:

// 添加插件设置页面到后台菜单
function mfp_add_admin_menu() {
    add_options_page(
        '我的第一个插件设置', // 页面标题
        '我的插件设置',       // 菜单标题
        'manage_options',     // 权限要求
        'my-first-plugin',    // 菜单slug
        'mfp_render_settings_page' // 用于渲染页面的回调函数
    );
}
add_action( 'admin_menu', 'mfp_add_admin_menu' );

// 渲染设置页面的回调函数
function mfp_render_settings_page() {
    ?>
    <div class="wrap">
        <h1>My first plugin settings</h1>
        <form action="/en/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            settings_fields( 'mfp_settings_group' );
            do_settings_sections( 'my-first-plugin' );
            submit_button();
            ?>
        <input type="hidden" name="trp-form-language" value="en"/></form>
    </div>
    &lt;?php
}

Registration and settings options for processing

The WordPress API allows for the safe registration, validation, and storage of settings options. You need to define the settings fields and sections, and use a processing function to save the data.

InterServer Shared Hosting

Shared hosting $2.50 USD per month , first month $0.1 USD promo code tryinterserver, 461 cloud apps scripts, one click install.

access page

Continue to add the following code to the plugin’s main file to register the settings:

// 初始化插件设置
function mfp_settings_init() {
    // 注册一个新的设置组和选项
    register_setting( 'mfp_settings_group', 'mfp_settings', 'mfp_sanitize_settings' );

// 在插件设置页面添加一个节
    add_settings_section(
        'mfp_section_basic',
        '基本设置',
        null,
        'my-first-plugin'
    );

// 向节中添加一个字段
    add_settings_field(
        'mfp_greeting_text',
        '问候语文本',
        'mfp_greeting_text_render',
        'my-first-plugin',
        'mfp_section_basic'
    );
}
add_action( 'admin_init', 'mfp_settings_init' );

// 渲染问候语文本输入字段
function mfp_greeting_text_render() {
    $options = get_option( 'mfp_settings' );
    $value = isset( $options['greeting_text'] ) ? $options['greeting_text'] : '你好，世界！';
    echo '<input type="text" name="mfp_settings[greeting_text]" value="' . esc_attr( $value ) . '" class="regular-text">';
}

// 清理和验证设置输入
function mfp_sanitize_settings( $input ) {
    $sanitized = [];
    if ( isset( $input['greeting_text'] ) ) {
        $sanitized['greeting_text'] = sanitize_text_field( $input['greeting_text'] );
    }
    return $sanitized;
}

Plugin Internationalization and Deployment Preparation

In order for the plugin to be used by users around the world and eventually be released, you need to carry out internationalization (i18n) and code optimization efforts.

Implementing text internationalization

Using WordPress __()、_e() Use functions to wrap all the text strings that need to be translated, and ensure that the text fields are loaded correctly.

Modify your output function to support translation.

function mfp_display_greeting() {
    $options = get_option( ‘mfp_settings’ );
    $greeting = isset( $options[‘greeting_text’] ) ? $options[‘greeting_text’] : __( ‘你好，世界！’, ‘my-first-plugin’ );
    echo ‘<p>’ . esc_html( $greeting ) . ‘</p>’;
}

// 在插件加载时加载翻译文件
function mfp_load_textdomain() {
    load_plugin_textdomain( ‘my-first-plugin’, false, dirname( plugin_basename( __FILE__ ) ) . ‘/languages/’ );
}
add_action( ‘plugins_loaded’, ‘mfp_load_textdomain’ );

Optimizing code and creating release packages

After completing the development, you need to remove the debugging code and ensure that all functions have a unique prefix. Next, compress the entire plugin directory into a ZIP file, which can then be uploaded and installed through the WordPress administration panel.

Make sure the main file contains a standard uninstallation handler that cleans up the database options when the user deletes the plugin. This is achieved by registering an uninstallation hook:

// 插件卸载时的清理操作
register_uninstall_hook( __FILE__, ‘mfp_uninstall’ );
function mfp_uninstall() {
    delete_option( ‘mfp_settings’ );
}

summarize

This article provides a detailed guide on the entire process of creating a custom WordPress plugin from scratch. We start by understanding the basic structure and security guidelines of plugins, then gradually delve into WordPress’s core hook system (actions and filters), and learn how to build a backend administration interface with a settings page. Finally, we also discuss the internationalization of plugins, code optimization, and the steps necessary for final deployment.

Remember: Excellent plugin development is not just about implementing functionality; it also involves ensuring the security and maintainability of the code, as well as compliance with WordPress standards. I recommend that you thoroughly study the official WordPress plugin documentation, follow coding best practices, and continuously apply what you’ve learned in real-world projects.

FAQ Frequently Asked Questions

What preparatory knowledge is required to develop WordPress plugins?

It would be very helpful if you have a basic understanding of PHP programming, including knowledge of variables, functions, arrays, and conditional statements. A basic knowledge of HTML and CSS, as well as an understanding of the basic operations and backend structure of WordPress, would also be beneficial. Having knowledge of object-oriented programming (OOP) is an added advantage for more advanced development.

我必须使用类（Class）来编写插件吗？

Not necessarily. For simple plugins, using procedural programming (a set of functions) is completely feasible, which is also the approach adopted in the examples in this article. However, for larger plugins with more complex functionality, object-oriented programming (OOP) and organizing the code in the form of classes is a better choice. This allows for more efficient code organization, avoids naming conflicts, and improves maintainability.

How to debug my WordPress plugin code?

The first step is to enable the debugging mode in WordPress. On the website’s… wp-config.php In the document, it will be stated that... WP_DEBUG The constant is set to trueThis will display PHP errors, notifications, and warnings on the page. In addition, you can use… error_log() The function writes debugging information to the server’s error log, or uses specialized debugging tools (such as Query Monitor) to check for issues with database queries, hook executions, and performance.

How to ensure security in plugin development?

Key measures to ensure security include: always validating and cleaning user input (by using…) sanitize_text_field(), esc_html(), wp_kses_post() (Functions such as…) are used for all database queries. $wpdb Use the methods of the class, and utilize its `prepare` statement to prevent SQL injection; escape all dynamic content that is sent to the browser; employ WordPress’s built-in non-verification fields (nonces) and permission checks.current_user_can()) to protect forms and AJAX requests.