Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Plugin Best Practices section on Avoid Naming Collisions to include namespaces as an option #1679

Closed
jonathanbossenger opened this issue Aug 22, 2024 · 4 comments
Assignees
Labels
developer documentation (DevHub) Improvements or additions to developer documentation plugins Issues for Plugin Developer Handbook [Status] Done Issue is completed

Comments

@jonathanbossenger
Copy link

Issue Description

The Avoid Naming Collisions section of the Best Practices page in the Plugin developer handbook includes the options to use prefixes, and classes, but not namespaces, to avoid naming collisions.

We do have a section on using namespaces in our coding standards, so it makes sense to add this to our plugin developer handbook as well.

URL of the Page with the Issue

https://developer.wordpress.org/plugins/plugin-basics/best-practices/

Section of Page with the issue

The section Avoid Naming Collisions

Why is this a problem?

It doesn't include namespaces as a solution

Suggested Fix

Add a section on the use of namespaces as an option, after the prefix section. Include details on how to create good namespaces based on the WordPress coding standards

@jonathanbossenger jonathanbossenger added the [Status] To do Issue marked as Todo label Aug 22, 2024
@jonathanbossenger jonathanbossenger self-assigned this Aug 22, 2024
Copy link

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

@github-actions github-actions bot added [Status] In progress Issue is in progress and removed [Status] To do Issue marked as Todo labels Aug 22, 2024
@jonathanbossenger jonathanbossenger added plugins Issues for Plugin Developer Handbook [Status] To do Issue marked as Todo and removed [Status] In progress Issue is in progress labels Aug 22, 2024
Copy link

Heads up @theMikeD - the "plugins" label was applied to this issue.

@github-actions github-actions bot added the developer documentation (DevHub) Improvements or additions to developer documentation label Aug 22, 2024
@jonathanbossenger
Copy link
Author

I am also offering to add the content for this section, and I will share a draft here for review in the next few days.

@jonathanbossenger
Copy link
Author

Closing in favour of WordPress/developer-plugins-handbook#44

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer documentation (DevHub) Improvements or additions to developer documentation plugins Issues for Plugin Developer Handbook [Status] Done Issue is completed
Projects
None yet
Development

No branches or pull requests

1 participant