> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://knowledge.clym.io/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Craft CMS plugin

# Clym CMP for Craft CMS

The Clym CMP plugin for Craft allows you to quickly integrate Clym's consent and accessibility management solutions into your Craft CMS website without needing to manually add the installation embed code to your site's header. Once installed, the plugin connects your website to your Clym account, making setup and ongoing management simpler and more streamlined. Once you have configured the plugin, the Clym widget will automatically be injected into every front-end page, allowing you to easily deploy and manage Clym functionality across your site.

Below, you can find details on:
* [The requirements to use the Clym CMP plugin](#2-requirements)
* [How to install the plugin on your Craft CMS website](#2-installation)
* [How to configure your Clym widget](#2-configuration)
* [How to verify the installation was successful](#2-verification)
* [How to uninstall the plugin if necessary](#2-uninstalling)
---

## Requirements

* Craft CMS 4.x or 5.x
* PHP 8.0 or higher
* A Clym account — log in at [auth.clym.io](https://auth.clym.io) or register at [register.clym.io](https://register.clym.io)

---

## Installation

### Via Composer (recommended)

Run the following command in your Craft project root:

```bash
composer require clymio/craft-clym-cmp
```

Then install the plugin in Craft:

```bash
php craft plugin/install clym-cmp
```

### Via the Craft Plugin Store

1. Go to your Craft control panel
2. Navigate to **Settings → Plugins**
3. Search for **Clym CMP**
4. Click **Install**

---

## Configuration

1. In the Craft control panel, go to **Settings → Plugins → Clym CMP → Settings**
2. Enter your **Widget ID** in the field provided
3. Click **Save**

Your Widget ID can be found in your Clym Control Center account at [auth.clym.io](https://auth.clym.io). After signing into your Clym account, your property ID will be available in your URL.

![](https://storage.crisp.chat/users/helpdesk/website/-/a/e/3/8/ae38f50f15c00000/property-id_2eijf3.png)


---

## Verification

Visit any front-end page of your site and view the page source. You should see the following two script tags immediately after the opening `<head>` tag:

```html
<script src='https://config.clym-widget.net/v2/YOUR-WIDGET-ID.js'></script>
<script src='https://widget-next.clym-sdk.net/v2/stub.js' data-property='YOUR-WIDGET-ID'></script>
```

---

## Uninstalling

Go to **Settings → Plugins → Clym CMP** and click **Uninstall**. All plugin settings will be removed automatically.

---

## Support

If you encounter any challenges, please reach out to support@clym.io.
