Skip to content

fix: update cookie consent docs #2095

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
wannevancamp wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: update cookie consent docs #2095

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
76 changes: 29 additions & 47 deletions guides/plugins/plugins/storefront/add-cookie-to-manager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This guide is built upon the [Plugin base guide](../plugin-base-guide), so take

## Extend the cookie consent manager

Adding custom cookies requires you to listen to the `CookieGroupsCollectEvent` and add your custom cookies to the collection.
Adding custom cookies requires you to listen to the `CookieGroupCollectEvent` and add your custom cookies to the collection.

::: tip
It is recommended to use an event listener if you're listening to a single event. If you need to react to multiple events, an event subscriber is the better choice.
Expand All @@ -41,7 +41,7 @@ Start with creating the `services.xml` and registering your event listener.

<services>
<service id="PluginName\Listener\CookieListener">
<tag name="kernel.event_listener" event="Shopware\Storefront\Framework\Cookie\CookieGroupsCollectEvent"/>
<tag name="kernel.event_listener" event="Shopware\Core\Content\Cookie\Event\CookieGroupCollectEvent"/>
</service>
</services>
</container>
Expand All @@ -51,7 +51,7 @@ In the next step we'll create the actual listener class.

### Creating the listener

We need to create a class called `CookieListener` with an `__invoke` method. This method will be executed once the `CookieGroupsCollectEvent` is dispatched.
We need to create a class called `CookieListener` with an `__invoke` method. This method will be executed once the `CookieGroupCollectEvent` is dispatched.

The event object that is passed to our listener method contains the cookie groups collection, which we can use to add our custom cookies.

Expand All @@ -67,57 +67,39 @@ Let's have a look at an example:

namespace PluginName\Listener;

use Shopware\Storefront\Framework\Cookie\CookieGroupsCollectEvent;
use Shopware\Core\Framework\Cookie\CookieEntry;
use Shopware\Core\Framework\Cookie\CookieGroup;
use Shopware\Core\Content\Cookie\Event\CookieGroupCollectEvent;
use Shopware\Core\Content\Cookie\Service\CookieProvider;
use Shopware\Core\Content\Cookie\Struct\CookieEntry;
use Shopware\Core\Content\Cookie\Struct\CookieEntryCollection;

class CookieListener
{
public function __invoke(CookieGroupsCollectEvent $event): void
public function __invoke(CookieGroupCollectEvent $event): void
{
$cookieGroups = $event->getCookieGroups();

// Create a single cookie
$singleCookie = new CookieEntry(
'cookie.name',
'cookie-key',
'cookie value',
30,
'cookie.description'
);

// Create entries collection for cookie group
$groupEntries = [
new CookieEntry(
'cookie.first_child_name',
'cookie-key-1',
'cookie value',
30
),
new CookieEntry(
'cookie.second_child_name',
'cookie-key-2',
'cookie value',
60
)
];

// Create a cookie group with multiple cookies
$cookieGroup = new CookieGroup(
'cookie.group_name',
$groupEntries,
'cookie.group_description'
);

$cookieGroups->add($cookieGroup);
$cookieGroups->add($singleCookie);
$comfortFeaturesCookieGroup = $event->cookieGroupCollection->get(CookieProvider::SNIPPET_NAME_COOKIE_GROUP_COMFORT_FEATURES);
if (!$comfortFeaturesCookieGroup) {
return;
}

$entries = $comfortFeaturesCookieGroup->getEntries();
if ($entries === null) {
$entries = new CookieEntryCollection();
$comfortFeaturesCookieGroup->setEntries($entries);
}

$cookieEntry = new CookieEntry('my-cookie-key');
$cookieEntry->name = 'cookie.myCookieName';
$cookieEntry->value = '1';
$cookieEntry->expiration = 30;

$entries->add($cookieEntry);
}
}
```

This will eventually lead to a new group being created, containing two new cookies, as well as a new cookie without a group.
This will add your cookie to the existing "Comfort Features" group in the cookie consent manager.
Copy link
Contributor Author

@wannevancamp wannevancamp Feb 3, 2026

Choose a reason for hiding this comment

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

There are many plugins that create their own consent groups. To avoid uncontrolled growth of consent groups, this example has been updated to show how you can add a cookie to an existing group.


And that's basically it already. After loading your Storefront, you should now see your new cookies and the cookie-group.
And that's basically it already. After loading your Storefront, you should now see your new cookie in the cookie consent manager.

## Parameter Reference

Expand All @@ -132,7 +114,7 @@ Cookie groups should not have the `cookie`, `value`, `expiration`, or `isRequire

## Migrating from CookieProviderInterface (Shopware 6.7.2 and earlier)

If you are upgrading from an older version, you might have used the `CookieProviderInterface` to add custom cookies. This interface is now deprecated and should be replaced with the `CookieGroupsCollectEvent`.
If you are upgrading from an older version, you might have used the `CookieProviderInterface` to add custom cookies. This interface is now deprecated and should be replaced with the `CookieGroupCollectEvent`.

For backward compatibility, you can still use the `CookieProviderInterface` to provide cookies in the old array syntax. However, it is highly recommended to use the new event-based system to provide the new object structure.

Expand All @@ -148,7 +130,7 @@ While this feature helps with GDPR compliance, shop owners are responsible for e

### How it works

1. Your plugin adds/modifies cookies via the `CookieGroupsCollectEvent`
1. Your plugin adds/modifies cookies via the `CookieGroupCollectEvent`
2. Shopware calculates a hash of the entire cookie configuration
3. The hash is stored in the user's browser
4. On the next visit, if the hash differs, the consent banner appears again
Expand Down