Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,17 @@ We have chosen to document it here for the education of developers, as well as t

## Always Use Good Folder Names

Before we get into the code, we must stress the absolute best way to ensure your plugin won’t get overwritten by an update from WordPress.org is to use a good name. If you’re making a plugin for your company, give it a folder name like `companyname-function-plugin` — for example, if you work for FaceRange and you’re making a status plugin, you could name it `facerange-status-plugin`
A simple way to prevent your plugin from receiving updates from WordPress.org is to use a folder name that would not be allowed in the plugin directory.

Not only would we not accept it for using the prohibited term ‘plugin’, the plugin team would validate that the plugin owner **legally** represents FaceRange.
If the folder name of your plugin cannot exist on WordPress.org, it cannot collide with a plugin hosted in the directory.

The WordPress.org plugin directory does not allow plugin slugs containing the term `plugin`, so any folder name ending in `-plugin` cannot be registered there.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are specific cases in which plugin could be allowed, so I'd rephrase this as

In most cases, the WordPress.org plugin directory does not allow plugin slugs containing the term plugin


As part of the directory submission process, it is validated that the plugin owner has the right to represent the company name used.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd join this phrase with the previous one, the documentation tends to be written down using paragraphs composed of several sentences instead of small phrases.


If you’re making a plugin for your company, you can use a folder name like `companyname-function-plugin`. For example, if you work for FaceRange and you’re making a status plugin, you could name the folder `facerange-status-plugin`.

This approach affects only the plugin’s folder name and does not change the plugin name shown in the admin UI.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this clarification is needed. At this point a developer shall know that the name is taken from the plugin headers.


## Update URI

Expand Down