drupal_json_output

7 common.inc	`drupal_json_output($var = NULL)`
8 common.inc	`drupal_json_output($var = NULL)`

Returns data in JSON format.

This function should be used for JavaScript callback functions returning data in JSON format. It sets the header for JavaScript output.

Parameters

$var: (optional) If set, the variable will be converted to JSON and output.

▸ 20 functions call drupal_json_output()

▾ 20 functions call drupal_json_output()

database_test_db_query_temporary in modules/simpletest/tests/database_test.module: Run a db_query_temporary and output the table name and its number of rows.
database_test_even_pager_query in modules/simpletest/tests/database_test.module: Run a pager query and return the results.
database_test_odd_pager_query in modules/simpletest/tests/database_test.module: Run a pager query and return the results.
database_test_tablesort in modules/simpletest/tests/database_test.module: Run a tablesort query and return the results.
database_test_tablesort_first in modules/simpletest/tests/database_test.module: Run a tablesort query with a second order_by after and return the results.
file_ajax_progress in modules/file/file.module: Menu callback for upload progress.
form_test_form_state_values_clean_form_submit in modules/simpletest/tests/form_test.module: Form submit handler for form_state_values_clean() test form.
form_test_select_submit in modules/simpletest/tests/form_test.module: Form submit handler for form_test_select().
menu_parent_options_js in modules/menu/menu.module: Page callback. Get all the available menus and menu items as a JavaScript array.
profile_admin_settings_autocomplete in modules/profile/profile.admin.inc: Retrieve a pipe delimited string of autocomplete suggestions for profile categories
profile_autocomplete in modules/profile/profile.pages.inc: Callback to allow autocomplete of profile text fields.
system_date_time_lookup in modules/system/system.admin.inc: Return the date for a given format string via Ajax.
system_timezone in modules/system/system.module: Menu callback; Retrieve a JSON object containing a suggested time zone name.
taxonomy_autocomplete in modules/taxonomy/taxonomy.pages.inc: Page callback: Outputs JSON for taxonomy autocomplete suggestions.
user_autocomplete in modules/user/user.pages.inc: Menu callback; Retrieve a JSON object containing autocomplete suggestions for existing users.
_batch_do in includes/batch.inc: Does one execution pass with JavaScript and returns progress to the browser.
_form_test_checkbox_submit in modules/simpletest/tests/form_test.module: Return the form values via JSON.
_form_test_disabled_elements_submit in modules/simpletest/tests/form_test.module: Return the form values via JSON.
_form_test_input_forgery_submit in modules/simpletest/tests/form_test.module: Return the form values via JSON.
_form_test_submit_values_json in modules/simpletest/tests/form_test.module: Form submit handler to return form values as JSON.

File

includes/common.inc, line 4902: Common functions that many Drupal modules will need to reference.

Code

<?php
function drupal_json_output($var = NULL) {
  // We are returning JSON, so tell the browser.
  drupal_add_http_header('Content-Type', 'application/json');

  if (isset($var)) {
    echo drupal_json_encode($var);
  }
}
?>

Comments

Drupal 6

Posted by jhodgdon on February 25, 2010 at 4:06pm

The equivalent function in Drupal 6 is http://api.drupal.org/api/function/drupal_json/6

See http://drupal.org/update/modules/6/7#rename-drupal-to-js for more information.

However, D6 has some bugs

Posted by trungonly on July 24, 2011 at 7:02pm

However, D6 has some bugs about header content-type (not application/json but text/javascript) and breaks validation JSON if you are using jQuery update to 1.4. So use D6 version with care.