Adding Sack Ajax To Your WordPress Plugin’s Admin Page
Using my previous wordpress example plugin I’m going to demonstrate how to use ajax within the admin panel. WordPress uses the Simple AJAX Code-Kit (SACK) which is relatively easy to use and understand.
For this example I’m going to expand on my previous example and add a simple javascript function that queries some data from the server. WordPress forces us to do this in a roundabout way. First we have to add two new function hooks. One prints my javascript function in the scripts section of the admin panel and the other is the code that gets called by the ajax sack request.
//add my custom ajax function to the scripts section in the admin panel
add_action('admin_print_scripts', 'ajax_request');
//add data returning ajax refresh table function
add_action('wp_ajax_do_something', 'get_random_number');
The ajax_request function is a shell function for the javascript ajax call get_random_number_from_server which is our sack ajax request. Note that we are calling the admin-ajax.php script. This script will handle the calling of the get_random_number function for us because of the action defined above.
//This function will print out in the header section.
//Put all your javascript in this function.
function ajax_request()
{
//print out the sack ajax library
wp_print_scripts( array( 'sack' ));
?>
<script type="text/javascript">
//<![CDATA[
function get_random_number_from_server()
{
//creates the sack object and
//gives it the url that it should request to.
var mysack = new sack( '<?php
bloginfo( "wpurl" ); ?>/wp-admin/admin-ajax.php' );
mysack.execute = 1; //execute whatever is returned
mysack.method = 'POST';
//Set POST fields
mysack.setVar( "action", "do_something" );
mysack.encVar( "cookie", document.cookie, false );
mysack.onError = function() { alert('Ajax Error')};
mysack.runAJAX(); //run the result
return true;
} // end of JavaScript function myplugin_ajax_elevation
//]]>
</script>
<?php
}
This is the php function that is called by the javascript function above. It spits out a alert javascript function and then dies. Not sure why but it is recommended to die in this function.
//This is the server side code for the ajax sack request
function get_random_number()
{
$minimum_number = 0;
$maximum_number = 100;
die("alert('".rand($minimum_number,$maximum_number)."');");
}
This code can now be run like the following in your plugins admin page.
<input type='button' value='Get Random Number'
onclick='get_random_number_from_server();'>
When the button is hit a popup with a random number in it will pop up. Here’s a link to the entire example plugin code.
