Skip to content

docs: name the third Transition parameter as the transition name, not the new state #2607

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
Su (sushmangupta) merged 2 commits into from
Oct 14, 2026
Merged

docs: name the third Transition parameter as the transition name, not the new state #2607

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62f2240
docs: name the third Transition parameter as the transition name, not…
d-kirkland Oct 13, 2026
6bb06f4
Merge branch 'main' into fix/docs-state-machine-transition-parameter
sushmangupta Oct 14, 2026
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
6 changes: 3 additions & 3 deletions guides/plugins/plugins/checkout/order/using-the-state-machine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ This ensures, that if Shopware would ever change a state's name, your changes wo
This means the ID of the order, the order transaction or the order delivery entity.
You can find those using the respective entities' repositories, find out more about those in general in our guide about [reading data](../../framework/data-handling/reading-data).
There will a full example at the end of this guide as well.
* The third parameter is the new state to be transitioned to.
E.g. this could be `paid`, if the order is still `open`.
* The last parameter is the name of the `StateMachineStateField`.
* The third parameter is the name of the transition (action) to apply, for example `process` or `cancel` for an order (except in forced mode, see [Forcing a transition](#forcing-a-transition)).
The state machine determines the resulting state from the current state and this transition name.
* The fourth parameter is the name of the `StateMachineStateField`.
If you have a look at the [order definition](https://github.com/shopware/shopware/blob/v6.3.4.1/src/Core/Checkout/Order/OrderDefinition.php#L106), you will find the respective field.
This is the case for each of those definitions, the [order definition](https://github.com/shopware/shopware/blob/v6.3.4.1/src/Core/Checkout/Order/OrderDefinition.php#L106), the [order transaction](https://github.com/shopware/shopware/blob/v6.3.4.1/src/Core/Checkout/Order/Aggregate/OrderTransaction/OrderTransactionDefinition.php#L60) and the [order delivery](https://github.com/shopware/shopware/blob/v6.3.4.1/src/Core/Checkout/Order/Aggregate/OrderDelivery/OrderDeliveryDefinition.php#L79).
Thankfully, this field is always called `stateId` in our default definitions.
Expand Down
Loading