WordCamp LA 2014- Writing Code that Scales

Writing Code That Scales
by Dave Jesch
LA WordCamp - September 6, 2014

Write a Plugin Popularity Unrecognizable Code
© 2014 SpectrOMtech.com. All Rights Reserved.

Scalability: Think Big, Focus Small.

Warning:
There will be code.

Follow Slides:
http://SpectrOMTech.com/presentations/wcla2014/

Dave Jesch, Lifetime Geek & CTO @ .com
Scalability
➔Custom Plugins
➔Web Architecture
➔Everything eCommerce

Procedural Object Oriented
(est. 1800’s) (est. 1990’s)

Big Take-Away:
Only call in the code you need.

Today’s Goals:
1. Best Practices
2. Code Organization
3. Code Techniques

1. Best Practices

Coding Standards
● WordPress Coding Standards
http://codex.wordpress.org/WordPress_Coding_Standards
o Indentation
o Placement of Braces
o Class / Function / Variable Naming

Data Handling
● Validate All Input
http://codex.wordpress.org/Data_Validation
● Escape Output
● Escape Data in SQL Queries
http://codex.wordpress.org/Class_Reference/wpdb#Protect_Queries_Agai
nst_SQL_Injection_Attacks

2. Code Organization

Separate Code into Logical Areas
1. Admin Only
2. Front-end Only
3. Common

Sample Organization
● Main Plugin File plugin_directory/my_plugin.php
● Admin Code
plugin_directory/include/admin.php
● Front-end code
plugin_directory/include/frontend.php
● Common Code
plugin_directory/include/some_code.php
plugin_directory/include/more_code.php
● Assets
plugin_directory/assets/css/plugin.css
plugin_directory/assets/js/plugin.js

Minimize Code Usage
● Test for Front-end vs. Admin page request
● Register scripts/styles; don’t enqueue until you need to
● Separate out install/uninstall code
● Separate out Cron code

Determining Page Request
● is_admin()
● if (defined('DOING_AJAX') && DOING_AJAX)
● if (defined('DOING_CRON') && DOING_CRON)
● Understand WordPress’ Initialization Sequence
http://codex.wordpress.org/Plugin_API/Action_Reference

3. Code Techniques

Sample Techniques (1 of 8)
In main plugin file:
define('PLUGIN_FILE', __FILE__);
define('PLUGIN_DIR', plugin_dir_path(PLUGIN_FILE));
define('PLUGIN_INCLUDE', PLUGIN_DIR . 'include/');
define('PLUGIN_ASSETS', PLUGIN_DIR . 'assets/');
define('PLUGIN_ASSETS_URL', plugin_dir_url(PLUGIN_FILE) . 'assets/'
define('PLUGIN_VERSION', '1.0');

Check for Plugin Activation:
register_activation_hook(PLUGIN_FILE, 'plugin_activation');
function plugin_activation()
{
require_once(PLUGIN_INCLUDE . 'activate.php');
}

Load code appropriate for page request:
if (defined(DOING_CRON) && DOING_CRON)
require_once(PLUGIN_INCLUDE . 'cron_code.php');
else if (is_admin())
require_once(PLUGIN_INCLUDE . 'admin.php');
else
require_once(PLUGIN_INCLUDE . 'frontend.php');

admin.php:
add_action('admin_init', 'plugin_initialize');
function plugin_initialize()
{
add_menu_page('title', 'menu title', 'Administrator', 'plugin-slug',
'plugin_menu_page');
}
function plugin_menu_page()
{
include(PLUGIN_INCLUDE . 'plugin_page_contents.php');
}
include(PLUGIN_INCLUDE . 'some_code.php');

frontend.php:
add_action('wp_enqueue_scripts', 'plugin_register_script')
function plugin_register_script()
{
wp_register_script('plugin_javascript', PLUGIN_ASSETS . 'js/javascript.js',
array('jquery'), PLUGIN_VERSION, TRUE);
}
add_shortcode('sample_shortcode', 'plugin_shortcode')
function plugin_shortcode($attr)
{
wp_enqueue_script('plugin_javascript');
return ('<img src="' . PLUGIN_ASSETS_URL .
'images/plugin_image.png" width="16" height="16" />');
}
include(PLUGIN_INCLUDE . 'some_code.php');

some_code.php:
add_action('widget_init', 'plugin_register_widgets')
function plugin_register_widgets()
{
include(PLUGIN_INCLUDE . 'widget.php');
register_widget('PluginWidget');
}

widget.php:
class PluginWidget extends WP_Widget
{
public function widget()
{
// display widget contents
}
public function form()
{
include(PLUGIN_INCLUDE . 'widget_form.php');
}
public function update()
{
include(PLUGIN_INCLUDE . 'widget_update.php');
}
}

Use Transients When Appropriate:
// get data from transient
if (false === ($menu = get_transient('main_nav_menu'))) {
// nothing in transient, generate menu
$args = array(..., 'echo' => 0);
$menu = wp_nav_menu($args);
// save data from menu in transient
set_transient('main_nav_menu', $menu, 86400);
}
echo $menu;

Only call in the code you need.

Scalability Achieved!
1. Organize Your Code
2. Load Only What’s Needed
3. Use Your Actions
4. Always Learn More

Learning more about...
OOPin
Connect with us at Hello@SpectrOMTech.com
Live as if you were to die tomorrow. Learn as if you were to live forever. ~ Mahatma Gandhi

More References
PHP Optimization Presentation OC WordCamp:
http://wordpress.tv/2014/06/26/dave-jesch-php-optimization-getting-the-most-out-
of-your-php-code/
http://www.slideshare.net/djesch/php-optimization-35545593

WordCamp LA 2014- Writing Code that Scales

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (11)

Similaire à WordCamp LA 2014- Writing Code that Scales

Similaire à WordCamp LA 2014- Writing Code that Scales (20)

Dernier

Dernier (20)

WordCamp LA 2014- Writing Code that Scales