本文说明 WordPress 项目中 HTML 的编码规范,涵盖验证、自闭合标签、标签与属性大小写、引号使用和缩进等要求。目标是保证标记结构良好、可维护,并降低安全风险,尤其在与 PHP 混写时保持清晰的逻辑缩进。
<br />,而不是 <br/>。disabled="true"。<br />
<input type="text" name="email" disabled />
<?php if ( ! have_posts() ) : ?>
<div id="post-1" class="post">
<h1 class="entry-title">Not Found</h1>
<div class="entry-content">
<p>Apologies, but no results were found.</p>
<?php get_search_form(); ?>
</div>
</div>
<?php endif; ?>All HTML pages should be verified against the W3C validator to ensure that the markup is well formed. This in and of itself is not directly indicative of good code, but it helps to weed out problems that are able to be tested via automation. It is no substitute for manual code review. (For other validators, see HTML Validation in the Codex.)
All tags must be properly closed. For tags that can wrap nodes such as text or other elements, termination is a trivial enough task. For tags that are self-closing, the forward slash should have exactly one space preceding it:
<br />
rather than the compact but incorrect:
<br/>
The W3C specifies that a single space should precede the self-closing slash (source).
All tags and attributes must be written in lowercase. Additionally, attribute values should be lowercase when the purpose of the text therein is only to be interpreted by machines. For instances in which the data needs to be human readable, proper title capitalization should be followed.
For machines:
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
For humans:
<a href="http://example.com/" title="Description Here">Example.com</a>
According to the W3C specifications for XHTML, all attributes must have a value, and must use double- or single-quotes (source). The following are examples of proper and improper usage of quotes and attribute/value pairs.
Correct:
<input type="text" name="email" disabled="disabled" />
<input type='text' name='email' disabled='disabled' />
Incorrect:
<input type=text name=email disabled>
In HTML, attributes do not all have to have values, and attribute values do not always have to be quoted. While all of the examples above are valid HTML, failing to quote attributes can lead to security vulnerabilities. Always quote attributes. Omitting the value on boolean attributes is allowed. The values true and false are not valid on boolean attributes (HTML5 source).
Correct:
<input type="text" name="email" disabled />
Incorrect:
<input type="text" name="email" disabled="true" />
As with PHP, HTML indentation should always reflect logical structure. Use tabs and not spaces.
When mixing PHP and HTML together, indent PHP blocks to match the surrounding HTML code. Closing PHP blocks should match the same indentation level as the opening block.
Correct:
<?php if ( ! have_posts() ) : ?>
<div id="post-1" class="post">
<h1 class="entry-title">Not Found</h1>
<div class="entry-content">
<p>Apologies, but no results were found.</p>
<?php get_search_form(); ?>
</div>
</div>
<?php endif; ?>
Incorrect:
<?php if ( ! have_posts() ) : ?>
<div id="post-0" class="post error404 not-found">
<h1 class="entry-title">Not Found</h1>
<div class="entry-content">
<p>Apologies, but no results were found.</p>
<?php get_search_form(); ?>
</div>
</div>
<?php endif; ?>