Schedule a Free Consultation
Install Php Code Sniffer on Windows & PHPStorm

Install Php Code Sniffer on Windows & PHPStorm

Read Article

If you are concerned about delivering high-quality code, compliant with WordPress coding standards, you’d better use an automated tool for these checks.

PHP Code Sniffer together with PHPStorm editor is a great and powerful combination as you get all these code checks in real time, as you type your code.

There are many great tutorials on how to install PHP Code Sniffer with PHPStorm on Mac, but we did not find any article explaining how to install and configure these tools on Windows.

So here’s a small contribution for those who need to check their code on Windows:

  • Using Composer
  • Using PEAR
    • Install PHP. Suggested are bundle: XAMPP OR WAMP
      1. Restart computer
      2. XAMPP ship with PEAR and PHP_CodeSniffer you can skip steps 2-
      3. To check if PHP_CodeSniffer is installer run this command in CMD: phpcs -i
    • Add System Environment variable: https://www.screencast.com/t/1zs1WY31l with link to PHP.exe from BIN folder
    • How to install PEAR(if needed)
      1. Download from: http://pear.php.net/go-pear.phar
      2. Copy PEAR to php location
      3. Open CMD to this location. Can be done two ways
        1. RUN -> write cmd -> CD into your php server folder
        2. Open Explorer -> go to PHP location -> SHIFT + RIGHT CLICK there and open SHELL
      4. RUN command php go-pear.phar
        1. Check folder settings to be OK
        2. Follow on screen details and complete installation
    • Install PHP_CodeSniffer
      1. Run command from cmd(see step 3-C-i and 3-C-ii) pear install PHP_CodeSniffer from PHP -> PEAR folder
      2. Download WORDPRESS STANDARDS from https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/archive/master.zip
      3. Unpack the archive folders: https://www.screencast.com/t/jgucqIDo to ~phpPEARphpCodeSniffersrcStandards where ~ means path to PHP
    • For Updates you need to download the WORDPRESS STANDARDS from the link above and copy them to CodeSniffer location.
  • PHPStorm settings – is suggested to work on “default settings” dialog (from File)

Reference:
https://github.com/squizlabs/PHP_CodeSniffer
https://w3guy.com/setup-php-code-sniffer-phpstorm-windows/
https://kellenmace.com/set-up-php-codesniffer-in-phpstorm-with-wordpress-coding-standards/

Navigate to

You Might Also Enjoy These Digital Marketing Articles:

Add html Comments Using Newly Created User Role
Add html Comments Using Newly Created User Role
I was recently working on a piece of code that will: create as special user role allow that user role to insert HTML comments on posts (specifically we needed images and links) from wp-admin If I was commenting like admin, all was good – the comment with image was getting published. But if instead I […]
Customizing Your WordPress Site: Tailoring Your Brand Identity
Building a distinctive brand identity is crucial for any business wanting to stand out these days. Consumers are becoming more discerning and educated, seeking brands with compatible values and the ability to deliver real value. Fortunately, customizing your WordPress website is one of the best ways to establish and reinforce your brand identity online.  We […]
How To Optimize Your WordPress Online Learning Platform for Real-Time Interaction
Online education has been around since the late 1900s, but it wasn’t until COVID-19 halted the world in 2020 that online learning was thrust into the spotlight. With physical classrooms out of commission across the globe, virtual classrooms became the norm overnight. This sudden shift revealed a major limitation of many online learning platforms—the lack […]