pressbooks / coding-standards
Installs: 21 085
Dependents: 13
Suggesters: 0
Security: 0
Stars: 2
Watchers: 9
Forks: 2
Open Issues: 5
Type:project
Requires
Requires (Dev)
- phpunit/phpunit: ^7.0
This package is auto-updated.
Last update: 2024-10-30 01:59:29 UTC
README
These are our coding standards. There are many like these, but these are ours.
Our standards are basically Human Made's coding standards with a few tweaks:
- Use camelCase for class methods & properties, UPPERCASE for class constants, snake_case everywhere else.
- PHP Sessions are allowed.
- A few more...
Tips
Pressbooks classes that extend WP Core classes will fail the PSR1.Methods.CamelCapsMethodName
rule. In those cases, add something like this in your phpcs.ruleset.xml file:
<rule ref="PSR1.Methods.CamelCapsMethodName" > <exclude-pattern>/inc/admin/class-catalog-list-table.php</exclude-pattern> <exclude-pattern>/inc/admin/class-network-managers-list-table.php</exclude-pattern> <exclude-pattern>/api/endpoints/controller/*</exclude-pattern> </rule>
Link to docs: https://docs.pressbooks.org/coding-standards/