WordPress / WordPress/WordPress-Coding-Standards
What are the standards for writing interfaces and traits?
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 2.8k
- Forks
- 521
- Avg merge
- 5d 20h
- Merged PRs (30d)
- 1
Description
In the coding standards only the naming of the classes is covered here. So a class called Example_Class has to reside in a class-example-class.php file.
What should we use for interfaces and traits?
SomeInterface like in PSR-2 or Some_Interface or ISomeInterface with I as a prefix?
And what for traits? Also should the files that hold them have interface- or trait- prefix?
This could be a bit out of scope since WP is clinging to php 5.2, but just because core isn't implementing them, doesn't mean that the developers shouldn't, so it would be great to have some sort of unified guideline how to implement them.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the linked PHP coding-standards naming-conventions section and compare its class and file naming rule with the interface and trait cases described here. Review the existing issue discussion for any consensus, then document agreed naming and file-prefix guidance in the relevant coding standards; done means contributors have a clear, unified rule.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100