Skip to content

require/import vs require/include in PHP Coding Standards Documentation. - Fix for #143 #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dingo-d merged 10 commits into from
Mar 27, 2025
Merged

require/import vs require/include in PHP Coding Standards Documentation. - Fix for #143 #144

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9529fde
Update php.md
apermo Sep 10, 2024
eccc5b6
Update php.md
apermo Sep 10, 2024
5508008
Update php.md
apermo Sep 10, 2024
9c97d9b
Update php.md
apermo Sep 11, 2024
c9ea3ca
Update php.md
apermo Sep 13, 2024
e520d9e
Update php.md
apermo Sep 23, 2024
5d9cd35
Update wordpress-coding-standards/php.md
apermo Mar 26, 2025
754aca9
Merge branch 'WordPress:master' into master
apermo Mar 26, 2025
4e23a9f
Applied code review from jrfnl
apermo Mar 26, 2025
d9fb11e
Update wordpress-coding-standards/php.md
apermo Mar 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update php.md 
Switched from alphabetical order, to recommendation order.
  • Loading branch information
@apermo
apermo authored Sep 23, 2024
commit e520d9e02f1761b3ade93c5f0753882335fa5775
8 changes: 4 additions & 4 deletions wordpress-coding-standards/php.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,11 @@ echo "<a href='{$escaped_link}'>text with a ' single quote</a>";

Text that goes into HTML or XML attributes should be escaped so that single or double quotes do not end the attribute value and invalidate the HTML, causing a security issue. See [Data Validation](https://developer.wordpress.org/plugins/security/data-validation/) in the Plugin Handbook for further details.

### Writing include/require statements
### Writing require/include statements

Because `include[_once]` and `require[_once]` are language constructs, they do not need parentheses around the path, so those shouldn't be used. There should only be one space between the path and the include/require keywords.
Because `require[_once]` and `include[_once]` are language constructs, they do not need parentheses around the path, so those shouldn't be used. There should only be one space between the path and the require/include keywords.

It is _strongly recommended_ to use `require[_once]` for unconditional includes. When using `include[_once]`, PHP will throw a warning when the file is not found but will continue execution, which will almost certainly lead to other errors/warnings/notices being thrown if your application depends on the file loaded, potentially leading to security leaks. For that reason, `require[_once]` is generally the better choice as it will throw a `Fatal Error` if the file cannot be found.
It is _strongly recommended_ to use `require[_once]` for unconditional includes. When using `include[_once]`, PHP will throw a warning when the file is not found but will continue execution, which will almost certainly lead to other errors/warnings/notices being thrown if your application depends on the file loaded, potentially leading to security leaks, or result in silent malfunctions which are hard to track down. For that reason, `require[_once]` is generally the better choice as it will throw a `Fatal Error` if the file cannot be found.

```php
// Correct.
Expand Down Expand Up @@ -605,7 +605,7 @@ Group `use` statements are available from PHP 7.0, and trailing commas in group
[/alert]

[info]
Note that, unless you have implemented [autoloading](https://www.php.net/manual/en/language.oop5.autoload.php), the `use` statement won't automatically load referenced classes. You'll either need to set up autoloading or load the file containing the class using `include[_once]` or `require[_once]` statement, for the imported classes to be loaded when used. Autoloading is only applicable to classes; for functions and constants, you must always use `include[_once]` or `require[_once]`.
Note that, unless you have implemented [autoloading](https://www.php.net/manual/en/language.oop5.autoload.php), the `use` statement won't automatically load referenced classes. You'll either need to set up autoloading or load the file containing the class using `require[_once]` or `include[_once]` statement, for the imported classes to be loaded when used. Autoloading is only applicable to classes; for functions and constants, you must always use `require[_once]` or `include[_once]`.
[/info]

**Note about WordPress Core usage**
Expand Down