PHP | popen( ) Function

The popen() function used to open a pipe to the program specified by the user using the command parameter. It returns a file pointer which is identical to that returned by fopen(), but it is unidirectional in nature i.e it can be only used for reading or writing. The popen() pointer can be used with fgets(), fgetss(), and fwrite(). The file pointer initiated by the popen() function must be closed with pclose().
The command and the mode are sent as parameters to the popen() function and it returns a unidirectional file pointer on success or FALSE on failure.

Syntax:

popen(command, mode)

Parameters Used:
The popen() function in PHP accepts two parameters.



  1. command : It is a mandatory parameter which specifies the command to be executed.
  2. mode : It is a mandatory parameter which specifies the connection mode such as read only(r) or write only(w).

Return Value:
It returns a file pointer which is identical to that returned by fopen(), but it is unidirectional in nature.

Errors And Exceptions:

  1. The file pointer initiated by the popen() function must be closed with pclose().
  2. If the command to be executed could not be found, then the popen() function returns a valid resource.

Examples:

Input : $my_file= popen("/bin/ls", "r");
Output : 1

Input : $my_file= popen('/executable/gfg.exe', 'r');
        echo "'my_file'; " . get_class($my_handle) . "\n";
        $file_read = fread($my_file, 4192);
        echo $file_read;
        pclose($my_file);
Output : 1

Below programs illustrate the popen() function.

Program 1

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
  
// opening a pipe 
$my_file= popen("/bin/ls", "r");
?>

chevron_right


Output:

1

Program 2

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php 
// opening a pipe
$my_file= popen('/executable/gfg.exe', 'r');
  
// returning name of class of an object using get_class()
  echo "'$my_file'; " . get_class($my_file) . "\n";
  
// reading file using fread()
$filereader = fread($my_file, 4192);
   echo $filereader;
  
// closing the pipe
pclose($my_file);
?>

chevron_right


Output:

1

Related Article: PHP | pclose( ) Function

Reference:
http://php.net/manual/en/function.popen.php



My Personal Notes arrow_drop_up

I am a technology enthusiast who has a keen interest in programming I am pursuing Engineering in Computer Science from GEU, Dehradun I like to unwind by watching movies and English sitcomsI have a keen interest in music

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.