Make $cookie_domain comments match $base_url comments [#140468]

The new settings.php’s comments for $cookie_domain should be using the same format as the $base_url comment above it.

Specifically:

 * cross between your various domains.
*/

#$cookie_domain = 'example.com';

should be:

 * cross between your various domains.
 */
# $cookie_domain = 'example.com';

…to make it clearer that you should remove just the # and not the #$.

Comment	File	Size	Author
#1	settings_spacing_0.patch	1.19 KB	johnalbin
	settings_spacing.patch	1.15 KB	johnalbin

Comments

Comment #1

johnalbin

they/他

English

Taipei, Taiwan

commented 16 June 2007 at 09:57

Status:

Active

» Needs review

Status	File	Size
new	settings_spacing_0.patch	1.19 KB

Re-rolled for default.settings.php. Again, only the spacing is changed; no comment or code changes.

Comment #2

forngren commented 16 June 2007 at 12:16

Status:

Needs review

» Reviewed & tested by the community

Nice one.

Comment #3

dries commented 17 June 2007 at 10:45

Status:

Reviewed & tested by the community

» Fixed

Committed to CVS HEAD. Thanks John.

Comment #4

(not verified) commented 1 July 2007 at 11:16

Status:

Fixed

» Closed (fixed)

Comment #5

MiMe commented 25 October 2010 at 13:14

It should actually be '.example.com'

The documentation in the settings.php has an example of the cookie domain set to:
# $cookie_domain = 'example.com';

But the cookie domain must be replaced with .example.com since the . is Always added in the bootstrap.

So the correct documentation for cookie domain should be:
# $cookie_domain = '.example.com';

Comment #6

mooffie commented 3 January 2011 at 13:10

Version:	6.x-dev	» 7.x-dev
Component:	user system	» documentation
Category:	feature	» bug
Priority:	Minor	» Normal
Status:	Closed (fixed)	» Active

@MiMe is right, I believe.

Do we need to put a dot in front? If so, we should fix that comment.

The php docs says "RFC 2109 requires it to be included". And our own code is:

  // Per RFC 2109, cookie domains must contain at least one dot other than the
  // first. For hosts such as 'localhost' or IP Addresses we don't set a cookie domain.
  if (count(explode('.', $cookie_domain)) > 2 && !is_numeric(str_replace('.', '', $cookie_domain))) {
    ini_set('session.cookie_domain', $cookie_domain);

and it seem "example.com" won't pass this.