require_once
Since I like to reuse a lot of code it came handy to me to begin some sort of library that I stored in a subdir
e.g. "lib"
The only thing that bothered me for some time was that although everything worked all IDEs reported during editing
these useless warnings "file not found" when library files included other library files, since my path were given all relative to the corresponding document-root.
Here is a short workaround that makes that gone:
<?php
// Change to your path
if(strpos(__FILE__,'/lib/') != FALSE){
chdir("..");
}
include_once ('./lib/other_lib.inc');
// ... or any other include[_once] / require[_once]
?>
just adjust the path and it will be fine - also for your IDE.
greetings
include_once
(PHP 4, PHP 5)
The include_once statement includes and evaluates the specified file during the execution of the script. This is a behavior similar to the include statement, with the only difference being that if the code from a file has already been included, it will not be included again. As the name suggests, it will be included just once.
include_once may be used in cases where the same file might be included and evaluated more than once during a particular execution of a script, so in this case it may help avoid problems such as function redefinitions, variable value reassignments, etc.
See the include documentation for information about how this function works.
Nota:
With PHP 4, _once functionality differs with case-insensitive operating systems (like Windows) so for example:
Exemplo #1 include_once with a case insensitive OS in PHP 4
<?php
include_once "a.php"; // this will include a.php
include_once "A.php"; // this will include a.php again! (PHP 4 only)
?>This behaviour changed in PHP 5, so for example with Windows the path is normalized first so that C:\PROGRA~1\A.php is realized the same as C:\Program Files\a.php and the file is included just once.
add a note
User Contributed Notes
include_once - [13 notes]
webmaster AT domaene - kempten DOT de ¶
6 years ago
emanuele at rogledi dot com ¶
4 years ago
For include_once a file in every paths of application we can do simply this
include_once($_SERVER["DOCUMENT_ROOT"] . "mypath/my2ndpath/myfile.php");
Kamil Pawelkiewicz ¶
6 months ago
PHP can distinguish if file is a symlink while including.
I've created example.php file containing code below:
<?php
print __FILE__.' included';
?>
Then I've created symlink to example.php in the same directory.
Executing this code in the working directory:
<?php
include_once 'example.php';
include_once 'symlink';
?>
prints only 'example.php included' instead of 2 lines.
Pure-PHP ¶
8 years ago
Inlude_once can slower your app, if you include to many files.
You cann use this wrapper class, it is faster than include_once
http://www.pure-php.de/node/19
include_once("includeWrapper.class.php")
includeWrapper::includeOnce("Class1.class.php");
includeWrapper::requireOnce("Class1.class.php");
includeWrapper::includeOnce("Class2.class.php")
bioster at peri dot csclub dot uwaterloo dot ca ¶
8 years ago
Something to be wary of: When you use include_once and the data that you include falls out of scope, if you use include_once again later it will not include despite the fact that what you included is no longer available.
So you should be wary of using include_once inside functions.
falmeida1988 (email from google.) ¶
1 month ago
I would like to point out that (for both include_once and require_once), if you're using these to load code, (i.e. you require/include a file that only returns data), this function will return the data for the first time but only return true for all subsequent times.
neil at holcomb dot com ¶
4 years ago
Using include_once() in the __autoload() function is redundant. __autoload() is only called when php can't find your class definition. If your file containg your class was already included, the class defenition would already be loaded and __autoload() would not be called. So save a little overhead and only use include() within __autoload()
Neil Holcomb
roach dot scott+spam at googlemail dot com ¶
4 years ago
If you include a file that does not exist with include_once, the return result will be false.
If you try to include that same file again with include_once the return value will be true.
Example:
<?php
var_dump(include_once 'fakefile.ext'); // bool(false)
var_dump(include_once 'fakefile.ext'); // bool(true)
?>
This is because according to php the file was already included once (even though it does not exist).
php at metagg dot com ¶
5 years ago
If you are like me and make heavy use of the __autoload magic function, always set include paths so you can just instantiate your class, and have multiple locations and name schemes for your custom libraries then you might be frustrated by simple parse errors being supressed when using @include_once('lib.php').
The solution I came up with was:
define('IN_PRODUCTION_ENV',FALSE);
function __autoload($class){
$paths = array();
$paths[] = "{$class}_lib.php";
$paths[] = "{$class}_inc.php";
$paths[] = "{$class}.php";
if(IN_PRODUCTION_ENV){
foreach($paths as &$path){
if((@include_once $path) !== false){ return; }//if
}//foreach
}else{
// we are not in a production environment so we want to see all errors...
$include_paths = explode(PATH_SEPARATOR,get_include_path());
foreach($include_paths as $include_path){
// go through each of the different class names...
foreach($paths as $path){
// attach each class name to the include path...
$include_file = $include_path.$path;
if(file_exists($include_file)){
if((include_once $include_file) !== false){ return; }//if
}//if
}//foreach
}//foreach
}//if/else
trigger_error("{$class} was not found",E_USER_ERROR);
}//method
Now, just make sure you define IN_PRODUCTION_ENV to true or false to get either the slower (with all parse errors shown) or the faster (just suppress everything) autoloading. Hope this helps someone else since it was annoying just having blank screens show up when I had a simple parse error. Thanks to flobee at gmail dot com for providing me with the epiphany on why pages were showing up blank...-Metagg
Anonymous ¶
7 years ago
Dealing with function redefinitions
include_once and require_once are very useful if you have a library of common functions. If you try to override with - that is define - an identically named local function however, PHP will halt noting that it cannot redeclare functions. You can allow for this by bracketing (within the include file):
function myUsefulFunc($arg1, $arg2) {
... }
with
if (!function_exists('myUsefulFunc')) {
function myUsefulFunc($arg1, $arg2) {
... }}
Top level functions (ie. those not defined within other functions or dependent on code running) in the local file are always parsed first, so http://php.net/function_exists within the included/required file is safe - it doesn't matter where the include statements are in the local code.
Csaba Gabor from Vienna
flobee at gmail dot com ¶
7 years ago
i already had a discussion with several people about "not shown errors"
error reporting and all others in php.ini set to: "show errors" to find problems:
the answer i finally found:
if you have an "@include..." instead of "include..." or "require..('somthing') in any place in your code
all following errors are not shown too!!!
so, this is actually a bad idea when developing because paser errors will be droped too:
<?php
if(!@include_once('./somthing') ) {
echo 'can not include';
}
?>
solution:
<?php
if(!@file_exists('./somthing') ) {
echo 'can not include';
} else {
include('./something');
}
?>
Frankbrennanfilms at yahoo dot com ¶
2 years ago
Need some help please. I keep getting this error:
can not include
Fatal error: Cannot redeclare get_postdata()
Here's the solution I was told to put in, but it's not working
<?php
if(!@file_exists('deprecated.php') ) {
echo 'can not include';
} else {
include('deprecated.php');
}
* @package WordPress
* @subpackage Deprecated
*/
nospam at freeproxylist dot org ¶
4 years ago
I would like to share one very useful tip with include_* statements. For example we have two classes first.class.php and second.class.php both located in the same directory (./classes) and first one uses the second one. So we have:
first.class.php
<?php
include_once './second.class.php';
...
?>
also we have file which uses first.class.php:
<?php
include_once './classes/first.class.php';
...
?>
if you will try to execute your script you will get error. Reason: the current directory is different and the relative path in first.class.php (./second.class.php) will be incorrect.
Here is two possible solution I have found:
<?php
include_once dirname(__FILE__).'/second.class.php';
...
?>
or
<?php
chdir(dirname(__FILE__));
include_once './second.class.php';
...
?>
Hope that tip will be useful for some other software developer
Admin of http://FreeProxyList.org