drupal_query_string_encode

5 common.inc drupal_query_string_encode($query, $exclude = array(), $parent = '')
6 common.inc drupal_query_string_encode($query, $exclude = array(), $parent = '')

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

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

Related topics

5 calls to drupal_query_string_encode()

File

includes/common.inc, line 227
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 = rawurlencode($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 . '=' . rawurlencode($value);
    }
  }

  return implode('&', $params);
}

Comments

Function name change in Drupal 7

In Drupal 7 you should use drupal_http_build_query().

Login or register to post comments