Add an initial guide to modifying the plugin template#19
Merged
michaelwood merged 2 commits intoMay 7, 2026
Conversation
snim2
reviewed
May 7, 2026
|
|
||
| To create a new plugin start by modify the following: | ||
|
|
||
| * `index.php` - Metadata for the plugin (name, version, etc) |
Contributor
There was a problem hiding this comment.
This should be renamed to plugin-name.php
snim2
reviewed
May 7, 2026
| * `composer.json` - Package Metadata and namespace (psr-4) | ||
| * `load.php` - Define the namespace | ||
|
|
||
| Note: As we're distributing the `vendor.phar` file it may be a good idea to add an [autoload-suffix](https://getcomposer.org/doc/06-config.md#autoloader-suffix)" to the `config` object in `composer.json` and then re-generate the lock file. This ensures that there are no other namespace clashes and a unique hash is generated from the composer.json. This is especially important if other plugins have been based off this template. No newline at end of file |
Add some initial guidance on which files to modify, and a note to help mitigate the namespace clash/hash issue. Fixes: #16
Expand the note about clashing namespace and give it its own section. Add an example of an autoloader-suffix
michaelwood
force-pushed
the
chore/update-readme-to-add-note-on-hash-collision
branch
from
7785f75 to
340b5b9
Compare
snim2
approved these changes
May 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add some initial guidance on which files to modify, and a note to help mitigate the namespace clash/hash issue.
Fixes: #16