Correct indentation of HTML and PHP using Vim

Question

I've been using Vim for a while, and I can't get proper HTML indentation working in PHP files.

For example, what I want is for each child to be indented one tab more than it's parent, as shown below.

<?php
if(isset($sports)) {
    //Do something
?>
<div>
    <label>Uniform Size</label>
    <ul>
        <li class="left"><label for="s" class="small">S</label><input type="radio" name="size[]" value="S" id="s" class="radio" /></li>
        <li class="left"><label for="m" class="small">M</label><input type="radio" name="size[]" value="M" id="m" class="radio" /></li>
        <li class="left"><label for="l" class="small">L</label><input type="radio" name="size[]" value="L" id="l" class="radio" /></li>
        <li class="left"><label for="xl" class="small">XL</label><input type="radio" name="size[]" value="XL" id="xl" class="radio" /></li>
    </ul>
</div>
<?php
}
?>

Using the PHP-correct-Indent script, the code results in being formatted as follows:

<?php
if(isset($sports)) {
    //Do something
?>
<div>
<label>Uniform Size</label>
<ul>
<li class="left"><label for="s" class="small">S</label><input type="radio" name="size[]" value="S" id="s" class="radio" /></li>
<li class="left"><label for="m" class="small">M</label><input type="radio" name="size[]" value="M" id="m" class="radio" /></li>
<li class="left"><label for="l" class="small">L</label><input type="radio" name="size[]" value="L" id="l" class="radio" /></li>
<li class="left"><label for="xl" class="small">XL</label><input type="radio" name="size[]" value="XL" id="xl" class="radio" /></li>
</ul>
</div>
<?php
}
?>

Even with indented HTML which I then add PHP code to, the indentation is ignored, moving new lines of HTML code without any indentation at all.

So, is there any way that I can get the indentation format that I want working with HTML within PHP files, using Vim?

steve · Accepted Answer · 2010-11-03 07:49:30Z

67

This still bothers me. I only just decided that the best work-around (for me personally) is this:

:set filetype=html

And then highlight your text and hit =. BOOM! HTML formatting succes. (Not ideal, I know, but at least it works.)

answered Nov 3, 2010 at 7:49

steve

3,35631 silver badges29 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

LVB Over a year ago

Thanks for this. After a point I find it easier to do this sort of thing than to fight automatic workarounds.

Sasha Over a year ago

After more than a year of using Vim I've changed my perspective. Toggling between :set ft=php and :set ft=html is a better solution to the problem.

Joe Mills Over a year ago

To get better php support you might try :set ft=phtml

steve Over a year ago

@JoeMills that sounds good I'll try that the next time I'm cursed with writing php. ;)

Jonathan Cutrell Over a year ago

To make this a little less painful, add this to your vimrc: map <leader>h :set ft=html<CR> and map <leader>p :set ft=php<CR>

|

cmc · Accepted Answer · 2015-08-19 12:17:07Z

27

There is a set of vimrc instructions on the Vim Wiki called Better indent support for PHP with HTML that will use the correct plugin depending on the block.

There is also a Vundle/Pathogen Plugin that uses the same code but is easier to install and keeps your .vimrc clean.

Pathogen

cd ~/.vim/bundle
git clone https://github.com/captbaritone/better-indent-support-for-php-with-html.git

Vundle

Place in .vimrc

Bundle 'captbaritone/better-indent-support-for-php-with-html'

Run in vim

:BundleInstall

edited Aug 19, 2015 at 12:17

cmc

4,4232 gold badges39 silver badges37 bronze badges

answered Jan 20, 2009 at 18:44

Brian Carper

73.4k28 gold badges171 silver badges169 bronze badges

6 Comments

Nathan Long Over a year ago

This also works under Cygwin - the file should be located at ~/.vim/indent/php.vim. If you paste from that page into Cygwin, double-check that the pasted code wasn't screwed up (wrong line breaks and extraneous quotation marks) in the process.

Sasha Over a year ago

Thanks Brian. That seems to be working almost exactly as I want it to. Thank you Naum and bobince as well for your answers.

Eligio Becerra Over a year ago

I followed the tip, but it's not working for me. Do I have to explicit call the function or it's supposed to work out of the box? if I have to call it, what parameter should I pass?

James Over a year ago

If you're using pathogen throw this file in your autoload/php/indent folder with the name php.vim and it should work fine. If on MacVim, either reload or restart MacVim.

Jordan Eldredge Over a year ago

This worked perfectly for me. I wrapped it in a Vundle compatible plugin to make it easier to include: github.com/captbaritone/better-indent-support-for-php-with-html

