Wordpress 2.8.4

[autoinstalls/wordpress.git] / wp-config-sample.php

diff --git a/wp-config-sample.php b/wp-config-sample.php
index f557e6d05ebe7d0af501b52465af5d60a1e392a3..2e316c7776292710881136804eb394c70635d018 100644 (file)
--- a/wp-config-sample.php
+++ b/wp-config-sample.php
@@ -1,31 +1,76 @@
 <?php\r
 <?php\r

-// ** MySQL settings ** //\r
-define('DB_NAME', 'putyourdbnamehere');    // The name of the database\r
-define('DB_USER', 'usernamehere');     // Your MySQL username\r
-define('DB_PASSWORD', 'yourpasswordhere'); // ...and password\r
-define('DB_HOST', 'localhost');    // 99% chance you won't need to change this value\r
+/** \r
+ * The base configurations of the WordPress.\r
+ *\r
+ * This file has the following configurations: MySQL settings, Table Prefix,\r
+ * Secret Keys, WordPress Language, and ABSPATH. You can find more information by\r
+ * visiting {@link http://codex.wordpress.org/Editing_wp-config.php Editing\r
+ * wp-config.php} Codex page. You can get the MySQL settings from your web host.\r
+ *\r
+ * This file is used by the wp-config.php creation script during the\r
+ * installation. You don't have to use the web site, you can just copy this file\r
+ * to "wp-config.php" and fill in the values.\r
+ *\r
+ * @package WordPress\r
+ */\r
+\r
+// ** MySQL settings - You can get this info from your web host ** //\r
+/** The name of the database for WordPress */\r
+define('DB_NAME', 'putyourdbnamehere');\r
+\r
+/** MySQL database username */\r
+define('DB_USER', 'usernamehere');\r
+\r
+/** MySQL database password */\r
+define('DB_PASSWORD', 'yourpasswordhere');\r
+\r
+/** MySQL hostname */\r
+define('DB_HOST', 'localhost');\r
+\r
+/** Database Charset to use in creating database tables. */\r

 define('DB_CHARSET', 'utf8');\r
 define('DB_CHARSET', 'utf8');\r

+\r
+/** The Database Collate type. Don't change this if in doubt. */\r

 define('DB_COLLATE', '');\r
 \r
 define('DB_COLLATE', '');\r
 \r

-// Change each KEY to a different unique phrase.  You won't have to remember the phrases later,\r
-// so make them long and complicated.  You can visit http://api.wordpress.org/secret-key/1.1/\r
-// to get keys generated for you, or just make something up.  Each key should have a different phrase.\r
-define('AUTH_KEY', 'put your unique phrase here'); // Change this to a unique phrase.\r
-define('SECURE_AUTH_KEY', 'put your unique phrase here'); // Change this to a unique phrase.\r
-define('LOGGED_IN_KEY', 'put your unique phrase here'); // Change this to a unique phrase.\r
+/**#@+\r
+ * Authentication Unique Keys.\r
+ *\r
+ * Change these to different unique phrases!\r
+ * You can generate these using the {@link https://api.wordpress.org/secret-key/1.1/ WordPress.org secret-key service}\r
+ * You can change these at any point in time to invalidate all existing cookies. This will force all users to have to log in again.\r
+ *\r
+ * @since 2.6.0\r
+ */\r
+define('AUTH_KEY', 'put your unique phrase here');\r
+define('SECURE_AUTH_KEY', 'put your unique phrase here');\r
+define('LOGGED_IN_KEY', 'put your unique phrase here');\r
+define('NONCE_KEY', 'put your unique phrase here');\r
+/**#@-*/\r

 \r
 \r

-// You can have multiple installations in one database if you give each a unique prefix\r
-$table_prefix  = 'wp_';   // Only numbers, letters, and underscores please!\r
+/**\r
+ * WordPress Database Table prefix.\r
+ *\r
+ * You can have multiple installations in one database if you give each a unique\r
+ * prefix. Only numbers, letters, and underscores please!\r
+ */\r
+$table_prefix  = 'wp_';\r

 \r
 \r

-// Change this to localize WordPress.  A corresponding MO file for the\r
-// chosen language must be installed to wp-content/languages.\r
-// For example, install de.mo to wp-content/languages and set WPLANG to 'de'\r
-// to enable German language support.\r
+/**\r
+ * WordPress Localized Language, defaults to English.\r
+ *\r
+ * Change this to localize WordPress.  A corresponding MO file for the chosen\r
+ * language must be installed to wp-content/languages. For example, install\r
+ * de.mo to wp-content/languages and set WPLANG to 'de' to enable German\r
+ * language support.\r
+ */\r

 define ('WPLANG', '');\r
 \r
 /* That's all, stop editing! Happy blogging. */\r
 \r
 define ('WPLANG', '');\r
 \r
 /* That's all, stop editing! Happy blogging. */\r
 \r

+/** WordPress absolute path to the Wordpress directory. */\r

 if ( !defined('ABSPATH') )\r
        define('ABSPATH', dirname(__FILE__) . '/');\r
 if ( !defined('ABSPATH') )\r
        define('ABSPATH', dirname(__FILE__) . '/');\r

+\r
+/** Sets up WordPress vars and included files. */\r

 require_once(ABSPATH . 'wp-settings.php');\r
 require_once(ABSPATH . 'wp-settings.php');\r

-?>\r