do_action( “wp_ajax_{$action}” )

User Contributed Notes

1. Skip to note 3 content

   Steven Lin 4 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note

   Example migrated from Codex:

   If you need to create an AJAX handler for an “add_foobar” request, you would create a hook like this:

   add_action( 'wp_ajax_foobar', 'my_ajax_foobar_handler' );
   
   function my_ajax_foobar_handler() {
       // Make your response and echo it.
   
       // Don't forget to stop execution afterward.
       wp_die();
   }

   The following code is an example using jQuery that would trigger the above hook.

   jQuery.post(
       my_foobar_client.ajaxurl, 
       {
           'action': 'foobar',
           'foobar_id':   123
       }, 
       function(response) {
           console.log('The server responded: ', response);
       }
   );

   Note: The foobar_id would be available in your PHP hook handler via $_POST['foobar_id'].

   • In jQuery.post example provided, ‘my_foobar_client.ajaxurl’ should be: ‘my_foobar_client.ajax_url’

     Stringman 4 years ago
2. Skip to note 4 content

   Dhimas Kirana 3 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   using wp_send_json() to output your result as a json format

   add_action( 'wp_ajax_foobar_json', 'my_ajax_foobar_json_handler' );
   function my_ajax_foobar_json_handler() {
       // Your response in array
   	$array_result = array(
   		'data' => 'your data',
   		'message' => 'your message'
   	);
   
       // Make your array as json
   	wp_send_json($array_result);
    
       // Don't forget to stop execution afterward.
       wp_die();
   }

   • For the sake of cleaner & more concise code: There is no need for wp_die() when using wp_send_json().

     Sam Hayman 3 years ago
   • wp_die() is not needed here, since wp_send_json() already makes a wp_die()

     Samy RABIH 1 year ago