0 Day Analytics – Snippets Module Developer Documentation

<?php
public const STATUS_TRASHED  = -1;
public const STATUS_DISABLED = 0;
public const STATUS_ENABLED  = 1;

public const SCOPE_EVERYWHERE = 'global';
public const SCOPE_ADMIN      = 'admin';
public const SCOPE_FRONTEND   = 'frontend';
public const SCOPE_MANUAL     = 'manual';

private const DEFAULT_HOOK     = 'init';
private const DEFAULT_PRIORITY = 10;
private const SUPPORTED_TYPES  = array( 'php' => 'PHP', 'wp_cli' => 'WP-CLI' );

<?php
public const PAGE_SLUG            = '0-day_page_advan_snippets';
public const SCREEN_OPTIONS_SLUG  = 'advanced_analytics_snippets_list';
public const SEARCH_INPUT         = 's';
public const MENU_SLUG            = 'advan_snippets';
public const NONCE_NAME           = 'advan_manage_snippets';

// Action names for admin_post handlers
public const SAVE_ACTION    = 'advan_snippet_save';
public const DELETE_ACTION  = 'advan_snippet_delete';
public const EXECUTE_ACTION = 'advan_snippet_execute';
public const TRASH_ACTION   = 'advan_snippet_trash';
public const RESTORE_ACTION = 'advan_snippet_restore';
public const CLONE_ACTION   = 'advan_snippet_clone';
public const TOGGLE_ACTION  = 'advan_snippet_toggle';

private const BULK_FIELD = 'aadvana_snippet_ids';

<?php
array(
    'emptyCodeMessage' => __( 'Please enter some code.', '0-day-analytics' ),
    'sidebarCollapsed' => __( 'Show options', '0-day-analytics' ),
    'sidebarExpanded'  => __( 'Hide options', '0-day-analytics' ),
    'storageKey'       => 'advanSnippetSidebarState',
)

<?php
$token = wp_generate_password( 12, false, false );
set_transient(
    'advana_snippet_exec_' . $token,
    array(
        'status'      => 'success', // or 'error'
        'message'     => '',
        'output'      => '',        // captured output
        'result_dump' => '',        // stringified return value
        'duration'    => 0.00123,   // execution time in seconds
        'snippet'     => array(
            'id'   => 42,
            'name' => 'My Snippet',
        ),
    ),
    5 * MINUTE_IN_SECONDS
);

<?php
private static function should_execute_in_context( array $snippet ): bool {
    $scope = (string) ( $snippet['execution_scope'] ?? Snippet_Entity::SCOPE_EVERYWHERE );
    switch ( $scope ) {
        case Snippet_Entity::SCOPE_ADMIN:
            return is_admin();
        case Snippet_Entity::SCOPE_FRONTEND:
            return ! is_admin() || wp_doing_ajax();
        case Snippet_Entity::SCOPE_MANUAL:
            return false;
        default:
            return true;
    }
}

<?php
private const OUTPUT_LIMIT   = 15000;  // Max output size in bytes
private const STORAGE_UPLOADS = 'uploads';
private const STORAGE_STREAM  = 'php_temp';

<?php
array(
    'status'      => 'success', // 'success', 'error', or 'skipped'
    'message'     => '',        // Error message if status is 'error'
    'output'      => '',        // Captured echo/print output
    'duration'    => 0.00123,   // Execution time in seconds
    'result_dump' => '',        // Stringified return value or exception trace
)

<?php
$defaults = array(
    'wpdb'         => $wpdb,            // Database connection
    'current_user' => wp_get_current_user(),
    'site_url'     => site_url(),
    'home_url'     => home_url(),
    'blog_id'      => get_current_blog_id(),
    'is_multisite' => is_multisite(),
);
// Plus any additional context passed to execute()

<?php
$wrapper = "return ( static function( array \$context ) {
    extract( \$context, EXTR_SKIP );
    " . $code . "
} );";

<?php
$snippet = array(
    'id'              => 42,
    'blog_id'         => 1,
    'name'            => 'My Custom Snippet',
    'slug'            => 'my-custom-snippet',
    'type'            => 'php',
    'status'          => 1,                    // enabled
    'code'            => 'echo "Hello!";',
    'tags'            => 'utility, frontend',
    'execution_scope' => 'frontend',
    'execution_hook'  => 'wp_footer',
    'hook_priority'   => 99,
    'shortcode_tag'   => 'my_snippet',         // or null
    'run_conditions'  => 'role=administrator',
    'last_run_at'     => '2026-03-25 10:30:00',
    'last_run_status' => 'success',
    'last_run_message'=> '',
    'created_at'      => '2026-03-01 09:00:00',
    'updated_at'      => '2026-03-25 10:30:00',
);

<?php
$context = array(
    'trigger'   => 'shortcode',
    'atts'      => $atts,          // Shortcode attributes
    'content'   => $content,       // Enclosed content
    'shortcode' => $tag,           // The shortcode tag name
);

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

// Get sandbox storage mode
$storage = Settings::get_option( 'snippets_temp_storage' ); // 'uploads' or 'php_temp'

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

