- How to pass an array in a URL query string using PHP
- PHP pass an array in a URL query string using http_build_query() function
- Syntax of http_build_query()
- Pass simple array in http_build_query()
- Pass indexed array in http_build_query()
- Pass multidimentional array in http_build_query()
- PHP pass an array in a URL query string using serialize() and urlencode() functions
- How to pass an array in a URL query string using PHP
- PHP pass an array in a URL query string using http_build_query() function
- Syntax of http_build_query()
- Pass simple array in http_build_query()
- Pass indexed array in http_build_query()
- Pass multidimentional array in http_build_query()
- PHP pass an array in a URL query string using serialize() and urlencode() functions
- How to Pass an Array in URL Query String with PHP
- Passing a Simple Array within http_build_query()
- Passing an Indexed Array within http_build_query()
- Passing a Multidimensional Array within http_build_query()
- Describing Query String
How to pass an array in a URL query string using PHP
In this article, you will learn how to pass an array from one page to another in a URL query string using PHP.
You will learn not only how to pass a single array, but also learn to pass indexed and multidimensional arrays to an URL query string using PHP.
The term ‘Query String‘ is a part of a Uniform Resource Locator(URL). This is in the form of a series of key-value pairs and is called as url parameter. This is basically used to build a typical url or to get data from url. For example-
https://www.example.com/emp?name=Smith&dept=it&role=developer&exp=5
In the above url, ‘name=Smith&dept=it&role=developer&exp=5‘ is the query string, having multiple parameters. The parameters are separated by ‘&‘ and within each pair, the field name and value are separated by an equal sign(=).
The query string is used for many purposes, like the form get method, which takes input field values in the url query string, search keywords, particular web page tracking, url building, and so on.
In HTML, you have observed how the form input name with value is passed in a URL query string if the form method is post. But, this generates only a static query string. To build query strings dynamically, methods are provided by almost all popular programming languages. In this article, you will learn how to pass an array variables in a URL query string using PHP.
PHP pass an array in a URL query string using http_build_query() function
PHP provides the http_build_query() method to generate URL-encoded query string. This is available with PHP 5 and later versions. The http_build_query() function converts an array to its equivalent URL-encoded query string.
Syntax of http_build_query()
http_build_query($query, $numeric_prefix, $separator, $encoded_type)
$query— It is an associative array or indexed array containing parameters. This can be a one-dimensional array or a multidimensional array.
$numeric_prefix— A numeric prefix is provided if numeric indices are used in the base array.
$separator— This overrides the default parameter separator.
$encoded_type— This is the query string encoding type, like- PHP_QUERY_RFC1738, PHP_QUERY_RFC3986.
Pass simple array in http_build_query()
In the below example, we have used the $vars array to create the URL query string. The $vars array contains data on search keywords and page numbers. In the next line, we pass this array to the http_build_query() method to generate a query string.
?php $vars = array('page' => 23, 'search' => 'etutorialspoint'); $qs = http_build_query($vars); $url = 'http://www.example.com/search.php?' . $qs; echo $url; ?>
The above code returns this url query string —
http://www.example.com/search.php?page=23&search=etutorialspoint
Pass indexed array in http_build_query()
Here, $vars is an indexed array containing employee data.
?php $vars = array('employee','smith','technical','emp_id' => '332'); $qs = http_build_query($vars); $url = 'http://www.example.com/search.php?' . $qs; echo $url; ?>
The above code returns this url query string-
http://www.example.com/search.php?0=employee&1=smith&2=technical&emp_id=332
Pass multidimentional array in http_build_query()
Here, the ‘$vars‘ is a multidimensional array containing employee data. This is returned by the http_build_query() method as a complex url query string.
?php $vars = array('employee'=>array('name'=>'Smith', 'age'=>39, 'dept'=>'IT', 'dob'=>'9/22/1980'), 'role'=>array('developer', 'designer')); $qs = http_build_query($vars); $url = 'http://www.example.com/search.php?' . $qs; echo $url; ?>
The above script returns this url query string-
http://www.example.com/search.php?employee%5Bname%5D=Smith&employee%5Bage%5D=39&employee%5Bdept%5D=IT&employee%5Bdob%5D=9%2F22%2F1980&role%5B0%5D=developer&role%5B1%5D=designer
PHP pass an array in a URL query string using serialize() and urlencode() functions
We can also use the urlencode() function with the serialize() function to create an URL-encoded string. In the given example, first we have converted the array into its byte stream representation, which is a string using the serialize() function. And then, we have created an URL-encoded string of that byte stream.
?php $vars = array('page' => 40, 'search' => 'etutorialspoint'); echo "http://www.example.com/search.php?" . urlencode(serialize($vars)); ?>
http://www.example.com/search.php?a%3A2%3A%7Bs%3A4%3A%22page%22%3Bi%3A40%3Bs%3A6%3A%22search%22%3Bs%3A15%3A%22etutorialspoint%22%3B%7D
How to pass an array in a URL query string using PHP
In this article, you will learn how to pass an array from one page to another in a URL query string using PHP.
You will learn not only how to pass a single array, but also learn to pass indexed and multidimensional arrays to an URL query string using PHP.
The term ‘Query String‘ is a part of a Uniform Resource Locator(URL). This is in the form of a series of key-value pairs and is called as url parameter. This is basically used to build a typical url or to get data from url. For example-
https://www.example.com/emp?name=Smith&dept=it&role=developer&exp=5
In the above url, ‘name=Smith&dept=it&role=developer&exp=5‘ is the query string, having multiple parameters. The parameters are separated by ‘&‘ and within each pair, the field name and value are separated by an equal sign(=).
The query string is used for many purposes, like the form get method, which takes input field values in the url query string, search keywords, particular web page tracking, url building, and so on.
In HTML, you have observed how the form input name with value is passed in a URL query string if the form method is post. But, this generates only a static query string. To build query strings dynamically, methods are provided by almost all popular programming languages. In this article, you will learn how to pass an array variables in a URL query string using PHP.
PHP pass an array in a URL query string using http_build_query() function
PHP provides the http_build_query() method to generate URL-encoded query string. This is available with PHP 5 and later versions. The http_build_query() function converts an array to its equivalent URL-encoded query string.
Syntax of http_build_query()
http_build_query($query, $numeric_prefix, $separator, $encoded_type)
$query— It is an associative array or indexed array containing parameters. This can be a one-dimensional array or a multidimensional array.
$numeric_prefix— A numeric prefix is provided if numeric indices are used in the base array.
$separator— This overrides the default parameter separator.
$encoded_type— This is the query string encoding type, like- PHP_QUERY_RFC1738, PHP_QUERY_RFC3986.
Pass simple array in http_build_query()
In the below example, we have used the $vars array to create the URL query string. The $vars array contains data on search keywords and page numbers. In the next line, we pass this array to the http_build_query() method to generate a query string.
?php $vars = array('page' => 23, 'search' => 'etutorialspoint'); $qs = http_build_query($vars); $url = 'http://www.example.com/search.php?' . $qs; echo $url; ?>
The above code returns this url query string —
http://www.example.com/search.php?page=23&search=etutorialspoint
Pass indexed array in http_build_query()
Here, $vars is an indexed array containing employee data.
?php $vars = array('employee','smith','technical','emp_id' => '332'); $qs = http_build_query($vars); $url = 'http://www.example.com/search.php?' . $qs; echo $url; ?>
The above code returns this url query string-
http://www.example.com/search.php?0=employee&1=smith&2=technical&emp_id=332
Pass multidimentional array in http_build_query()
Here, the ‘$vars‘ is a multidimensional array containing employee data. This is returned by the http_build_query() method as a complex url query string.
?php $vars = array('employee'=>array('name'=>'Smith', 'age'=>39, 'dept'=>'IT', 'dob'=>'9/22/1980'), 'role'=>array('developer', 'designer')); $qs = http_build_query($vars); $url = 'http://www.example.com/search.php?' . $qs; echo $url; ?>
The above script returns this url query string-
http://www.example.com/search.php?employee%5Bname%5D=Smith&employee%5Bage%5D=39&employee%5Bdept%5D=IT&employee%5Bdob%5D=9%2F22%2F1980&role%5B0%5D=developer&role%5B1%5D=designer
PHP pass an array in a URL query string using serialize() and urlencode() functions
We can also use the urlencode() function with the serialize() function to create an URL-encoded string. In the given example, first we have converted the array into its byte stream representation, which is a string using the serialize() function. And then, we have created an URL-encoded string of that byte stream.
?php $vars = array('page' => 40, 'search' => 'etutorialspoint'); echo "http://www.example.com/search.php?" . urlencode(serialize($vars)); ?>
http://www.example.com/search.php?a%3A2%3A%7Bs%3A4%3A%22page%22%3Bi%3A40%3Bs%3A6%3A%22search%22%3Bs%3A15%3A%22etutorialspoint%22%3B%7D
How to Pass an Array in URL Query String with PHP
PHP includes the http_build_query() method for creating URL encoded query string. This method is available only on PHP 5 and above versions. In this snippet, you will learn how to pass an array in URL query string using PHP.
The syntax of http_build_query() will look as follows:
http_build_query($query, $numeric_prefix, $separator, $encoded_type)
Passing a Simple Array within http_build_query()
In this section, we are going to use $vars array for generating the URL query string. The $vars array includes the data of search keyword, as well as the page number.
Let’s see an example where this array is passed to the http_build_query() method for generating a query string:
$vars = ['page' => 26, 'search' => 'w3docs']; $qs = http_build_query($vars); $url = 'http://www.example.com/search.php?' . $qs; echo $url; ?>
The code, represented above will return the following url query string:
http://www.example.com/search.php?page=26&search=w3docs
Passing an Indexed Array within http_build_query()
Now, let’s see an example where $vars is an indexed array that comprises an employee data:
$vars = ['employee', 'brown', 'developer', 'emp_id' => '332']; $qs = http_build_query($vars); $url = 'http://www.example.com/search.php?' . $qs; echo $url; ?>
The code above will return the following url query string:
http://www.example.com/search.php?0=employee&1=brown&2=developer&emp_id=332
Passing a Multidimensional Array within http_build_query()
In this section, we will consider $vars as a multidimensional array with employee data. Once passing through the http_build_query() method, it will return a complex url query string.
$vars = ['employee' => ['name' => 'Brown', 'age' => 41, 'dept' => 'IT', 'dob' => '9/22/1980'], 'role' => ['engineer', 'developer']]; $qs = http_build_query($vars); $url = 'http://www.example.com/search.php?' . $qs; echo $url; ?>
This code will return the following url query string:
http://www.example.com/search.php?employee%5Bname%5D=Brown&employee%5Bage%5D=39&employee%5Bdept%5D=IT&employee%5Bdob%5D=9%2F22%2F1980&role%5B0%5D=engineer&role%5B1%5D=developer
Describing Query String
The query string term is considered a part of Uniform Resource Locator (URL). It is in the form of a series of key-value pairs. Generally, it is used for creating a typical url or getting data from URL.
So, you can use the query string for different purposes such as search keywords, url building, specific web page tracking, and many more.