PHP - Manual: get_included_files

2024-11-14

get_loaded_extensions »

« get_include_path

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

注释

注意:
使用 auto_prepend_file 配置指令所包含的文件不会包含在返回的数组里。

参见

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

add a note

User Contributed Notes 7 notes

down

keystorm :at: gmail dotcom ¶

17 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.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.

down

yarco dot w at gmail dot com ¶

14 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:
<?php
function 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 ¶

2 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 ¶

16 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.php

As 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 ¶

10 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 ¶

4 months ago


This is a great way to emulate Python's '__name__ = "__main__"'

<?php
  if(get_included_files()[0] === __FILE__) doStuff();
?>

down

-15

indigohaze at gmail dot com ¶

15 years ago


Something that's not noted in the docs, if a file is included remotely and you do a get_included_files() in the include itself it will *not* return the document that included it.

ie:
test2.php (server 192.168.1.14):
<?php

include("http://192.168.1.11/test/test3.php");

?>

test3.php (server 192.168.1.11):

<?php

$files = get_included_files();

print_r($files);
?>

returns:

Array ( [0] => /var/www/localhost/htdocs/test/test3.php ) 

Which means you can use get_included_files() to help intercept and prevent XSS-style attacks against your code.

add a note

官方地址：https://www.php.net/manual/en/function.get-included-files.php

有任何技术问题请点击这里网站运营推广招聘

IT PHP 编程语言 Linux 开发编程科技 Elasticsearch HTML/CSS/XML 网络 JAVA NoSQL 数据库面试 C/C++ Golang Git 算法操作系统正则表达式 Redis 互联网 MySql JavaScript 运维软件国际架构设计 Mac OS TCP/IP Excel Vim Windows Socket Oracle VR MongoDB Python 运营 MemCache 商业硬件电子娱乐设计 nginx 摄影游戏 WordPress HTTP 团建数码电器

php7 安装fileinfo扩展 preg_split — 通过一个正则表达式分隔字符串 php位值,解决 PHP 中 usort 在值相同时改变原始位置的问题 [PHP] inet_pton/inet_ntop IP地址转换函数 array_multisort() 多字段排序 PHPMailer设置utf8 PHPMailer字符集CharSet ADORecordSet对象 adodb手册 PHP 8.1 [鸟哥]PHP_INT_MIN 和 -9223372036854775808 opcache预加载 Composer的Packagist资源 mysql面试题 [鸟哥]PHP FFI详解 - 一种全新的PHP扩展方式 PHP7添加redis扩展 PHP mkdir()写出来的权限与mode值不符合 Packagist / Composer 中国全量镜像 php中几种注释规范利用php soap实现web service PHP获取指定函数定义在哪个文件中及行号

略微加速

PHP官方手册 - 互联网笔记

get_included_files

说明

返回值

范例

注释

参见

User Contributed Notes 7 notes