Home › API reference

Definition

drupal_query_string_encode($query, $exclude = array(), $parent = '')
drupal-cvs/includes/common.inc, line 223

Description

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.

Code

<?php
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);
}
?>