Starting from scratch: The ultimate guide and practical tutorial for WordPress plugin development

The core concepts of WordPress plugin development

Before delving into the code, it's crucial to understand the basic principles of WordPress plugins. A WordPress plugin is essentially a PHP script or a set of scripts that extend or modify the core functionality of WordPress through the standard WordPress hook system. Its core lies in seamlessly integrating with the WordPress workflow without directly modifying the core files.

A core file refers to a PHP file with specific file header comments. This file header is the way WordPress identifies a plugin. For example, the main file of a basic plugin my-first-plugin.php The beginning of the document must include the following information:

<?php
/**
 * Plugin Name: 我的第一个插件
 * Description: 这是一个用于演示的简单WordPress插件。
 * Version: 1.0.0
 * Author: 你的名字
 */

Once this file has been placed in /wp-content/plugins/ Under the “Plugins” page in the WordPress backend, it can be recognized and listed there.

Recommended Reading A Comprehensive Guide to WordPress Theme Development: Building a Professional-Level Website Theme from Scratch。

The operation mechanism of the plugin relies on two core concepts: Action Hooks and Filter Hooks. Action Hooks allow you to insert your own code at specific points in the execution of WordPress, such as after an article is published or before a stylesheet is loaded in the header of a page. Use the function add_action() You can “mount” your function to these hooks. The filter hook allows you to modify the data before it is used or saved to the database, for example, by modifying the article content, title, or excerpt. This is achieved through add_filter() It's implemented by functions. Understanding and skillfully using the hook system is a crucial step in transforming from a WordPress user to a developer.

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

Build your first functional plugin.

Let's start with a practical and useful example: creating a small plugin that automatically adds a copyright statement to the bottom of a website's article page. This process will cover the creation of the plugin, the use of filter hooks, and the basic setup of plugin options.

First, in your local or test environment, /wp-content/plugins/ Create a new folder under the directory and name it my-copyright-noticeWithin this folder, create the main plugin file. my-copyright-notice.phpAnd enter the following code:

<?php
/**
 * Plugin Name: 文章版权声明
 * Description: 自动在文章内容末尾附加自定义版权声明。
 * Version: 1.0.0
 * Author: 开发者
 */

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

/**
 * 在文章内容后追加版权声明
 */
function mycn_add_copyright_to_content( $content ) {
    // 确保只在主循环的单篇文章中显示
    if ( is_single() && in_the_loop() && is_main_query() ) {
        $site_url = get_site_url();
        $current_year = date( 'Y' );
        // 构建版权文本，这里用 2026 作为示例，实际开发可动态获取
        $copyright_text = sprintf(
            &#039;<p><em>© 2026 %s. This article is written by <strong>%s</strong> Original content. Please indicate the source if reposting it.</em></p>',
            esc_html( get_bloginfo( 'name' ) ),
            esc_url( $site_url )
        );
        $content .= $copyright_text;
    }
    return $content;
}
// 将函数挂载到 ‘the_content’ 过滤器
add_filter( 'the_content', 'mycn_add_copyright_to_content' );

This plug-in demonstrates the basic usage of filters.mycn_add_copyright_to_content The function receives the content of the article. $content\n, through conditional judgment, ensure that copyright information is only added to the single article page and in the main query, and then modify and return the new content.add_filter( ‘the_content’， ‘mycn_add_copyright_to_content’ ) This line of code completes the injection of the function.

Add a management interface and options to the plug-in

A mature plugin usually needs to allow users to configure it. This is achieved by creating an options page in the WordPress backend. We will add a settings page to the copyright plugin mentioned above, allowing users to customize the copyright text.

Recommended Reading How to customize a WordPress theme with unique features and an eye-catching design to meet professional needs。

First, we need to create a function to register a settings menu item. This is usually done when the administrator initializes the system.

Modify your my-copyright-notice.php For the file, add the following code:

\n// Add an administrator menu
function mycn_add_admin_menu() {
    add_options_page(
        'Copyright Statement Settings', // Page title
        'Article Copyright',     // Menu title
        'manage_options', // Permission
        'my_copyright_notice', // Menu slug
        'mycn_settings_page_html' // Callback function for outputting page HTML
    );
}
add_action( 'admin_menu', 'mycn_add_admin_menu' );

// Initialize the plugin's settings
function mycn_settings_init() {
    // Register a new setting item to the ‘mycn_settings’ group
    register_setting( ‘mycn_settings’, ‘mycn_copyright_text’ );

// Add a setting section within the ‘mycn_settings’ group
    add_settings_section(
        ‘mycn_settings_section’,
        ‘Custom Copyright Text’,
        null, // Optional section description callback function
        ‘mycn_settings’
    );

// Add a field to the section
    add_settings_field(
        ‘mycn_copyright_field’,
        ‘Copyright Statement’,
        ‘mycn_copyright_field_html’,
        ‘mycn_settings’,
        ‘mycn_settings_section’
    );
}
add_action( ‘admin_init’, ‘mycn_settings_init’ );

// Set the HTML output for the field
function mycn_copyright_field_html() {
    $option = get_option( ‘mycn_copyright_text’, ‘© 2026 [site_name]. This article is original from [site_url].’ );
    ?>
    <textarea name="‘mycn_copyright_text’" rows="‘5’" cols="‘50’"><?php echo esc_textarea( $option ); ?></textarea>
    <p class="“description”">Support short codes: [site_name] for the website name, and [site_url] for the website address.</p>
    <?php
}

// 设置页面的HTML结构
function mycn_settings_page_html() {
    // 检查用户权限
    if ( ! current_user_can( ‘manage_options’ ) ) {
        return;
    }
    ?>
    <div class="“wrap”">
        <h1></h1>
        <form action="/en/“options.php”/" method="“post”" data-trp-original-action="“options.php”">
            <?php
            settings_fields( ‘mycn_settings’ );
            do_settings_sections( ‘mycn_settings’ );
            submit_button();
            ?>
        <input type="hidden" name="trp-form-language" value="en"/></form>
    </div>
    &lt;?php
}

