Best practice for adding JavaScript code to WordPress plugins

This article is intended as a guide on how to add JavaScript code to your plugins.

Here is a practical example from WP Wall plugin.

Start by hooking your function to wp_print_action:

add_action('wp_print_scripts', 'WPWall_ScriptsAction');

Next, add the scripts you want to use:

function WPWall_ScriptsAction()
{
 $wp_wall_plugin_url = trailingslashit( get_bloginfo('wpurl') ).PLUGINDIR.'/'. dirname( plugin_basename(__FILE__) );
 
 if (!is_admin())
	{
	  wp_enqueue_script('jquery');
	  wp_enqueue_script('jquery-form');
	  wp_enqueue_script('wp_wall_script', $wp_wall_plugin_url.'/wp-wall.js', array('jquery', 'jquery-form'));
	  wp_localize_script( 'wp_wall_script', 'WPWallSettings', array(
	  	'refreshtime' => 5,
                'mode' => "auto"
		));
	}
}

The code above checks if the opened page is not an admin page as we do not want to load scripts there. Next we use wp_enqueue_script function which can add predefined scripts (like jquery, thickbox, sack etc.) or your own scripts to the printing 'queue'. This will ensure that all scripts will be loaded only once even if referenced multiple times by different plugins

Passing parameters to JavaScript using wp_localize_script

WordPress provides an elegant way to pass parameters to your JavaScript code using wp_localize_script function.

WordPress will automatically add the parameters before the call to your script, even using CDATA for validation.

In the previous example refreshtime and mode parameters were passed and can be easily accessed in JavaScript:

refresh = parseInt( WPWallSettings.refreshtime );
 
mode = WPWallSettings.mode;

Load scripts only when needed

In the example we had a simple check to make sure the scripts are not loaded on admin pages.

In admin pages you can specify exactly on what pages you want the scripts to load.

add_action( "admin_print_scripts-options.php", 'my_admin_scripts' );
 
function my_admin_scripts() {
  // wp_enqueue_script...
}

The admin_print_scripts action can be used, and you just need to append the name of the page. In the previous example scripts would load only on /wp-admin/options.php page.

Conclusion

Using this way to add JavaScript to your code is recommended for all plugins. Not only it is elegant and efficient but it is usually faster than manually printing your scripts and parameters.

About this entry

You’re currently reading “Best practice for adding JavaScript code to WordPress plugins,” an entry on Vladimir Prelovac site, published: Sunday, November 30th, 2008

Check more articles like this: Or, browse the WordPress category.
Write a comment.
Get my newsletter, RSS feed or twitter.