WordPress.org

Make WordPress Core

Changeset 19725


Ignore:
Timestamp:
01/09/12 20:52:08 (2 years ago)
Author:
ryan
Message:

Update wp_salt() phpdoc. fixes #18696

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/pluggable.php

    r19687 r19725  
    12771277if ( !function_exists('wp_salt') ) : 
    12781278/** 
    1279  * Get salt to add to hashes to help prevent attacks. 
    1280  * 
    1281  * The secret key is located in two places: the database in case the secret key 
    1282  * isn't defined in the second place, which is in the wp-config.php file. If you 
    1283  * are going to set the secret key, then you must do so in the wp-config.php 
    1284  * file. 
    1285  * 
    1286  * The secret key in the database is randomly generated and will be appended to 
    1287  * the secret key that is in wp-config.php file in some instances. It is 
    1288  * important to have the secret key defined or changed in wp-config.php. 
    1289  * 
    1290  * If you have installed WordPress 2.5 or later, then you will have the 
    1291  * SECRET_KEY defined in the wp-config.php already. You will want to change the 
    1292  * value in it because hackers will know what it is. If you have upgraded to 
    1293  * WordPress 2.5 or later version from a version before WordPress 2.5, then you 
    1294  * should add the constant to your wp-config.php file. 
    1295  * 
    1296  * Below is an example of how the SECRET_KEY constant is defined with a value. 
    1297  * You must not copy the below example and paste into your wp-config.php. If you 
    1298  * need an example, then you can have a 
    1299  * {@link https://api.wordpress.org/secret-key/1.1/ secret key created} for you. 
     1279 * Get salt to add to hashes. 
     1280 * 
     1281 * Salts are created using secret keys. Secret keys are located in two places: 
     1282 * in the database and in the wp-config.php file. The secret key in the database 
     1283 * is randomly generated and will be appended to the secret keys in wp-config.php. 
     1284 * 
     1285 * The secret keys in wp-config.php should be updated to strong, random keys to maximize 
     1286 * security. Below is an example of how the secret key constants are defined. 
     1287 * Do not paste this example directly into wp-config.php. Instead, have a 
     1288 * {@link https://api.wordpress.org/secret-key/1.1/salt/ secret key created} just 
     1289 * for you. 
    13001290 * 
    13011291 * <code> 
    1302  * define('SECRET_KEY', 'mAry1HadA15|\/|b17w55w1t3asSn09w'); 
     1292 * define('AUTH_KEY',         ' Xakm<o xQy rw4EMsLKM-?!T+,PFF})H4lzcW57AF0U@N@< >M%G4Yt>f`z]MON'); 
     1293 * define('SECURE_AUTH_KEY',  'LzJ}op]mr|6+![P}Ak:uNdJCJZd>(Hx.-Mh#Tz)pCIU#uGEnfFz|f ;;eU%/U^O~'); 
     1294 * define('LOGGED_IN_KEY',    '|i|Ux`9<p-h$aFf(qnT:sDO:D1P^wZ$$/Ra@miTJi9G;ddp_<q}6H1)o|a +&JCM'); 
     1295 * define('NONCE_KEY',        '%:R{[P|,s.KuMltH5}cI;/k<Gx~j!f0I)m_sIyu+&NJZ)-iO>z7X>QYR0Z_XnZ@|'); 
     1296 * define('AUTH_SALT',        'eZyT)-Naw]F8CwA*VaW#q*|.)g@o}||wf~@C-YSt}(dh_r6EbI#A,y|nU2{B#JBW'); 
     1297 * define('SECURE_AUTH_SALT', '!=oLUTXh,QW=H `}`L|9/^4-3 STz},T(w}W<I`.JjPi)<Bmf1v,HpGe}T1:Xt7n'); 
     1298 * define('LOGGED_IN_SALT',   '+XSqHc;@Q*K_b|Z?NC[3H!!EONbh.n<+=uKR:>*c(u`g~EJBf#8u#R{mUEZrozmm'); 
     1299 * define('NONCE_SALT',       'h`GXHhD>SLWVfg1(1(N{;.V!MoE(SfbA_ksP@&`+AycHcAV$+?@3q+rxV{%^VyKT'); 
    13031300 * </code> 
    13041301 * 
    13051302 * Salting passwords helps against tools which has stored hashed values of 
    1306  * common dictionary strings. The added values makes it harder to crack if given 
    1307  * salt string is not weak. 
     1303 * common dictionary strings. The added values makes it harder to crack. 
    13081304 * 
    13091305 * @since 2.5 
    1310  * @link https://api.wordpress.org/secret-key/1.1/ Create a Secret Key for wp-config.php 
     1306 * 
     1307 * @link https://api.wordpress.org/secret-key/1.1/salt/ Create secrets for wp-config.php 
    13111308 * 
    13121309 * @param string $scheme Authentication scheme 
Note: See TracChangeset for help on using the changeset viewer.