Skip to content

Instantly share code, notes, and snippets.

@manutheblacker

manutheblacker/phpcs.md

Forked from PatelUtkarsh/phpcs.md
Created September 16, 2022 03:02
Show Gist options
  • Save manutheblacker/1e9466da40f3ad3d339628e0a3a4d219 to your computer and use it in GitHub Desktop.
Save manutheblacker/1e9466da40f3ad3d339628e0a3a4d219 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @PatelUtkarsh PatelUtkarsh created this gist Apr 29, 2016.
    45 changes: 45 additions & 0 deletions phpcs.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,45 @@
    ## Installation

    ### Install `PEAR`

    ```
    sudo apt-get install php-pear
    ```

    ### Install PHP_CodeSniffer

    ```
    pear install PHP_CodeSniffer
    ```

    ## Setup WordPress Coding Standards

    ```
    cd $(pear config-get php_dir)/PHP/CodeSniffer/Standards
    ```

    ```
    git clone git://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git
    ```

    To setup WordPress Coding Standards
    ```
    ln -s WordPress-Coding-Standards/WordPress WordPress
    ln -s WordPress-Coding-Standards/WordPress-Core WordPress-Core
    ln -s WordPress-Coding-Standards/WordPress-VIP WordPress-VIP
    ln -s WordPress-Coding-Standards/WordPress-Extra WordPress-Extra
    ```

    There are other standards as well such as WordPress-Core, WordPress-VIP & WordPress-Extra.

    The WordPress standard encompasses a superset of the sniffs that the WordPress community may need. It includes sniffs for Core standards, but then it also includes sniffs for the WordPress VIP coding requirements, as well as some best practice Extras. If you just use the WordPress standard, you'll get everything. But if you're not working in the WordPress VIP environment, for example, this won't good for you. So there are additional standards included in this project, standards which include a subset of the sniffs in the WordPress standard. You can use all of the following as standard names when invoking phpcs:

    - **WordPress-Core:** Sniffs that seek to implement the Core coding standards and go no further.
    - **WordPress-VIP:** Core sniffs plus sniffs specifically implemented to check against the VIP coding requirements
    - **WordPress-Extra:** Core sniffs plus any extras that are best practices but could be controversial.


    Here is one liner
    ```
    sudo apt-get -y install php-pear && sudo pear install PHP_CodeSniffer && cd $(pear config-get php_dir)/PHP/CodeSniffer/Standards && sudo git clone git://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git && sudo ln -s WordPress-Coding-Standards/WordPress WordPress && sudo ln -s WordPress-Coding-Standards/WordPress-Core WordPress-Core && sudo ln -s WordPress-Coding-Standards/WordPress-VIP WordPress-VIP && sudo ln -s WordPress-Coding-Standards/WordPress-Extra WordPress-Extra
    ```