WordPress Plugin Development: A Guide to Creating a Base Plugin for WordPress.org
The WordPress.org Plugin Directory is a treasure trove of plugins, often the first stop for WordPress users seeking enhanced site functionality. This directory also presents significant opportunities for developers, but adherence to specific guidelines is crucial. A well-structured base plugin simplifies the development process.
Key Considerations:
- The WordPress.org Plugin Directory demands adherence to specific guidelines for plugin creation and submission. This includes proper file and directory structuring, comprehensive README.txt instructions, and compliance with WordPress coding standards.
- The
assets
directory houses essential plugin visuals: screenshots, a banner image, and an icon. While not mandatory, these assets significantly boost user engagement. - Maintaining a clear
trunk
andtags
directory structure is vital for version control. Thetrunk
serves as the active development directory. Upon release, code is copied to a version-specific directory withintags
. Users download from these versioned directories, not thetrunk
. - Internationalization is key. Translate all displayed strings to support non-English speakers. This involves creating a
.pot
file containing translated string versions.
Base Plugin Structure:
Every plugin destined for the WordPress.org directory requires these files and directories:
<code>--plugin-name --assets -screenshot-n.png -icon-256x256.png -banner-772x250.png --trunk --admin --css --js --inc -admin.php --public --css --js --inc -public.php --inc -activation.php -deactivation.php --languages -plugin-name.pot -plugin-name.php -uninstall.php -README.txt --tags </code>
Let's examine each component's function and required code.
Assets Directory:
This folder holds plugin images: screenshots, a banner, and an icon. Multiple screenshots (png, jpg, jpeg, or gif) showcasing the latest version are recommended. The icon should be 256x256 pixels, and the banner 772x250 pixels. While optional, these visuals enhance plugin visibility.
Trunk and Tags Directories:
The trunk
directory is your workspace. For releases, copy the trunk
contents to a new version directory within tags
(e.g., tags/1.0
, tags/2.0
). Users download from these version directories, not the trunk
.
README.txt File:
This file is paramount; it's the primary information source displayed on WordPress.org. It should clearly explain the plugin's purpose and usage, even if seemingly obvious. Use Markdown formatting. The Stable tag
in the trunk
's README.txt
must point to the latest version directory in tags
.
Example README.txt Content (Markdown):
<code>--plugin-name --assets -screenshot-n.png -icon-256x256.png -banner-772x250.png --trunk --admin --css --js --inc -admin.php --public --css --js --inc -public.php --inc -activation.php -deactivation.php --languages -plugin-name.pot -plugin-name.php -uninstall.php -README.txt --tags </code>
plugin-name.pot File:
Create a .pot
file for internationalization. Use load_plugin_textdomain()
in plugin-name.php
:
=== Plugin Name === Contributors: developer1, developer2 Donate link: http://example.com/ Tags: tag1, tag2, tag3 Requires at least: 3.0.1 Tested up to: 3.4 Stable tag: 2.0 License: GPLv2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html Short description (under 150 characters). == Description == Detailed plugin description. == Installation == Installation instructions. ... (FAQs, Screenshots, Changelog, Upgrade Notice)
Activation and Deactivation Files (inc/activation.php, inc/deactivation.php):
These files contain code executed upon plugin activation and deactivation, respectively. Use register_activation_hook()
and register_deactivation_hook()
in plugin-name.php
:
load_plugin_textdomain("plugin-name", false, basename(dirname(__FILE__)), "/languages");
uninstall.php:
This file runs when the plugin is deleted. Include a check to prevent manual execution:
register_activation_hook(__FILE__, 'plugin_activated'); register_deactivation_hook(__FILE__, 'plugin_deactivated');
Admin and Public Directories:
admin/admin.php
contains admin-specific functionality, while public/public.php
houses public-facing features.
Publishing Your Plugin:
Your plugin becomes an SVN repository on WordPress.org. After approval, use SVN to manage changes and releases.
Further Resources:
Consult the WordPress.org Plugin Directory FAQ, use a README.txt
validator, and consider using a README.txt
generator.
This detailed guide provides a solid foundation for developing and submitting your WordPress plugin to the WordPress.org directory. Remember to always adhere to their guidelines and best practices.
The above is the detailed content of Developing for the WordPress.org Plugin Directory. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

