How to send a status code in PHP, without maintaining an array of status names?

Question

All I want to do, is send a 404 status code from PHP - but in a generic fashion. Both Router::statusCode(404) and Router::statusCode(403) should work, as well as any other valid HTTP status code.

I do know, that you can specify a status code as third parameter to header. Sadly this only works if you specify a string. Thus calling header('', false, 404) does not work.

Furthermore I know, that one can send a status code via a header call with a status line: header('HTTP/1.1 404 Not Found')

But to do this I have to maintain an array of reason phrases (Not Found) for all status codes (404). I don't like the idea of this, as it somehow is a duplication of what PHP already does itself (for the third header parameter).

So, my question is: Is there any simple and clean way to send a status code in PHP?

The simple and clean way is to send the proper header. Any other way (including using the 3rd parameter to header() IMHO) is dirty. There are not that many status codes, and they are well documented. What's not clean about doing a simple map? — ircmaxell
– ircmaxell, Commented Jan 25, 2011 at 18:20

hakre · Accepted Answer · 2013-03-08 14:13:51Z

79

There is a new function for this in PHP >= 5.4.0 http_response_code

Simply do http_response_code(404).

If you have a lower PHP version try header(' ', true, 404); (note the whitespace in the string).

If you want to set the reason phrase as well try:

header('HTTP/ 433 Reason Phrase As You Wish');

edited Mar 8, 2013 at 14:13

hakre

200k55 gold badges454 silver badges865 bronze badges

answered Jun 17, 2012 at 9:50

hectorct

3,6551 gold badge27 silver badges43 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

hakre Over a year ago

+1 for the whitespace at the beginning. The second parameter can be either true or false according to my experience.

Pacerier Over a year ago

@hectorct, why do we need true as the second parameter?

hectorct Over a year ago

It doesn't matter. The result is the same if the second parameter is set to true or false. In fact, it can be marginally faster with it set to false because php doesn't try to replace previous headers.

Marc B · Accepted Answer · 2011-01-25 18:22:15Z

27

The actual text of the code is irrelevant. You could do

header('The goggles, they do nawtink!', true, 404);

and it'd still be seen as a 404 by the browser - it's the code that matters.

answered Jan 25, 2011 at 18:22

Marc B

362k44 gold badges433 silver badges508 bronze badges

10 Comments

ircmaxell Over a year ago

Are you really suggesting this as a valid and clean way of setting a status code?

Marc B Over a year ago

No, just a goofy way to show that the text of the header is irrelevant, as long as the status code is there.

Kyle Wild Over a year ago

+1 because it's true, and because a comment like that is certainly going to make that apparent to any future developers :) @ircmaxell - hey, it's php!

Marc B Over a year ago

Sure, not saying to put something totally different, like "Access denied" for a 404, but "Not found" is just a simple suggested default. You could put a 500 page poem that boils down to the same thing if you so chose.

ircmaxell Over a year ago

@nikic: PHP will pass it on, it's up to the webserver (Apache, etc) to throw it away or not...

|

Mike B · Accepted Answer · 2011-01-25 18:19:25Z

17

Zend Framework has a packaged solution in Zend_Http_Response

Zend_Http_Response::$messages contains:

/**
 * List of all known HTTP response codes - used by responseCodeAsText() to
 * translate numeric codes to messages.
 *
 * @var array
 */
protected static $messages = array(
    // Informational 1xx
    100 => 'Continue',
    101 => 'Switching Protocols',

    // Success 2xx
    200 => 'OK',
    201 => 'Created',
    202 => 'Accepted',
    203 => 'Non-Authoritative Information',
    204 => 'No Content',
    205 => 'Reset Content',
    206 => 'Partial Content',

    // Redirection 3xx
    300 => 'Multiple Choices',
    301 => 'Moved Permanently',
    302 => 'Found',  // 1.1
    303 => 'See Other',
    304 => 'Not Modified',
    305 => 'Use Proxy',
    // 306 is deprecated but reserved
    307 => 'Temporary Redirect',

    // Client Error 4xx
    400 => 'Bad Request',
    401 => 'Unauthorized',
    402 => 'Payment Required',
    403 => 'Forbidden',
    404 => 'Not Found',
    405 => 'Method Not Allowed',
    406 => 'Not Acceptable',
    407 => 'Proxy Authentication Required',
    408 => 'Request Timeout',
    409 => 'Conflict',
    410 => 'Gone',
    411 => 'Length Required',
    412 => 'Precondition Failed',
    413 => 'Request Entity Too Large',
    414 => 'Request-URI Too Long',
    415 => 'Unsupported Media Type',
    416 => 'Requested Range Not Satisfiable',
    417 => 'Expectation Failed',

    // Server Error 5xx
    500 => 'Internal Server Error',
    501 => 'Not Implemented',
    502 => 'Bad Gateway',
    503 => 'Service Unavailable',
    504 => 'Gateway Timeout',
    505 => 'HTTP Version Not Supported',
    509 => 'Bandwidth Limit Exceeded'
);

Even if you're not using zend-framework you might be able to break this out for personal use.

answered Jan 25, 2011 at 18:19

Mike B

32.2k13 gold badges89 silver badges113 bronze badges

4 Comments

ircmaxell Over a year ago

Isn't this exactly what the question specified that they didn't want?

Mike B Over a year ago

@ircmaxwell, As you said, there is no maintaining this list as it's already developed to spec.. and the spec isn't changing.

RileyE Over a year ago

I love that the Mike and Mark B brothers decided to help us all out here. Also, @eyelidlessness, thanks for making an awkward situation at my office. Uncontrollable laughter is a curse.

Clamburger Over a year ago

@MikeB Untrue; RFC 6585, for example, added more status codes.

Brad · Accepted Answer · 2011-01-25 18:20:11Z

4

Yeah, just do this...

header('x', true, 404);

The first string parameter can be anything that doesn't contain a :. PHP will then replace and go with the standard phrase. The second parameter specifies "always replace", and the 3rd is the status code you want.

References:

answered Jan 25, 2011 at 18:20

Brad

164k57 gold badges380 silver badges559 bronze badges

2 Comments

NikiC Over a year ago

Can't this have any implications? Can one do this, because X denotes custom headers? Is this considered bad style?

Brad Over a year ago

@nikic, I don't believe so, because you aren't specifying the full header. See my latest edit.

John · Accepted Answer · 2020-12-16 06:37:40Z

0

Your server's responses should reflect the context of the response to a client's request. Additionally you shouldn't bother with the excess text, simply return the HTTP status number.

header('HTTP/2.0 200');//Ok / successful response.
header('HTTP/2.0 301');//Permanent redirect
header('HTTP/2.0 400');//Client request error: Bad request (e.g. missing $_POST, $_GET).
header('HTTP/2.0 401');//Client request error: Not authenticated
header('HTTP/2.0 403');//Client request error: Authenticated, still lacking permission.
header('HTTP/2.0 404');//Client request error: File Not Found
header('HTTP/2.0 500');//Server error, general.

answered Dec 16, 2020 at 6:37

John

1

Collectives™ on Stack Overflow

How to send a status code in PHP, without maintaining an array of status names?

5 Answers 5

3 Comments

10 Comments

4 Comments

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

3 Comments

10 Comments

4 Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related