Next, we need to modify the previous one. mycn_add_copyright_to_content The function makes it possible to use the options saved by the user and replace the shortcodes in them.

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

function mycn_add_copyright_to_content( $content ) {
    if ( is_single() && in_the_loop() && is_main_query() ) {
        $text = get_option( ‘mycn_copyright_text’, ‘© 2026 [site_name]. This article was originally published from [site_url].’ );
        $text = str_replace(
            array( ‘[site_name]’, ‘[site_url]’ ),
            array( esc_html( get_bloginfo( ‘name’ ) ), esc_url( get_site_url() )),
            $text
        ).
        $content . = ‘<p><em>’ . wp_kses_post( $text ) . ‘</em></p>’;
    }
    return $content.
}

Now, users can see the “Article Copyright” sub-menu under the “Settings” menu in the WordPress backend, and they can customize the declaration text as they wish.

Best practices for plugin security, debugging, and internationalization

When developing a plugin for others to use, it's essential to consider security, stability, and maintainability. Here are several key best practices to keep in mind.

Security: Never trust user input. All data from users, databases, or third-party APIs must be properly escaped or cleaned before being output to the screen, inserted into the database, or used for file operations. WordPress provides a wealth of security functions, such as using them for HTML. esc_html(), use the URL esc_url()Use HTML attributes for this. esc_attr()When it's necessary to allow some safe HTML tags, use < wp_kses_post() Or wp_kses()At the beginning of the plug-in, be sure to use if ( ! defined( ‘ABSPATH’ ) ) exit; This is to prevent the files from being accessed directly.

Recommended Reading Complete Guide to WordPress Plugin Development: From Zero to Live Deployment。

Debugging: During the development process, enable WP_DEBUG Constant values are crucial. In your wp-config.php Settings are defined in the file. define( ‘WP_DEBUG’， true);This will display all PHP errors, warnings, and notifications on the screen (only in the development environment). At the same time, it can be used in conjunction with other tools. error_log() Functions or debugging plugins like Query Monitor can greatly assist you in tracking variables and SQL queries.

Translation preparation (internationalization/i18n): To enable your plugin to be used by users all over the world, all user-facing strings should be prepared for translation. This means not using hardcoded Chinese or English, but instead using WordPress' translation functions.

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

For example, modify the previous plug-in information to:

/**
 * Plugin Name: 文章版权声明
 * Description: 自动在文章内容末尾附加自定义版权声明。
 * Version: 1.0.0
 * Author: 开发者
 * Text Domain: my-copyright-notice
 */

In the code, replace the strings that need to be translated with placeholders such as `%s`, `%1$s`, or `{{var}}`. __( ‘string’， ‘text-domain’ ) Or _e( ‘string’， ‘text-domain’ ) Function wrappers. For example, in the settings page function:

function mycn_settings_page_html() {
    if ( ! current_user_can( ‘manage_options’ ) {
        return; }
    }
    ? >}
    <div class="“wrap”">
        <h1><?php echo esc_html( __( ‘版权声明设置’， ‘my-copyright-notice’ ) ); ?></h1>
        ...
    </div>
    &lt;?php
}

Then, you can use tools like Poedit to extract these strings and generate the desired output. .pot Template files for translators to create .po/.mo Language files.

summarize

WordPress plugin development is the process of transforming creative ideas into functional components that are seamlessly integrated into the world’s most popular content management system. By starting with a thorough understanding of the core mechanisms of Hooks, you can quickly get started by creating simple plugins. Creating a management interface and options for your plugin enhances its professionalism and usability. Following best practices for security, debuggability, and internationalization is crucial for ensuring that your plugin is stable, secure, and easy to distribute. Remember, the best way to learn is to practice hands-on; start with a real-world requirement and gradually build and improve your plugin.

FAQ Frequently Asked Questions

What basic knowledge is required for developing WordPress plugins?

You need to have a good foundation in PHP programming, as the plugin is primarily written in PHP. At the same time, you need to have a basic understanding of HTML, CSS, and JavaScript to create front-end output and manage interfaces. It's essential to understand the basic architecture of WordPress, such as themes, post types, taxonomies, and especially the action hooks and filter hooks systems.

How to start debugging a plugin that doesn't work

Firstly, in your wp-config.php Enable in the file. WP_DEBUG and WP_DEBUG_LOGThis will record the error message in the log file instead of displaying it to visitors. Secondly, make sure that your plugin is activated. Then, check the code syntax and ensure that all function names, hook names, and file paths are correct. Use var_dump() Or error_log() Output the values of the key variables, or install a professional WordPress debugging plugin (such as Query Monitor) to assist in troubleshooting.

Which folder should I put my plugin in?

Your plugin must be placed in the WordPress installation directory. /wp-content/plugins/ Inside the folder. You can directly create a PHP file under this directory (suitable for minimalist plugins), but a more standard approach is to create a separate folder for your plugin and place the main file and other resource files (such as JS, CSS, and images) in this folder. The naming of the folder and the main PHP file should be unique to avoid conflicts with other plugins.

How to submit my plugin to the official WordPress plugin directory?

First, you need to register an account on WordPress.org and submit your plugin. Your plugin code must comply with the official code guidelines and standards, including security, absence of malicious code, and inclusion of appropriate file header comments. You also need to provide a valid readme.txt The file meets the official requirements in terms of format. After submission, the plugin review team will conduct a manual review, which may take several weeks. Once the review is completed, your plugin will be available for users worldwide to search for and install.