Hot Topics

To roll back the WordPress version, you can use the plug-in or manually replace the core file and disable automatic updates. 1. Use WPDowngrade and other plug-ins to enter the target version number to automatically download and replace; 2. Manually download the old version of WordPress and replace wp-includes, wp-admin and other files through FTP, but retain wp-config.php and wp-content; 3. Add code in wp-config.php or use filters to disable core automatic updates to prevent further upgrades. Be sure to back up the website and database before operation to ensure safety and reliability. It is recommended to keep the latest version for security and functional support in the long term.

The steps to create a custom shortcode in WordPress are as follows: 1. Write a PHP function through functions.php file or custom plug-in; 2. Use add_shortcode() to bind the function to the shortcode tag; 3. Process parameters in the function and return the output content. For example, when creating button shortcodes, you can define color and link parameters for flexible configuration. When using it, you can insert a tag like [buttoncolor="red"url="https://example.com"] in the editor, and you can use do_shortcode() to model it

The main reasons why WordPress causes the surge in server CPU usage include plug-in problems, inefficient database query, poor quality of theme code, or surge in traffic. 1. First, confirm whether it is a high load caused by WordPress through top, htop or control panel tools; 2. Enter troubleshooting mode to gradually enable plug-ins to troubleshoot performance bottlenecks, use QueryMonitor to analyze the plug-in execution and delete or replace inefficient plug-ins; 3. Install cache plug-ins, clean up redundant data, analyze slow query logs to optimize the database; 4. Check whether the topic has problems such as overloading content, complex queries, or lack of caching mechanisms. It is recommended to use standard topic tests to compare and optimize the code logic. Follow the above steps to check and solve the location and solve the problem one by one.

Methods to optimize WordPress sites that do not rely on plug-ins include: 1. Use lightweight themes, such as Astra or GeneratePress, to avoid pile-up themes; 2. Manually compress and merge CSS and JS files to reduce HTTP requests; 3. Optimize images before uploading, use WebP format and control file size; 4. Configure.htaccess to enable browser cache, and connect to CDN to improve static resource loading speed; 5. Limit article revisions and regularly clean database redundant data.

Miniving JavaScript files can improve WordPress website loading speed by removing blanks, comments, and useless code. 1. Use cache plug-ins that support merge compression, such as W3TotalCache, enable and select compression mode in the "Minify" option; 2. Use a dedicated compression plug-in such as FastVelocityMinify to provide more granular control; 3. Manually compress JS files and upload them through FTP, suitable for users familiar with development tools. Note that some themes or plug-in scripts may conflict with the compression function, and you need to thoroughly test the website functions after activation.

TransientsAPI is a built-in tool in WordPress for temporarily storing automatic expiration data. Its core functions are set_transient, get_transient and delete_transient. Compared with OptionsAPI, transients supports setting time of survival (TTL), which is suitable for scenarios such as cache API request results and complex computing data. When using it, you need to pay attention to the uniqueness of key naming and namespace, cache "lazy deletion" mechanism, and the issue that may not last in the object cache environment. Typical application scenarios include reducing external request frequency, controlling code execution rhythm, and improving page loading performance.

Object cache assists persistent storage, suitable for high access and low updates, tolerating short-term lost data. 1. Data suitable for "persistence" in cache includes user configuration, popular product information, etc., which can be restored from the database but can be accelerated by using cache. 2. Select a cache backend that supports persistence such as Redis, enable RDB or AOF mode, and configure a reasonable expiration policy, but it cannot replace the main database. 3. Set long TTL or never expired keys, adopt clear key name structure such as user:1001:profile, and update the cache synchronously when modifying data. 4. It can combine local and distributed caches to store small data locally and big data Redis to store big data and use it for recovery after restart, while paying attention to consistency and resource usage issues.

When developing Gutenberg blocks, the correct method of enqueue assets includes: 1. Use register_block_type to specify the paths of editor_script, editor_style and style; 2. Register resources through wp_register_script and wp_register_style in functions.php or plug-in, and set the correct dependencies and versions; 3. Configure the build tool to output the appropriate module format and ensure that the path is consistent; 4. Control the loading logic of the front-end style through add_theme_support or enqueue_block_assets to ensure that the loading logic of the front-end style is ensured.
