Josh Winn jawinn

PHP Style Guide

All rules and guidelines in this document apply to PHP files unless otherwise noted. References to PHP/HTML files can be interpreted as files that primarily contain HTML, but use PHP for templating purposes.

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

Most sections are broken up into two parts:

Overview of all rules with a quick example
Each rule called out with examples of do's and don'ts

	// This gist can be found at https://gist.github.com/bestknighter/660e6a53cf6a6643618d8531f962be2c
	// I modified Aras Pranckevičius's awesome shader code to be able to handle Infinite and Not A Number numbers
	// Tested on Unity 2023.1.0a15 with ShaderGraph 15.0.1.


	// Quick try at doing a "print value" node for Unity ShaderGraph.
	//
	// Use with CustomFunction node, with two inputs:
	// - Vector1 Value, the value to display,
	// - Vector2 UV, the UVs of area to display at.

	/*
	This is free and unencumbered software released into the public
	domain.

	Anyone is free to copy, modify, publish, use, compile, sell, or
	distribute this software, either in source code form or as a compiled
	binary, for any purpose, commercial or non-commercial, and by any
	means.

	In jurisdictions that recognize copyright laws, the author or authors

	// Usage:
	// get_id_by_slug('any-page-slug');

	function get_id_by_slug($page_slug) {
	$page = get_page_by_path($page_slug);
	if ($page) {
	return $page->ID;
	} else {
	return null;
	}

	/**
	* Be sure to include library scripts in this order. Can be placed either
	* in the header or footer.
	*/
	<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.0/jquery.min.js"></script>
	<script src="//cdnjs.cloudflare.com/ajax/libs/jquery-infinitescroll/2.0b2.120519/jquery.infinitescroll.min.js"></script>
	<script src="//cdnjs.cloudflare.com/ajax/libs/masonry/3.1.2/masonry.pkgd.js"></script>
	<script src="//cdnjs.cloudflare.com/ajax/libs/jquery.imagesloaded/3.0.4/jquery.imagesloaded.min.js"></script>

	// Usage:
	// get_id_by_slug('any-page-slug');

	function get_id_by_slug($page_slug) {
	$page = get_page_by_path($page_slug);
	if ($page) {
	return $page->ID;
	} else {
	return null;
	}

	jQuery(function($){

	var $flexslider = $('.flexslider'),
	$slides = $flexslider.find('li'),
	stripComment = function(string) {
	return string.replace(/<!--/g, '').replace(/-->/g, '');
	},
	initItem = function(item) {
	var $this = $(item);
	if(!$this.hasClass('init')) {

	<?php

	add_filter("the_content", "the_content_filter");

	function the_content_filter($content) {

	// array of custom shortcodes requiring the fix
	$block = join("\|",array("col","shortcode2","shortcode3"));

	// opening tag

	var toast=function(msg){
	$("<div class='ui-loader ui-overlay-shadow ui-body-e ui-corner-all'><h3>"+msg+"</h3></div>")
	.css({ display: "block",
	opacity: 0.90,
	position: "fixed",
	padding: "7px",
	"text-align": "center",
	width: "270px",
	left: ($(window).width() - 284)/2,
	top: $(window).height()/2 })

	<?php
	add_theme_support('menus');

	/**
	* Register Menus
	* http://codex.wordpress.org/Function_Reference/register_nav_menus#Examples
	*/
	register_nav_menus(array(
	'top-bar-l' => 'Left Top Bar', // registers the menu in the WordPress admin menu editor
	'top-bar-r' => 'Right Top Bar'