Slim PHP and GET Parameters

Question

I'm using Slim PHP as a framework for a RESTful API.

How do I grab GET params from the URL in Slim PHP?

For example, if I wanted to use the following:

http://api.example.com/dataset/schools?zip=99999&radius=5

These are not GET params?? Are you sure? – Galled Nov 14 '11 at 16:57 — Galled, Nov 14 '11 at 16:57
Blerg! I did mean GET, not POST, sorry. – Eric Arenson Nov 14 '11 at 16:59 — Eric Arenson, Nov 14 '11 at 16:59
How about the $_GET variable? Doesn't works? – Galled Nov 14 '11 at 17:03 — Galled, Nov 14 '11 at 17:03
Just use `$_GET['zip']` or `$_GET['radius']` – fire Nov 14 '11 at 17:05 — fire, Nov 14 '11 at 17:05

score 118 · Accepted Answer · edited Apr 19 '19 at 08:57

You can do this very easily within the Slim framework, you can use:

$paramValue = $app->request()->params('paramName');

$app here is a Slim instance.

Or if you want to be more specific

//GET parameter

$paramValue = $app->request()->get('paramName');

//POST parameter

$paramValue = $app->request()->post('paramName');

You would use it like so in a specific route

$app->get('/route',  function () use ($app) {
          $paramValue = $app->request()->params('paramName');
});

You can read the documentation on the request object http://docs.slimframework.com/request/variables/

As of Slim v3:

$app->get('/route', function ($request, $response, $args) {
    $paramValue = $request->params(''); // equal to $_REQUEST
    $paramValue = $request->post(''); // equal to $_POST
    $paramValue = $request->get(''); // equal to $_GET

    // ...

    return $response;
});

vlp · Answer 2 · 2020-11-24T20:30:55.533

32

For Slim 3/4 you need to use the method getQueryParams() on the PSR 7 Request object.

Citing Slim 3 / Slim 4 documentation:

You can get the query parameters as an associative array on the Request object using getQueryParams().

edited Nov 24 '20 at 20:30

answered Oct 08 '16 at 18:57

vlp

7,811
2
23
51

1

Somehow I'm getting `getQueryParam()` method not found but `getQueryParams()` works fine. – JackTheKnife Mar 20 '19 at 14:29
e.g. `$zip = $request->getQueryParams()['zip'] ?? null;` – Fabien Snauwaert Sep 08 '22 at 15:19

score 4 · Answer 3 · answered Apr 09 '13 at 11:01

4

I fixed my api to receive a json body OR url parameter like this.

$data = json_decode($request->getBody()) ?: $request->params();

This might not suit everyone but it worked for me.

answered Apr 09 '13 at 11:01

Mulhoon

1,852
21
26

score 3 · Answer 4 · answered Sep 13 '19 at 09:32

3

Slim 3

$request->getQueryParam('page')

or

$app->request->getQueryParam('page')

answered Sep 13 '19 at 09:32

Edmunds22

715
9
10

score 2 · Answer 5 · answered Jan 26 '16 at 18:52

IF YOU WANT TO GET PARAMS WITH PARAM NAME

$value = $app->request->params('key');

The params() method will first search PUT variables, then POST variables, then GET variables. If no variables are found, null is returned. If you only want to search for a specific type of variable, you can use these methods instead:

//--- GET variable

$paramValue = $app->request->get('paramName');

//--- POST variable

$paramValue = $app->request->post('paramName');

//--- PUT variable

$paramValue = $app->request->put('paramName');

IF YOU WANT TO GET ALL PARAMETERS FROM REQUEST WITHOUT SPECIFYING PARAM NAME, YOU CAN GET ALL OF THEM INTO ARRAY IN FORMAT KEY => VALUE

$data = json_decode( $app->request->getBody() ) ?: $app->request->params();

$data will be an array that contains all fields from request as below

$data = array(
    'key' => 'value',
    'key' => 'value',
    //...
);

Hope it helps you!

score 2 · Answer 6 · answered Apr 12 '17 at 15:32

2

Use $id = $request->getAttribute('id'); //where id is the name of the param

answered Apr 12 '17 at 15:32

Cengkuru Michael

4,590
1
33
33

score 2 · Answer 7 · answered Jun 19 '17 at 00:30

2

In Slim 3.0 the following also works:

routes.php

require_once 'user.php';

$app->get('/user/create', '\UserController:create');

user.php

class UserController
{
    public function create($request, $response, array $args)
    {
        $username = $request->getParam('username'));
        $password = $request->getParam('password'));
        // ...
    }
}

answered Jun 19 '17 at 00:30

Tamas Kalman

1,925
1
19
24

`getParam()` - method not found – JackTheKnife Mar 20 '19 at 14:27
which version of Slim are you using? See Slim v3.0 related documentation here: http://www.slimframework.com/docs/v3/objects/request.html – Tamas Kalman Mar 27 '19 at 18:14
I would recommend to use POST method for creation of new entries: `$app->post('/users'), '\UserController:create');` – Nique Oct 13 '21 at 23:02

score 1 · Answer 8 · answered Oct 25 '22 at 06:09

Inside your api controller function write the following code of line:

public function your_api_function_name(Request $request, Response $response)
    {
        $data = $request->getQueryParams();
        $zip = $data['zip'];
        $radius = $data['radius'];

    }

The variable $data contains all the query parameters.

score 1 · Answer 9 · answered Nov 14 '11 at 17:05

1

Not sure much about Slim PHP, but if you want to access the parameters from a URL then you should use the:

$_SERVER['QUERY_STRING']

You'll find a bunch of blog posts on Google to solve this. You can also use the PHP function parse_url.

answered Nov 14 '11 at 17:05

George P

736
5
12

1

George P and fire are right, I just had to use $_GET['var']. I thought maybe because of SlimPHP's built-in routing I'd have to do something fancy, but nope. Good old fashioned $_GET[] works just fine. Just overthinking it - thanks guys! – Eric Arenson Nov 14 '11 at 17:10
1

I would recommend sticking to $app->request->get('paramName'); even tho this does work. – Alex Mar 06 '17 at 13:05
@Alex can you explain why you would recommend that? – Holonaut Sep 18 '17 at 11:56
1

@Holonaut This is how the framework expects the parameters to be consumed. Consider in the future, a new middleware is added to escape, encode or trim white space. Your app using `$_SERVER['param']` would not get the benefit, where as, `$app->request()->get('paramName');` would – Alex Sep 19 '17 at 08:06

bkudrle · Answer 10 · 2019-05-04T21:13:26.370

Probably obvious to most, but just in case, building on vip's answer concerning Slim 3, you can use something like the following to get the values for the parameters.

        $logger = $this->getService('logger');
        $params = $request->getQueryParams();
        if ($params)  {
            foreach ($params as $key => $param)     {
                if (is_array($param))   {
                    foreach ($param as $value)  {
                        $logger->info("param[" . $key . "] = " . $value);
                    }
                }
                else    {
                    $logger->info("param[" . $key . "] = " . $param);
                }
            }
        }

Slim PHP and GET Parameters

10 Answers10

Linked