0 Day Analytics – Transients Module Developer Documentation

<?php
// WordPress core transients that are auto-detected and flagged in the UI
public const WP_CORE_TRANSIENTS = array(
    'update_themes',
    'update_plugins',
    'update_core',
    'theme_roots',
    'poptags_',
    'doing_cron',
    'wp_theme_files_patterns-',
    'wp_plugin_dependencies_plugin_data',
    'wp_styles_for_blocks',
    'wp_core_block_css_files',
    'health-check-site-status-result',
);

<?php
public const SCREEN_OPTIONS_SLUG  = 'advanced_analytics_transients_list';
public const PAGE_SLUG            = ADVAN_INNER_SLUG . '_page_advan_transients';
public const UPDATE_ACTION        = 'advan_transients_update';
public const NEW_ACTION           = 'advan_transients_new';
public const NONCE_NAME           = 'advana_transients_manager';
public const SEARCH_INPUT         = 'sgp';
public const TRANSIENTS_MENU_SLUG = 'advan_transients';

<?php
// The get_views() method builds filter links using get_filtered_transients()
// which classifies all transients into these categories:
$filtered = array(
    'persistent'      => /* transients where schedule === 0 */,
    'core'            => /* transients matching WP_CORE_TRANSIENTS names */,
    'expired'         => /* transients where schedule > 0 and time has passed */,
    'with_expiration' => /* transients where schedule > 0 */,
);

<?php
// analytics_transients_page() routes based on the 'action' parameter:
$action = sanitize_key( $_REQUEST['action'] ?? '' );

if ( 'edit_transient' === $action ) {
    // Render edit form with pre-filled values from database
} elseif ( 'new_transient' === $action ) {
    // Render blank new transient form
} else {
    // Render the list table (default view)
}

<?php
$transient = array(
    'transient_name' => 'my_custom_data',    // Clean name (no prefix)
    'value'          => '<code>...</code>',  // Truncated HTML for display
    'schedule'       => 1711900800,           // Unix timestamp or 0 (persistent)
    'id'             => 42,                   // option_id (positive = DB, negative = Redis)
    'source'         => 'database',           // 'database' or 'redis'
);

<?php
$patterns = array(
    $prefix . $blog_id . ':transient:*',
    $prefix . $blog_id . ':site-transient:*',
    $prefix . 'transient:*',
    $prefix . 'site-transient:*',
    $prefix . 'wp_' . $blog_id . ':transient:*',
    $prefix . 'wp_' . $blog_id . ':site-transient:*',
);
// Uses Redis SCAN command with count=200 for efficient iteration

<?php
// Check if transients module is enabled
$enabled = Settings::get_option( 'transients_module_enabled' );

<?php
// How the settings are defined in transient-list.php
Settings::build_option(
    array(
        'title' => esc_html__( 'Transients Options', '0-day-analytics' ),
        'id'    => 'options-settings-tab',
        'type'  => 'tab-title',
    )
);

Settings::build_option(
    array(
        'name'    => esc_html__( 'Enable transients module', '0-day-analytics' ),
        'id'      => 'transients_module_enabled',
        'type'    => 'checkbox',
        'hint'    => esc_html__( 'If you disable this, the entire plugin transients module will be disabled...', '0-day-analytics' ),
        'default' => Settings::get_option( 'transients_module_enabled' ),
    )
);

<?php
use ADVAN\Helpers\Settings;

$enabled = Settings::get_option( 'transients_module_enabled' );

if ( $enabled ) {
    echo 'Transients module is active.';
} else {
    echo 'Transients module is disabled.';
}

<?php
use ADVAN\Helpers\Transients_Helper;

if ( Transients_Helper::is_object_cache_active() ) {
    $backend = Transients_Helper::get_object_cache_backend();
    $label   = Transients_Helper::get_object_cache_description();

    echo 'Object cache is active: ' . esc_html( $label );
    // Output: "Object cache is active: Redis"
} else {
    echo 'No external object cache detected. Transients use the database.';
}

<?php
use ADVAN\Helpers\Transients_Helper;

// Get all transients matching "woo" in name
$transients = Transients_Helper::get_transient_items( array(
    'search'   => 'woo',
    'offset'   => 0,
    'per_page' => 50,
) );

foreach ( $transients as $transient ) {
    printf(
        "Name: %s | Expires: %s | Source: %s\n",
        $transient['transient_name'],
        $transient['schedule'] ? gmdate( 'Y-m-d H:i:s', $transient['schedule'] ) : 'Persistent',
        $transient['source']
    );
}

<?php
use ADVAN\Helpers\Transients_Helper;

// Count all transients
$total = Transients_Helper::get_transient_items( array( 'count' => true ) );

// Count only persistent transients
$persistent = Transients_Helper::get_transient_items( array(
    'count' => true,
    'type'  => 'persistent',
) );

// Count expired transients
$expired = Transients_Helper::get_transient_items( array(
    'count' => true,
    'type'  => 'expired',
) );

echo "Total: $total | Persistent: $persistent | Expired: $expired";

<?php
use ADVAN\Helpers\Transients_Helper;

$transient = Transients_Helper::get_transient_by_id( null, 42 );

if ( ! empty( $transient ) ) {
    $name       = Transients_Helper::get_transient_name( $transient['option_name'] );
    $expiration = Transients_Helper::get_transient_expiration_time( $transient['option_name'] );
    $is_site    = Transients_Helper::is_site_wide( $transient['option_name'] );

    echo 'Name: ' . esc_html( $name );
    echo 'Value: ' . esc_html( $transient['option_value'] );
    echo 'Expires: ' . ( $expiration ? gmdate( 'Y-m-d H:i:s', $expiration ) : 'Never' );
    echo 'Site-wide: ' . ( $is_site ? 'Yes' : 'No' );
}

<?php
use ADVAN\Helpers\Transients_Helper;

$option_id = 42;
$result    = Transients_Helper::delete_transient( $option_id );

if ( true === $result ) {
    echo 'Transient deleted successfully.';
} elseif ( is_wp_error( $result ) ) {
    echo 'Error: ' . $result->get_error_message();
} else {
    echo 'Transient not found or already deleted.';
}

<?php
use ADVAN\Helpers\Transients_Helper;

// Only works when Redis object cache is active
if ( 'redis' === Transients_Helper::get_object_cache_backend() ) {
    $redis_transients = Transients_Helper::get_redis_transients( array(
        'search' => 'session',
    ) );

    foreach ( $redis_transients as $t ) {
        printf(
            "Redis transient: %s | TTL expires: %s\n",
            $t['transient_name'],
            $t['schedule'] > 0 ? gmdate( 'Y-m-d H:i:s', $t['schedule'] ) : 'Persistent'
        );
    }
}

<?php
use ADVAN\Helpers\Transients_Helper;

$name = 'update_plugins';

$is_core = in_array( $name, Transients_Helper::WP_CORE_TRANSIENTS, true );

if ( ! $is_core ) {
    // Also check prefix matches (e.g., "poptags_" matches "poptags_40")
    foreach ( Transients_Helper::WP_CORE_TRANSIENTS as $core_name ) {
        if ( str_starts_with( $name, $core_name ) ) {
            $is_core = true;
            break;
        }
    }
}

echo $is_core ? 'This is a WP core transient.' : 'This is a custom transient.';