You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
106 lines
3.1 KiB
106 lines
3.1 KiB
9 months ago
|
<?php
|
||
|
|
/**
|
||
|
|
* TablePress WP User Option Wrapper class for WordPress Options
|
||
|
|
*
|
||
|
|
* Wraps the WordPress Options API, so that (especially) arrays are stored as JSON, instead of being serialized by PHP.
|
||
|
|
*
|
||
|
|
* @package TablePress
|
||
|
|
* @subpackage Classes
|
||
|
|
* @author Tobias Bäthge
|
||
|
|
* @since 1.0.0
|
||
|
|
*/
|
||
|
|
|
||
|
|
// Prohibit direct script loading.
|
||
|
|
defined( 'ABSPATH' ) || die( 'No direct script access allowed!' );
|
||
|
|
|
||
|
|
// Load parent class.
|
||
|
|
TablePress::load_file( 'class-wp_option.php', 'classes' );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* TablePress WP User Option Wrapper class
|
||
|
|
*
|
||
|
|
* @package TablePress
|
||
|
|
* @subpackage Classes
|
||
|
|
* @author Tobias Bäthge
|
||
|
|
* @since 1.0.0
|
||
|
|
*/
|
||
|
|
class TablePress_WP_User_Option extends TablePress_WP_Option {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the value of a WP User Option with the WP User Options API.
|
||
|
|
*
|
||
|
|
* @since 1.0.0
|
||
|
|
*
|
||
|
|
* @param string $option_name Name of the WP User Option.
|
||
|
|
* @param mixed $default_value Default value of the WP User Option.
|
||
|
|
* @return mixed Current value of the WP User Option, or $default_value if it does not exist.
|
||
|
|
*/
|
||
|
|
#[\Override]
|
||
|
|
protected function _get_option( string $option_name, /* string|int|float|bool|array|null */ $default_value ) /* : string|int|float|bool|array|null */ {
|
||
|
|
// Non-logged-in user can never have a saved option value.
|
||
|
|
if ( ! is_user_logged_in() ) {
|
||
|
|
return $default_value;
|
||
|
|
}
|
||
|
|
|
||
|
|
$option_value = get_user_option( $option_name );
|
||
|
|
// get_user_option() only knows false as the default value, so we have to wrap that.
|
||
|
|
if ( false === $option_value ) {
|
||
|
|
$option_value = $default_value;
|
||
|
|
}
|
||
|
|
return $option_value;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Update the value of a WP User Option with the WP User Options API.
|
||
|
|
*
|
||
|
|
* @since 1.0.0
|
||
|
|
*
|
||
|
|
* @param string $option_name Name of the WP User Option.
|
||
|
|
* @param string $new_value New value of the WP User Option (not slashed).
|
||
|
|
* @return bool True on success, false on failure.
|
||
|
|
*/
|
||
|
|
#[\Override]
|
||
|
|
protected function _update_option( string $option_name, string $new_value ): bool {
|
||
|
|
// Non-logged-in user can never have a saved option value to be updated.
|
||
|
|
if ( ! is_user_logged_in() ) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
// WP expects a slashed value.
|
||
|
|
$new_value = wp_slash( $new_value );
|
||
|
|
return (bool) update_user_option( get_current_user_id(), $option_name, $new_value, false );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete a WP User Option with the WP User Options API.
|
||
|
|
*
|
||
|
|
* @since 1.0.0
|
||
|
|
*
|
||
|
|
* @param string $option_name Name of the WP User Option.
|
||
|
|
* @return bool True on success, false on failure.
|
||
|
|
*/
|
||
|
|
#[\Override]
|
||
|
|
protected function _delete_option( string $option_name ): bool {
|
||
|
|
// Non-logged-in user can never have a saved option value to be deleted.
|
||
|
|
if ( ! is_user_logged_in() ) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
return delete_user_option( get_current_user_id(), $option_name, false );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete a WP User Option with the WP User Options API, for all users of the site.
|
||
|
|
*
|
||
|
|
* @since 1.0.0
|
||
|
|
*/
|
||
|
|
public function delete_for_all_users(): void {
|
||
|
|
$users = get_users();
|
||
|
|
foreach ( $users as $user ) {
|
||
|
|
delete_user_option( $user->ID, $this->option_name, false );
|
||
|
|
// @todo Add other user options for different actions as well.
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
} // class TablePress_WP_User_Option
|