---
title: "Code Quality: How to setup phpcs in PHPStorm"
description: "A step-by-step guide to configuring PHP_CodeSniffer (phpcs) in PHPStorm, both when cloning a new project and when fixing an existing project that isn't yet reporting code quality issues."
author: "Alex Karajos"
date_published: "2024-01-05"
canonical_url: "https://www.dotkernel.com/phpstorm/code-quality-how-to-setup-phpcs-in-phpstorm/"
category: "PHPStorm"
language: "en"
---

# Code Quality: How to setup phpcs in PHPStorm

## TL;DR

PHP_CodeSniffer (phpcs) needs to be configured correctly in PHPStorm under PHP > Quality Tools > PHP_CodeSniffer, with the Custom coding standard pointed at your project's phpcs.xml file.
This article gives separate setup steps for a freshly cloned project versus an existing one that isn't reporting issues yet, and explains how to read the resulting inline error and warning indicators in the editor.

PHP_CodeSniffer or phpcs is a tool that helps developers maintain a specific standard in the way they write code.
In order to be able to provide relevant information, phpcs needs to be configured correctly in PHPStorm (see image).

![](/uploads/article/019f8a80-cc90-7160-853d-18cb7411b9ff/image.png)

Whether you just cloned or you are already working on a project, follow the below guide on how to prepare your environment.

## When Cloning a Project

1. Windows Terminal: Move to the directory where you want to clone the project.
2. Windows Terminal: Clone the project.
3. PHPStorm: install composer dependencies.
4. PHPStorm: restart.
5. PHPStorm: Open Settings (File -> Settings) and go to PHP -> Quality Tools -> PHP_CodeSniffer:
    - Make sure that the inspection button is ON.
    - Coding standard is set to Custom and the field next to it contains the path to your project's phpcs.xml file.

## For an Existing Project

1. PHPStorm: Open Settings (File -> Settings) and go to PHP -> Quality Tools -> PHP_CodeSniffer.
There, if Coding standard is set to Custom and the field next to it contains the path to your project's phpcs.xml file, then PHPStorm is configured correctly to use phpcs - NO need to continue with the next steps.
2. PHPStorm: delete (if exists) the vendor directory.
3. PHPStorm: install composer dependencies.
4. PHPStorm: restart.
5. Go to Step 1.

After you have the above configurations, you should start seeing information in the top-right corner of the editor.

![](/uploads/article/019f8a80-cc90-7160-853d-18cb7411b9ff/image-1-1024x83.png)

Once PHPStorm has finished analyzing the opened file, you should see either a green tick (meaning no errors)

![](/uploads/article/019f8a80-cc90-7160-853d-18cb7411b9ff/image-2-1024x66.png)

or a count of all the errors, warnings, and typos.

![](/uploads/article/019f8a80-cc90-7160-853d-18cb7411b9ff/image-3.png)

Clicking on them will open a section where you get detailed information on each item, their location, and recommendations on how to fix them.

![](/uploads/article/019f8a80-cc90-7160-853d-18cb7411b9ff/image-5.png)

## FAQ

**Q: What is phpcs and why do you need to configure it in PHPStorm?**
A: PHP_CodeSniffer (phpcs) is a tool that helps developers maintain a specific standard in the way they write code. In order for it to provide relevant information, it needs to be configured correctly in PHPStorm.

**Q: What are the steps to set up phpcs in PHPStorm when cloning a new project?**
A: Move to the directory where you want to clone the project, clone the project, install composer dependencies in PHPStorm, restart PHPStorm, then open Settings (File -> Settings) and go to PHP -> Quality Tools -> PHP_CodeSniffer, making sure the inspection button is ON and the Coding standard is set to Custom with the field pointing to your project's phpcs.xml file.

**Q: How do you check whether phpcs is already configured correctly for an existing project?**
A: Open Settings (File -> Settings) and go to PHP -> Quality Tools -> PHP_CodeSniffer. If Coding standard is already set to Custom and the field points to your project's phpcs.xml file, PHPStorm is configured correctly and there's no need to continue with the next steps.

**Q: What should you do if phpcs is not configured correctly on an existing project?**
A: Delete the vendor directory if it exists, install composer dependencies, restart PHPStorm, and then go back and repeat the check from Step 1 of the existing-project process.

**Q: How do you know phpcs is working once configured?**
A: After the above configuration, you should start seeing information in the top-right corner of the editor: a green tick means no errors, while a count indicates errors, warnings, or typos. Clicking on them opens a section with detailed information on each item, its location, and recommendations on how to fix it.