WordPress Plugin Starter

This is an open-source project of WordPress, PHP, Bootstrap, and JavaScript.

Repository: github.com/martinrosbier/wordpresspluginstarter

The WordPress Plugin Starter is a powerful tool designed to simplify the process of creating custom WordPress plugins. With this project, you can generate a blank plugin file customized with your plugin's name, description, author information, and other essential details. This customizable plugin file serves as a starting point for developing unique WordPress plugins tailored to your specific needs.

This project is built upon the WordPress Plugin Boilerplate, providing a standardized, organized, and object-oriented foundation for developing high-quality WordPress plugins. It offers the flexibility to customize the boilerplate according to your needs, automatically renaming classes and files for seamless integration into your WordPress plugins folder.

Form

Please fill out the form below to generate a zip file with your WordPress plugin. Make sure to provide accurate and valid information for each field.

Instructions

Enter a name for your plugin.

Provide the URL of your plugin's website. Make sure it starts with "https://" and includes the full address.

Enter your name as the plugin author.

Provide the URL of your personal website or portfolio. Ensure it starts with "https://" and includes the complete address.

Write a brief description of your plugin's functionality. Please keep it concise and informative.

Enter a unique identifier for your plugin. The slug should be all lowercase, without spaces or symbols. You can use hyphens to separate words.

Enter your email address. Make sure it is in the correct format (e.g., name@example.com).

Once you have filled in all the fields, click the "Generate Zip File" button to generate your plugin's zip file.

Contents

  • plugin-name directory: Contains the source code - a fully executable WordPress plugin.

Features

  • The Boilerplate is based on the Plugin API, Coding Standards, and Documentation Standards.
  • All classes, functions, and variables are documented so that you know what you need to change.
  • The Boilerplate uses a strict file organization scheme that corresponds both to the WordPress Plugin Repository structure and makes it easy to organize the files that compose the plugin.
  • The project includes a .pot file as a starting point for internationalization.

Installation

The Boilerplate can be installed directly into your plugins folder "as-is". It's safe to activate the plugin at this point. Because the Boilerplate has no real functionality, there will be no menu items, meta boxes, or custom post types added until you write the code.

License

The WordPress Plugin Boilerplate is licensed under the GPL v2 or later.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

A copy of the license is included in the root of the plugin’s directory. The file is named LICENSE.

Includes

Note that if you include your own classes or third-party libraries, there are three locations in which said files may go:

  • plugin-name/includes: Functionality shared between the admin area and the public-facing parts of the site reside.
  • plugin-name/admin: All admin-specific functionality.
  • plugin-name/public: All public-facing functionality.

Note that previous versions of the Boilerplate did not include Plugin_Name_Loader, but this class is used to register all filters and actions with WordPress. The example code provided shows how to register your hooks with the Loader class.

Credits

The WordPress Plugin Starter was developed and is maintained by Martin Rosbier.

The WordPress Plugin Boilerplate was started in 2011 by Tom McFarlin and has since included a number of great contributions. In March of 2015, the project was handed over by Tom to Devin Vinson.

Contact Information

If you have any inquiries or would like to discuss a project, feel free to reach out to me.