Settings::build_option(
    array(
        'name'    => esc_html__( 'Enable Snippets module', '0-day-analytics' ),
        'id'      => 'snippets_module_enabled',
        'type'    => 'checkbox',
        'hint'    => esc_html__( 'If you disable this, the Snippets module will be disabled...', '0-day-analytics' ),
        'toggle'  => '#advana_snippets_settings-item',
        'default' => Settings::get_option( 'snippets_module_enabled' ),
    )
);

Settings::build_option(
    array(
        'name'    => esc_html__( 'Sandbox storage location', '0-day-analytics' ),
        'id'      => 'snippets_temp_storage',
        'type'    => 'radio',
        'default' => Settings::get_option( 'snippets_temp_storage' ),
        'options' => array(
            'uploads'  => esc_html__( 'Dedicated folder inside uploads/', '0-day-analytics' ),
            'php_temp' => esc_html__( 'php://temp memory stream', '0-day-analytics' ),
        ),
    )
);

<?php
use ADVAN\Entities\Snippet_Entity;

$snippet = Snippet_Entity::get_snippet( 42 );

if ( ! empty( $snippet ) ) {
    echo 'Snippet: ' . $snippet['name'];
    echo 'Status: ' . ( Snippet_Entity::STATUS_ENABLED === (int) $snippet['status'] ? 'Enabled' : 'Disabled' );
}

<?php
use ADVAN\Helpers\Snippets_Sandbox;
use ADVAN\Entities\Snippet_Entity;

$snippet = Snippet_Entity::get_snippet( 42 );

if ( ! empty( $snippet ) && 'php' === $snippet['type'] ) {
    $result = Snippets_Sandbox::execute(
        (string) $snippet['code'],
        array(
            'custom_var' => 'my_value',
        )
    );

    if ( 'success' === $result['status'] ) {
        echo 'Output: ' . $result['output'];
        echo 'Duration: ' . $result['duration'] . 's';
    } else {
        echo 'Error: ' . $result['message'];
    }
}

<?php
use ADVAN\Helpers\Snippet_Condition_Evaluator;

$conditions = 'role=administrator, request=admin';
$context = array(
    'trigger' => 'hook',
    'hook'    => 'admin_init',
);

if ( Snippet_Condition_Evaluator::evaluate( $conditions, $context ) ) {
    echo 'Conditions passed!';
} else {
    echo 'Conditions not met.';
}

<?php
use ADVAN\Entities\Snippet_Entity;

// Get enabled PHP snippets containing "woo" in name or tags
$filters = array(
    'search' => 'woo',
    'status' => 'enabled',
    'type'   => 'php',
);

$snippets = Snippet_Entity::get_snippets_with_filters( $filters, 0, 50 );
$count    = Snippet_Entity::get_snippets_count_with_filters( $filters );

foreach ( $snippets as $snippet ) {
    printf(
        "ID: %d | Name: %s | Hook: %s\n",
        $snippet['id'],
        $snippet['name'],
        $snippet['execution_hook']
    );
}

<?php
use ADVAN\Entities\Snippet_Entity;

$now  = gmdate( 'Y-m-d H:i:s' );
$name = 'My Auto-Created Snippet';
$slug = Snippet_Entity::build_unique_slug( $name );

$data = array(
    'blog_id'         => get_current_blog_id(),
    'name'            => $name,
    'slug'            => $slug,
    'type'            => 'php',
    'status'          => Snippet_Entity::STATUS_DISABLED,
    'code'            => 'echo "Hello from auto-generated snippet!";',
    'tags'            => 'auto, generated',
    'execution_scope' => Snippet_Entity::SCOPE_FRONTEND,
    'execution_hook'  => 'wp_footer',
    'hook_priority'   => 99,
    'shortcode_tag'   => null,
    'run_conditions'  => '',
    'last_run_status' => 'never',
    'last_run_message'=> '',
    'last_run_at'     => null,
    'created_at'      => $now,
    'updated_at'      => $now,
);

Snippet_Entity::insert( $data );

<?php
use ADVAN\Helpers\Snippet_Condition_Evaluator;

$conditions = 'role=admin||editor, url_path=/products/*';

if ( Snippet_Condition_Evaluator::is_valid( $conditions ) ) {
    echo 'Conditions are valid!';
    
    // Get normalized rules for inspection
    $rules = Snippet_Condition_Evaluator::get_normalized_rules( $conditions );
    print_r( $rules );
} else {
    echo 'Invalid condition syntax.';
}

<?php
use ADVAN\Entities\Snippet_Entity;

$snippet = Snippet_Entity::get_by_shortcode( 'my_custom_shortcode' );

if ( ! empty( $snippet ) ) {
    echo 'Found snippet: ' . $snippet['name'];
    echo 'Code length: ' . strlen( $snippet['code'] ) . ' bytes';
}

<?php
use ADVAN\Entities\Snippet_Entity;

$original_id = 42;
$new_id      = Snippet_Entity::duplicate( $original_id );

if ( $new_id ) {
    echo 'Created duplicate with ID: ' . $new_id;
    
    // The duplicate is created as disabled
    $new_snippet = Snippet_Entity::get_snippet( $new_id );
    echo 'New name: ' . $new_snippet['name']; // "[Copy] Original Name"
}