From e228178d1b7c86c34344fa88a6f63f2fd1bdb2cf Mon Sep 17 00:00:00 2001
From: John Blackbourn <johnbillion@git.wordpress.org>
Date: Sat, 26 Oct 2019 23:44:02 +0000
Subject: [PATCH] Docs: Add missing docs for the
 `auth_cookie_bad_session_token` action.

See #48303


git-svn-id: https://develop.svn.wordpress.org/trunk@46598 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/pluggable.php | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/wp-includes/pluggable.php b/src/wp-includes/pluggable.php
index 76babe3f23..47bdafd395 100644
--- a/src/wp-includes/pluggable.php
+++ b/src/wp-includes/pluggable.php
@@ -676,6 +676,13 @@ if ( ! function_exists( 'wp_validate_auth_cookie' ) ) :
 
 		$manager = WP_Session_Tokens::get_instance( $user->ID );
 		if ( ! $manager->verify( $token ) ) {
+			/**
+			 * Fires if a bad session token is encountered.
+			 *
+			 * @since 4.0.0
+			 *
+			 * @param string[] $cookie_elements An array of data for the authentication cookie.
+			 */
 			do_action( 'auth_cookie_bad_session_token', $cookie_elements );
 			return false;
 		}