PHP 8.1.31 Released!

exit

(PHP 4, PHP 5, PHP 7, PHP 8)

exitメッセージを出力し、現在のスクリプトを終了する

説明

exit(string $status = ?): void
exit(int $status): void

スクリプトの実行を終了します。 シャットダウン関数オブジェクトのデストラクタ は、exit がコールされた場合にも実行されます。

exit は言語構造です。 status を指定しない場合は括弧なしでコールできます。

パラメータ

status

status が文字列の場合は、この関数は終了直前に status を表示します。

statusint の場合は その値が終了ステータスとして使われ、表示はされません。終了ステータスは 0 から 254 までの値でなければなりません。終了ステータス 255 は PHP に予約されており、使用してはいけません。ステータス 0 は、 プログラムを正常終了させる際に使用します。

戻り値

値を返しません。

例1 exit の例

<?php

$filename
= '/path/to/data-file';
$file = fopen($filename, 'r')
or exit(
"ファイル ($filename) をオープンできません");

?>

例2 exit でステータスを指定する例

<?php

// 正常終了
exit;
exit();
exit(
0);

// エラーコードつきの終了
exit(1);
exit(
0376); // 八進数

?>

例3 シャットダウン関数やデストラクタが実行される例

<?php
class Foo
{
public function
__destruct()
{
echo
'Destruct: ' . __METHOD__ . '()' . PHP_EOL;
}
}

function
shutdown()
{
echo
'Shutdown: ' . __FUNCTION__ . '()' . PHP_EOL;
}

$foo = new Foo();
register_shutdown_function('shutdown');

exit();
echo
'これは出力されません。';
?>

上の例の出力は以下となります。

Shutdown: shutdown()
 Destruct: Foo::__destruct()

注意

注意: これは、関数ではなく 言語構造のため、可変関数名前付き引数 を用いてコールすることはできません。

注意:

この言語構造は、die() と等価です。

参考

add a note

User Contributed Notes 14 notes

up
38
dexen dot devries at gmail dot com
14 years ago
If you want to avoid calling exit() in FastCGI as per the comments below, but really, positively want to exit cleanly from nested function call or include, consider doing it the Python way:

define an exception named `SystemExit', throw it instead of calling exit() and catch it in index.php with an empty handler to finish script execution cleanly.

<?php

// file: index.php
class SystemExit extends Exception {}
try {
/* code code */
}
catch (
SystemExit $e) { /* do nothing */ }
// end of file: index.php

// some deeply nested function or .php file

if (SOME_EXIT_CONDITION)
throw new
SystemExit(); // instead of exit()

?>
up
35
albert at removethis dot peschar dot net
15 years ago
jbezorg at gmail proposed the following:

<?php

if($_SERVER['SCRIPT_FILENAME'] == __FILE__ )
header('Location: /');

?>

After sending the `Location:' header PHP _will_ continue parsing, and all code below the header() call will still be executed. So instead use:

<?php

if($_SERVER['SCRIPT_FILENAME'] == __FILE__)
{
header('Location: /');
exit;
}

?>
up
18
theonenkl at gmail dot com
9 years ago
A side-note for the use of exit with finally: if you exit somewhere in a try block, the finally won't be executed. Could not sound obvious: for instance in Java you never issue an exit, at least a return in your controller; in PHP instead you could find yourself exiting from a controller method (e.g. in case you issue a redirect).

Here follows the POC:

<?php
echo "testing finally wit exit\n";

try {
echo
"In try, exiting\n";

exit;
} catch(
Exception $e) {
echo
"catched\n";
} finally {
echo
"in finally\n";
}

echo
"In the end\n";
?>

This will print:

testing finally wit exit
In try, exiting
up
2
tianyiw at vip dot qq dot com
2 years ago
These are the standard error codes in Linux or UNIX.

1 - Catchall for general errors
2 - Misuse of shell builtins (according to Bash documentation)
126 - Command invoked cannot execute
127 - “command not found”
128 - Invalid argument to exit
128+n - Fatal error signal “n”
130 - Script terminated by Control-C
255\* - Exit status out of range
up
11
vincent dot laag at gmail dot com
14 years ago
Don't use the exit() function in the auto prepend file with fastcgi (linux/bsd os).
It has the effect of leaving opened files with for result at least a nice "Too many open files ..." error.
up
3
chris at ocproducts dot com
6 years ago
Calling 'exit' will bypass the auto_append_file option.
On some free hosting this risks you getting removed, as they may be using for ads and analytics.

