function user_cookie_delete

Same name and namespace in other branches
  1. 11.x core/modules/user/user.module \user_cookie_delete()
  2. 10 core/modules/user/user.module \user_cookie_delete()
  3. 9 core/modules/user/user.module \user_cookie_delete()
  4. 8.9.x core/modules/user/user.module \user_cookie_delete()
  5. 7.x modules/user/user.module \user_cookie_delete()

Delete a visitor information cookie.

Parameters

string $cookie_name: A cookie name such as 'homepage'.

Deprecated

in drupal:11.4.0 and is removed from drupal:13.0.0. There is no replacement.

See also

https://www.drupal.org/node/3581570

File

core/modules/user/user.module, line 604

Code

function user_cookie_delete($cookie_name) : void {
  @trigger_error(__METHOD__ . '() is deprecated in drupal:11.4.0 and is removed from drupal:13.0.0. There is no replacement. See https://www.drupal.org/node/3581570', E_USER_DEPRECATED);
  setrawcookie('Drupal.visitor.' . $cookie_name, '', \Drupal::time()->getRequestTime() - 3600, '/');
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.