scan( $iterator, $pattern, 200 ); if ( false !== $keys && is_array( $keys ) ) { $found_keys = array_merge( $found_keys, $keys ); } } while ( $iterator > 0 ); } } catch ( \Exception $e ) { return array(); } // De-duplicate. $found_keys = array_unique( $found_keys ); // Filter by search term if provided. $search = ! empty( $args['search'] ) ? strtolower( $args['search'] ) : ''; $counter = 0; foreach ( $found_keys as $key ) { // Extract the transient name from the Redis key. $name = self::extract_transient_name_from_redis_key( $key ); if ( empty( $name ) ) { continue; } // Filter by search. if ( ! empty( $search ) && false === strpos( strtolower( $name ), $search ) ) { continue; } // Get TTL for expiration. try { $ttl = $redis->ttl( $key ); } catch ( \Exception $e ) { $ttl = -1; } $schedule = 0; if ( $ttl > 0 ) { $schedule = time() + $ttl; } // $ttl === -1 means no expiration (persistent). // $ttl === -2 means key doesn't exist. if ( -2 === $ttl ) { continue; } // Filter by type. if ( ! empty( $args['type'] ) ) { if ( 'persistent' === $args['type'] && 0 !== $schedule ) { continue; } if ( 'with_expiration' === $args['type'] && 0 === $schedule ) { continue; } if ( 'expired' === $args['type'] ) { continue; // Redis auto-expires keys, so there won't be expired ones. } } // Get the value. try { $raw_value = $redis->get( $key ); } catch ( \Exception $e ) { $raw_value = ''; } $value = \maybe_unserialize( $raw_value ); if ( is_string( $value ) ) { $display_value = self::get_transient_value( $value ); } elseif ( is_array( $value ) || is_object( $value ) ) { $serialized = \maybe_serialize( $value ); $display_value = self::get_transient_value( $serialized ); } else { $display_value = self::get_transient_value( (string) $raw_value ); } --$counter; $transients[] = array( 'transient_name' => $name, 'value' => $display_value, 'schedule' => $schedule, 'id' => $counter, // Negative IDs to distinguish from DB option_ids. 'source' => 'redis', ); } return $transients; } /** * Extracts the transient name from a Redis key. * * @param string $key The full Redis key. * * @return string The cleaned transient name, or empty string if not a transient key. * * @since 5.0.0 */ private static function extract_transient_name_from_redis_key( string $key ): string { // Match patterns like: prefix:blog_id:transient:name or prefix:site-transient:name. if ( preg_match( '/(?:^|:)(?:site-)?transient:(.+)$/', $key, $matches ) ) { return $matches[1]; } return ''; } /** * Gets a Redis connection instance from the WordPress object cache. * * Attempts to access the Redis client through the global object cache * or by creating a new connection using WordPress Redis constants. * * @return \Redis|null The Redis instance or null if unavailable. * * @since 5.0.0 */ private static function get_redis_instance(): ?\Redis { // Try to get from the global object cache (most reliable). global $wp_object_cache; if ( $wp_object_cache ) { // Plugin: redis-cache (by Till Krüss) - most popular. if ( method_exists( $wp_object_cache, 'connection' ) ) { try { $redis = $wp_object_cache->connection(); if ( $redis instanceof \Redis ) { return $redis; } } catch ( \Exception $e ) { // Fall through to other methods. } } // Plugin: wp-redis (by Pantheon). if ( property_exists( $wp_object_cache, 'redis' ) && $wp_object_cache->redis instanceof \Redis ) { return $wp_object_cache->redis; } // Generic: try redis_instance() method. if ( method_exists( $wp_object_cache, 'redis_instance' ) ) { try { $redis = $wp_object_cache->redis_instance(); if ( $redis instanceof \Redis ) { return $redis; } } catch ( \Exception $e ) { // Fall through. } } } // Last resort: try to create our own connection using WP constants. if ( class_exists( '\Redis', false ) && defined( 'WP_REDIS_HOST' ) ) { try { $redis = new \Redis(); $host = WP_REDIS_HOST; $port = defined( 'WP_REDIS_PORT' ) ? (int) WP_REDIS_PORT : 6379; $redis->connect( $host, $port, 2.0 ); // 2 second timeout. if ( defined( 'WP_REDIS_PASSWORD' ) && WP_REDIS_PASSWORD ) { $redis->auth( WP_REDIS_PASSWORD ); } if ( defined( 'WP_REDIS_DATABASE' ) ) { $redis->select( (int) WP_REDIS_DATABASE ); } return $redis; } catch ( \Exception $e ) { return null; } } return null; } /** * Returns a human-readable description of the active object cache backend. * * @return string Description string, e.g. "Redis (redis-cache plugin)". * * @since 5.0.0 */ public static function get_object_cache_description(): string { $backend = self::get_object_cache_backend(); switch ( $backend ) { case 'redis': return __( 'Redis', '0-day-analytics' ); case 'memcached': return __( 'Memcached', '0-day-analytics' ); case 'memcache': return __( 'Memcache (legacy)', '0-day-analytics' ); case 'apcu': return __( 'APCu', '0-day-analytics' ); case 'unknown': return __( 'External object cache (unknown backend)', '0-day-analytics' ); default: return __( 'None (database)', '0-day-analytics' ); } } /** * Deletes a transient * * @param int $id - The hash of the transient to delete. * * @return bool|\WP_Error * * @since 1.7.0 */ public static function delete_transient( int $id ) { if ( 0 < $id ) { global $wpdb; $esc_name = '%' . $wpdb->esc_like( '_transient_' ) . '%'; $esc_time = '%' . $wpdb->esc_like( '_transient_timeout_' ) . '%'; $sql = array( 'SELECT' ); $sql[] = 'option_name'; $sql[] = "FROM {$wpdb->options} WHERE option_name LIKE %s AND option_name NOT LIKE %s AND option_id = %d"; $query = implode( ' ', $sql ); // Prepare. $prepared = $wpdb->prepare( $query, $esc_name, $esc_time, $id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared $transient = $wpdb->get_var( $prepared, 0 ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.PreparedSQL.NotPrepared } // Bail if no Transient. if ( empty( $transient ) ) { return false; } $transient_name = self::get_transient_name( $transient ); // Transient type. $retval = ( false !== self::is_site_wide( $transient ) ) ? \delete_site_transient( $transient_name ) : \delete_transient( $transient_name ); if ( false === $retval ) { return new \WP_Error( 'transient_not_deleted', __( 'Transient is not / can not be deleted.', '0-day-analytics' ) ); } // Return. return $retval; } /** * Removes all cron events for a specific hook * * @param string $hook The action hook name. * * @since 1.7.0 */ public static function clear_events( $hook ) { \wp_clear_scheduled_hook( $hook ); } /** * Is a transient name site-wide? * * @param string $transient_name - The transient name. * * @return boolean * * @since 1.7.0 */ public static function is_site_wide( $transient_name = '' ): bool { return ( false !== strpos( (string) $transient_name, '_site_transient' ) ); } /** * Retrieve the transient name from the transient object * * @param string $transient - The transient name. * * @return string * * @since 1.7.0 */ public static function get_transient_name( $transient = false ): string { // Bail if no Transient. if ( empty( $transient ) ) { return ''; } // Position. $pos = self::is_site_wide( $transient ) ? 16 : 11; return substr( $transient, $pos, strlen( $transient ) ); } /** * Retrieve a transient by its ID * * @param \WP_REST_Request $request - The request object. * @param int $id - The ID of the transient to retrieve. * * @return array * * @since 1.8.5 * @since 3.8.0 - Added $request parameter. */ public static function get_transient_by_id( ?\WP_REST_Request $request = null, $id = 0 ) { global $wpdb; $id = \absint( $id ); // Bail if empty ID. if ( empty( $id ) ) { if ( null !== $request ) { $id = $request->get_param( 'transient_id' ); } if ( empty( $id ) ) { return false; } } // Prepare. $prepared = $wpdb->prepare( "SELECT * FROM {$wpdb->options} WHERE option_id = %d", $id ); // Query. $transient = $wpdb->get_row( $prepared, ARRAY_A ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared if ( null === $request ) { return $transient; } elseif ( ! empty( $transient ) ) { \ob_start(); $name = self::get_transient_name( $transient['option_name'] ); if ( in_array( $name, self::WP_CORE_TRANSIENTS ) ) { ?>
tag.
$value = '' . \esc_html( $value ) . '';
// Return.
return $value . '
' . esc_html( $type ) . '';
}
/**
* Try to guess the type of value the Transient is
*
* @param mixed $transient - The transient value.
*
* @return string
*
* @since 1.7.0
*/
private static function get_transient_value_type( $transient ): string {
// Default type.
$type = \esc_html__( 'unknown', '0-day-analytics' );
// Try to unserialize.
$value = \maybe_unserialize( $transient );
// Array.
if ( is_array( $value ) ) {
$type = \esc_html__( 'array', '0-day-analytics' );
// Object.
} elseif ( is_object( $value ) ) {
$type = \esc_html__( 'object', '0-day-analytics' );
// Serialized array.
} elseif ( \is_serialized( $value ) ) {
$type = \esc_html__( 'serialized', '0-day-analytics' );
// HTML.
} elseif ( strip_tags( $value ) !== $value ) {
$type = \esc_html__( 'html', '0-day-analytics' );
// Scalar.
} elseif ( is_scalar( $value ) ) {
if ( is_numeric( $value ) ) {
// Likely a timestamp.
if ( 10 === strlen( $value ) ) {
$type = \esc_html__( 'timestamp?', '0-day-analytics' );
// Likely a boolean.
} elseif ( in_array( $value, array( '0', '1' ), true ) ) {
$type = \esc_html__( 'boolean?', '0-day-analytics' );
// Any number.
} else {
$type = \esc_html__( 'numeric', '0-day-analytics' );
}
// JSON.
} elseif ( is_string( $value ) && is_object( json_decode( $value ) ) ) {
$type = \esc_html__( 'json', '0-day-analytics' );
} elseif ( is_string( $value ) && in_array( $value, array( 'no', 'yes', 'false', 'true' ), true ) ) {
$type = \esc_html__( 'boolean?', '0-day-analytics' );
// Scalar.
} else {
$type = \esc_html__( 'scalar', '0-day-analytics' );
}
// Empty.
} elseif ( empty( $value ) ) {
$type = \esc_html__( 'empty', '0-day-analytics' );
}
// Return type.
return $type;
}
/**
* Retrieve the expiration timestamp
*
* @param string $transient - The transient name.
*
* @return int
*
* @since 1.7.0
*/
public static function get_transient_expiration_time( $transient ): int {
// Get the same to use in the option key.
$name = self::get_transient_name( $transient );
// Get the value of the timeout.
$time = self::is_site_wide( $transient )
? \get_option( "_site_transient_timeout_{$name}" )
: \get_option( "_transient_timeout_{$name}" );
// Return the value.
return (int) $time;
}
/**
* Collect error items.
*
* @param array $args - Array with arguments to use.
*
* @return array|int
*
* @since 1.9.0
*/
public static function get_transient_items( $args = array() ) {
global $wpdb;
$timezone = WP_Helper::get_mysql_time_zone();
$wpdb->query( $wpdb->prepare( "SET time_zone = %s", $timezone ) );
// Parse arguments.
$parsed_args = Transients_List::parse_args( $args );
// Escape some LIKE parts.
$esc_name = '' . $wpdb->esc_like( '_transient_' ) . '%';
$esc_site_name = '' . $wpdb->esc_like( '_site_transient_' ) . '%';
$esc_time = '%' . $wpdb->esc_like( '_transient_timeout_' ) . '%';
// SELECT.
$sql = array( 'SELECT' );
// COUNT.
if ( ! empty( $parsed_args['count'] ) ) {
$sql[] = 'count(go.option_id)';
} else {
$sql[] = 'go.option_id, go.option_name, go.option_value, go.autoload, d.option_value AS schedule';
}
$sql[] = "FROM {$wpdb->options} as go ";
// if ( empty( $parsed_args['count'] ) ) {
// FROM.
// old - ON d.option_name LIKE CONCAT('%_transient_timeout_', SUBSTRING_INDEX( go.option_name, '_transient_', -1 ), '%')
$sql[] = "LEFT JOIN
{$wpdb->options} d
ON d.option_name = CONCAT(
'_transient_timeout_',
SUBSTRING( go.option_name, LENGTH( '_transient_' ) + 1 )
)
WHERE ( go.option_name LIKE %s OR go.option_name LIKE %s ) AND go.option_name NOT LIKE %s";
if ( ! empty( $parsed_args['type'] ) ) {
if ( 'persistent' === $parsed_args['type'] ) {
$sql[] = ' AND d.option_value IS NULL';
}
if ( 'with_expiration' === $parsed_args['type'] ) {
$sql[] = ' AND d.option_value IS NOT NULL';
}
if ( 'expired' === $parsed_args['type'] ) {
$sql[] = ' AND ( d.option_value IS NOT NULL AND d.option_value < UNIX_TIMESTAMP( CURRENT_TIMESTAMP ) )';
}
if ( 'core' === $parsed_args['type'] ) {
$sql[] = ' AND (';
$in_sql = '';
foreach ( self::WP_CORE_TRANSIENTS as $transient_name ) {
$search = '%' . $wpdb->esc_like( $transient_name ) . '%';
$in_sql .= $wpdb->prepare( ' go.option_name LIKE %s OR', $search );
// $in_sql .= ' go.option_name LIKE \'%' . $wpdb->esc_like( $transient_name ) . '%\' OR ';
}
$sql[] = \rtrim( $in_sql, ' OR ' );
$sql[] = ')';
}
}
// }
// Search.
if ( ! empty( $parsed_args['search'] ) ) {
$search = '%' . $wpdb->esc_like( $parsed_args['search'] ) . '%';
$sql[] = $wpdb->prepare( 'AND go.option_name LIKE %s', $search );
}
// Limits.
if ( empty( $parsed_args['count'] ) && empty( $parsed_args['all'] ) ) {
$offset = absint( $parsed_args['offset'] );
$per_page = absint( $parsed_args['per_page'] );
// if ( ! empty( $parsed_args['orderby'] ) && \in_array( $parsed_args['orderby'], array( 'transient_name' ) ) ) {
// $orderby = 'option_name';
// $order = 'DESC';
// if ( ! empty( $parsed_args['order'] ) && \in_array( $parsed_args['order'], array( 'ASC', 'DESC', 'asc', 'desc' ) ) ) {
// $order = $parsed_args['order'];
// }
// $sql[] = $wpdb->prepare(
// 'ORDER BY ' . \esc_sql( $orderby ) . ' ' . \esc_sql( $order ) . ' LIMIT %d, %d',
// $offset,
// $number
// );
// } else {
$sql[] = $wpdb->prepare( 'ORDER BY option_id DESC LIMIT %d, %d', $offset, $per_page );
// }
}
// Combine the SQL parts.
$query = implode( ' ', $sql );
// Prepare.
$prepared = $wpdb->prepare( $query, $esc_name, $esc_site_name, $esc_time ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
// Query.
$transients = empty( $parsed_args['count'] )
? $wpdb->get_results( $prepared, \ARRAY_A ) // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
: $wpdb->get_var( $prepared, 0 ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
if ( empty( $parsed_args['count'] ) && ! empty( $transients ) ) {
$normalized_data = array();
foreach ( $transients as $transient ) {
$normalized_data[] = array(
'transient_name' => self::get_transient_name( $transient['option_name'] ),
'value' => self::get_transient_value( $transient['option_value'] ),
'schedule' => (int) $transient['schedule'],
'id' => $transient['option_id'],
'source' => 'database',
);
}
$transients = $normalized_data;
}
// Merge Redis transients when Redis object cache is active.
if ( empty( $parsed_args['count'] ) && 'redis' === self::get_object_cache_backend() ) {
$redis_transients = self::get_redis_transients( $args );
if ( ! empty( $redis_transients ) ) {
// Build a set of DB transient names for de-duplication.
$db_names = array();
if ( is_array( $transients ) ) {
foreach ( $transients as $t ) {
$db_names[ $t['transient_name'] ] = true;
}
}
// Add only Redis transients not already present in DB results.
foreach ( $redis_transients as $rt ) {
if ( ! isset( $db_names[ $rt['transient_name'] ] ) ) {
if ( ! is_array( $transients ) ) {
$transients = array();
}
$transients[] = $rt;
}
}
}
}
// Return transients.
return $transients;
}
/**
* Checks for _transient and _site_transient strings and removes them if present.
*
* @param string $transient - The name of the transient to clear.
*
* @return string
*
* @since 2.7.0
*/
public static function clear_transient_name( string $transient ): string {
if ( \str_starts_with( $transient, '_site_transient_' ) ) {
return str_replace( '_site_transient_', '', $transient );
} elseif ( \str_starts_with( $transient, '_transient_' ) ) {
return str_replace( '_transient_', '', $transient );
}
return $transient;
}
}
}