Skip to content
Blank template showing the structure expected for plugins that use the extension framework
PHP
Branch: master
Clone or download

Latest commit

mitogh Merge pull request #17 from mt-support/fix/text-domains
Don't use Constants for Text Domains
Latest commit 5c3c2e7 Mar 24, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
languages rename .pot file for new plugin name Oct 19, 2018
src Don't use Constants for Text Domains Mar 21, 2020
README.md Unique namespace with simplified class name Nov 5, 2018
license.txt Change to GPLv3+ Jan 24, 2018
readme.txt wording and version tweaks Feb 27, 2020
tribe-ext-extension-template.php lets remove all constants then, since no IDE support Mar 24, 2020

README.md

What and Why?

This is the Modern Tribe Extension Template. It allows you to easily extend our plugins: The Events Calendar, Event Tickets, and their associated add-on plugins.

The primary benefits of using this template is that it's gets you up-and-running quicker than building a custom plugin yourself, and it's best to extend one plugin via another plugin instead of adding custom code to your child theme's functions.php file.

We ensure your new extension does not run if its required base plugin is not activated, which helps avoid fatal errors and means fewer class_exists() checks are applicable.

Extensions have been available since The Events Calendar version 4.3.3 (November 16, 2016). If you try to use this template to work with versions before this date, your extension will not run at all.

How?

If you want to suggest an edit to this template, submit a pull request to this repo.

If you want to make your own new extension:

  1. Create your own new repository, prefixing its name with the required tribe-ext- prefix (or else your extension will not run at all, even if activated).
  2. Download the master branch of this template as a .zip and unzip it.
  3. Because you cannot make a new branch until you have an initial commit to your own new repo's master branch, copy this template's license.txt file and commit it to your repo's master branch.
  4. Create a new branch called initial or v1 or whatever is appropriate and check out this branch.
  5. Place the remainder of this template's files in your repo's new branch.
  6. Find and replace these strings throughout all file names and file contents:
    1. Extension plugin's slug: tribe-ext-extension-template
    2. [Base Plugin Name] Extension: [Extension Name]:
      1. [Base Plugin Name] should be something like The Events Calendar
      2. [Extension Name] should be the name of your extension, such as Remove Export Links
    3. [Extension Description] with your extension plugin's short description.
    4. PHP namespace: Tribe\Extensions\Example (must be unique among all extensions)
  7. Set Plugin URI accordingly.
  8. Set GitHub Plugin URI accordingly.
  9. Set Author: and Author URI: accordingly if not being authored by Modern Tribe.
  10. Set the == Description == section of readme.txt
  11. Add your required plugin(s) via $this->add_required_plugin().
    1. You should have at least one required plugin and/or conditionally-required plugin(s), making use of Tribe__Dependency.
    2. If you're requiring a specific version, add a small code comment why this version is required. You should probably also mention this in readme.txt.
  12. Remove the starter bits that don't apply to your extension, such as required PHP version comments.
    1. Look for TODO comments to identify some things to modify or remove, as applicable. For example, remove the entire src directory and the Tribe__Autoloader code if you do not have any settings to add to the admin UI and do not need the autoloader for any other purpose.
    2. It might be advisable to leave the PHP version checking logic (and matching part of readme.txt) unmodified until one of your last commits to ensure you correctly determine the required version.
  13. Add your filters and actions in the init() method, creating your custom methods as needed.
  14. Remove all unused/unnecessary code and comments, as this template may handle edge cases that do not apply to your extension.
  15. Sanitize all input and escape all output, as appropriate.
  16. Double-check your plugin's slug, name, and descriptions still apply to the end result of what your code actually accomplishes.
  17. Set the == Changelog == section of readme.txt.
  18. Delete this README.md file.
  19. Zip and release your plugin!
You can’t perform that action at this time.