31 Home

Patryk Chowratowicz edited this page 2023-12-29 13:08:47 +01:00

Welcome to the WordPress-Coding-Standards wiki!

Here you can learn things like how to:

• Customize the behaviour of WordPressCS using custom properties in your ruleset
• Fix errors relating to sanitizing input data, including:
  • Sanitizing array input data.
• Fix errors related to escaping, like how to:
  • Escape a WP_Error object.
• And if all else fails, you can ignore parts of a file.
• Set up your IDE to work with PHP_CodeSniffer & WordPressCS
  • Setting up WordPressCS to work in Atom
  • Setting up WordPressCS when using Eclipse with XAMPP
  • Setting up WordPressCS to work in Sublime Text
  • Setting up WordPressCS to work in PHPStorm (external link)
  • Setting up WordPressCS to work in Visual Studio Code (external link)
  • Setting up WordPressCS to work in Visual Studio Code with Remote-SSH (external link)
• Run in CI
  • Running in GitHub Actions
  • Running in Travis
• Upgrade guides
  • Upgrade Guide to WordPressCS 3.0.0 for ruleset maintainers and end-users
  • Upgrade Guide to WordPressCS 3.0.0 for Developers of external standards
  • Upgrade Guide to WordPressCS 2.0.0 for Developers of external standards
• Learn about the project's history

IDE configuration

• Atom
• Eclipse with XAMPP
• Sublime Text

Fixing violations

• Fixing errors for input data
• Sanitizing array input data
• Escaping a WP_Error object

Ignoring violations

• Ignoring parts of a file

Running in CI

• Running in GitHub Actions
• Running in Travis

For ruleset maintainers

• Customizable sniff properties
• Upgrading to WordPressCS 3.0.0

For developers

• Upgrading to WordPressCS 2.0.0
• Upgrading to WordPressCS 3.0.0

Project History

• Project Timeline