php8.5
Home/ Manual/ stream / functions/ stream_isatty

stream_isatty

PHP function Edit on GitHub ✎

(PHP 7 >= 7.2.0, PHP 8)

Check if a stream is a TTY

Description

stream_isatty(resource $stream): bool

Determines if stream stream refers to a valid terminal type device. This is a more portable version of posix_isatty(), since it works on Windows systems too.

Parameters

stream

Return Values

Success

Examples

stream_isatty() example

This command can be used to determine if a standard output / standard error stream is redirected to a file.

sh
     php -r "var_export(stream_isatty(STDERR));"
    

The above example will output something similar to:

output
     true
    
sh
     php -r "var_export(stream_isatty(STDERR));" 2>output.txt
    

The above example will output something similar to:

output
     false
    

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