php

PHP Standards

To match WordPress convention, we should adhere to the WordPress PHP Coding Standards.

No Shorthand PHP Tags: <?=$var ?> or <? function() ?>

Remove trailing whitespace at the end of each line of code.

Omitting the closing PHP tag at the end of a file is preferred. If you use the tag, make sure you remove trailing whitespace.

Put spaces on both sides of the opening and closing parenthesis of if, elseif, foreach, for, and switch blocks: if ( $conditional ) {

When referring to array items, only include a space around the index if it is a variable:

$x = $foo['bar']; // correct
$x = $foo[ 'bar' ]; // incorrect

Always use underscore (snake) notation:

$this_is_correct;
$thisIsIncorrect;

Files should be named descriptively using lowercase letters. Hyphens should separate words.

Else/elseif statements should be on the same line as the closing bracket:

if ( function_call( $parameter ) ) {
	// ...
} else {
	// ...
}

Logic statements outside templates use braces syntax:

if ( function_call( $parameter ) ) {
	// ...
}

Logic statements instead templates use colon syntax:

if ( function_call( $parameter ) ):
	// ...
endif;

Note that requiring the use of braces (or colons) just means that single-statement inline control structures are prohibited.

Nesting should follow html and php as follows. PHP will open on the same line as the next nested element should. each subsequent "child" should be nested in the same way. Note: Use single PHP blocks as much as possible to descrease some response time.

<ul>
	<?php
		foreach :
			if () :
	?>
				<li>Example</li>

				<?php if () :?>
					<li>Example</li>
				<?php endif; ?>
	<?php
			endif;
		endforeach;
	?>
</ul>

When doing logical comparisons, always put the variable on the right side, constants or literals on the left (yoda conditions):

if ( true == $the_force ) {
	$victorious = you_will( $be );
}

For associative arrays, values should start on a new line. Note the comma after the last array item: this is recommended because it makes it easier to change the order of the array, and makes for cleaner diffs when new items are added.

$my_array = array(
	[tab]'foo'   => 'somevalue',
	[tab]'foo2'  => 'somevalue2',
	[tab]'foo3'  => 'somevalue3',
	[tab]'foo34' => 'somevalue3',
);

In general, readability is more important than cleverness or brevity.

View Logic

When using html within view logic, use colon syntax.

When logic exists between open and close html tags, use curly brackets.

Single line curly brackets within opening and closing html tags

<div class="<?php if ( $foo ) { echo 'bar'; } ?>"></div>

Multi line curly brackets between opening and closing html tags with heavy logic

<div class="
	<?php
		if ( $foo ) {
			if ( $another_foo ) {
				echo "Another Foo";
			}
			echo "Foo";
		} elseif ( $bar ) {
			echo "Bar"
		} else {
			echo "Nothing";
		}
	?>
"></div>

Single line colon syntax

<ul>
	<?php foreach ( $foo as $bar ): ?>
		<li class="<?php echo $bar; ?>"><?php echo $bar; ?></li>
	<?php endforeach; ?>
</ul>

Multiple line colon syntax with mixed curly brackets

<div class="list">
	<?php
		$args = array(
			'numberposts'	=> -1,
			'post_type'		=> 'pages',
			'orderby'		=> 'menu_order',
			'order'			=> 'ASC'
		);

		$query = new WP_Query( $args );

		if ( $query->have_posts() ) :
			while ( $query->have_posts() ) :
				$query->the_post();
				$fields = get_fields();
				$i ++; ?>
				<div class="item">
					<div class="image-container">
						<div class="overlay"></div>
						<?php if ( has_post_thumbnail() ) { the_post_thumbnail( 'medium' ); } ?>
						<h3 class="sub-title"><?php _e( the_title(), '_vtg' )?></h3>
					</div>
					<div class="content">
						<?php _e( the_excerpt(), '_vtg' ); ?>
						<div class="cta">
							<a href="<?php _e( the_permalink(), '_vtg' ); ?>" >Learn More</a>
						</div>
					</div>
				</div>
				<?php
			endwhile;
		endif;
		wp_reset_query(); ?>
</div>

To Do

• .editorconfig
• Set up PHPLint