/wp-includes/user.php

  1. <?php 
  2. /** 
  3. * Core User API 
  4. * 
  5. * @package WordPress 
  6. * @subpackage Users 
  7. */ 
  8.  
  9. /** 
  10. * Authenticates and logs a user in with 'remember' capability. 
  11. * 
  12. * The credentials is an array that has 'user_login', 'user_password', and 
  13. * 'remember' indices. If the credentials is not given, then the log in form 
  14. * will be assumed and used if set. 
  15. * 
  16. * The various authentication cookies will be set by this function and will be 
  17. * set for a longer period depending on if the 'remember' credential is set to 
  18. * true. 
  19. * 
  20. * @since 2.5.0 
  21. * 
  22. * @global string $auth_secure_cookie 
  23. * 
  24. * @param array $credentials Optional. User info in order to sign on. 
  25. * @param string|bool $secure_cookie Optional. Whether to use secure cookie. 
  26. * @return WP_User|WP_Error WP_User on success, WP_Error on failure. 
  27. */ 
  28. function wp_signon( $credentials = array(), $secure_cookie = '' ) { 
  29. if ( empty($credentials) ) { 
  30. $credentials = array(); // Back-compat for plugins passing an empty string. 
  31.  
  32. if ( ! empty($_POST['log']) ) 
  33. $credentials['user_login'] = $_POST['log']; 
  34. if ( ! empty($_POST['pwd']) ) 
  35. $credentials['user_password'] = $_POST['pwd']; 
  36. if ( ! empty($_POST['rememberme']) ) 
  37. $credentials['remember'] = $_POST['rememberme']; 
  38.  
  39. if ( !empty($credentials['remember']) ) 
  40. $credentials['remember'] = true; 
  41. else 
  42. $credentials['remember'] = false; 
  43.  
  44. /** 
  45. * Fires before the user is authenticated. 
  46. * 
  47. * The variables passed to the callbacks are passed by reference,  
  48. * and can be modified by callback functions. 
  49. * 
  50. * @since 1.5.1 
  51. * 
  52. * @todo Decide whether to deprecate the wp_authenticate action. 
  53. * 
  54. * @param string $user_login Username, passed by reference. 
  55. * @param string $user_password User password, passed by reference. 
  56. */ 
  57. do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) ); 
  58.  
  59. if ( '' === $secure_cookie ) 
  60. $secure_cookie = is_ssl(); 
  61.  
  62. /** 
  63. * Filters whether to use a secure sign-on cookie. 
  64. * 
  65. * @since 3.1.0 
  66. * 
  67. * @param bool $secure_cookie Whether to use a secure sign-on cookie. 
  68. * @param array $credentials { 
  69. * Array of entered sign-on data. 
  70. * 
  71. * @type string $user_login Username. 
  72. * @type string $user_password Password entered. 
  73. * @type bool $remember Whether to 'remember' the user. Increases the time 
  74. * that the cookie will be kept. Default false. 
  75. * } 
  76. */ 
  77. $secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials ); 
  78.  
  79. global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie 
  80. $auth_secure_cookie = $secure_cookie; 
  81.  
  82. add_filter('authenticate', 'wp_authenticate_cookie', 30, 3); 
  83.  
  84. $user = wp_authenticate($credentials['user_login'], $credentials['user_password']); 
  85.  
  86. if ( is_wp_error($user) ) { 
  87. if ( $user->get_error_codes() == array('empty_username', 'empty_password') ) { 
  88. $user = new WP_Error('', ''); 
  89.  
  90. return $user; 
  91.  
  92. wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie); 
  93. /** 
  94. * Fires after the user has successfully logged in. 
  95. * 
  96. * @since 1.5.0 
  97. * 
  98. * @param string $user_login Username. 
  99. * @param WP_User $user WP_User object of the logged-in user. 
  100. */ 
  101. do_action( 'wp_login', $user->user_login, $user ); 
  102. return $user; 
  103.  
  104. /** 
  105. * Authenticate a user, confirming the username and password are valid. 
  106. * 
  107. * @since 2.8.0 
  108. * 
  109. * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null. 
  110. * @param string $username Username for authentication. 
  111. * @param string $password Password for authentication. 
  112. * @return WP_User|WP_Error WP_User on success, WP_Error on failure. 
  113. */ 
  114. function wp_authenticate_username_password($user, $username, $password) { 
  115. if ( $user instanceof WP_User ) { 
  116. return $user; 
  117.  
  118. if ( empty($username) || empty($password) ) { 
  119. if ( is_wp_error( $user ) ) 
  120. return $user; 
  121.  
  122. $error = new WP_Error(); 
  123.  
  124. if ( empty($username) ) 
  125. $error->add('empty_username', __('<strong>ERROR</strong>: The username field is empty.')); 
  126.  
  127. if ( empty($password) ) 
  128. $error->add('empty_password', __('<strong>ERROR</strong>: The password field is empty.')); 
  129.  
  130. return $error; 
  131.  
  132. $user = get_user_by('login', $username); 
  133.  
  134. if ( !$user ) { 
  135. return new WP_Error( 'invalid_username',  
  136. __( '<strong>ERROR</strong>: Invalid username.' ) . 
  137. ' <a href="' . wp_lostpassword_url() . '">' . 
  138. __( 'Lost your password?' ) . 
  139. '</a>' 
  140. ); 
  141.  
  142. /** 
  143. * Filters whether the given user can be authenticated with the provided $password. 
  144. * 
  145. * @since 2.5.0 
  146. * 
  147. * @param WP_User|WP_Error $user WP_User or WP_Error object if a previous 
  148. * callback failed authentication. 
  149. * @param string $password Password to check against the user. 
  150. */ 
  151. $user = apply_filters( 'wp_authenticate_user', $user, $password ); 
  152. if ( is_wp_error($user) ) 
  153. return $user; 
  154.  
  155. if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) { 
  156. return new WP_Error( 'incorrect_password',  
  157. sprintf( 
  158. /** translators: %s: user name */ 
  159. __( '<strong>ERROR</strong>: The password you entered for the username %s is incorrect.' ),  
  160. '<strong>' . $username . '</strong>' 
  161. ) . 
  162. ' <a href="' . wp_lostpassword_url() . '">' . 
  163. __( 'Lost your password?' ) . 
  164. '</a>' 
  165. ); 
  166.  
  167. return $user; 
  168.  
  169. /** 
  170. * Authenticates a user using the email and password. 
  171. * 
  172. * @since 4.5.0 
  173. * 
  174. * @param WP_User|WP_Error|null $user WP_User or WP_Error object if a previous 
  175. * callback failed authentication. 
  176. * @param string $email Email address for authentication. 
  177. * @param string $password Password for authentication. 
  178. * @return WP_User|WP_Error WP_User on success, WP_Error on failure. 
  179. */ 
  180. function wp_authenticate_email_password( $user, $email, $password ) { 
  181. if ( $user instanceof WP_User ) { 
  182. return $user; 
  183.  
  184. if ( empty( $email ) || empty( $password ) ) { 
  185. if ( is_wp_error( $user ) ) { 
  186. return $user; 
  187.  
  188. $error = new WP_Error(); 
  189.  
  190. if ( empty( $email ) ) { 
  191. $error->add( 'empty_username', __( '<strong>ERROR</strong>: The email field is empty.' ) ); // Uses 'empty_username' for back-compat with wp_signon() 
  192.  
  193. if ( empty( $password ) ) { 
  194. $error->add( 'empty_password', __( '<strong>ERROR</strong>: The password field is empty.' ) ); 
  195.  
  196. return $error; 
  197.  
  198. if ( ! is_email( $email ) ) { 
  199. return $user; 
  200.  
  201. $user = get_user_by( 'email', $email ); 
  202.  
  203. if ( ! $user ) { 
  204. return new WP_Error( 'invalid_email',  
  205. __( '<strong>ERROR</strong>: Invalid email address.' ) . 
  206. ' <a href="' . wp_lostpassword_url() . '">' . 
  207. __( 'Lost your password?' ) . 
  208. '</a>' 
  209. ); 
  210.  
  211. /** This filter is documented in wp-includes/user.php */ 
  212. $user = apply_filters( 'wp_authenticate_user', $user, $password ); 
  213.  
  214. if ( is_wp_error( $user ) ) { 
  215. return $user; 
  216.  
  217. if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) { 
  218. return new WP_Error( 'incorrect_password',  
  219. sprintf( 
  220. /** translators: %s: email address */ 
  221. __( '<strong>ERROR</strong>: The password you entered for the email address %s is incorrect.' ),  
  222. '<strong>' . $email . '</strong>' 
  223. ) . 
  224. ' <a href="' . wp_lostpassword_url() . '">' . 
  225. __( 'Lost your password?' ) . 
  226. '</a>' 
  227. ); 
  228.  
  229. return $user; 
  230.  
  231. /** 
  232. * Authenticate the user using the WordPress auth cookie. 
  233. * 
  234. * @since 2.8.0 
  235. * 
  236. * @global string $auth_secure_cookie 
  237. * 
  238. * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null. 
  239. * @param string $username Username. If not empty, cancels the cookie authentication. 
  240. * @param string $password Password. If not empty, cancels the cookie authentication. 
  241. * @return WP_User|WP_Error WP_User on success, WP_Error on failure. 
  242. */ 
  243. function wp_authenticate_cookie($user, $username, $password) { 
  244. if ( $user instanceof WP_User ) { 
  245. return $user; 
  246.  
  247. if ( empty($username) && empty($password) ) { 
  248. $user_id = wp_validate_auth_cookie(); 
  249. if ( $user_id ) 
  250. return new WP_User($user_id); 
  251.  
  252. global $auth_secure_cookie; 
  253.  
  254. if ( $auth_secure_cookie ) 
  255. $auth_cookie = SECURE_AUTH_COOKIE; 
  256. else 
  257. $auth_cookie = AUTH_COOKIE; 
  258.  
  259. if ( !empty($_COOKIE[$auth_cookie]) ) 
  260. return new WP_Error('expired_session', __('Please log in again.')); 
  261.  
  262. // If the cookie is not set, be silent. 
  263.  
  264. return $user; 
  265.  
  266. /** 
  267. * For Multisite blogs, check if the authenticated user has been marked as a 
  268. * spammer, or if the user's primary blog has been marked as spam. 
  269. * 
  270. * @since 3.7.0 
  271. * 
  272. * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null. 
  273. * @return WP_User|WP_Error WP_User on success, WP_Error if the user is considered a spammer. 
  274. */ 
  275. function wp_authenticate_spam_check( $user ) { 
  276. if ( $user instanceof WP_User && is_multisite() ) { 
  277. /** 
  278. * Filters whether the user has been marked as a spammer. 
  279. * 
  280. * @since 3.7.0 
  281. * 
  282. * @param bool $spammed Whether the user is considered a spammer. 
  283. * @param WP_User $user User to check against. 
  284. */ 
  285. $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy( $user ), $user ); 
  286.  
  287. if ( $spammed ) 
  288. return new WP_Error( 'spammer_account', __( '<strong>ERROR</strong>: Your account has been marked as a spammer.' ) ); 
  289. return $user; 
  290.  
  291. /** 
  292. * Validates the logged-in cookie. 
  293. * 
  294. * Checks the logged-in cookie if the previous auth cookie could not be 
  295. * validated and parsed. 
  296. * 
  297. * This is a callback for the {@see 'determine_current_user'} filter, rather than API. 
  298. * 
  299. * @since 3.9.0 
  300. * 
  301. * @param int|bool $user_id The user ID (or false) as received from the 
  302. * determine_current_user filter. 
  303. * @return int|false User ID if validated, false otherwise. If a user ID from 
  304. * an earlier filter callback is received, that value is returned. 
  305. */ 
  306. function wp_validate_logged_in_cookie( $user_id ) { 
  307. if ( $user_id ) { 
  308. return $user_id; 
  309.  
  310. if ( is_blog_admin() || is_network_admin() || empty( $_COOKIE[LOGGED_IN_COOKIE] ) ) { 
  311. return false; 
  312.  
  313. return wp_validate_auth_cookie( $_COOKIE[LOGGED_IN_COOKIE], 'logged_in' ); 
  314.  
  315. /** 
  316. * Number of posts user has written. 
  317. * 
  318. * @since 3.0.0 
  319. * @since 4.1.0 Added `$post_type` argument. 
  320. * @since 4.3.0 Added `$public_only` argument. Added the ability to pass an array 
  321. * of post types to `$post_type`. 
  322. * 
  323. * @global wpdb $wpdb WordPress database abstraction object. 
  324. * 
  325. * @param int $userid User ID. 
  326. * @param array|string $post_type Optional. Single post type or array of post types to count the number of posts for. Default 'post'. 
  327. * @param bool $public_only Optional. Whether to only return counts for public posts. Default false. 
  328. * @return string Number of posts the user has written in this post type. 
  329. */ 
  330. function count_user_posts( $userid, $post_type = 'post', $public_only = false ) { 
  331. global $wpdb; 
  332.  
  333. $where = get_posts_by_author_sql( $post_type, true, $userid, $public_only ); 
  334.  
  335. $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" ); 
  336.  
  337. /** 
  338. * Filters the number of posts a user has written. 
  339. * 
  340. * @since 2.7.0 
  341. * @since 4.1.0 Added `$post_type` argument. 
  342. * @since 4.3.1 Added `$public_only` argument. 
  343. * 
  344. * @param int $count The user's post count. 
  345. * @param int $userid User ID. 
  346. * @param string|array $post_type Single post type or array of post types to count the number of posts for. 
  347. * @param bool $public_only Whether to limit counted posts to public posts. 
  348. */ 
  349. return apply_filters( 'get_usernumposts', $count, $userid, $post_type, $public_only ); 
  350.  
  351. /** 
  352. * Number of posts written by a list of users. 
  353. * 
  354. * @since 3.0.0 
  355. * 
  356. * @global wpdb $wpdb WordPress database abstraction object. 
  357. * 
  358. * @param array $users Array of user IDs. 
  359. * @param string|array $post_type Optional. Single post type or array of post types to check. Defaults to 'post'. 
  360. * @param bool $public_only Optional. Only return counts for public posts. Defaults to false. 
  361. * @return array Amount of posts each user has written. 
  362. */ 
  363. function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) { 
  364. global $wpdb; 
  365.  
  366. $count = array(); 
  367. if ( empty( $users ) || ! is_array( $users ) ) 
  368. return $count; 
  369.  
  370. $userlist = implode( ', ', array_map( 'absint', $users ) ); 
  371. $where = get_posts_by_author_sql( $post_type, true, null, $public_only ); 
  372.  
  373. $result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N ); 
  374. foreach ( $result as $row ) { 
  375. $count[ $row[0] ] = $row[1]; 
  376.  
  377. foreach ( $users as $id ) { 
  378. if ( ! isset( $count[ $id ] ) ) 
  379. $count[ $id ] = 0; 
  380.  
  381. return $count; 
  382.  
  383. // 
  384. // User option functions 
  385. // 
  386.   
  387. /** 
  388. * Get the current user's ID 
  389. * 
  390. * @since MU 
  391. * 
  392. * @return int The current user's ID 
  393. */ 
  394. function get_current_user_id() { 
  395. if ( ! function_exists( 'wp_get_current_user' ) ) 
  396. return 0; 
  397. $user = wp_get_current_user(); 
  398. return ( isset( $user->ID ) ? (int) $user->ID : 0 ); 
  399.  
  400. /** 
  401. * Retrieve user option that can be either per Site or per Network. 
  402. * 
  403. * If the user ID is not given, then the current user will be used instead. If 
  404. * the user ID is given, then the user data will be retrieved. The filter for 
  405. * the result, will also pass the original option name and finally the user data 
  406. * object as the third parameter. 
  407. * 
  408. * The option will first check for the per site name and then the per Network name. 
  409. * 
  410. * @since 2.0.0 
  411. * 
  412. * @global wpdb $wpdb WordPress database abstraction object. 
  413. * 
  414. * @param string $option User option name. 
  415. * @param int $user Optional. User ID. 
  416. * @param string $deprecated Use get_option() to check for an option in the options table. 
  417. * @return mixed User option value on success, false on failure. 
  418. */ 
  419. function get_user_option( $option, $user = 0, $deprecated = '' ) { 
  420. global $wpdb; 
  421.  
  422. if ( !empty( $deprecated ) ) 
  423. _deprecated_argument( __FUNCTION__, '3.0.0' ); 
  424.  
  425. if ( empty( $user ) ) 
  426. $user = get_current_user_id(); 
  427.  
  428. if ( ! $user = get_userdata( $user ) ) 
  429. return false; 
  430.  
  431. $prefix = $wpdb->get_blog_prefix(); 
  432. if ( $user->has_prop( $prefix . $option ) ) // Blog specific 
  433. $result = $user->get( $prefix . $option ); 
  434. elseif ( $user->has_prop( $option ) ) // User specific and cross-blog 
  435. $result = $user->get( $option ); 
  436. else 
  437. $result = false; 
  438.  
  439. /** 
  440. * Filters a specific user option value. 
  441. * 
  442. * The dynamic portion of the hook name, `$option`, refers to the user option name. 
  443. * 
  444. * @since 2.5.0 
  445. * 
  446. * @param mixed $result Value for the user's option. 
  447. * @param string $option Name of the option being retrieved. 
  448. * @param WP_User $user WP_User object of the user whose option is being retrieved. 
  449. */ 
  450. return apply_filters( "get_user_option_{$option}", $result, $option, $user ); 
  451.  
  452. /** 
  453. * Update user option with global blog capability. 
  454. * 
  455. * User options are just like user metadata except that they have support for 
  456. * global blog options. If the 'global' parameter is false, which it is by default 
  457. * it will prepend the WordPress table prefix to the option name. 
  458. * 
  459. * Deletes the user option if $newvalue is empty. 
  460. * 
  461. * @since 2.0.0 
  462. * 
  463. * @global wpdb $wpdb WordPress database abstraction object. 
  464. * 
  465. * @param int $user_id User ID. 
  466. * @param string $option_name User option name. 
  467. * @param mixed $newvalue User option value. 
  468. * @param bool $global Optional. Whether option name is global or blog specific. 
  469. * Default false (blog specific). 
  470. * @return int|bool User meta ID if the option didn't exist, true on successful update,  
  471. * false on failure. 
  472. */ 
  473. function update_user_option( $user_id, $option_name, $newvalue, $global = false ) { 
  474. global $wpdb; 
  475.  
  476. if ( !$global ) 
  477. $option_name = $wpdb->get_blog_prefix() . $option_name; 
  478.  
  479. return update_user_meta( $user_id, $option_name, $newvalue ); 
  480.  
  481. /** 
  482. * Delete user option with global blog capability. 
  483. * 
  484. * User options are just like user metadata except that they have support for 
  485. * global blog options. If the 'global' parameter is false, which it is by default 
  486. * it will prepend the WordPress table prefix to the option name. 
  487. * 
  488. * @since 3.0.0 
  489. * 
  490. * @global wpdb $wpdb WordPress database abstraction object. 
  491. * 
  492. * @param int $user_id User ID 
  493. * @param string $option_name User option name. 
  494. * @param bool $global Optional. Whether option name is global or blog specific. 
  495. * Default false (blog specific). 
  496. * @return bool True on success, false on failure. 
  497. */ 
  498. function delete_user_option( $user_id, $option_name, $global = false ) { 
  499. global $wpdb; 
  500.  
  501. if ( !$global ) 
  502. $option_name = $wpdb->get_blog_prefix() . $option_name; 
  503. return delete_user_meta( $user_id, $option_name ); 
  504.  
  505. /** 
  506. * Retrieve list of users matching criteria. 
  507. * 
  508. * @since 3.1.0 
  509. * 
  510. * @see WP_User_Query 
  511. * 
  512. * @param array $args Optional. Arguments to retrieve users. See WP_User_Query::prepare_query(). 
  513. * for more information on accepted arguments. 
  514. * @return array List of users. 
  515. */ 
  516. function get_users( $args = array() ) { 
  517.  
  518. $args = wp_parse_args( $args ); 
  519. $args['count_total'] = false; 
  520.  
  521. $user_search = new WP_User_Query($args); 
  522.  
  523. return (array) $user_search->get_results(); 
  524.  
  525. /** 
  526. * Get the sites a user belongs to. 
  527. * 
  528. * @since 3.0.0 
  529. * @since 4.7.0 Converted to use get_sites(). 
  530. * 
  531. * @global wpdb $wpdb WordPress database abstraction object. 
  532. * 
  533. * @param int $user_id User ID 
  534. * @param bool $all Whether to retrieve all sites, or only sites that are not 
  535. * marked as deleted, archived, or spam. 
  536. * @return array A list of the user's sites. An empty array if the user doesn't exist 
  537. * or belongs to no sites. 
  538. */ 
  539. function get_blogs_of_user( $user_id, $all = false ) { 
  540. global $wpdb; 
  541.  
  542. $user_id = (int) $user_id; 
  543.  
  544. // Logged out users can't have sites 
  545. if ( empty( $user_id ) ) 
  546. return array(); 
  547.  
  548. /** 
  549. * Filters the list of a user's sites before it is populated. 
  550. * 
  551. * Passing a non-null value to the filter will effectively short circuit 
  552. * get_blogs_of_user(), returning that value instead. 
  553. * 
  554. * @since 4.6.0 
  555. * 
  556. * @param null|array $sites An array of site objects of which the user is a member. 
  557. * @param int $user_id User ID. 
  558. * @param bool $all Whether the returned array should contain all sites, including 
  559. * those marked 'deleted', 'archived', or 'spam'. Default false. 
  560. */ 
  561. $sites = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all ); 
  562.  
  563. if ( null !== $sites ) { 
  564. return $sites; 
  565.  
  566. $keys = get_user_meta( $user_id ); 
  567. if ( empty( $keys ) ) 
  568. return array(); 
  569.  
  570. if ( ! is_multisite() ) { 
  571. $site_id = get_current_blog_id(); 
  572. $sites = array( $site_id => new stdClass ); 
  573. $sites[ $site_id ]->userblog_id = $site_id; 
  574. $sites[ $site_id ]->blogname = get_option('blogname'); 
  575. $sites[ $site_id ]->domain = ''; 
  576. $sites[ $site_id ]->path = ''; 
  577. $sites[ $site_id ]->site_id = 1; 
  578. $sites[ $site_id ]->siteurl = get_option('siteurl'); 
  579. $sites[ $site_id ]->archived = 0; 
  580. $sites[ $site_id ]->spam = 0; 
  581. $sites[ $site_id ]->deleted = 0; 
  582. return $sites; 
  583.  
  584. $site_ids = array(); 
  585.  
  586. if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) { 
  587. $site_ids[] = 1; 
  588. unset( $keys[ $wpdb->base_prefix . 'capabilities' ] ); 
  589.  
  590. $keys = array_keys( $keys ); 
  591.  
  592. foreach ( $keys as $key ) { 
  593. if ( 'capabilities' !== substr( $key, -12 ) ) 
  594. continue; 
  595. if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) ) 
  596. continue; 
  597. $site_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key ); 
  598. if ( ! is_numeric( $site_id ) ) 
  599. continue; 
  600.  
  601. $site_ids[] = (int) $site_id; 
  602.  
  603. $sites = array(); 
  604.  
  605. if ( ! empty( $site_ids ) ) { 
  606. $args = array( 
  607. 'number' => '',  
  608. 'site__in' => $site_ids,  
  609. ); 
  610. if ( ! $all ) { 
  611. $args['archived'] = 0; 
  612. $args['spam'] = 0; 
  613. $args['deleted'] = 0; 
  614.  
  615. $_sites = get_sites( $args ); 
  616.  
  617. foreach ( $_sites as $site ) { 
  618. $sites[ $site->id ] = (object) array( 
  619. 'userblog_id' => $site->id,  
  620. 'blogname' => $site->blogname,  
  621. 'domain' => $site->domain,  
  622. 'path' => $site->path,  
  623. 'site_id' => $site->network_id,  
  624. 'siteurl' => $site->siteurl,  
  625. 'archived' => $site->archived,  
  626. 'mature' => $site->mature,  
  627. 'spam' => $site->spam,  
  628. 'deleted' => $site->deleted,  
  629. ); 
  630.  
  631. /** 
  632. * Filters the list of sites a user belongs to. 
  633. * 
  634. * @since MU 
  635. * 
  636. * @param array $sites An array of site objects belonging to the user. 
  637. * @param int $user_id User ID. 
  638. * @param bool $all Whether the returned sites array should contain all sites, including 
  639. * those marked 'deleted', 'archived', or 'spam'. Default false. 
  640. */ 
  641. return apply_filters( 'get_blogs_of_user', $sites, $user_id, $all ); 
  642.  
  643. /** 
  644. * Find out whether a user is a member of a given blog. 
  645. * 
  646. * @since MU 1.1 
  647. * 
  648. * @param int $user_id Optional. The unique ID of the user. Defaults to the current user. 
  649. * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site. 
  650. * @return bool 
  651. */ 
  652. function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) { 
  653. global $wpdb; 
  654.  
  655. $user_id = (int) $user_id; 
  656. $blog_id = (int) $blog_id; 
  657.  
  658. if ( empty( $user_id ) ) { 
  659. $user_id = get_current_user_id(); 
  660.  
  661. // Technically not needed, but does save calls to get_site and get_user_meta 
  662. // in the event that the function is called when a user isn't logged in 
  663. if ( empty( $user_id ) ) { 
  664. return false; 
  665. } else { 
  666. $user = get_userdata( $user_id ); 
  667. if ( ! $user instanceof WP_User ) { 
  668. return false; 
  669.  
  670. if ( ! is_multisite() ) { 
  671. return true; 
  672.  
  673. if ( empty( $blog_id ) ) { 
  674. $blog_id = get_current_blog_id(); 
  675.  
  676. $blog = get_site( $blog_id ); 
  677.  
  678. if ( ! $blog || ! isset( $blog->domain ) || $blog->archived || $blog->spam || $blog->deleted ) { 
  679. return false; 
  680.  
  681. $keys = get_user_meta( $user_id ); 
  682. if ( empty( $keys ) ) { 
  683. return false; 
  684.  
  685. // no underscore before capabilities in $base_capabilities_key 
  686. $base_capabilities_key = $wpdb->base_prefix . 'capabilities'; 
  687. $site_capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities'; 
  688.  
  689. if ( isset( $keys[ $base_capabilities_key ] ) && $blog_id == 1 ) { 
  690. return true; 
  691.  
  692. if ( isset( $keys[ $site_capabilities_key ] ) ) { 
  693. return true; 
  694.  
  695. return false; 
  696.  
  697. /** 
  698. * Add meta data field to a user. 
  699. * 
  700. * Post meta data is called "Custom Fields" on the Administration Screens. 
  701. * 
  702. * @since 3.0.0 
  703. * @link https://codex.wordpress.org/Function_Reference/add_user_meta 
  704. * 
  705. * @param int $user_id User ID. 
  706. * @param string $meta_key Metadata name. 
  707. * @param mixed $meta_value Metadata value. 
  708. * @param bool $unique Optional, default is false. Whether the same key should not be added. 
  709. * @return int|false Meta ID on success, false on failure. 
  710. */ 
  711. function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) { 
  712. return add_metadata('user', $user_id, $meta_key, $meta_value, $unique); 
  713.  
  714. /** 
  715. * Remove metadata matching criteria from a user. 
  716. * 
  717. * You can match based on the key, or key and value. Removing based on key and 
  718. * value, will keep from removing duplicate metadata with the same key. It also 
  719. * allows removing all metadata matching key, if needed. 
  720. * 
  721. * @since 3.0.0 
  722. * @link https://codex.wordpress.org/Function_Reference/delete_user_meta 
  723. * 
  724. * @param int $user_id User ID 
  725. * @param string $meta_key Metadata name. 
  726. * @param mixed $meta_value Optional. Metadata value. 
  727. * @return bool True on success, false on failure. 
  728. */ 
  729. function delete_user_meta($user_id, $meta_key, $meta_value = '') { 
  730. return delete_metadata('user', $user_id, $meta_key, $meta_value); 
  731.  
  732. /** 
  733. * Retrieve user meta field for a user. 
  734. * 
  735. * @since 3.0.0 
  736. * @link https://codex.wordpress.org/Function_Reference/get_user_meta 
  737. * 
  738. * @param int $user_id User ID. 
  739. * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys. 
  740. * @param bool $single Whether to return a single value. 
  741. * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true. 
  742. */ 
  743. function get_user_meta($user_id, $key = '', $single = false) { 
  744. return get_metadata('user', $user_id, $key, $single); 
  745.  
  746. /** 
  747. * Update user meta field based on user ID. 
  748. * 
  749. * Use the $prev_value parameter to differentiate between meta fields with the 
  750. * same key and user ID. 
  751. * 
  752. * If the meta field for the user does not exist, it will be added. 
  753. * 
  754. * @since 3.0.0 
  755. * @link https://codex.wordpress.org/Function_Reference/update_user_meta 
  756. * 
  757. * @param int $user_id User ID. 
  758. * @param string $meta_key Metadata key. 
  759. * @param mixed $meta_value Metadata value. 
  760. * @param mixed $prev_value Optional. Previous value to check before removing. 
  761. * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure. 
  762. */ 
  763. function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') { 
  764. return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value); 
  765.  
  766. /** 
  767. * Count number of users who have each of the user roles. 
  768. * 
  769. * Assumes there are neither duplicated nor orphaned capabilities meta_values. 
  770. * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query() 
  771. * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users. 
  772. * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257. 
  773. * 
  774. * @since 3.0.0 
  775. * @since 4.4.0 The number of users with no role is now included in the `none` element. 
  776. * 
  777. * @global wpdb $wpdb WordPress database abstraction object. 
  778. * 
  779. * @param string $strategy 'time' or 'memory' 
  780. * @return array Includes a grand total and an array of counts indexed by role strings. 
  781. */ 
  782. function count_users($strategy = 'time') { 
  783. global $wpdb; 
  784.  
  785. // Initialize 
  786. $id = get_current_blog_id(); 
  787. $blog_prefix = $wpdb->get_blog_prefix($id); 
  788. $result = array(); 
  789.  
  790. if ( 'time' == $strategy ) { 
  791. $avail_roles = wp_roles()->get_names(); 
  792.  
  793. // Build a CPU-intensive query that will return concise information. 
  794. $select_count = array(); 
  795. foreach ( $avail_roles as $this_role => $name ) { 
  796. $select_count[] = $wpdb->prepare( "COUNT(NULLIF(`meta_value` LIKE %s, false))", '%' . $wpdb->esc_like( '"' . $this_role . '"' ) . '%'); 
  797. $select_count[] = "COUNT(NULLIF(`meta_value` = 'a:0:{}', false))"; 
  798. $select_count = implode(', ', $select_count); 
  799.  
  800. // Add the meta_value index to the selection list, then run the query. 
  801. $row = $wpdb->get_row( "SELECT $select_count, COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'", ARRAY_N ); 
  802.  
  803. // Run the previous loop again to associate results with role names. 
  804. $col = 0; 
  805. $role_counts = array(); 
  806. foreach ( $avail_roles as $this_role => $name ) { 
  807. $count = (int) $row[$col++]; 
  808. if ($count > 0) { 
  809. $role_counts[$this_role] = $count; 
  810.  
  811. $role_counts['none'] = (int) $row[$col++]; 
  812.  
  813. // Get the meta_value index from the end of the result set. 
  814. $total_users = (int) $row[$col]; 
  815.  
  816. $result['total_users'] = $total_users; 
  817. $result['avail_roles'] =& $role_counts; 
  818. } else { 
  819. $avail_roles = array( 
  820. 'none' => 0,  
  821. ); 
  822.  
  823. $users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" ); 
  824.  
  825. foreach ( $users_of_blog as $caps_meta ) { 
  826. $b_roles = maybe_unserialize($caps_meta); 
  827. if ( ! is_array( $b_roles ) ) 
  828. continue; 
  829. if ( empty( $b_roles ) ) { 
  830. $avail_roles['none']++; 
  831. foreach ( $b_roles as $b_role => $val ) { 
  832. if ( isset($avail_roles[$b_role]) ) { 
  833. $avail_roles[$b_role]++; 
  834. } else { 
  835. $avail_roles[$b_role] = 1; 
  836.  
  837. $result['total_users'] = count( $users_of_blog ); 
  838. $result['avail_roles'] =& $avail_roles; 
  839.  
  840. if ( is_multisite() ) { 
  841. $result['avail_roles']['none'] = 0; 
  842.  
  843. return $result; 
  844.  
  845. // 
  846.  // Private helper functions 
  847. // 
  848.   
  849. /** 
  850. * Set up global user vars. 
  851. * 
  852. * Used by wp_set_current_user() for back compat. Might be deprecated in the future. 
  853. * 
  854. * @since 2.0.4 
  855. * 
  856. * @global string $user_login The user username for logging in 
  857. * @global object $userdata User data. 
  858. * @global int $user_level The level of the user 
  859. * @global int $user_ID The ID of the user 
  860. * @global string $user_email The email address of the user 
  861. * @global string $user_url The url in the user's profile 
  862. * @global string $user_identity The display name of the user 
  863. * 
  864. * @param int $for_user_id Optional. User ID to set up global data. 
  865. */ 
  866. function setup_userdata($for_user_id = '') { 
  867. global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_identity; 
  868.  
  869. if ( '' == $for_user_id ) 
  870. $for_user_id = get_current_user_id(); 
  871. $user = get_userdata( $for_user_id ); 
  872.  
  873. if ( ! $user ) { 
  874. $user_ID = 0; 
  875. $user_level = 0; 
  876. $userdata = null; 
  877. $user_login = $user_email = $user_url = $user_identity = ''; 
  878. return; 
  879.  
  880. $user_ID = (int) $user->ID; 
  881. $user_level = (int) $user->user_level; 
  882. $userdata = $user; 
  883. $user_login = $user->user_login; 
  884. $user_email = $user->user_email; 
  885. $user_url = $user->user_url; 
  886. $user_identity = $user->display_name; 
  887.  
  888. /** 
  889. * Create dropdown HTML content of users. 
  890. * 
  891. * The content can either be displayed, which it is by default or retrieved by 
  892. * setting the 'echo' argument. The 'include' and 'exclude' arguments do not 
  893. * need to be used; all users will be displayed in that case. Only one can be 
  894. * used, either 'include' or 'exclude', but not both. 
  895. * 
  896. * The available arguments are as follows: 
  897. * 
  898. * @since 2.3.0 
  899. * @since 4.5.0 Added the 'display_name_with_login' value for 'show'. 
  900. * @since 4.7.0 Added the `$role`, `$role__in`, and `$role__not_in` parameters. 
  901. * 
  902. * @param array|string $args { 
  903. * Optional. Array or string of arguments to generate a drop-down of users. 
  904. * See WP_User_Query::prepare_query() for additional available arguments. 
  905. * 
  906. * @type string $show_option_all Text to show as the drop-down default (all). 
  907. * Default empty. 
  908. * @type string $show_option_none Text to show as the drop-down default when no 
  909. * users were found. Default empty. 
  910. * @type int|string $option_none_value Value to use for $show_option_non when no users 
  911. * were found. Default -1. 
  912. * @type string $hide_if_only_one_author Whether to skip generating the drop-down 
  913. * if only one user was found. Default empty. 
  914. * @type string $orderby Field to order found users by. Accepts user fields. 
  915. * Default 'display_name'. 
  916. * @type string $order Whether to order users in ascending or descending 
  917. * order. Accepts 'ASC' (ascending) or 'DESC' (descending). 
  918. * Default 'ASC'. 
  919. * @type array|string $include Array or comma-separated list of user IDs to include. 
  920. * Default empty. 
  921. * @type array|string $exclude Array or comma-separated list of user IDs to exclude. 
  922. * Default empty. 
  923. * @type bool|int $multi Whether to skip the ID attribute on the 'select' element. 
  924. * Accepts 1|true or 0|false. Default 0|false. 
  925. * @type string $show User data to display. If the selected item is empty 
  926. * then the 'user_login' will be displayed in parentheses. 
  927. * Accepts any user field, or 'display_name_with_login' to show 
  928. * the display name with user_login in parentheses. 
  929. * Default 'display_name'. 
  930. * @type int|bool $echo Whether to echo or return the drop-down. Accepts 1|true (echo) 
  931. * or 0|false (return). Default 1|true. 
  932. * @type int $selected Which user ID should be selected. Default 0. 
  933. * @type bool $include_selected Whether to always include the selected user ID in the drop- 
  934. * down. Default false. 
  935. * @type string $name Name attribute of select element. Default 'user'. 
  936. * @type string $id ID attribute of the select element. Default is the value of $name. 
  937. * @type string $class Class attribute of the select element. Default empty. 
  938. * @type int $blog_id ID of blog (Multisite only). Default is ID of the current blog. 
  939. * @type string $who Which type of users to query. Accepts only an empty string or 
  940. * 'authors'. Default empty. 
  941. * @type string|array $role An array or a comma-separated list of role names that users must 
  942. * match to be included in results. Note that this is an inclusive 
  943. * list: users must match *each* role. Default empty. 
  944. * @type array $role__in An array of role names. Matched users must have at least one of 
  945. * these roles. Default empty array. 
  946. * @type array $role__not_in An array of role names to exclude. Users matching one or more of 
  947. * these roles will not be included in results. Default empty array. 
  948. * } 
  949. * @return string String of HTML content. 
  950. */ 
  951. function wp_dropdown_users( $args = '' ) { 
  952. $defaults = array( 
  953. 'show_option_all' => '', 'show_option_none' => '', 'hide_if_only_one_author' => '',  
  954. 'orderby' => 'display_name', 'order' => 'ASC',  
  955. 'include' => '', 'exclude' => '', 'multi' => 0,  
  956. 'show' => 'display_name', 'echo' => 1,  
  957. 'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',  
  958. 'blog_id' => get_current_blog_id(), 'who' => '', 'include_selected' => false,  
  959. 'option_none_value' => -1,  
  960. 'role' => '',  
  961. 'role__in' => array(),  
  962. 'role__not_in' => array(),  
  963. ); 
  964.  
  965. $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0; 
  966.  
  967. $r = wp_parse_args( $args, $defaults ); 
  968.  
  969. $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who', 'role', 'role__in', 'role__not_in' ) ); 
  970.  
  971. $fields = array( 'ID', 'user_login' ); 
  972.  
  973. $show = ! empty( $r['show'] ) ? $r['show'] : 'display_name'; 
  974. if ( 'display_name_with_login' === $show ) { 
  975. $fields[] = 'display_name'; 
  976. } else { 
  977. $fields[] = $show; 
  978.  
  979. $query_args['fields'] = $fields; 
  980.  
  981. $show_option_all = $r['show_option_all']; 
  982. $show_option_none = $r['show_option_none']; 
  983. $option_none_value = $r['option_none_value']; 
  984.  
  985. /** 
  986. * Filters the query arguments for the list of users in the dropdown. 
  987. * 
  988. * @since 4.4.0 
  989. * 
  990. * @param array $query_args The query arguments for get_users(). 
  991. * @param array $r The arguments passed to wp_dropdown_users() combined with the defaults. 
  992. */ 
  993. $query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $r ); 
  994.  
  995. $users = get_users( $query_args ); 
  996.  
  997. $output = ''; 
  998. if ( ! empty( $users ) && ( empty( $r['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) { 
  999. $name = esc_attr( $r['name'] ); 
  1000. if ( $r['multi'] && ! $r['id'] ) { 
  1001. $id = ''; 
  1002. } else { 
  1003. $id = $r['id'] ? " id='" . esc_attr( $r['id'] ) . "'" : " id='$name'"; 
  1004. $output = "<select name='{$name}'{$id} class='" . $r['class'] . "'>\n"; 
  1005.  
  1006. if ( $show_option_all ) { 
  1007. $output .= "\t<option value='0'>$show_option_all</option>\n"; 
  1008.  
  1009. if ( $show_option_none ) { 
  1010. $_selected = selected( $option_none_value, $r['selected'], false ); 
  1011. $output .= "\t<option value='" . esc_attr( $option_none_value ) . "'$_selected>$show_option_none</option>\n"; 
  1012.  
  1013. if ( $r['include_selected'] && ( $r['selected'] > 0 ) ) { 
  1014. $found_selected = false; 
  1015. $r['selected'] = (int) $r['selected']; 
  1016. foreach ( (array) $users as $user ) { 
  1017. $user->ID = (int) $user->ID; 
  1018. if ( $user->ID === $r['selected'] ) { 
  1019. $found_selected = true; 
  1020.  
  1021. if ( ! $found_selected ) { 
  1022. $users[] = get_userdata( $r['selected'] ); 
  1023.  
  1024. foreach ( (array) $users as $user ) { 
  1025. if ( 'display_name_with_login' === $show ) { 
  1026. /** translators: 1: display name, 2: user_login */ 
  1027. $display = sprintf( _x( '%1$s (%2$s)', 'user dropdown' ), $user->display_name, $user->user_login ); 
  1028. } elseif ( ! empty( $user->$show ) ) { 
  1029. $display = $user->$show; 
  1030. } else { 
  1031. $display = '(' . $user->user_login . ')'; 
  1032.  
  1033. $_selected = selected( $user->ID, $r['selected'], false ); 
  1034. $output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n"; 
  1035.  
  1036. $output .= "</select>"; 
  1037.  
  1038. /** 
  1039. * Filters the wp_dropdown_users() HTML output. 
  1040. * 
  1041. * @since 2.3.0 
  1042. * 
  1043. * @param string $output HTML output generated by wp_dropdown_users(). 
  1044. */ 
  1045. $html = apply_filters( 'wp_dropdown_users', $output ); 
  1046.  
  1047. if ( $r['echo'] ) { 
  1048. echo $html; 
  1049. return $html; 
  1050.  
  1051. /** 
  1052. * Sanitize user field based on context. 
  1053. * 
  1054. * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The 
  1055. * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display' 
  1056. * when calling filters. 
  1057. * 
  1058. * @since 2.3.0 
  1059. * 
  1060. * @param string $field The user Object field name. 
  1061. * @param mixed $value The user Object value. 
  1062. * @param int $user_id User ID. 
  1063. * @param string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display',  
  1064. * 'attribute' and 'js'. 
  1065. * @return mixed Sanitized value. 
  1066. */ 
  1067. function sanitize_user_field($field, $value, $user_id, $context) { 
  1068. $int_fields = array('ID'); 
  1069. if ( in_array($field, $int_fields) ) 
  1070. $value = (int) $value; 
  1071.  
  1072. if ( 'raw' == $context ) 
  1073. return $value; 
  1074.  
  1075. if ( !is_string($value) && !is_numeric($value) ) 
  1076. return $value; 
  1077.  
  1078. $prefixed = false !== strpos( $field, 'user_' ); 
  1079.  
  1080. if ( 'edit' == $context ) { 
  1081. if ( $prefixed ) { 
  1082.  
  1083. /** This filter is documented in wp-includes/post.php */ 
  1084. $value = apply_filters( "edit_{$field}", $value, $user_id ); 
  1085. } else { 
  1086.  
  1087. /** 
  1088. * Filters a user field value in the 'edit' context. 
  1089. * 
  1090. * The dynamic portion of the hook name, `$field`, refers to the prefixed user 
  1091. * field being filtered, such as 'user_login', 'user_email', 'first_name', etc. 
  1092. * 
  1093. * @since 2.9.0 
  1094. * 
  1095. * @param mixed $value Value of the prefixed user field. 
  1096. * @param int $user_id User ID. 
  1097. */ 
  1098. $value = apply_filters( "edit_user_{$field}", $value, $user_id ); 
  1099.  
  1100. if ( 'description' == $field ) 
  1101. $value = esc_html( $value ); // textarea_escaped? 
  1102. else 
  1103. $value = esc_attr($value); 
  1104. } elseif ( 'db' == $context ) { 
  1105. if ( $prefixed ) { 
  1106. /** This filter is documented in wp-includes/post.php */ 
  1107. $value = apply_filters( "pre_{$field}", $value ); 
  1108. } else { 
  1109.  
  1110. /** 
  1111. * Filters the value of a user field in the 'db' context. 
  1112. * 
  1113. * The dynamic portion of the hook name, `$field`, refers to the prefixed user 
  1114. * field being filtered, such as 'user_login', 'user_email', 'first_name', etc. 
  1115. * 
  1116. * @since 2.9.0 
  1117. * 
  1118. * @param mixed $value Value of the prefixed user field. 
  1119. */ 
  1120. $value = apply_filters( "pre_user_{$field}", $value ); 
  1121. } else { 
  1122. // Use display filters by default. 
  1123. if ( $prefixed ) { 
  1124.  
  1125. /** This filter is documented in wp-includes/post.php */ 
  1126. $value = apply_filters( $field, $value, $user_id, $context ); 
  1127. } else { 
  1128.  
  1129. /** 
  1130. * Filters the value of a user field in a standard context. 
  1131. * 
  1132. * The dynamic portion of the hook name, `$field`, refers to the prefixed user 
  1133. * field being filtered, such as 'user_login', 'user_email', 'first_name', etc. 
  1134. * 
  1135. * @since 2.9.0 
  1136. * 
  1137. * @param mixed $value The user object value to sanitize. 
  1138. * @param int $user_id User ID. 
  1139. * @param string $context The context to filter within. 
  1140. */ 
  1141. $value = apply_filters( "user_{$field}", $value, $user_id, $context ); 
  1142.  
  1143. if ( 'user_url' == $field ) 
  1144. $value = esc_url($value); 
  1145.  
  1146. if ( 'attribute' == $context ) { 
  1147. $value = esc_attr( $value ); 
  1148. } elseif ( 'js' == $context ) { 
  1149. $value = esc_js( $value ); 
  1150. return $value; 
  1151.  
  1152. /** 
  1153. * Update all user caches 
  1154. * 
  1155. * @since 3.0.0 
  1156. * 
  1157. * @param object|WP_User $user User object to be cached 
  1158. * @return bool|null Returns false on failure. 
  1159. */ 
  1160. function update_user_caches( $user ) { 
  1161. if ( $user instanceof WP_User ) { 
  1162. if ( ! $user->exists() ) { 
  1163. return false; 
  1164.  
  1165. $user = $user->data; 
  1166.  
  1167. wp_cache_add($user->ID, $user, 'users'); 
  1168. wp_cache_add($user->user_login, $user->ID, 'userlogins'); 
  1169. wp_cache_add($user->user_email, $user->ID, 'useremail'); 
  1170. wp_cache_add($user->user_nicename, $user->ID, 'userslugs'); 
  1171.  
  1172. /** 
  1173. * Clean all user caches 
  1174. * 
  1175. * @since 3.0.0 
  1176. * @since 4.4.0 'clean_user_cache' action was added. 
  1177. * 
  1178. * @param WP_User|int $user User object or ID to be cleaned from the cache 
  1179. */ 
  1180. function clean_user_cache( $user ) { 
  1181. if ( is_numeric( $user ) ) 
  1182. $user = new WP_User( $user ); 
  1183.  
  1184. if ( ! $user->exists() ) 
  1185. return; 
  1186.  
  1187. wp_cache_delete( $user->ID, 'users' ); 
  1188. wp_cache_delete( $user->user_login, 'userlogins' ); 
  1189. wp_cache_delete( $user->user_email, 'useremail' ); 
  1190. wp_cache_delete( $user->user_nicename, 'userslugs' ); 
  1191.  
  1192. /** 
  1193. * Fires immediately after the given user's cache is cleaned. 
  1194. * 
  1195. * @since 4.4.0 
  1196. * 
  1197. * @param int $user_id User ID. 
  1198. * @param WP_User $user User object. 
  1199. */ 
  1200. do_action( 'clean_user_cache', $user->ID, $user ); 
  1201.  
  1202. /** 
  1203. * Checks whether the given username exists. 
  1204. * 
  1205. * @since 2.0.0 
  1206. * 
  1207. * @param string $username Username. 
  1208. * @return int|false The user's ID on success, and false on failure. 
  1209. */ 
  1210. function username_exists( $username ) { 
  1211. if ( $user = get_user_by( 'login', $username ) ) { 
  1212. return $user->ID; 
  1213. return false; 
  1214.  
  1215. /** 
  1216. * Checks whether the given email exists. 
  1217. * 
  1218. * @since 2.1.0 
  1219. * 
  1220. * @param string $email Email. 
  1221. * @return int|false The user's ID on success, and false on failure. 
  1222. */ 
  1223. function email_exists( $email ) { 
  1224. if ( $user = get_user_by( 'email', $email) ) { 
  1225. return $user->ID; 
  1226. return false; 
  1227.  
  1228. /** 
  1229. * Checks whether a username is valid. 
  1230. * 
  1231. * @since 2.0.1 
  1232. * @since 4.4.0 Empty sanitized usernames are now considered invalid 
  1233. * 
  1234. * @param string $username Username. 
  1235. * @return bool Whether username given is valid 
  1236. */ 
  1237. function validate_username( $username ) { 
  1238. $sanitized = sanitize_user( $username, true ); 
  1239. $valid = ( $sanitized == $username && ! empty( $sanitized ) ); 
  1240.  
  1241. /** 
  1242. * Filters whether the provided username is valid or not. 
  1243. * 
  1244. * @since 2.0.1 
  1245. * 
  1246. * @param bool $valid Whether given username is valid. 
  1247. * @param string $username Username to check. 
  1248. */ 
  1249. return apply_filters( 'validate_username', $valid, $username ); 
  1250.  
  1251. /** 
  1252. * Insert a user into the database. 
  1253. * 
  1254. * Most of the `$userdata` array fields have filters associated with the values. Exceptions are 
  1255. * 'ID', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl',  
  1256. * 'user_registered', and 'role'. The filters have the prefix 'pre_user_' followed by the field 
  1257. * name. An example using 'description' would have the filter called, 'pre_user_description' that 
  1258. * can be hooked into. 
  1259. * 
  1260. * @since 2.0.0 
  1261. * @since 3.6.0 The `aim`, `jabber`, and `yim` fields were removed as default user contact 
  1262. * methods for new installs. See wp_get_user_contact_methods(). 
  1263. * @since 4.7.0 The user's locale can be passed to `$userdata`. 
  1264. * 
  1265. * @global wpdb $wpdb WordPress database abstraction object. 
  1266. * 
  1267. * @param array|object|WP_User $userdata { 
  1268. * An array, object, or WP_User object of user data arguments. 
  1269. * 
  1270. * @type int $ID User ID. If supplied, the user will be updated. 
  1271. * @type string $user_pass The plain-text user password. 
  1272. * @type string $user_login The user's login username. 
  1273. * @type string $user_nicename The URL-friendly user name. 
  1274. * @type string $user_url The user URL. 
  1275. * @type string $user_email The user email address. 
  1276. * @type string $display_name The user's display name. 
  1277. * Default is the user's username. 
  1278. * @type string $nickname The user's nickname. 
  1279. * Default is the user's username. 
  1280. * @type string $first_name The user's first name. For new users, will be used 
  1281. * to build the first part of the user's display name 
  1282. * if `$display_name` is not specified. 
  1283. * @type string $last_name The user's last name. For new users, will be used 
  1284. * to build the second part of the user's display name 
  1285. * if `$display_name` is not specified. 
  1286. * @type string $description The user's biographical description. 
  1287. * @type string|bool $rich_editing Whether to enable the rich-editor for the user. 
  1288. * False if not empty. 
  1289. * @type string|bool $comment_shortcuts Whether to enable comment moderation keyboard 
  1290. * shortcuts for the user. Default false. 
  1291. * @type string $admin_color Admin color scheme for the user. Default 'fresh'. 
  1292. * @type bool $use_ssl Whether the user should always access the admin over 
  1293. * https. Default false. 
  1294. * @type string $user_registered Date the user registered. Format is 'Y-m-d H:i:s'. 
  1295. * @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user on the 
  1296. * site's front end. Default true. 
  1297. * @type string $role User's role. 
  1298. * @type string $locale User's locale. Default empty. 
  1299. * } 
  1300. * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not 
  1301. * be created. 
  1302. */ 
  1303. function wp_insert_user( $userdata ) { 
  1304. global $wpdb; 
  1305.  
  1306. if ( $userdata instanceof stdClass ) { 
  1307. $userdata = get_object_vars( $userdata ); 
  1308. } elseif ( $userdata instanceof WP_User ) { 
  1309. $userdata = $userdata->to_array(); 
  1310.  
  1311. // Are we updating or creating? 
  1312. if ( ! empty( $userdata['ID'] ) ) { 
  1313. $ID = (int) $userdata['ID']; 
  1314. $update = true; 
  1315. $old_user_data = get_userdata( $ID ); 
  1316.  
  1317. if ( ! $old_user_data ) { 
  1318. return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) ); 
  1319.  
  1320. // hashed in wp_update_user(), plaintext if called directly 
  1321. $user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass; 
  1322. } else { 
  1323. $update = false; 
  1324. // Hash the password 
  1325. $user_pass = wp_hash_password( $userdata['user_pass'] ); 
  1326.  
  1327. $sanitized_user_login = sanitize_user( $userdata['user_login'], true ); 
  1328.  
  1329. /** 
  1330. * Filters a username after it has been sanitized. 
  1331. * 
  1332. * This filter is called before the user is created or updated. 
  1333. * 
  1334. * @since 2.0.3 
  1335. * 
  1336. * @param string $sanitized_user_login Username after it has been sanitized. 
  1337. */ 
  1338. $pre_user_login = apply_filters( 'pre_user_login', $sanitized_user_login ); 
  1339.  
  1340. //Remove any non-printable chars from the login string to see if we have ended up with an empty username 
  1341. $user_login = trim( $pre_user_login ); 
  1342.  
  1343. // user_login must be between 0 and 60 characters. 
  1344. if ( empty( $user_login ) ) { 
  1345. return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') ); 
  1346. } elseif ( mb_strlen( $user_login ) > 60 ) { 
  1347. return new WP_Error( 'user_login_too_long', __( 'Username may not be longer than 60 characters.' ) ); 
  1348.  
  1349. if ( ! $update && username_exists( $user_login ) ) { 
  1350. return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) ); 
  1351.  
  1352. /** 
  1353. * Filters the list of blacklisted usernames. 
  1354. * 
  1355. * @since 4.4.0 
  1356. * 
  1357. * @param array $usernames Array of blacklisted usernames. 
  1358. */ 
  1359. $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() ); 
  1360.  
  1361. if ( in_array( strtolower( $user_login ), array_map( 'strtolower', $illegal_logins ) ) ) { 
  1362. return new WP_Error( 'invalid_username', __( 'Sorry, that username is not allowed.' ) ); 
  1363.  
  1364. /** 
  1365. * If a nicename is provided, remove unsafe user characters before using it. 
  1366. * Otherwise build a nicename from the user_login. 
  1367. */ 
  1368. if ( ! empty( $userdata['user_nicename'] ) ) { 
  1369. $user_nicename = sanitize_user( $userdata['user_nicename'], true ); 
  1370. if ( mb_strlen( $user_nicename ) > 50 ) { 
  1371. return new WP_Error( 'user_nicename_too_long', __( 'Nicename may not be longer than 50 characters.' ) ); 
  1372. } else { 
  1373. $user_nicename = mb_substr( $user_login, 0, 50 ); 
  1374.  
  1375. $user_nicename = sanitize_title( $user_nicename ); 
  1376.  
  1377. // Store values to save in user meta. 
  1378. $meta = array(); 
  1379.  
  1380. /** 
  1381. * Filters a user's nicename before the user is created or updated. 
  1382. * 
  1383. * @since 2.0.3 
  1384. * 
  1385. * @param string $user_nicename The user's nicename. 
  1386. */ 
  1387. $user_nicename = apply_filters( 'pre_user_nicename', $user_nicename ); 
  1388.  
  1389. $raw_user_url = empty( $userdata['user_url'] ) ? '' : $userdata['user_url']; 
  1390.  
  1391. /** 
  1392. * Filters a user's URL before the user is created or updated. 
  1393. * 
  1394. * @since 2.0.3 
  1395. * 
  1396. * @param string $raw_user_url The user's URL. 
  1397. */ 
  1398. $user_url = apply_filters( 'pre_user_url', $raw_user_url ); 
  1399.  
  1400. $raw_user_email = empty( $userdata['user_email'] ) ? '' : $userdata['user_email']; 
  1401.  
  1402. /** 
  1403. * Filters a user's email before the user is created or updated. 
  1404. * 
  1405. * @since 2.0.3 
  1406. * 
  1407. * @param string $raw_user_email The user's email. 
  1408. */ 
  1409. $user_email = apply_filters( 'pre_user_email', $raw_user_email ); 
  1410.  
  1411. /** 
  1412. * If there is no update, just check for `email_exists`. If there is an update,  
  1413. * check if current email and new email are the same, or not, and check `email_exists` 
  1414. * accordingly. 
  1415. */ 
  1416. if ( ( ! $update || ( ! empty( $old_user_data ) && 0 !== strcasecmp( $user_email, $old_user_data->user_email ) ) ) 
  1417. && ! defined( 'WP_IMPORTING' ) 
  1418. && email_exists( $user_email ) 
  1419. ) { 
  1420. return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) ); 
  1421. $nickname = empty( $userdata['nickname'] ) ? $user_login : $userdata['nickname']; 
  1422.  
  1423. /** 
  1424. * Filters a user's nickname before the user is created or updated. 
  1425. * 
  1426. * @since 2.0.3 
  1427. * 
  1428. * @param string $nickname The user's nickname. 
  1429. */ 
  1430. $meta['nickname'] = apply_filters( 'pre_user_nickname', $nickname ); 
  1431.  
  1432. $first_name = empty( $userdata['first_name'] ) ? '' : $userdata['first_name']; 
  1433.  
  1434. /** 
  1435. * Filters a user's first name before the user is created or updated. 
  1436. * 
  1437. * @since 2.0.3 
  1438. * 
  1439. * @param string $first_name The user's first name. 
  1440. */ 
  1441. $meta['first_name'] = apply_filters( 'pre_user_first_name', $first_name ); 
  1442.  
  1443. $last_name = empty( $userdata['last_name'] ) ? '' : $userdata['last_name']; 
  1444.  
  1445. /** 
  1446. * Filters a user's last name before the user is created or updated. 
  1447. * 
  1448. * @since 2.0.3 
  1449. * 
  1450. * @param string $last_name The user's last name. 
  1451. */ 
  1452. $meta['last_name'] = apply_filters( 'pre_user_last_name', $last_name ); 
  1453.  
  1454. if ( empty( $userdata['display_name'] ) ) { 
  1455. if ( $update ) { 
  1456. $display_name = $user_login; 
  1457. } elseif ( $meta['first_name'] && $meta['last_name'] ) { 
  1458. /** translators: 1: first name, 2: last name */ 
  1459. $display_name = sprintf( _x( '%1$s %2$s', 'Display name based on first name and last name' ), $meta['first_name'], $meta['last_name'] ); 
  1460. } elseif ( $meta['first_name'] ) { 
  1461. $display_name = $meta['first_name']; 
  1462. } elseif ( $meta['last_name'] ) { 
  1463. $display_name = $meta['last_name']; 
  1464. } else { 
  1465. $display_name = $user_login; 
  1466. } else { 
  1467. $display_name = $userdata['display_name']; 
  1468.  
  1469. /** 
  1470. * Filters a user's display name before the user is created or updated. 
  1471. * 
  1472. * @since 2.0.3 
  1473. * 
  1474. * @param string $display_name The user's display name. 
  1475. */ 
  1476. $display_name = apply_filters( 'pre_user_display_name', $display_name ); 
  1477.  
  1478. $description = empty( $userdata['description'] ) ? '' : $userdata['description']; 
  1479.  
  1480. /** 
  1481. * Filters a user's description before the user is created or updated. 
  1482. * 
  1483. * @since 2.0.3 
  1484. * 
  1485. * @param string $description The user's description. 
  1486. */ 
  1487. $meta['description'] = apply_filters( 'pre_user_description', $description ); 
  1488.  
  1489. $meta['rich_editing'] = empty( $userdata['rich_editing'] ) ? 'true' : $userdata['rich_editing']; 
  1490.  
  1491. $meta['comment_shortcuts'] = empty( $userdata['comment_shortcuts'] ) || 'false' === $userdata['comment_shortcuts'] ? 'false' : 'true'; 
  1492.  
  1493. $admin_color = empty( $userdata['admin_color'] ) ? 'fresh' : $userdata['admin_color']; 
  1494. $meta['admin_color'] = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $admin_color ); 
  1495.  
  1496. $meta['use_ssl'] = empty( $userdata['use_ssl'] ) ? 0 : $userdata['use_ssl']; 
  1497.  
  1498. $user_registered = empty( $userdata['user_registered'] ) ? gmdate( 'Y-m-d H:i:s' ) : $userdata['user_registered']; 
  1499.  
  1500. $meta['show_admin_bar_front'] = empty( $userdata['show_admin_bar_front'] ) ? 'true' : $userdata['show_admin_bar_front']; 
  1501.  
  1502. $meta['locale'] = isset( $userdata['locale'] ) ? $userdata['locale'] : ''; 
  1503.  
  1504. $user_nicename_check = $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->users WHERE user_nicename = %s AND user_login != %s LIMIT 1" , $user_nicename, $user_login)); 
  1505.  
  1506. if ( $user_nicename_check ) { 
  1507. $suffix = 2; 
  1508. while ($user_nicename_check) { 
  1509. // user_nicename allows 50 chars. Subtract one for a hyphen, plus the length of the suffix. 
  1510. $base_length = 49 - mb_strlen( $suffix ); 
  1511. $alt_user_nicename = mb_substr( $user_nicename, 0, $base_length ) . "-$suffix"; 
  1512. $user_nicename_check = $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->users WHERE user_nicename = %s AND user_login != %s LIMIT 1" , $alt_user_nicename, $user_login)); 
  1513. $suffix++; 
  1514. $user_nicename = $alt_user_nicename; 
  1515.  
  1516. $compacted = compact( 'user_pass', 'user_email', 'user_url', 'user_nicename', 'display_name', 'user_registered' ); 
  1517. $data = wp_unslash( $compacted ); 
  1518.  
  1519. if ( $update ) { 
  1520. if ( $user_email !== $old_user_data->user_email ) { 
  1521. $data['user_activation_key'] = ''; 
  1522. $wpdb->update( $wpdb->users, $data, compact( 'ID' ) ); 
  1523. $user_id = (int) $ID; 
  1524. } else { 
  1525. $wpdb->insert( $wpdb->users, $data + compact( 'user_login' ) ); 
  1526. $user_id = (int) $wpdb->insert_id; 
  1527.  
  1528. $user = new WP_User( $user_id ); 
  1529.  
  1530. /** 
  1531. * Filters a user's meta values and keys before the user is created or updated. 
  1532. * 
  1533. * Does not include contact methods. These are added using `wp_get_user_contact_methods( $user )`. 
  1534. * 
  1535. * @since 4.4.0 
  1536. * 
  1537. * @param array $meta { 
  1538. * Default meta values and keys for the user. 
  1539. * 
  1540. * @type string $nickname The user's nickname. Default is the user's username. 
  1541. * @type string $first_name The user's first name. 
  1542. * @type string $last_name The user's last name. 
  1543. * @type string $description The user's description. 
  1544. * @type bool $rich_editing Whether to enable the rich-editor for the user. False if not empty. 
  1545. * @type bool $comment_shortcuts Whether to enable keyboard shortcuts for the user. Default false. 
  1546. * @type string $admin_color The color scheme for a user's admin screen. Default 'fresh'. 
  1547. * @type int|bool $use_ssl Whether to force SSL on the user's admin area. 0|false if SSL is 
  1548. * not forced. 
  1549. * @type bool $show_admin_bar_front Whether to show the admin bar on the front end for the user. 
  1550. * Default true. 
  1551. * } 
  1552. * @param WP_User $user User object. 
  1553. * @param bool $update Whether the user is being updated rather than created. 
  1554. */ 
  1555. $meta = apply_filters( 'insert_user_meta', $meta, $user, $update ); 
  1556.  
  1557. // Update user meta. 
  1558. foreach ( $meta as $key => $value ) { 
  1559. update_user_meta( $user_id, $key, $value ); 
  1560.  
  1561. foreach ( wp_get_user_contact_methods( $user ) as $key => $value ) { 
  1562. if ( isset( $userdata[ $key ] ) ) { 
  1563. update_user_meta( $user_id, $key, $userdata[ $key ] ); 
  1564.  
  1565. if ( isset( $userdata['role'] ) ) { 
  1566. $user->set_role( $userdata['role'] ); 
  1567. } elseif ( ! $update ) { 
  1568. $user->set_role(get_option('default_role')); 
  1569. wp_cache_delete( $user_id, 'users' ); 
  1570. wp_cache_delete( $user_login, 'userlogins' ); 
  1571.  
  1572. if ( $update ) { 
  1573. /** 
  1574. * Fires immediately after an existing user is updated. 
  1575. * 
  1576. * @since 2.0.0 
  1577. * 
  1578. * @param int $user_id User ID. 
  1579. * @param object $old_user_data Object containing user's data prior to update. 
  1580. */ 
  1581. do_action( 'profile_update', $user_id, $old_user_data ); 
  1582. } else { 
  1583. /** 
  1584. * Fires immediately after a new user is registered. 
  1585. * 
  1586. * @since 1.5.0 
  1587. * 
  1588. * @param int $user_id User ID. 
  1589. */ 
  1590. do_action( 'user_register', $user_id ); 
  1591.  
  1592. return $user_id; 
  1593.  
  1594. /** 
  1595. * Update a user in the database. 
  1596. * 
  1597. * It is possible to update a user's password by specifying the 'user_pass' 
  1598. * value in the $userdata parameter array. 
  1599. * 
  1600. * If current user's password is being updated, then the cookies will be 
  1601. * cleared. 
  1602. * 
  1603. * @since 2.0.0 
  1604. * 
  1605. * @see wp_insert_user() For what fields can be set in $userdata. 
  1606. * 
  1607. * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User. 
  1608. * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated. 
  1609. */ 
  1610. function wp_update_user($userdata) { 
  1611. if ( $userdata instanceof stdClass ) { 
  1612. $userdata = get_object_vars( $userdata ); 
  1613. } elseif ( $userdata instanceof WP_User ) { 
  1614. $userdata = $userdata->to_array(); 
  1615.  
  1616. $ID = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0; 
  1617. if ( ! $ID ) { 
  1618. return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) ); 
  1619.  
  1620. // First, get all of the original fields 
  1621. $user_obj = get_userdata( $ID ); 
  1622. if ( ! $user_obj ) { 
  1623. return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) ); 
  1624.  
  1625. $user = $user_obj->to_array(); 
  1626.  
  1627. // Add additional custom fields 
  1628. foreach ( _get_additional_user_keys( $user_obj ) as $key ) { 
  1629. $user[ $key ] = get_user_meta( $ID, $key, true ); 
  1630.  
  1631. // Escape data pulled from DB. 
  1632. $user = add_magic_quotes( $user ); 
  1633.  
  1634. if ( ! empty( $userdata['user_pass'] ) && $userdata['user_pass'] !== $user_obj->user_pass ) { 
  1635. // If password is changing, hash it now 
  1636. $plaintext_pass = $userdata['user_pass']; 
  1637. $userdata['user_pass'] = wp_hash_password( $userdata['user_pass'] ); 
  1638.  
  1639. /** 
  1640. * Filters whether to send the password change email. 
  1641. * 
  1642. * @since 4.3.0 
  1643. * 
  1644. * @see wp_insert_user() For `$user` and `$userdata` fields. 
  1645. * 
  1646. * @param bool $send Whether to send the email. 
  1647. * @param array $user The original user array. 
  1648. * @param array $userdata The updated user array. 
  1649. * 
  1650. */ 
  1651. $send_password_change_email = apply_filters( 'send_password_change_email', true, $user, $userdata ); 
  1652.  
  1653. if ( isset( $userdata['user_email'] ) && $user['user_email'] !== $userdata['user_email'] ) { 
  1654. /** 
  1655. * Filters whether to send the email change email. 
  1656. * 
  1657. * @since 4.3.0 
  1658. * 
  1659. * @see wp_insert_user() For `$user` and `$userdata` fields. 
  1660. * 
  1661. * @param bool $send Whether to send the email. 
  1662. * @param array $user The original user array. 
  1663. * @param array $userdata The updated user array. 
  1664. * 
  1665. */ 
  1666. $send_email_change_email = apply_filters( 'send_email_change_email', true, $user, $userdata ); 
  1667.  
  1668. wp_cache_delete( $user['user_email'], 'useremail' ); 
  1669. wp_cache_delete( $user['user_nicename'], 'userslugs' ); 
  1670.  
  1671. // Merge old and new fields with new fields overwriting old ones. 
  1672. $userdata = array_merge( $user, $userdata ); 
  1673. $user_id = wp_insert_user( $userdata ); 
  1674.  
  1675. if ( ! is_wp_error( $user_id ) ) { 
  1676.  
  1677. $blog_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ); 
  1678.  
  1679. $switched_locale = false; 
  1680. if ( ! empty( $send_password_change_email ) || ! empty( $send_email_change_email ) ) { 
  1681. $switched_locale = switch_to_locale( get_user_locale( $user_id ) ); 
  1682.  
  1683. if ( ! empty( $send_password_change_email ) ) { 
  1684. /** translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */ 
  1685. $pass_change_text = __( 'Hi ###USERNAME###,  
  1686.  
  1687. This notice confirms that your password was changed on ###SITENAME###. 
  1688.  
  1689. If you did not change your password, please contact the Site Administrator at 
  1690. ###ADMIN_EMAIL### 
  1691.  
  1692. This email has been sent to ###EMAIL### 
  1693.  
  1694. Regards,  
  1695. All at ###SITENAME### 
  1696. ###SITEURL###' ); 
  1697.  
  1698. $pass_change_email = array( 
  1699. 'to' => $user['user_email'],  
  1700. /** translators: User password change notification email subject. 1: Site name */ 
  1701. 'subject' => __( '[%s] Notice of Password Change' ),  
  1702. 'message' => $pass_change_text,  
  1703. 'headers' => '',  
  1704. ); 
  1705.  
  1706. /** 
  1707. * Filters the contents of the email sent when the user's password is changed. 
  1708. * 
  1709. * @since 4.3.0 
  1710. * 
  1711. * @param array $pass_change_email { 
  1712. * Used to build wp_mail(). 
  1713. * @type string $to The intended recipients. Add emails in a comma separated string. 
  1714. * @type string $subject The subject of the email. 
  1715. * @type string $message The content of the email. 
  1716. * The following strings have a special meaning and will get replaced dynamically: 
  1717. * - ###USERNAME### The current user's username. 
  1718. * - ###ADMIN_EMAIL### The admin email in case this was unexpected. 
  1719. * - ###EMAIL### The old email. 
  1720. * - ###SITENAME### The name of the site. 
  1721. * - ###SITEURL### The URL to the site. 
  1722. * @type string $headers Headers. Add headers in a newline (\r\n) separated string. 
  1723. * } 
  1724. * @param array $user The original user array. 
  1725. * @param array $userdata The updated user array. 
  1726. * 
  1727. */ 
  1728. $pass_change_email = apply_filters( 'password_change_email', $pass_change_email, $user, $userdata ); 
  1729.  
  1730. $pass_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $pass_change_email['message'] ); 
  1731. $pass_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $pass_change_email['message'] ); 
  1732. $pass_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $pass_change_email['message'] ); 
  1733. $pass_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $pass_change_email['message'] ); 
  1734. $pass_change_email['message'] = str_replace( '###SITEURL###', home_url(), $pass_change_email['message'] ); 
  1735.  
  1736. wp_mail( $pass_change_email['to'], sprintf( $pass_change_email['subject'], $blog_name ), $pass_change_email['message'], $pass_change_email['headers'] ); 
  1737.  
  1738. if ( ! empty( $send_email_change_email ) ) { 
  1739. /** translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */ 
  1740. $email_change_text = __( 'Hi ###USERNAME###,  
  1741.  
  1742. This notice confirms that your email was changed on ###SITENAME###. 
  1743.  
  1744. If you did not change your email, please contact the Site Administrator at 
  1745. ###ADMIN_EMAIL### 
  1746.  
  1747. This email has been sent to ###EMAIL### 
  1748.  
  1749. Regards,  
  1750. All at ###SITENAME### 
  1751. ###SITEURL###' ); 
  1752.  
  1753. $email_change_email = array( 
  1754. 'to' => $user['user_email'],  
  1755. /** translators: User email change notification email subject. 1: Site name */ 
  1756. 'subject' => __( '[%s] Notice of Email Change' ),  
  1757. 'message' => $email_change_text,  
  1758. 'headers' => '',  
  1759. ); 
  1760.  
  1761. /** 
  1762. * Filters the contents of the email sent when the user's email is changed. 
  1763. * 
  1764. * @since 4.3.0 
  1765. * 
  1766. * @param array $email_change_email { 
  1767. * Used to build wp_mail(). 
  1768. * @type string $to The intended recipients. 
  1769. * @type string $subject The subject of the email. 
  1770. * @type string $message The content of the email. 
  1771. * The following strings have a special meaning and will get replaced dynamically: 
  1772. * - ###USERNAME### The current user's username. 
  1773. * - ###ADMIN_EMAIL### The admin email in case this was unexpected. 
  1774. * - ###EMAIL### The old email. 
  1775. * - ###SITENAME### The name of the site. 
  1776. * - ###SITEURL### The URL to the site. 
  1777. * @type string $headers Headers. 
  1778. * } 
  1779. * @param array $user The original user array. 
  1780. * @param array $userdata The updated user array. 
  1781. */ 
  1782. $email_change_email = apply_filters( 'email_change_email', $email_change_email, $user, $userdata ); 
  1783.  
  1784. $email_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $email_change_email['message'] ); 
  1785. $email_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $email_change_email['message'] ); 
  1786. $email_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $email_change_email['message'] ); 
  1787. $email_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $email_change_email['message'] ); 
  1788. $email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] ); 
  1789.  
  1790. wp_mail( $email_change_email['to'], sprintf( $email_change_email['subject'], $blog_name ), $email_change_email['message'], $email_change_email['headers'] ); 
  1791.  
  1792. if ( $switched_locale ) { 
  1793. restore_previous_locale(); 
  1794.  
  1795. // Update the cookies if the password changed. 
  1796. $current_user = wp_get_current_user(); 
  1797. if ( $current_user->ID == $ID ) { 
  1798. if ( isset($plaintext_pass) ) { 
  1799. wp_clear_auth_cookie(); 
  1800.  
  1801. // Here we calculate the expiration length of the current auth cookie and compare it to the default expiration. 
  1802. // If it's greater than this, then we know the user checked 'Remember Me' when they logged in. 
  1803. $logged_in_cookie = wp_parse_auth_cookie( '', 'logged_in' ); 
  1804. /** This filter is documented in wp-includes/pluggable.php */ 
  1805. $default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $ID, false ); 
  1806. $remember = ( ( $logged_in_cookie['expiration'] - time() ) > $default_cookie_life ); 
  1807.  
  1808. wp_set_auth_cookie( $ID, $remember ); 
  1809.  
  1810. return $user_id; 
  1811.  
  1812. /** 
  1813. * A simpler way of inserting a user into the database. 
  1814. * 
  1815. * Creates a new user with just the username, password, and email. For more 
  1816. * complex user creation use wp_insert_user() to specify more information. 
  1817. * 
  1818. * @since 2.0.0 
  1819. * @see wp_insert_user() More complete way to create a new user 
  1820. * 
  1821. * @param string $username The user's username. 
  1822. * @param string $password The user's password. 
  1823. * @param string $email Optional. The user's email. Default empty. 
  1824. * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not 
  1825. * be created. 
  1826. */ 
  1827. function wp_create_user($username, $password, $email = '') { 
  1828. $user_login = wp_slash( $username ); 
  1829. $user_email = wp_slash( $email ); 
  1830. $user_pass = $password; 
  1831.  
  1832. $userdata = compact('user_login', 'user_email', 'user_pass'); 
  1833. return wp_insert_user($userdata); 
  1834.  
  1835. /** 
  1836. * Returns a list of meta keys to be (maybe) populated in wp_update_user(). 
  1837. * 
  1838. * The list of keys returned via this function are dependent on the presence 
  1839. * of those keys in the user meta data to be set. 
  1840. * 
  1841. * @since 3.3.0 
  1842. * @access private 
  1843. * 
  1844. * @param WP_User $user WP_User instance. 
  1845. * @return array List of user keys to be populated in wp_update_user(). 
  1846. */ 
  1847. function _get_additional_user_keys( $user ) { 
  1848. $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front', 'locale' ); 
  1849. return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) ); 
  1850.  
  1851. /** 
  1852. * Set up the user contact methods. 
  1853. * 
  1854. * Default contact methods were removed in 3.6. A filter dictates contact methods. 
  1855. * 
  1856. * @since 3.7.0 
  1857. * 
  1858. * @param WP_User $user Optional. WP_User object. 
  1859. * @return array Array of contact methods and their labels. 
  1860. */ 
  1861. function wp_get_user_contact_methods( $user = null ) { 
  1862. $methods = array(); 
  1863. if ( get_site_option( 'initial_db_version' ) < 23588 ) { 
  1864. $methods = array( 
  1865. 'aim' => __( 'AIM' ),  
  1866. 'yim' => __( 'Yahoo IM' ),  
  1867. 'jabber' => __( 'Jabber / Google Talk' ) 
  1868. ); 
  1869.  
  1870. /** 
  1871. * Filters the user contact methods. 
  1872. * 
  1873. * @since 2.9.0 
  1874. * 
  1875. * @param array $methods Array of contact methods and their labels. 
  1876. * @param WP_User $user WP_User object. 
  1877. */ 
  1878. return apply_filters( 'user_contactmethods', $methods, $user ); 
  1879.  
  1880. /** 
  1881. * The old private function for setting up user contact methods. 
  1882. * 
  1883. * Use wp_get_user_contact_methods() instead. 
  1884. * 
  1885. * @since 2.9.0 
  1886. * @access private 
  1887. * 
  1888. * @param WP_User $user Optional. WP_User object. Default null. 
  1889. * @return array Array of contact methods and their labels. 
  1890. */ 
  1891. function _wp_get_user_contactmethods( $user = null ) { 
  1892. return wp_get_user_contact_methods( $user ); 
  1893.  
  1894. /** 
  1895. * Gets the text suggesting how to create strong passwords. 
  1896. * 
  1897. * @since 4.1.0 
  1898. * 
  1899. * @return string The password hint text. 
  1900. */ 
  1901. function wp_get_password_hint() { 
  1902. $hint = __( 'Hint: The password should be at least twelve characters long. To make it stronger, use upper and lower case letters, numbers, and symbols like ! " ? $ % ^ & ).' ); 
  1903.  
  1904. /** 
  1905. * Filters the text describing the site's password complexity policy. 
  1906. * 
  1907. * @since 4.1.0 
  1908. * 
  1909. * @param string $hint The password hint text. 
  1910. */ 
  1911. return apply_filters( 'password_hint', $hint ); 
  1912.  
  1913. /** 
  1914. * Creates, stores, then returns a password reset key for user. 
  1915. * 
  1916. * @since 4.4.0 
  1917. * 
  1918. * @global wpdb $wpdb WordPress database abstraction object. 
  1919. * @global PasswordHash $wp_hasher Portable PHP password hashing framework. 
  1920. * 
  1921. * @param WP_User $user User to retrieve password reset key for. 
  1922. * 
  1923. * @return string|WP_Error Password reset key on success. WP_Error on error. 
  1924. */ 
  1925. function get_password_reset_key( $user ) { 
  1926. global $wpdb, $wp_hasher; 
  1927.  
  1928. /** 
  1929. * Fires before a new password is retrieved. 
  1930. * 
  1931. * Use the {@see 'retrieve_password'} hook instead. 
  1932. * 
  1933. * @since 1.5.0 
  1934. * @deprecated 1.5.1 Misspelled. Use 'retrieve_password' hook instead. 
  1935. * 
  1936. * @param string $user_login The user login name. 
  1937. */ 
  1938. do_action( 'retreive_password', $user->user_login ); 
  1939.  
  1940. /** 
  1941. * Fires before a new password is retrieved. 
  1942. * 
  1943. * @since 1.5.1 
  1944. * 
  1945. * @param string $user_login The user login name. 
  1946. */ 
  1947. do_action( 'retrieve_password', $user->user_login ); 
  1948.  
  1949. $allow = true; 
  1950. if ( is_multisite() && is_user_spammy( $user ) ) { 
  1951. $allow = false; 
  1952.  
  1953. /** 
  1954. * Filters whether to allow a password to be reset. 
  1955. * 
  1956. * @since 2.7.0 
  1957. * 
  1958. * @param bool $allow Whether to allow the password to be reset. Default true. 
  1959. * @param int $user_data->ID The ID of the user attempting to reset a password. 
  1960. */ 
  1961. $allow = apply_filters( 'allow_password_reset', $allow, $user->ID ); 
  1962.  
  1963. if ( ! $allow ) { 
  1964. return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) ); 
  1965. } elseif ( is_wp_error( $allow ) ) { 
  1966. return $allow; 
  1967.  
  1968. // Generate something random for a password reset key. 
  1969. $key = wp_generate_password( 20, false ); 
  1970.  
  1971. /** 
  1972. * Fires when a password reset key is generated. 
  1973. * 
  1974. * @since 2.5.0 
  1975. * 
  1976. * @param string $user_login The username for the user. 
  1977. * @param string $key The generated password reset key. 
  1978. */ 
  1979. do_action( 'retrieve_password_key', $user->user_login, $key ); 
  1980.  
  1981. // Now insert the key, hashed, into the DB. 
  1982. if ( empty( $wp_hasher ) ) { 
  1983. $wp_hasher = new PasswordHash( 8, true ); 
  1984. $hashed = time() . ':' . $wp_hasher->HashPassword( $key ); 
  1985. $key_saved = $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) ); 
  1986. if ( false === $key_saved ) { 
  1987. return new WP_Error( 'no_password_key_update', __( 'Could not save password reset key to database.' ) ); 
  1988.  
  1989. return $key; 
  1990.  
  1991. /** 
  1992. * Retrieves a user row based on password reset key and login 
  1993. * 
  1994. * A key is considered 'expired' if it exactly matches the value of the 
  1995. * user_activation_key field, rather than being matched after going through the 
  1996. * hashing process. This field is now hashed; old values are no longer accepted 
  1997. * but have a different WP_Error code so good user feedback can be provided. 
  1998. * 
  1999. * @since 3.1.0 
  2000. * 
  2001. * @global wpdb $wpdb WordPress database object for queries. 
  2002. * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance. 
  2003. * 
  2004. * @param string $key Hash to validate sending user's password. 
  2005. * @param string $login The user login. 
  2006. * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys. 
  2007. */ 
  2008. function check_password_reset_key($key, $login) { 
  2009. global $wpdb, $wp_hasher; 
  2010.  
  2011. $key = preg_replace('/[^a-z0-9]/i', '', $key); 
  2012.  
  2013. if ( empty( $key ) || !is_string( $key ) ) 
  2014. return new WP_Error('invalid_key', __('Invalid key')); 
  2015.  
  2016. if ( empty($login) || !is_string($login) ) 
  2017. return new WP_Error('invalid_key', __('Invalid key')); 
  2018.  
  2019. $row = $wpdb->get_row( $wpdb->prepare( "SELECT ID, user_activation_key FROM $wpdb->users WHERE user_login = %s", $login ) ); 
  2020. if ( ! $row ) 
  2021. return new WP_Error('invalid_key', __('Invalid key')); 
  2022.  
  2023. if ( empty( $wp_hasher ) ) { 
  2024. $wp_hasher = new PasswordHash( 8, true ); 
  2025.  
  2026. /** 
  2027. * Filters the expiration time of password reset keys. 
  2028. * 
  2029. * @since 4.3.0 
  2030. * 
  2031. * @param int $expiration The expiration time in seconds. 
  2032. */ 
  2033. $expiration_duration = apply_filters( 'password_reset_expiration', DAY_IN_SECONDS ); 
  2034.  
  2035. if ( false !== strpos( $row->user_activation_key, ':' ) ) { 
  2036. list( $pass_request_time, $pass_key ) = explode( ':', $row->user_activation_key, 2 ); 
  2037. $expiration_time = $pass_request_time + $expiration_duration; 
  2038. } else { 
  2039. $pass_key = $row->user_activation_key; 
  2040. $expiration_time = false; 
  2041.  
  2042. if ( ! $pass_key ) { 
  2043. return new WP_Error( 'invalid_key', __( 'Invalid key' ) ); 
  2044.  
  2045. $hash_is_correct = $wp_hasher->CheckPassword( $key, $pass_key ); 
  2046.  
  2047. if ( $hash_is_correct && $expiration_time && time() < $expiration_time ) { 
  2048. return get_userdata( $row->ID ); 
  2049. } elseif ( $hash_is_correct && $expiration_time ) { 
  2050. // Key has an expiration time that's passed 
  2051. return new WP_Error( 'expired_key', __( 'Invalid key' ) ); 
  2052.  
  2053. if ( hash_equals( $row->user_activation_key, $key ) || ( $hash_is_correct && ! $expiration_time ) ) { 
  2054. $return = new WP_Error( 'expired_key', __( 'Invalid key' ) ); 
  2055. $user_id = $row->ID; 
  2056.  
  2057. /** 
  2058. * Filters the return value of check_password_reset_key() when an 
  2059. * old-style key is used. 
  2060. * 
  2061. * @since 3.7.0 Previously plain-text keys were stored in the database. 
  2062. * @since 4.3.0 Previously key hashes were stored without an expiration time. 
  2063. * 
  2064. * @param WP_Error $return A WP_Error object denoting an expired key. 
  2065. * Return a WP_User object to validate the key. 
  2066. * @param int $user_id The matched user ID. 
  2067. */ 
  2068. return apply_filters( 'password_reset_key_expired', $return, $user_id ); 
  2069.  
  2070. return new WP_Error( 'invalid_key', __( 'Invalid key' ) ); 
  2071.  
  2072. /** 
  2073. * Handles resetting the user's password. 
  2074. * 
  2075. * @since 2.5.0 
  2076. * 
  2077. * @param object $user The user 
  2078. * @param string $new_pass New password for the user in plaintext 
  2079. */ 
  2080. function reset_password( $user, $new_pass ) { 
  2081. /** 
  2082. * Fires before the user's password is reset. 
  2083. * 
  2084. * @since 1.5.0 
  2085. * 
  2086. * @param object $user The user. 
  2087. * @param string $new_pass New user password. 
  2088. */ 
  2089. do_action( 'password_reset', $user, $new_pass ); 
  2090.  
  2091. wp_set_password( $new_pass, $user->ID ); 
  2092. update_user_option( $user->ID, 'default_password_nag', false, true ); 
  2093.  
  2094. /** 
  2095. * Fires after the user's password is reset. 
  2096. * 
  2097. * @since 4.4.0 
  2098. * 
  2099. * @param object $user The user. 
  2100. * @param string $new_pass New user password. 
  2101. */ 
  2102. do_action( 'after_password_reset', $user, $new_pass ); 
  2103.  
  2104. /** 
  2105. * Handles registering a new user. 
  2106. * 
  2107. * @since 2.5.0 
  2108. * 
  2109. * @param string $user_login User's username for logging in 
  2110. * @param string $user_email User's email address to send password and add 
  2111. * @return int|WP_Error Either user's ID or error on failure. 
  2112. */ 
  2113. function register_new_user( $user_login, $user_email ) { 
  2114. $errors = new WP_Error(); 
  2115.  
  2116. $sanitized_user_login = sanitize_user( $user_login ); 
  2117. /** 
  2118. * Filters the email address of a user being registered. 
  2119. * 
  2120. * @since 2.1.0 
  2121. * 
  2122. * @param string $user_email The email address of the new user. 
  2123. */ 
  2124. $user_email = apply_filters( 'user_registration_email', $user_email ); 
  2125.  
  2126. // Check the username 
  2127. if ( $sanitized_user_login == '' ) { 
  2128. $errors->add( 'empty_username', __( '<strong>ERROR</strong>: Please enter a username.' ) ); 
  2129. } elseif ( ! validate_username( $user_login ) ) { 
  2130. $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ) ); 
  2131. $sanitized_user_login = ''; 
  2132. } elseif ( username_exists( $sanitized_user_login ) ) { 
  2133. $errors->add( 'username_exists', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ) ); 
  2134.  
  2135. } else { 
  2136. /** This filter is documented in wp-includes/user.php */ 
  2137. $illegal_user_logins = array_map( 'strtolower', (array) apply_filters( 'illegal_user_logins', array() ) ); 
  2138. if ( in_array( strtolower( $sanitized_user_login ), $illegal_user_logins ) ) { 
  2139. $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: Sorry, that username is not allowed.' ) ); 
  2140.  
  2141. // Check the email address 
  2142. if ( $user_email == '' ) { 
  2143. $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your email address.' ) ); 
  2144. } elseif ( ! is_email( $user_email ) ) { 
  2145. $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn’t correct.' ) ); 
  2146. $user_email = ''; 
  2147. } elseif ( email_exists( $user_email ) ) { 
  2148. $errors->add( 'email_exists', __( '<strong>ERROR</strong>: This email is already registered, please choose another one.' ) ); 
  2149.  
  2150. /** 
  2151. * Fires when submitting registration form data, before the user is created. 
  2152. * 
  2153. * @since 2.1.0 
  2154. * 
  2155. * @param string $sanitized_user_login The submitted username after being sanitized. 
  2156. * @param string $user_email The submitted email. 
  2157. * @param WP_Error $errors Contains any errors with submitted username and email,  
  2158. * e.g., an empty field, an invalid username or email,  
  2159. * or an existing username or email. 
  2160. */ 
  2161. do_action( 'register_post', $sanitized_user_login, $user_email, $errors ); 
  2162.  
  2163. /** 
  2164. * Filters the errors encountered when a new user is being registered. 
  2165. * 
  2166. * The filtered WP_Error object may, for example, contain errors for an invalid 
  2167. * or existing username or email address. A WP_Error object should always returned,  
  2168. * but may or may not contain errors. 
  2169. * 
  2170. * If any errors are present in $errors, this will abort the user's registration. 
  2171. * 
  2172. * @since 2.1.0 
  2173. * 
  2174. * @param WP_Error $errors A WP_Error object containing any errors encountered 
  2175. * during registration. 
  2176. * @param string $sanitized_user_login User's username after it has been sanitized. 
  2177. * @param string $user_email User's email. 
  2178. */ 
  2179. $errors = apply_filters( 'registration_errors', $errors, $sanitized_user_login, $user_email ); 
  2180.  
  2181. if ( $errors->get_error_code() ) 
  2182. return $errors; 
  2183.  
  2184. $user_pass = wp_generate_password( 12, false ); 
  2185. $user_id = wp_create_user( $sanitized_user_login, $user_pass, $user_email ); 
  2186. if ( ! $user_id || is_wp_error( $user_id ) ) { 
  2187. $errors->add( 'registerfail', sprintf( __( '<strong>ERROR</strong>: Couldn’t register you… please contact the <a href="mailto:%s">webmaster</a> !' ), get_option( 'admin_email' ) ) ); 
  2188. return $errors; 
  2189.  
  2190. update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag. 
  2191.  
  2192. /** 
  2193. * Fires after a new user registration has been recorded. 
  2194. * 
  2195. * @since 4.4.0 
  2196. * 
  2197. * @param int $user_id ID of the newly registered user. 
  2198. */ 
  2199. do_action( 'register_new_user', $user_id ); 
  2200.  
  2201. return $user_id; 
  2202.  
  2203. /** 
  2204. * Initiates email notifications related to the creation of new users. 
  2205. * 
  2206. * Notifications are sent both to the site admin and to the newly created user. 
  2207. * 
  2208. * @since 4.4.0 
  2209. * @since 4.6.0 Converted the `$notify` parameter to accept 'user' for sending 
  2210. * notifications only to the user created. 
  2211. * 
  2212. * @param int $user_id ID of the newly created user. 
  2213. * @param string $notify Optional. Type of notification that should happen. Accepts 'admin' 
  2214. * or an empty string (admin only), 'user', or 'both' (admin and user). 
  2215. * Default 'both'. 
  2216. */ 
  2217. function wp_send_new_user_notifications( $user_id, $notify = 'both' ) { 
  2218. wp_new_user_notification( $user_id, null, $notify ); 
  2219.  
  2220. /** 
  2221. * Retrieve the current session token from the logged_in cookie. 
  2222. * 
  2223. * @since 4.0.0 
  2224. * 
  2225. * @return string Token. 
  2226. */ 
  2227. function wp_get_session_token() { 
  2228. $cookie = wp_parse_auth_cookie( '', 'logged_in' ); 
  2229. return ! empty( $cookie['token'] ) ? $cookie['token'] : ''; 
  2230.  
  2231. /** 
  2232. * Retrieve a list of sessions for the current user. 
  2233. * 
  2234. * @since 4.0.0 
  2235. * @return array Array of sessions. 
  2236. */ 
  2237. function wp_get_all_sessions() { 
  2238. $manager = WP_Session_Tokens::get_instance( get_current_user_id() ); 
  2239. return $manager->get_all(); 
  2240.  
  2241. /** 
  2242. * Remove the current session token from the database. 
  2243. * 
  2244. * @since 4.0.0 
  2245. */ 
  2246. function wp_destroy_current_session() { 
  2247. $token = wp_get_session_token(); 
  2248. if ( $token ) { 
  2249. $manager = WP_Session_Tokens::get_instance( get_current_user_id() ); 
  2250. $manager->destroy( $token ); 
  2251.  
  2252. /** 
  2253. * Remove all but the current session token for the current user for the database. 
  2254. * 
  2255. * @since 4.0.0 
  2256. */ 
  2257. function wp_destroy_other_sessions() { 
  2258. $token = wp_get_session_token(); 
  2259. if ( $token ) { 
  2260. $manager = WP_Session_Tokens::get_instance( get_current_user_id() ); 
  2261. $manager->destroy_others( $token ); 
  2262.  
  2263. /** 
  2264. * Remove all session tokens for the current user from the database. 
  2265. * 
  2266. * @since 4.0.0 
  2267. */ 
  2268. function wp_destroy_all_sessions() { 
  2269. $manager = WP_Session_Tokens::get_instance( get_current_user_id() ); 
  2270. $manager->destroy_all(); 
  2271.  
  2272. /** 
  2273. * Get the user IDs of all users with no role on this site. 
  2274. * 
  2275. * This function returns an empty array when used on Multisite. 
  2276. * 
  2277. * @since 4.4.0 
  2278. * 
  2279. * @return array Array of user IDs. 
  2280. */ 
  2281. function wp_get_users_with_no_role() { 
  2282. global $wpdb; 
  2283.  
  2284. if ( is_multisite() ) { 
  2285. return array(); 
  2286.  
  2287. $prefix = $wpdb->get_blog_prefix(); 
  2288. $regex = implode( '|', array_keys( wp_roles()->get_names() ) ); 
  2289. $regex = preg_replace( '/[^a-zA-Z_\|-]/', '', $regex ); 
  2290. $users = $wpdb->get_col( $wpdb->prepare( " 
  2291. SELECT user_id 
  2292. FROM $wpdb->usermeta 
  2293. WHERE meta_key = '{$prefix}capabilities' 
  2294. AND meta_value NOT REGEXP %s 
  2295. ", $regex ) ); 
  2296.  
  2297. return $users; 
  2298.  
  2299. /** 
  2300. * Retrieves the current user object. 
  2301. * 
  2302. * Will set the current user, if the current user is not set. The current user 
  2303. * will be set to the logged-in person. If no user is logged-in, then it will 
  2304. * set the current user to 0, which is invalid and won't have any permissions. 
  2305. * 
  2306. * This function is used by the pluggable functions wp_get_current_user() and 
  2307. * get_currentuserinfo(), the latter of which is deprecated but used for backward 
  2308. * compatibility. 
  2309. * 
  2310. * @since 4.5.0 
  2311. * @access private 
  2312. * 
  2313. * @see wp_get_current_user() 
  2314. * @global WP_User $current_user Checks if the current user is set. 
  2315. * 
  2316. * @return WP_User Current WP_User instance. 
  2317. */ 
  2318. function _wp_get_current_user() { 
  2319. global $current_user; 
  2320.  
  2321. if ( ! empty( $current_user ) ) { 
  2322. if ( $current_user instanceof WP_User ) { 
  2323. return $current_user; 
  2324.  
  2325. // Upgrade stdClass to WP_User 
  2326. if ( is_object( $current_user ) && isset( $current_user->ID ) ) { 
  2327. $cur_id = $current_user->ID; 
  2328. $current_user = null; 
  2329. wp_set_current_user( $cur_id ); 
  2330. return $current_user; 
  2331.  
  2332. // $current_user has a junk value. Force to WP_User with ID 0. 
  2333. $current_user = null; 
  2334. wp_set_current_user( 0 ); 
  2335. return $current_user; 
  2336.  
  2337. if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST ) { 
  2338. wp_set_current_user( 0 ); 
  2339. return $current_user; 
  2340.  
  2341. /** 
  2342. * Filters the current user. 
  2343. * 
  2344. * The default filters use this to determine the current user from the 
  2345. * request's cookies, if available. 
  2346. * 
  2347. * Returning a value of false will effectively short-circuit setting 
  2348. * the current user. 
  2349. * 
  2350. * @since 3.9.0 
  2351. * 
  2352. * @param int|bool $user_id User ID if one has been determined, false otherwise. 
  2353. */ 
  2354. $user_id = apply_filters( 'determine_current_user', false ); 
  2355. if ( ! $user_id ) { 
  2356. wp_set_current_user( 0 ); 
  2357. return $current_user; 
  2358.  
  2359. wp_set_current_user( $user_id ); 
  2360.  
  2361. return $current_user; 
.