Skip to content

require

The PHP "require" Keyword: A Comprehensive Guide

In PHP, the require keyword is used to include and evaluate external PHP files within your code. This guide covers its syntax, best practices, and key differences from similar functions.

Syntax

The require keyword is used in PHP to include and evaluate an external PHP file. Here is the basic syntax for using the require keyword:

The PHP syntax of REQUIRE

php
require __DIR__ . '/path/to/file.php';

In this example, we use the require keyword to include and evaluate the contents of the file located at the specified path. Using __DIR__ ensures the path is resolved relative to the current script, preventing issues when the script is executed from different directories.

Examples

Let's look at some practical examples of how the require keyword can be used:

Examples of PHP require

php
<?php

// Example 1
require __DIR__ . '/config.php';

// Example 2
function myFunction()
{
  require __DIR__ . '/helpers.php';
  // Code block here
}

These examples demonstrate including configuration files and loading helpers inside functions.

Error Handling and require_once Unlike include, which only issues a warning when a file is missing, require triggers a fatal error (E_COMPILE_ERROR) and stops script execution. This makes it ideal for critical files like configuration or database connections. If a file should only be included once to prevent duplicate function or class declarations, use require_once instead.

Benefits

Using the require keyword has several benefits, including:

  • Code reuse: By including external PHP files with require, you can reuse code across multiple files and projects, saving time and effort.
  • Improved code organization: Separating your code into distinct files and loading them with require enhances readability and maintainability.

Conclusion

In summary, require is a reliable tool for loading external PHP files. By using __DIR__ for paths and understanding its fatal error behavior, you can build more robust and organized PHP applications. We hope this guide helps you master this essential feature.

Practice

What happens when the required file is not found in PHP?

Dual-run preview — compare with live Symfony routes.