Skip to content

docs: clarify available operations for beforeOperation hook #14774

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

Open
wensleyio wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: clarify available operations for beforeOperation hook #14774

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7d1d30
docs: clarify available operations for beforeOperation hook in collec…
davidmv Dec 1, 2025
46d02f5
docs: remove redundant operation listings from beforeOperation and af…
davidmv Dec 1, 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
14 changes: 8 additions & 6 deletions docs/hooks/collections.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ export const CollectionWithHooks: CollectionConfig = {

The `beforeOperation` hook can be used to modify the arguments that operations accept or execute side-effects that run before an operation begins.

Available Collection operations include `create`, `find`, `findByID`, `update`, `updateByID`, `delete`, `deleteByID`, `login`, `refresh`, and `forgotPassword`.
Copy link
Contributor

@JarrodMFlesch JarrodMFlesch Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It feels like this could be removed completely.

Copy link
Author

@wensleyio wensleyio Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found it useful, but agree since I could have just checked the type it isn't required. Probably remove it from afterOperation also.


```ts
import type { CollectionBeforeOperationHook } from 'payload'

Expand All @@ -81,12 +83,12 @@ const beforeOperationHook: CollectionBeforeOperationHook = async ({

The following arguments are provided to the `beforeOperation` hook:

| Option | Description |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`collection`** | The [Collection](../configuration/collections) in which this Hook is running against. Available options include: `autosave`, `count`, `countVersions`, `create`, `delete`, `forgotPassword`, `login`, `read`, `readDistinct`, `refresh`, `resetPassword`, `restoreVersion`, and `update`. |
| **`context`** | Custom context passed between Hooks. [More details](./context). |
| **`operation`** | The name of the operation that this hook is running within. |
| **`req`** | The [Web Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object. This is mocked for [Local API](../local-api/overview) operations. |
| Option | Description |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------|
| **`collection`** | The [Collection](../configuration/collections) in which this Hook is running against. |
| **`context`** | Custom context passed between Hooks. [More details](./context). |
| **`operation`** | The name of the operation that this hook is running within. |
| **`req`** | The [Web Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object. This is mocked for [Local API](../local-api/overview) operations. |

### beforeValidate

Expand Down