|

alessioalex · Accepted Answer · 2011-05-13 20:31:13Z

19

After looking really really hard into all solutions, I found out this plugin:

http://www.vim.org/scripts/script.php?script_id=604

It seems to have solved my problems!!!!!

answered May 13, 2011 at 20:31

alessioalex

63.8k16 gold badges158 silver badges123 bronze badges

4 Comments

puk Over a year ago

Instructions are lacking, put this in the ~/.vim/indents folder

mblackwell8 Over a year ago

this screwed up indentation in my php code files... somehow set the tabstop to 3 spaces. Not worth it, IMHO

Nithin Philips Over a year ago

@mblackwell8 You can edit the php.vim file, line 27, to control indent spacing. You can set it to the number of spaces you prefer or if rather have tabs, just delete the line.

Nicklasos Over a year ago

This is new php 5.4 syntax, try it vim.org/scripts/script.php?script_id=4159

gitaarik · Accepted Answer · 2017-10-10 11:42:58Z

14

For me it works good if I first do :set ft=html and then :set syn=php.

edited Oct 10, 2017 at 11:42

answered Nov 19, 2014 at 12:45

gitaarik

47k12 gold badges101 silver badges109 bronze badges

3 Comments

Diego Somar Over a year ago

I'm using this solution. The only inconvenient is that language support (coc-phpls) stops working.

Zac Over a year ago

This should really be the correct answer. No plugins or scripts, just vanilla vim settings.

Burrito Over a year ago

Nice! ft=html fixes indenting but messes up the php syntax highlighting, and syn=php fixes it back.

shin · Accepted Answer · 2014-01-07 13:05:31Z

6

In php+html I found the following is good for me.

:set ft=html # Change the file type to html
=G # to indent all lines 
:set ft=phtml # Change the file type to phtml
=G # to indent all php lines

answered Jan 7, 2014 at 13:05

shin

32.9k73 gold badges196 silver badges272 bronze badges

2 Comments

van abel Over a year ago

that's really help me a lot. Why this shouldn't be the answer then?

Navidot Over a year ago

It indent only current line and all lines bellow to the end of the file.

bobince · Accepted Answer · 2009-01-20 01:51:56Z

php-correct-indenting only cares about your PHP, and assumes the readability of the HTML is of no interest. An XML indenter would position the tags nicely, but wouldn't be able to indent the contents of a <?php> processing instruction to match. Maybe there is an indentation script that understands both the C-like syntax of PHP the programming language and [X][HT]ML the markup language being templated, but I've never met one yet - sorry.

Still, I'd like to fiddle with the indenting in your example even before php-correct-indenting mauled it! The <div> element is inside an outer if-statement, but I have no way to see that from the indenting. I'd suggest something like:

<?php if(isset($sports)) { ?>
    <?php
        // Do something
    ?>
    <div>
        <label>Uniform Size</label>
        <ul>
            <li>etc. etc.</li>
        </ul>
    </div>
<?php } ?>

xinquan · Accepted Answer · 2011-09-21 03:10:05Z

1

i found this solution is much better. http://www.vim.org/scripts/script.php?script_id=1120

supporting HEREDOC html style. which occur frequently in my code.
BTW:it's has more versions than the old one (script id 604, alex posted it above)

answered Sep 21, 2011 at 3:10

xinquan

112 bronze badges

Comments

Ricardo Schalch · Accepted Answer · 2016-03-28 16:05:26Z

1

inside your .vimrc:

:function IndentPHPHTML()
:  set ft=html
:  normal gg=G
:  set ft=php
:endfunction

use ctrl-shift-L (or whatever) to indent

nnoremap <C-S-l> :call IndentPHPHTML()<cr>

answered Mar 28, 2016 at 16:05

Ricardo Schalch

1573 silver badges9 bronze badges

Comments

kapil · Accepted Answer · 2016-12-30 02:47:51Z

0

After searching for days for the solution ,nothing worked and finally this worked,add this to your vimrc

au BufEnter,BufNew *.php :set filetype=html

answered Dec 30, 2016 at 2:47

kapil

62412 silver badges21 bronze badges

1 Comment

Fuseteam Over a year ago

this will ruin the syntax highlighting and indenthing for php

Collectives™ on Stack Overflow

Correct indentation of HTML and PHP using Vim

9 Answers 9

6 Comments

6 Comments

4 Comments

3 Comments

2 Comments

Comments

Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

9 Answers 9

6 Comments

6 Comments

4 Comments

3 Comments

2 Comments

Comments

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related