Plugin developer prefixes
All plugin developers must have a prefix to name their plugins and use in plugin development.
A prefix is a three-character (alphanumeric) indication of who the plugin developer is, and precedes a plugin name with an underscore. For example, wet_haystack is one of several plugins by Robert Wetzlmayr. The prefix in this case is ‘wet’, which precedes the specific plugin name (‘haystack’) with an underscore. All together it forms the unique and complete name of the plugin. An underscore is used for each additional word in a compound name, for example smd_user_manager. Plugin names are entirely lowercase.
On this page:
- Guidelines for choosing and using a prefix
- How to register a prefix
- Registered prefixes
- Where to use the prefix
Guidelines for choosing and using a prefix
There are some courtesies to keep in mind when registering a plugin prefix:
- You must have a Textpattern CMS support forum account, and you should provide the link to your forum profile when registering a prefix.
- You can only have one prefix.1
- Your prefix should be three alphanumeric characters. No less and no more. (Ignore any you see that defy this convention.)
- Register a prefix when you have a plugin ready for publication. Or to put it another way, don’t register a prefix and sit on it indefinitely without ever creating a plugin. This is just squatting, and it’s not fair to someone else who might like that prefix and have their first plugin ready. Unused prefixes go to the person who first has a plugin to share.
- You cannot use a prefix already used by another developer, even if that developer is no longer active in the community.2
How to register a prefix
When you’re ready to register a prefix, create an ‘issue’ in the Textpattern user documentation repo on GitHub and an editor will add it to the plugin developer prefix list.
Prefix owners, if you’re username is not linked with your forum profile and you would like it to be, create an issue as described indicating your forum profile link and it will be added.
The prefixes in the following table are registered, but see the guidelines above.
Prefixes are noted in relation to their owners (prefix/username). Owners are identified by their Textpattern CMS support forum usernames. Usernames link to forum profiles, not personal websites (which should be indicated in the profiles anyway).
- Red prefixes are off limits until further notice (notably “foo”).
- Yellow prefixes are used internally by Textpattern and are off limits.
- Green prefixes mean the developer has left the community and no plugins remain with that prefix anymore. These prefixes can be claimed by a new developer.
- (?) next to a username means no forum profile is found and the status of the prefix is questionable. If an external link is known, it will be on the ‘?’. These prefixes could certainly be challenged for new ownership (see guidelines above).
- (!) next to a username means the indicated developer has adopted all the original developer’s plugins, which were abandoned (orphaned).
- abc (for user docs only)
- act/angryCat (?)
- aud/Alex McKee (?)
- bnk/Duncan Clarke
- ied/Bloke (!)
- jrh/Jan H (?)
None at this time.
- sir/fabio sirna
- vg/Vincent Grouls (?)
Where to use the prefix
In addition to plugin names, you’ll apply your prefix in the following locations:
- The names of PHP classes, functions, and global variables in the plugin’s code.
- The database table and indices names.
- The names of stored preferences in the
_txp_prefs_table and/or the
- IDs, and to some extent, classes of HTML elements that you add to the backend interface.3
- URL parameter names. Replace
?abc_foo=bar&abc_baz=1, where “
abc” would be your own prefix.
Sometimes a plugin developer will assume the prefix of a retired plugin developer when the former ‘adopts’ the latter’s ‘orphaned’ plugins. This is the preferred practice against simply changing plugin names. For example, username ‘wet’ has his own plugins (wet/wet), as indicated in the prefix table at bottom, but he’s adopted the orphaned plugins with prefix ‘djw’ too (djw/wet). ↩
Prefix ownership may be challenged if it’s found that a developer has not created a plugin yet and is squatting on the prefix. In this case, you (the challenger) must produce the first plugin to earn ownership of the prefix in question. To challenge prefix ownership, bring the issue to light in the Plugin discussion forum, where others can help determine if the challenge is reasonable. ↩
The exception to this is if an element of your markup is logically similar to an already existing core element and you wish it to be styled in the same way by themes. Doing this saves theme designers from having to write specific rules to target your plugin’s markup. ↩