Why would I use dirname(__FILE__) in an include or include_once statement?

by

Let’s say I have a (fake) directory structure like:

.../root/
        /app
            bootstrap.php
        /scripts
            something/
                somescript.php
        /public
            index.php

Now assume that bootstrap.php has some code included for setting up database connections or some other kind of boostrapping stuff.

Assume you want to include a file in boostrap.php‘s folder called init.php. Now, to avoid scanning the entire include path with include 'init.php', you could use include './init.php'.

There’s a problem though. That ./ will be relative to the script that included bootstrap.php, not bootstrap.php. (Technically speaking, it will be relative to the working directory.)

dirname(__FILE__) allows you to get an absolute path (and thus avoid an include path search) without relying on the working directory being the directory in which bootstrap.php resides.

(Note: since PHP 5.3, you can use __DIR__ in place of dirname(__FILE__).)

Now, why not just use include 'init.php';?

As odd as it is at first though, . is not guaranteed to be in the include path. Sometimes to avoid useless stat()‘s people remove it from the include path when they are rarely include files in the same directory (why search the current directory when you know includes are never going to be there?).

Note: About half of this answer is address in a rather old post: What’s better of require(dirname(__FILE__).’/’.’myParent.php’) than just require(‘myParent.php’)?

More Related Contents:

  1. how to use json_encode for my output?
  2. Extracting data from Json in Php
  3. regular expression [closed]
  4. How to log IP address in text file
  5. Displaying HTML with Blade shows the HTML code
  6. Why is require_once so bad to use?
  7. array_splice() for associative arrays
  8. Matching a space in regex
  9. Can PHP namespaces contain variables?
  10. How do I convert output of number_format back to numbers in PHP?
  11. Why can’t PHP create a directory with 777 permissions?
  12. PHP function to delete all between certain character(s) in string
  13. When setting environment variables in Apache RewriteRule directives, what causes the variable name to be prefixed with “REDIRECT_”?
  14. Rerouting all php requests through index.php
  15. How do you pull first 100 characters of a string in PHP
  16. PHP Array Syntax Parse Error Left Square Bracket “[” [closed]
  17. double results in my array ( mysql_fetch_array )
  18. How to decode a JSON String
  19. How to convert all images to JPG format in PHP?
  20. Post to another page within a PHP script
  21. Laravel – Using (:any?) wildcard for ALL routes?
  22. php string function to get substring before the last occurrence of a character
  23. Save PHP variables to a text file
  24. Difference between break and continue in PHP?
  25. Difference between Eloquent\Model::get() and all()
  26. How to Check for a Specific Type of Object in PHP
  27. Is there any way to test PHP locally without installing a server?
  28. Getting first weekday in a month with strtotime
  29. Escape HTML to PHP or Use Echo? Which is better?
  30. How do I detect non-ASCII characters in a string?

Leave a Comment