English
English
In development, it is often necessary to get the parent directory path of a file, particularly in scenarios involving file operations and path handling. Knowing how to conveniently and quickly retrieve the parent directory of a file is especially important. PHP provides a very simple yet practical function — dirname() — to obtain the parent directory path of a file. This article will give a detailed explanation of the usage and common applications of the dirname() function.
dirname() is a built-in PHP function used to get the parent directory path of a file. This function returns the directory portion of a given path, commonly used to extract the folder where a file is located from a full path.
Function syntax:
<span><span><span class="hljs-title function_ invoke__">dirname</span></span><span>(</span><span><span class="hljs-keyword">string</span></span><span> </span><span><span class="hljs-variable">$path</span></span><span>, </span><span><span class="hljs-keyword">int</span></span><span> </span><span><span class="hljs-variable">$levels</span></span><span> = </span><span><span class="hljs-number">1</span></span><span>): </span><span><span class="hljs-keyword">string</span></span>
</span></span>$path: Required, represents the full file path.
$levels: Optional, specifies how many levels of parent directories to return; default is 1. If the value of $levels is 2, it returns the parent of the parent directory, and so on.
The most common use case is to get the immediate parent directory of a file. Suppose there is a file path /var/www/html/index.php. We can easily get its parent directory /var/www/html using the dirname() function.
Example code:
<span><span><span class="hljs-variable">$file_path</span></span><span> = </span><span><span class="hljs-string">'/var/www/html/index.php'</span></span><span>;
</span><span><span class="hljs-variable">$parent_dir</span></span><span> = </span><span><span class="hljs-title function_ invoke__">dirname</span></span><span>(</span><span><span class="hljs-variable">$file_path</span></span><span>);
</span><span><span class="hljs-keyword">echo</span></span><span> </span><span><span class="hljs-variable">$parent_dir</span></span><span>; </span><span><span class="hljs-comment">// Output: /var/www/html</span></span><span>
</span></span>In the above code, dirname() returns the parent directory path /var/www/html of the file index.php.
Sometimes, we need to get directories higher up the tree. By setting the $levels parameter, we can control the number of parent directory levels returned. For example, get the parent directory of the parent directory of index.php.
Example code:
<span><span><span class="hljs-variable">$file_path</span></span><span> = </span><span><span class="hljs-string">'/var/www/html/index.php'</span></span><span>;
</span><span><span class="hljs-variable">$parent_dir_level2</span></span><span> = </span><span><span class="hljs-title function_ invoke__">dirname</span></span><span>(</span><span><span class="hljs-variable">$file_path</span></span><span>, </span><span><span class="hljs-number">2</span></span><span>);
</span><span><span class="hljs-keyword">echo</span></span><span> </span><span><span class="hljs-variable">$parent_dir_level2</span></span><span>; </span><span><span class="hljs-comment">// Output: /var/www</span></span><span>
</span></span>In this example, dirname($file_path, 2) returns /var/www, which is the parent directory of the parent directory of the file.
In some cases, we want to get the directory path of the current PHP script, especially when including files or performing path calculations. By combining the __FILE__ constant and the dirname() function, we can achieve this.
Example code:
<span><span><span class="hljs-variable">$current_file</span></span><span> = </span><span><span class="hljs-keyword">__FILE__</span></span><span>;
</span><span><span class="hljs-variable">$parent_dir</span></span><span> = </span><span><span class="hljs-title function_ invoke__">dirname</span></span><span>(</span><span><span class="hljs-variable">$current_file</span></span><span>);
</span><span><span class="hljs-keyword">echo</span></span><span> </span><span><span class="hljs-variable">$parent_dir</span></span><span>;
</span></span>__FILE__ returns the absolute path of the current script, which combined with dirname() gives the parent directory path of the current script.
dirname() is often used together with other path operation functions, especially when constructing relative paths or working with the file system. By extracting the parent directory with dirname() and then appending other file or directory names, we can easily manage file paths.
Example code:
<span><span><span class="hljs-variable">$file_path</span></span><span> = </span><span><span class="hljs-string">'/var/www/html/index.php'</span></span><span>;
</span><span><span class="hljs-variable">$parent_dir</span></span><span> = </span><span><span class="hljs-title function_ invoke__">dirname</span></span><span>(</span><span><span class="hljs-variable">$file_path</span></span><span>);
</span><span><span class="hljs-variable">$full_path</span></span><span> = </span><span><span class="hljs-variable">$parent_dir</span></span><span> . </span><span><span class="hljs-string">'/assets/style.css'</span></span>;
</span><span><span class="hljs-keyword">echo</span></span><span> </span><span><span class="hljs-variable">$full_path</span></span><span>; </span><span><span class="hljs-comment">// Output: /var/www/html/assets/style.css</span></span><span>
</span></span>Here, we use dirname() to get the parent directory of index.php, then append a subdirectory file path, generating a new file path.
The dirname() function is very sensitive to whether the path ends with a slash. If the path ends with a slash, it automatically removes it. For example, dirname('/var/www/html/') returns /var/www.
Be cautious about path case sensitivity when using dirname(), especially when porting between Linux and Windows systems.
If the path is invalid or does not exist, dirname() will still return a valid parent directory path, but this may not be an actually existing directory.
dirname() is a simple yet very practical PHP function that helps developers quickly obtain the parent directory path of a file. By using this function properly, it becomes easy to handle file paths, improving code maintainability and portability. Whether dynamically obtaining the current script’s directory or managing multi-level directory structures, dirname() is a tool worth mastering.
