Prescribed way to set cookies (from plugin or Twig)

Question

From either a plugin or a Twig template, is there a prescribed way to set (and get) cookies?

I've seen https://github.com/lewisjenkins/craft-lj-cookies/, which just uses PHP's setcookie.

Also noticed getCookie in craft.request. https://craftcms.com/docs/templating/craft.request#getCookie

I've noticed the cookies set with setcookie aren't readable by getCookie. How should one set a cookie so that it is readable by getCookie?

Answer 1

Cookies cannot be set via templates. However, in a plugin you have access to Craft's services. The UserSessionService has the saveCookie function.

craft()->userSession->saveCookie($cookieName, $data, $duration);

Answer 2

I wrote a plugin similar to lj_cookies that accomplishes this for both regular and craft secure cookies:

• Craft 2.x: Cookies
• Craft 3.x: Cookies

...enjoy.

Answer 3

In the new Craft 3, you can use the following in your plugin:

// Create cookie object.
$cookie = Craft::createObject([
    'class' => 'yii\web\Cookie',
    'name' => 'CookiesAccepted', 
    'httpOnly' => true,
    'value' => 'true',
    'expire' => time() + (86400 * 365),
]);

// Set cookie.
Craft::$app->getResponse()->getCookies()->add($cookie);

To get the cookie's value, use:

Craft::$app->request->cookies->get('CookiesAccepted');

Answer 4

To access a cookie you can use the plugin variable class

<?php

namespace Craft;

/**
 * Class PluginVariable
 * @package Craft
 */
class PluginVariable
{
    /**
     * Get the cookie value
     *
     * @param string $name
     * @return string
     */
    public function getPluginCookie($name)
    {
        return $_COOKIE[$name] ?? '';
    }
}

And inside your twig file you call

{% set pluginCookie = craft.plugin.getPluginCookie('some_cookie_name') %}