Skip to content
Snippets Groups Projects
wp-redis-user-session-storage.php 2.51 KiB
Newer Older
Erick Hitter's avatar
Erick Hitter committed
<?php
/**
Erick Hitter's avatar
Erick Hitter committed
 * Plugin Name: Redis User Session Storage
 * Plugin URI: https://ethitter.com/plugins/redis-user-session-storage/
Erick Hitter's avatar
Erick Hitter committed
 * Description: Store WordPress session tokens in Redis rather than the usermeta table. Requires the Redis PECL extension.
Erick Hitter's avatar
Erick Hitter committed
 * Version: 0.2
Erick Hitter's avatar
Erick Hitter committed
 * Author: Erick Hitter
 * Author URI: https://ethitter.com/
Erick Hitter's avatar
Erick Hitter committed
 * Text Domain: wp-redis-user-session-storage
 * Domain Path: /languages/
Erick Hitter's avatar
Erick Hitter committed
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
Erick Hitter's avatar
Erick Hitter committed
 *
 * @package WP_Redis_User_Session_Storage
Erick Hitter's avatar
Erick Hitter committed
namespace Redis_User_Session_Storage;

use Redis;
use WP_Session_Tokens;

/**
 * Load plugin when safe to do so, accounting for previous plugin name.
 *
 * WordPress.org no longer accepts plugins beginning with the `WP` prefix, so
 * this was renamed to comply.
 *
 * @return void
 */
function load() {
Erick Hitter's avatar
Erick Hitter committed
	if (
		! class_exists( Redis::class, false )
		|| ! class_exists( WP_Session_Tokens::class, false )
	) {
Erick Hitter's avatar
Erick Hitter committed
		return;
	}

	require_once __DIR__ . '/inc/class-plugin.php';
	require_once __DIR__ . '/inc/class-activation-deactivation-hooks.php';

	// Alias plugin's original class name.
	class_alias(
		Plugin::class,
		'WP_Redis_User_Session_Storage',
		false
	);

	new Activation_Deactivation_Hooks( __FILE__ );
Erick Hitter's avatar
Erick Hitter committed

Erick Hitter's avatar
Erick Hitter committed
	add_action( 'plugins_loaded',
		__NAMESPACE__ . '\action_plugins_loaded'
	);

Erick Hitter's avatar
Erick Hitter committed
	// Hooked at 9 in case old plugin is also active.
Erick Hitter's avatar
Erick Hitter committed
	add_filter(
		'session_token_manager',
Erick Hitter's avatar
Erick Hitter committed
		__NAMESPACE__ . '\set_session_token_manager',
		9
Erick Hitter's avatar
Erick Hitter committed
	);
}
Erick Hitter's avatar
Erick Hitter committed
load();
Erick Hitter's avatar
Erick Hitter committed

Erick Hitter's avatar
Erick Hitter committed
/**
 * Perform various actions after plugin loads.
 *
 * @return void
 */
function action_plugins_loaded() {
	load_plugin_textdomain(
		'wp-redis-user-session-storage',
		false,
		dirname( plugin_basename( __FILE__ ) ) . '/languages/'
	);
}

Erick Hitter's avatar
Erick Hitter committed
/**
Erick Hitter's avatar
Erick Hitter committed
 * Override Core's default usermeta-based token storage.
Erick Hitter's avatar
Erick Hitter committed
 *
Erick Hitter's avatar
Erick Hitter committed
 * @param string $manager Name of session-manager class.
Erick Hitter's avatar
Erick Hitter committed
 * @return string
 */
Erick Hitter's avatar
Erick Hitter committed
function set_session_token_manager( $manager ) {
Erick Hitter's avatar
Erick Hitter committed
	return Plugin::class;
}