Skip to content

Commit aa47d8a

Browse files
azaozzazaozz
committed
wp-config-sample.php inline documentation. Props santosj, fixes WordPress#7526
git-svn-id: https://develop.svn.wordpress.org/trunk@8655 602fd350-edb4-49c9-b593-d223f7449a82
1 parent d852afb commit aa47d8a

1 file changed

Lines changed: 150 additions & 18 deletions

File tree

‎wp-config-sample.php‎

Lines changed: 150 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,163 @@
11
<?php
2-
// ** MySQL settings ** //
3-
define('DB_NAME', 'putyourdbnamehere'); // The name of the database
4-
define('DB_USER', 'usernamehere'); // Your MySQL username
5-
define('DB_PASSWORD', 'yourpasswordhere'); // ...and password
6-
define('DB_HOST', 'localhost'); // 99% chance you won't need to change this value
2+
/**
3+
* The base configurations of the WordPress.
4+
*
5+
* This file has the following configurations: MySQL settings, Table Prefix,
6+
* Secret Key, WordPress Language, and ABSPATH. You can find more information by
7+
* visiting {@link http://codex.wordpress.org/Editing_wp-config.php Editing wp-config.php}
8+
* Codex page.
9+
*
10+
* This file is used by the wp-config.php creation script during the
11+
* installation. You don't have to use the web site, you can just copy this file
12+
* to "wp-config.php" and fill in the values.
13+
*
14+
* @package WordPress
15+
*/
16+
17+
/**
18+
* The name of the database.
19+
*
20+
* @var string
21+
* @since unknown
22+
*/
23+
define('DB_NAME', 'putyourdbnamehere');
24+
25+
/**
26+
* Your MySQL username.
27+
*
28+
* @var string
29+
* @since unknown
30+
*/
31+
define('DB_USER', 'usernamehere');
32+
33+
/**
34+
* The MySQL user's password
35+
*
36+
* @var string
37+
* @since unknown
38+
*/
39+
define('DB_PASSWORD', 'yourpasswordhere');
40+
41+
/**
42+
* The host location to the database server.
43+
*
44+
* You can get the hostname of the database server from your Web host.
45+
* (99% chance you won't need to change this value)
46+
*
47+
* @var string
48+
* @since unknown
49+
*/
50+
define('DB_HOST', 'localhost');
51+
52+
/**
53+
* DB Charset to use in creating database tables.
54+
*
55+
* (Don't change if in doubt)
56+
*
57+
* @var string
58+
* @since unknown
59+
*/
760
define('DB_CHARSET', 'utf8');
61+
62+
/**
63+
* The DB Collate type.
64+
*
65+
* (Don't change if in doubt)
66+
*
67+
* @var string
68+
* @since unknown
69+
*/
870
define('DB_COLLATE', '');
971

10-
// Change each KEY to a different unique phrase. You won't have to remember the phrases later,
11-
// so make them long and complicated. You can visit http://api.wordpress.org/secret-key/1.1/
12-
// to get keys generated for you, or just make something up. Each key should have a different phrase.
13-
define('AUTH_KEY', 'put your unique phrase here'); // Change this to a unique phrase.
14-
define('SECURE_AUTH_KEY', 'put your unique phrase here'); // Change this to a unique phrase.
15-
define('LOGGED_IN_KEY', 'put your unique phrase here'); // Change this to a unique phrase.
72+
/**
73+
* Non-SSL login cookie Key
74+
*
75+
* Change each KEY to a different unique phrase. You won't have to remember the
76+
* phrases later, so make them long and complicated. You can visit
77+
* {@link http://api.wordpress.org/secret-key/1.1/} to get keys generated for
78+
* you, or just make something up. Each key should have a different phrase.
79+
*
80+
* @link http://api.wordpress.org/secret-key/1.1/ Visit for unique phrase.
81+
* @link http://boren.nu/archives/2008/07/14/ssl-and-cookies-in-wordpress-26/ More information on secured cookies.
82+
* @since 2.6
83+
* @var string
84+
* @package WordPress
85+
* @subpackage Security
86+
*/
87+
define('AUTH_KEY', 'put your unique phrase here');
88+
89+
/**
90+
* SSL login cookie key
91+
*
92+
* Change each KEY to a different unique phrase. You won't have to remember the
93+
* phrases later, so make them long and complicated. You can visit
94+
* {@link http://api.wordpress.org/secret-key/1.1/} to get keys generated for
95+
* you, or just make something up. Each key should have a different phrase.
96+
*
97+
* @link http://api.wordpress.org/secret-key/1.1/ Visit for unique phrase.
98+
* @link http://boren.nu/archives/2008/07/14/ssl-and-cookies-in-wordpress-26/ More information on secured cookies.
99+
* @since 2.6
100+
* @var string
101+
* @package WordPress
102+
* @subpackage Security
103+
*/
104+
define('SECURE_AUTH_KEY', 'put your unique phrase here');
16105

17-
// You can have multiple installations in one database if you give each a unique prefix
18-
$table_prefix = 'wp_'; // Only numbers, letters, and underscores please!
106+
/**
107+
* Both SSL and non-SSL cookie
108+
*
109+
* Change each KEY to a different unique phrase. You won't have to remember the
110+
* phrases later, so make them long and complicated. You can visit
111+
* {@link http://api.wordpress.org/secret-key/1.1/} to get keys generated for
112+
* you, or just make something up. Each key should have a different phrase.
113+
*
114+
* @link http://api.wordpress.org/secret-key/1.1/ Visit for unique phrase.
115+
* @link http://boren.nu/archives/2008/07/14/ssl-and-cookies-in-wordpress-26/ More information on secured cookies.
116+
* @since 2.6
117+
* @var string
118+
* @package WordPress
119+
* @subpackage Security
120+
*/
121+
define('LOGGED_IN_KEY', 'put your unique phrase here');
19122

20-
// Change this to localize WordPress. A corresponding MO file for the
21-
// chosen language must be installed to wp-content/languages.
22-
// For example, install de.mo to wp-content/languages and set WPLANG to 'de'
23-
// to enable German language support.
123+
/**
124+
* Table prefix for WordPress
125+
*
126+
* You can have multiple installations in one database if you give each a unique
127+
* prefix. Only numbers, letters, and underscores required!
128+
*
129+
* @global string $table_prefix
130+
* @var string
131+
* @name $table_prefix
132+
* @since unknown
133+
*/
134+
$table_prefix = 'wp_';
135+
136+
/**
137+
* Change this to localize WordPress.
138+
*
139+
* A corresponding MO file for the chosen language must be installed to
140+
* wp-content/languages. For example, install de.mo to wp-content/languages and
141+
* set WPLANG to 'de' to enable German language support.
142+
*
143+
* @var string
144+
* @since unknown
145+
*/
24146
define ('WPLANG', '');
25147

26148
/* That's all, stop editing! Happy blogging. */
27149

150+
/**
151+
* Defines the base WordPress location.
152+
*
153+
* Has the forward slash at the end.
154+
*
155+
* @var string
156+
* @since unknown
157+
*/
28158
if ( !defined('ABSPATH') )
29159
define('ABSPATH', dirname(__FILE__) . '/');
160+
161+
/** Sets up WordPress vars and included files. */
30162
require_once(ABSPATH . 'wp-settings.php');
31-
?>
163+
?>

0 commit comments

Comments
 (0)