Emacs PHP Mode

A powerful and flexible Emacs major mode for editing PHP scripts

English   |   日本語

Please submit any bug reports or feature requests by creating issues on the GitHub page for PHP Mode.

Note

The latest version of PHP Mode supports Emacs 30.
Please feel free to open a discussion if you have any issues upgrading to Emacs 30.

Warning

After upgrading Emacs, when you open a PHP file for the first time, you may encounter errors related to CC Mode. These errors occur because a previously byte-compiled version of PHP Mode, cached on your disk, differs from the newly installed one. Reinstalling PHP Mode should resolve the issue.

Try running M-x php-mode-debug-reinstall or M-x package-reinstall php-mode.

Installation

PHP Mode works with Emacs 27.1 or later. For details on supported versions, see Supported Version. On Emacs 28 or later, you can install it simply by running:

M-x package-install php-mode

By adding MELPA to package-archives, you can extend Emacs with numerous packages from the web.

If you prefer not to rely on a package manager, you can install the Lisp files directly in the traditional manner. See Manual installation for our recommended method.

Configuration

Personal Settings

You can add configurations for PHP Mode in your .emacs file (~/.emacs.d/init.el):

(defun my-php-mode-init ()
  (subword-mode 1)
  (setq-local show-trailing-whitespace t)
  (setq-local ac-disable-faces '(font-lock-comment-face font-lock-string-face))
  (add-hook 'hack-local-variables-hook 'php-ide-turn-on nil t))

(with-eval-after-load 'php-mode
  (add-hook 'php-mode-hook #'my-php-mode-init)
  (custom-set-variables
   '(php-mode-coding-style 'psr2)
   '(php-mode-template-compatibility nil)
   '(php-imenu-generic-expression 'php-imenu-generic-expression-simple))

  ;; If you find phpcs to be bothersome, you can disable it.
  (when (require 'flycheck nil)
    (add-to-list 'flycheck-disabled-checkers 'php-phpmd)
    (add-to-list 'flycheck-disabled-checkers 'php-phpcs)))

Project Setting

You can add project-specific settings by creating a .dir-locals.el or .dir-locals-2.el file in the project's root directory. It is recommended not to put these files under version control, as they depend on the packages installed on each user's Emacs.

((nil
  (php-project-root . git)
  (php-project-coding-style . psr2)))

Reporting Bugs

When reporting a bug, please run M-x php-mode-debug and include its output in your bug report. This helps us reproduce any issues you may be experiencing.

How to Contribute

Please see CONTRIBUTING.md.

Copyright

PHP Mode is licensed under GNU General Public License Version 3 (GPLv3).

This project originated in php-mode.el written by Turadg Aleahmad in 1999. In 2013 Daniel Hackney began rewriting parts of PHP Mode in terms of Emacs' built-in CC Mode. Other contributors are listed in Authors and Contributors.

This project was maintained by Eric James Michael Ritz until 2017. Currently, the Friends of Emacs-PHP Development community inherits PHP Mode.

Copyright (C) 2022  Friends of Emacs-PHP development
Copyright (C) 1999, 2000, 2001, 2003, 2004 Turadg Aleahmad
              2008 Aaron S. Hawley
              2011, 2012, 2013, 2014, 2015, 2016, 2017 Eric James Michael Ritz

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.