Skip to content

[docs] Document the recommended use of the Override attribute in PHP #1567

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
ferranrecio merged 1 commit into from
Apr 16, 2026
Merged

[docs] Document the recommended use of the Override attribute in PHP #1567

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 18 additions & 1 deletion general/development/policies/codingstyle/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,23 @@ In the case of legacy functions (those not placed in classes), names should star

Verbosity is encouraged: function names should be as illustrative as is practical to enhance understanding.

:::tip[Overriding parent methods]

When writing a method which overrides a method in a parent Class, Interface, or Trait, it is strongly recommended that the `#[\Override]` attribute be used, for example:
Comment thread
ferranrecio marked this conversation as resolved.

```php title="Example of a method which overrides a third-party method"
class example extends \Some\Vendor\ExampleClass {
#[\Override]
public function makeRequest(): void {
// ...
}
}
```

In Moodle's coding standard, this attribute is also used by PHPCS rules as a signal that the method is a genuine override, so some sniffs relating to documentation and to the naming of the overridden method and its parameters are not applied.

:::

The uses of type hints and return type declarations is required in PHP in all possible locations for all new code. There will be necessary exclusions, such as code extending existing non-compliant code and implementing things where it is not available. Progressive approach will be applied.

:::note
Expand All @@ -286,7 +303,7 @@ function report_participation_get_overviews(string $action, ?int userid): ?array

</ValidExample>

There is an exception for [activity modules](/docs/apis/plugintypes/mod) modules|activity modules]] that still use only plugin name as the prefix for legacy reasons.
There is an exception for [activity modules](/docs/apis/plugintypes/mod) that still use only plugin name as the prefix for legacy reasons.

<ValidExample>

Expand Down
Loading