Extension Keys

Please note: You need to be logged in in order to register or manage extension keys.

An extension key is a string which uniquely identifies your extension worldwide. Having a unique extension key ensures that you can name modules, plugins, PHP-classes, database tables and fields with a prefix that others do not use. It garantees global portability and compatibility. Registration is free and encouraged by the TYPO3 community for all extensions you make.

Good keys are those which reflect what the extension is about. Examples:

• A booking system called "Hotel Manager" for hotels. Example key: "hotelmgr"
• A skin for TYPO3 with aliens in the background image, named "Black is Back". Example key: "skinb2b"

Notice: Using "_" (underscores) in your keys is discouraged since it will make the namespace more complex for you to manage. If possible, please avoid underscores!

Bad keys are strings which convey no information. Examples:

• A message board named "Michaels Super Board". Example key: "mc_superboard"
• A plugin (poll system) in a series of plugins made by you or your company which is named "Direct People Technology". Example key: "dpt_pollsystem"
• "asdf" - the typical default "whatever"-string. If you want to test the Extension Repository, please use at least a key like "test_asdf"...
• "d_d_o" - is too much of an abbreviation to tells us anything.
• "my_super_module_for_typo3" - this begs the question how it can be anything near "super" when you couldn't come up with a good extension key...
• "i_always_use_underscores" - Is bad because it uses underscores (see notice above). For your own sake.
• "ilove_very_long_extensionskeys" - You will love long extension keys only until you see all your classnames, tables, fields etc. prefixed with it. Keep them SHORT!
• "iLoveUpperCASE" - Uppercase is NOT allowed.

Some of these "bad examples" are allowed but they don't communicate anything useful for the extension.

Guidelines for good keys:

1. It should make sense.
2. It should not have to be changed. When the extension key has been picked, it's not so easy to change it.
3. Avoid underscores if you can (stick to a-z0-9) - that will provide you with the least confusing naming of your modules, tables, classes.
4. Keep it short, less than 10 characters.
5. All in lowercase.
6. Although the primary purpose of the an extension key is to be unique rather than convey information, you might look up which keys others has registered for which kind of extensions - that might help you settle for a good key!
7. Want to test this? Just enter any string prefixed "test_"...

Anyways, all technical limitations are validated when you submit a string, so just go ahead now...

Terms of use:

By registering an extension key you accept that all content uploaded to TER (TYPO3 Extension Repository) matches these terms:

• Published under the GPL license or GPL compatible
• You hold the copyright of the code or do not infringe the rights of others (meaning that work from others must be under GPL or GPL compatible already!)

Any extensions found to break these terms will be removed without further notice by the webmaster team.

The webmasters of TYPO3.org refuse to accept any responsibility for the content of extensions found in the repository since that responsibility is on the owner of the associated extension key who is in control of the uploaded content.