WordPress Plugin Development Guide: Creating Your First Custom Plugin from Scratch

Development environment and basic preparations

Before you start writing code, having a stable and efficient local development environment is essential. For WordPress plugin development, we recommend using integrated environments such as XAMPP, MAMP, or Local by Flywheel. These tools allow you to install Apache, MySQL, and PHP with just one click, eliminating the need for tedious configuration processes. Make sure that your PHP version is at least 7.4 and your MySQL version is at least 5.6 to meet the latest environmental requirements recommended by WordPress.

Next, you will need a code editor. Visual Studio Code, PhpStorm, or Sublime Text are all excellent choices; they offer syntax highlighting, code suggestions, and debugging features, which can greatly improve your development efficiency. Additionally, it is important to install a version control tool such as Git to manage the history of your code changes. This is a standard practice in modern development.

Understanding the basic structure of WordPress plugins is the first step. The most basic plugin contains at least one main PHP file, whose header comments serve as the plugin’s “identification card,” providing information about the plugin to the WordPress system. This file can exist on its own or act as the entry point for a more complex plugin directory.

Recommended Reading WordPress Plugin Development: From Beginner to Expert – Building Your First Custom Plugin。

Create your first plug-in file

Let’s start by creating the simplest plugin possible. First, navigate to the local WordPress installation directory on your computer.wp-content/pluginsFolder: Here, create a new folder and name it…my-first-pluginAll files related to the plugins will be placed in this directory.

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

Inside this folder, create a main PHP file, for example, name it `main.php`.my-first-plugin.phpThe header of this file must contain a specific block of comments with plugin information. Here is a standard example:

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

The “Plugin Name” in this comment is required. WordPress uses it to identify and display your plugin in the background plugin list. Additional information such as the version number and the author helps users understand more about the plugin. After saving the file, log in to your WordPress administration panel and go to the “Plugins” page. You should see “My First Plugin” listed in the plugin list, and you will be able to activate or deactivate it. Although the plugin currently has no functionality, you have successfully created a valid plugin framework.

Add core functionality to the plugin.

An activated plugin needs to execute its code through WordPress’s hook mechanism. There are two types of hooks: Action Hooks and Filter Hooks. Action Hooks allow you to insert code at specific points in the process to perform certain functions, while Filter Hooks enable you to modify the data that is being passed during that process.

Use action hooks to add a management menu.

In order to allow users to interact with plugins, we usually need to add a settings page in the WordPress administration area. This can be achieved by…add_action()The function is mounted.admin_menuThis action hook is used to implement the functionality.

Recommended Reading The Ultimate Guide to WordPress Plugin Development: Creating Your First Custom Plugin from Scratch。

First, we define a function in the main plugin file that is used to generate the HTML content for the settings page. This function can be named…mfp_settings_page_htmlThen, we create another function, for example…mfp_add_admin_menuUsing WordPress within itadd_menu_page()A function is used to register a new top-level menu item. Finally, use it…add_action('admin_menu', 'mfp_add_admin_menu')Mount the registration function to the system.

Use the filter hook to modify the content of an article.

In addition to backend functionality, plugins are often used to modify the front-end content of a website. For example, we can automatically add a copyright notice at the end of each article. This requires the use of plugins to achieve that.the_contentThis filter hook.

Let's define a function, for example, let's call it…mfp_add_copyright_to_contentIt receives a parameter (i.e., the original article content) and appends custom HTML text at the end of it. Then, it is processed further through…add_filter('the_content', 'mfp_add_copyright_to_content')Register this function as a filter. In this way, whenever WordPress retrieves the content of an article, it will first pass the content through our function for processing. The copyright information will be added before the content is displayed.

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

Plugin Security, Optimization, and Deployment

Developing new features is just the first step; ensuring the security and performance of the plugin is equally important. All data entered by users must be strictly validated, escaped, and cleaned before being stored in the database or displayed on the page. WordPress provides a wealth of security-related functions to help with this process.sanitize_text_field()(Clean the text)esc_html()(Escape HTML) andwp_kses()(Only specified HTML tags are allowed; make sure to use them in the appropriate places.)

To improve the maintainability and performance of the plugin, it is recommended to organize the code using the principles of object-oriented programming (OOP) by encapsulating functions within classes. Additionally, make proper use of WordPress’s Transients API to cache time-consuming query results or data retrieved from remote sources, thereby avoiding the need to recalculate these values with each page load.

Once your plugin’s functionality is fully developed and has passed all tests, you can then consider releasing it. You will need to prepare a clear…readme.txtThe files must comply with the requirements specified by WordPress.org, including the format for describing plugin functionality, installation methods, update logs, and frequently asked questions. If you wish to submit your plugin to the official WordPress plugin repository, you need to create an SVN repository and follow the code guidelines and submission instructions provided by WordPress. For commercial plugins, you will also need to set up your own servers for sales and updates.

Recommended Reading Master WordPress plugin development comprehensively: build custom features from scratch。

summarize

Through this guide, we have covered the core steps of WordPress plugin development: from setting up the environment and creating the basic file structure, to using action and filter hooks to add functionality to the plugin, and finally focusing on security, optimization, and preparation for release. The essence of plugin development is to extend the core functionality of WordPress, and the hook mechanism serves as the bridge that connects your code with the WordPress ecosystem. Once you have mastered these basics, you can explore more advanced APIs and possibilities by referring to the official plugin documentation and the core WordPress code, thereby creating powerful, secure, and popular plugins.

FAQ Frequently Asked Questions

What files must a plugin include?

The simplest plugin can consist of just a PHP file with the correct file header comments. However, as the functionality becomes more complex, it usually includes multiple PHP files, JavaScript, CSS, image resources, and also…readme.txtDocumentation file. The core main PHP file is essential.

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

How can I prevent my plugin from conflicting with other plugins?

Adding a unique prefix to all your function names, class names, constant names, and global variables is the best practice for avoiding naming conflicts. It is common to use plugin abbreviations or the names of the respective libraries as prefixes. For example…mfp_Ormy_plugin_At the same time, encapsulating the code within classes can also effectively isolate the scope of the variables and functions.

How to add configurable settings options for a plugin?

It is recommended to use the WordPress Settings API to create secure and standardized setup pages. This API provides functions for registering settings, adding setting fields and sections, and it automatically handles the saving, validation, and non-Cookie-based authentication (nonce validation) of user inputs. This approach is much more efficient than handling everything manually.$_POSTThe data is much safer and more convenient to use.

How to debug errors in a plugin during development?

First of all, make sure that your…wp-config.phpThe WordPress debugging mode has been enabled in the file.WP_DEBUGThe constant is set totrueAt the same time, you can install and enable professional debugging plugins such as Query Monitor. It can help you monitor database queries, the execution of hooks, PHP errors, and performance bottlenecks, making it an essential tool during the development process.