PHP’s Magic Constants: __LINE__ , __FILE__, __FUNCTION__, __CLASS__, and __METHOD__
Setting constants in PHP is as easy as using the define function, but PHP creates a few constants in every script for you that help mostly for debugging purposes (well, that's generally the only time I use them). These constants are called "magic constants."
Magic constants have a funny syntax, placing two underscores before and after the constant's word representation. These are PHP's magic constants:
__LINE__
__FILE__
__FUNCTION__
__CLASS__
__METHOD__
You can imagine how helpful these constants are for debugging...but if you can't:
if($sugar == '') { echo('$sugar has no value on line '.__LINE__.' of ['.__FILE__.']'); }
There are also helpful uses for these magic constants:
dirname(__FILE__) // get the directory name of the current script
What do you use them for?
![Page Visibility API]()
One event that's always been lacking within the document is a signal for when the user is looking at a given tab, or another tab. When does the user switch off our site to look at something else? When do they come back?
![CSS @supports]()
Feature detection via JavaScript is a client side best practice and for all the right reasons, but unfortunately that same functionality hasn't been available within CSS. What we end up doing is repeating the same properties multiple times with each browser prefix. Yuck. Another thing we...
![Editable Content Using MooTools 1.2, PHP, and MySQL]()
Everybody and their aerobics instructor wants to be able to edit their own website these days. And why wouldn't they? I mean, they have a $500 budget, no HTML/CSS experience, and extraordinary expectations. Enough ranting though. Having a website that allows for...
![CSS Animations Between Media Queries]()
CSS animations are right up there with sliced bread. CSS animations are efficient because they can be hardware accelerated, they require no JavaScript overhead, and they are composed of very little CSS code. Quite often we add CSS transforms to elements via CSS during...
My two favorite are
That you can use it to get parent directory:
or you can include the init.php file from anywhere in your filesystem:
You would use
in the init.php
Wow, awesome usage of the __FILE__ magic constant — I hadn’t thought of that one!
Useful!
To Jesus DeLaTorre:
Maybe it could be better, when you use this:
$dir = str_replace ( “\”, “/”, dirname ( _FILE_ ) )
-> for Windows based systems
(PS: nice book engine)
thanks for this, i knew only __FILE__ so i googled this article :)
@jeezaa:
Instead of
/for linux and\for windows, just use another constant:omg @ the comments
realpath(dirname(__FILE__)) or
__DIR__ or
realpath(dirname(__FILE__).’/..’).’/file.bla’
is there any way to get the constants defined in a php file using
define()?
Yes there is. The function get_defined_constants() shows you all of the defined constants see: http://www.php.net/manual/en/function.get-defined-constants.php.
I have never seen the use of __FUNCTION__
Can give me any Example.
I make it a habit to wrap these magic constants into SQL and PL/SQL blocks so that I can quickly trace the construction of queries and DML to the source.
There’s also the
__NAMESPACE__constant, e.g.namespace hyperdrive; add_action('wp_head', __NAMESPACE__ .'\engage');