get_included_files

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

get_included_files — 返回被 include 和 require 文件名的 array

说明

get_included_files(): array

返回所有被 include、 include_once、 require 和 require_once 的文件名。

参数

此函数没有参数。

返回值

返回所有文件名称的 array。

脚本最初被称为”被包含的文件“，所以脚本自身也会和 include 系列函数引用的脚本列在一起。

被多次 include 和 require 的文件在返回的 array 里只会列出一次。

示例

示例 #1 get_included_files() 示例

<?php
// 本文件是 abc.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";
}

?>

以上示例会输出：

/path/to/abc.php
/path/to/test1.php
/path/to/test2.php
/path/to/test3.php
/path/to/test4.php

参见

include - include
include_once - include_once
require - require
require_once - require_once
get_required_files() - 别名 get_included_files

发现了问题？

了解如何改进此页面 • 提交拉取请求 • 报告一个错误

＋添加备注

用户贡献的备注 6 notes

down

keystorm :at: gmail dotcom ¶

20 years ago

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.phpa.phpb.phpwhile in PHP<5 the array would be:a.phpb.phpIf 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.

down

yarco dot w at gmail dot com ¶

18 years ago

If you have a MAIN php script which you don't want to be included by other scripts, you could use this function. For example:main.php:<?phpfunction blockit(){  $buf = get_included_files();  return $buf[0] != __FILE__;}blockit() and exit("You can not include a MAIN file as a part of your script.");print "OK";?>So other script couldn't include main.php to modify its internal global vars.

down

D ¶

5 years ago

It's perhaps not clear from the existing docs that the returned list contains nested include files as well.That is, if A.php includes B.php, and B.php includes C.php, the result returned when calling get_included_files() from inside A.php WILL contain 'C.php'.

down

RPaseur at NationalPres dot org ¶

19 years ago

As is often the case, YMMV.  I tried the __FILE__ and SCRIPT_FILENAME comparison and found this:SCRIPT_FILENAME: /var/www/cgi-bin/php441__FILE__: /raid/home/natpresch/natpresch/RAY_included.phpAs an alternative:count(get_included_files()); Gives one when the script is standalone and always more than one when the script is included.

down

donikuntoro at integraasp dot com ¶

13 years ago

This function aims to perform filtering of files that have been included :

<?php
function setIncludeFiles($arrayInc = array()){
    $incFiles = get_included_files();
    if((count($arrayInc)>0)&&(count($incFiles)>0)){
        $aInt = array_intersect($arrayInc,$incFiles);
        if(count($aInt)>0){
            return false;
       }elseif(count($aInt)<1) {
        foreach($arrayInc as $inc){
            if(is_file($inc))
                include($inc);
            else{
                return false;
            }
        }
       }    
    }else{
        return false;
    }
}
?>

Usage :

<?php
$toBeInclude = array('/data/your_include_files_1.php',
'/data/your_include_files_2.php',
'/data/your_include_files_3.php',
);
setIncludeFiles($toBeInclude);
?>

Return false if something goes wrong.

down

Aurelien Marchand ¶

3 years ago

This is a great way to emulate Python's '__name__ = "__main__"'<?php  if(get_included_files()[0] === __FILE__) doStuff();?>