PHP: get_included_files

Description

array get_included_files ( void )

Returns an array of the names of all files that have been included using include(), include_once(), require() or require_once().

The script originally called is considered an "included file," so it will be listed together with the files referenced by include() and family.

Files that are included or required multiple times only show up once in the returned array.

Note: Files included using the auto_prepend_file configuration directive are not included in the returned array.

Example 1. get_included_files() example (abc.php)

<?php include 'test1.php'; include_once 'test2.php'; require 'test3.php'; require_once 'test4.php'; $included_files = get_included_files(); foreach ($included_files as $filename) { echo "$filename\n"; } ?>
will generate the following output:
abc.php test1.php test2.php test3.php test4.php

Note: In PHP 4.0.1pl2 and previous versions get_included_files() assumed that the required files ended in the extension .php; other extensions would not be returned. The array returned by get_included_files() was an associative array and only listed files included by include() and include_once().

User Contributed Notes
get_included_files

keystorm :at: gmail dotcom
07-Sep-2004 04:08


As of PHP5, this function seems to return an array with the first index being the script all subsequent scripts are included to.

If index.php includes b.php and c.php and calls get_included_files(), the returned array looks as follows:



index.php

a.php

b.php



while in PHP<5 the array would be:



a.php

b.php



If you want to know which is the script that is including current script you can use $_SERVER['SCRIPT_FILENAME'] or any other similar server global.



If you also want to ensure current script is being included and not run independently you should evaluate following expression:



__FILE__ != $_SERVER['SCRIPT_FILENAME']



If this expression returns TRUE, current script is being included or required.

php at bronosky dot com
02-Jun-2004 07:46


Just FYI, the given example will return this ONLY if executed from the filesystem root:

abc.php

test1.php

test2.php

test3.php

test4.php



What makes this function useful is that it actually returns the complete path of each file.  Like this:

/path/including/document_root/to/abc.php

/path/including/document_root/to/test1.php

/path/including/document_root/to/test2.php

/path/including/document_root/to/test3.php

/path/including/document_root/to/test4.php

search for in the