php8.5
Home/ Manual/ dir / functions/ chroot

chroot

PHP function Edit on GitHub ✎

(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)

Change the root directory

Description

chroot(string $directory): bool

Changes the root directory of the current process to directory, and changes the current working directory to "/".

This function is only available to GNU and BSD systems, and only when using the CLI, CGI or Embed SAPI. Also, this function requires root privileges.

Calling this function does not change the values of the __DIR__ and __FILE__ magic constants.

Parameters

directory

The path to change the root directory to.

Return Values

Success

Examples

chroot() example

php
<?php
chroot("/path/to/your/chroot/");
echo getcwd();
?>

The above example will output:

output
/

Notes No-windows No-zts

Source: reference/dir/functions/chroot.xml · from the official PHP manual (php/doc-en)