Cookie Tasting

Contributors: tarosky,Takahashi_Fumiki
Tags: cookie, membership, cache
Requires at least: 5.9
Requires PHP: 7.0
Tested up to: 6.2
Stable tag: nightly
License: GPL 3.0 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html

Detect user login only with a cookie. The best helper for cached WordPress sites.

Description

This plugin sets the user cookie when the user is logged in. You can use cookies as the data store to use them as UI resources.

Visibility

This plugin adds class to html element.

• ct-logged-in The current user is logged in.
• ct-not-logged-in The current user is anonymous.

You can control elements visibility with CSS.

.some-element{
  display: none;
}
.ct-logged-in .some-element{
  display: block;
}

From JavaScript

You can use Global Object CookieTasting for utility.

• CookieTasting.userName() Returns user name. If not logged in, returns 'Guest'.
• CookieTasting.lastUpdated() Returns timestamp of last log in check. If this equals 0, it means that user is anonymous.

Besides that, this plugin checks periodically log-in status. You can handle it with jQuery.

jQuery( document ).on( 'cookie.tasting', function( event, response ) {
  if ( response.login ) {
    // User is logged in.
    // If you use React...
    setAttributes({ name: CookieTasting.userName() })
  } else {
    // User is not logged in.
  }
} );

If you use react or something, updated the status with setState().

Check Before Action

If you manage cached WordPress and customizing your own theme, It's a good idea to implement dynamic UI components with JavaScript.

You can check user's credential just before important actions.

// Click action for button.
$('.read-more').click( function( e ) {
  e.preventDefault();
  // Check cookie before do something.
  CookieTasting.testBefore().then( function( response ) {
    // Now user has fresh information.
    // Load premium contents.
    loadPremiumContents();
  }).catch( function( response ) {
    // This user is not logged in.
    // Redirect them to login page.
    window.locaion.href = '/wp-login.php';
  } );
} );

Please remember adding a dependency for cookie-tasting-heartbeat to youar script.

Handle UUID

By default, this plugin sets UUID for each user. This will be...

• Unique for each logged-in user and will be saved as user_meta.
• Also kept for anonymous users.

So you can use it for Google Analytic's User ID View.

const uuid = CookieTasting.get( 'uuid' );
// For Google Analytics.
ga( 'set', "userId", uid );

Installation

• Download the zip file and unpack it.
• Upload the directory to wp-content/plugins.
• Go to WordPress admin screen and activate this plugin.

Recommendation: Search on WordPress admin screen and install it.

Frequently Asked Questions

How to Contribute

This plugin is hosted on Github. Please feel free to make an issue or send pull requests.

Changelog

1.1.0

• Drop older PHP version. Now requires PHP 7.2 and over.

1.0.11

• Display console.log only if SCRIPT_DEBUG is true.

1.0.10

• Bugfix: Add polyfill for Object.assign in favor of lte IE11. (Props @Kamata Ryo).

1.0.9

• Bugfix nonce refreshing for cached page.

1.0.8

• Add filter for Cookie check API. Now you can change error message.

1.0.7

• Fix UUID logic.
• Add automatic refresh for rewrite rules.

1.0.6

• Fix SSL bug.

1.0.5

• Fix fatal error. vendor directory was missing.

1.0.4

• Update nonce for @wordpress/wp-api-featch and wpApiSettings of wp-api.
• Change REST API endpoint because it requires COOKIES to be properly set. The endpoint wp-json/cookie/v1/nonce is pseudo and it's not REST API, actually, so you can refresh nonce with this endpoint. Normally, this refresh will be executed automatically, but if you get "rest_cookie_invalid_nonce", try updating the permalink from "Setting > Permalink". Just click "Save" and that's it.
• UUID will be set for the current user. It's useful for tracking.

1.0.3

• Add filter to cookie detection API.

1.0.2

• Bugfix: if the home url is not SSL, the cookie $secure flag is now false. But we sincerely recommend protecting your site under SSL.

1.0.0

• Initial release.