Changeset 40943

Timestamp:

06/25/2017 08:07:08 PM (6 years ago)

Author:

DrewAPicture

Message:

Docs: Add a note to the DocBlock for wp_signon() mentioning that it doesn't handle setting the current user.

Also outlines the conditions that must be met for is_user_logged_in() to work with it.

Part props SergeyBiryukov.
Fixes #28116.

File:

• trunk/src/wp-includes/user.php (modified) (1 diff)

trunk/src/wp-includes/user.php

@@ -17 +17 @@
  * set for a longer period depending on if the 'remember' credential is set to
  * true.
+ *
+ * Note: wp_signon() doesn't handle setting the current user. This means that if the
+ * function is called before the {@see 'init'} hook is fired, is_user_logged_in() will
+ * evaluate as false until that point. If is_user_logged_in() is needed in conjunction
+ * with wp_signon(), wp_set_current_user() should be called explicitly.
  *
  * @since 2.5.0