So be a bit careful if using this on the most common output branch.
up
5
emils at tvnet dot lv
21 years ago
Note, that using exit() will explicitly cause Roxen webserver to die, if PHP is used as Roxen SAPI module. There is no known workaround for that, except not to use exit(). CGI versions of PHP are not affected.
up
8
void a t informance d o t info
16 years ago
To rich dot lovely at klikzltd dot co dot uk:

Using a "@" before header() to suppress its error, and relying on the "headers already sent" error seems to me a very bad idea while building any serious website.

This is *not* a clean way to prevent a file from being called directly. At least this is not a secure method, as you rely on the presence of an exception sent by the parser at runtime.

I recommend using a more common way as defining a constant or assigning a variable with any value, and checking for its presence in the included script, like:

in index.php:
<?php
define
('INDEX', true);
?>

in your included file:
<?php
if (!defined('INDEX')) {
die(
'You cannot call this script directly !');
}
?>

BR.

Ninj
up
4
m dot libergolis at gmail dot com
9 years ago
In addition to "void a t informance d o t info", here's a one-liner that requires no constant:

<?php basename($_SERVER['PHP_SELF']) == basename(__FILE__) && die('Thou shall not pass!'); ?>

Placing it at the beginning of a PHP file will prevent direct access to the script.

To redirect to / instead of dying:

<?php
if (basename($_SERVER['PHP_SELF']) == basename(__FILE__)) {
if (
ob_get_contents()) ob_clean(); // ob_get_contents() even works without active output buffering
header('Location: /');
die;
}
?>

Doing the same in a one-liner:

<?php basename($_SERVER['PHP_SELF']) == basename(__FILE__) && (!ob_get_contents() || ob_clean()) && header('Location: /') && die; ?>

A note to security: Even though $_SERVER['PHP_SELF'] comes from the user, it's safe to assume its validity, as the "manipulation" takes place _before_ the actual file execution, meaning that the string _must_ have been valid enough to execute the file. Also, basename() is binary safe, so you can safely rely on this function.
up
2
jean dot claveau at gmail dot com
4 years ago
Beware if you enabled uopz extension, it disables exit / die() by default. They are just "skipped".

https://www.php.net/manual/en/function.uopz-allow-exit.php
up
3
alexyam at live dot com
12 years ago
When using php-fpm, fastcgi_finish_request() should be used instead of register_shutdown_function() and exit()

For example, under nginx and php-fpm 5.3+, this will make browsers wait 10 seconds to show output:

<?php
echo "You have to wait 10 seconds to see this.<br>";
register_shutdown_function('shutdown');
exit;
function
shutdown(){
sleep(10);
echo
"Because exit() doesn't terminate php-fpm calls immediately.<br>";
}
?>

This doesn't:

<?php
echo "You can see this from the browser immediately.<br>";
fastcgi_finish_request();
sleep(10);
echo
"You can't see this form the browser.";
?>
up
3
devinemke at devinemke dot com
22 years ago
If you are using templates with numerous includes then exit() will end you script and your template will not complete (no </table>, </body>, </html> etc...). Rather than having complex nested conditional logic within your content, just create a "footer.php" file that closes all of your HTML and if you want to exit out of a script just include() the footer before you exit().

for example:

include ('header.php');
blah blah blah
if (!$mysql_connect) {
echo "unable to connect";
include ('footer.php');
exit;
}
blah blah blah
include ('footer.php');
up
0
bill dot gates at hotmail dot com
3 years ago
Be noticed about uopz (User Operations for Zend) extension of PHP. It disables (prevents) halting of PHP scripts (both FPM and CLI) on calling `exit()` and `die()` by default just after enabling the extension. Therefore your script will continue to execute.

Details: https://www.php.net/manual/en/uopz.configuration.php#ini.uopz.exit
up
0
sunfundev at gmail dot com
7 years ago
>> Shutdown functions and object destructors will always be executed even if exit is called.

It is false if you call exit into desctructor.

Normal exit:
<?php
class A
{
public function
__destruct()
{
echo
"bye A\n";
}
}

class
B
{
public function
__destruct()
{
echo
"bye B\n";
}
}

$a = new A;
$b = new B;
exit;

// Output:
// bye B
// bye A
?>

// Exit into desctructor:
<?php
class A
{
public function
__destruct()
{
echo
"bye A\n";
}
}

class
B
{
public function
__destruct()
{
echo
"bye B\n";
exit;
}
}

$a = new A;
$b = new B;

// Output:
// bye B
?>
To Top