pressbooks/coding-standards

1.0.0 2018-12-14 16:09 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/