function drupal_query_string_encode in Drupal 5

Same name and namespace in other branches

1. 4 includes/common.inc \drupal_query_string_encode()
2. 6 includes/common.inc \drupal_query_string_encode()

Parse an array into a valid urlencoded query string.

Parameters

$query: The array to be processed e.g. $_GET

$exclude: The array filled with keys to be excluded. Use parent[child] to exclude nested items.

$parent: Should not be passed, only used in recursive calls

Return value

urlencoded string which can be appended to/as the URL query string

4 calls to drupal_query_string_encode()

drupal_get_destination in includes/common.inc

Prepare a destination query string for use in combination with drupal_goto(). Used to direct the user back to the referring page after completing a form. By default the current URL is returned. If a destination exists in the previous request, that…

pager_get_querystring in includes/pager.inc

Compose a query string to append to pager requests.

tablesort_get_querystring in includes/tablesort.inc

Compose a query string to append to table sorting requests.

theme_pager_link in includes/pager.inc

Format a link to a specific query result page.

File

includes/common.inc, line 213

Common functions that many Drupal modules will need to reference.

Code

function drupal_query_string_encode($query, $exclude = array(), $parent = '') {
  $params = array();
  foreach ($query as $key => $value) {
    $key = drupal_urlencode($key);
    if ($parent) {
      $key = $parent . '[' . $key . ']';
    }
    if (in_array($key, $exclude)) {
      continue;
    }
    if (is_array($value)) {
      $params[] = drupal_query_string_encode($value, $exclude, $key);
    }
    else {
      $params[] = $key . '=' . drupal_urlencode($value);
    }
  }
  return implode('&', $params);
}