# jetpack/16.3/jetpack_vendor/automattic/jetpack-agents-manager/src/class-open-state-store.php Jetpack – WP Security, Backup, Speed, & Growth, version 16.3. 216 lines. - Page: https://pluginprobe.com/plugins/jetpack/16.3/code/jetpack_vendor/automattic/jetpack-agents-manager/src/class-open-state-store.php - Raw: https://pluginprobe.com/plugins/jetpack/16.3/raw/jetpack_vendor/automattic/jetpack-agents-manager/src/class-open-state-store.php - Modified: 2026-09-08T18:39:34+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/jetpack/16.3/code/jetpack_vendor/automattic/jetpack-agents-manager/src/class-open-state-store.php#L10-L20`. ```php false, 'agents_manager_docked' => false, 'agents_manager_minimized' => false, 'agents_manager_floating_position' => 'right', 'agents_manager_router_history' => null, 'agents_manager_last_activity' => null, ); /** * Fetch the open state from wpcom and refresh the cache. * * @return array|\WP_Error Normalized state, or WP_Error when the request fails. */ public static function fetch() { $body = Client::wpcom_json_api_request_as_user( '/agents-manager/state', '2', array( 'method' => 'GET' ) ); if ( is_wp_error( $body ) ) { return $body; } $response = json_decode( wp_remote_retrieve_body( $body ), true ); $state = self::normalize( is_array( $response ) ? $response : array() ); self::cache( $state ); return $state; } /** * Persist the open state to wpcom and refresh the cache. * * @param array $state Partial state to update (subset of DEFAULTS keys). * @return array|\WP_Error Normalized state, or WP_Error when the request fails. */ public static function update( array $state ) { $body = Client::wpcom_json_api_request_as_user( '/agents-manager/state', '2', array( 'method' => 'POST' ), array( 'state' => $state ) ); if ( is_wp_error( $body ) ) { return $body; } $response = json_decode( wp_remote_retrieve_body( $body ), true ); if ( ! is_array( $response ) ) { return new \WP_Error( 'invalid_response', 'Invalid response from WPCOM endpoint', array( 'status' => 500 ) ); } $normalized = self::normalize( $response ); self::cache( $normalized ); return $normalized; } /** * Read the current user's open state from the fastest local source. * * For latency-sensitive callers like the server-side pre-render: Simple sites * read `calypso_preferences` directly, everywhere else uses the cached * transient (see the class docblock). Returns null when nothing is known yet, * so callers can skip pre-rendering until the frontend sets the real state. * * @return array|null `{ agents_manager_open, agents_manager_docked, agents_manager_minimized }` or null. */ public static function get_cached() { $user_id = get_current_user_id(); if ( ! $user_id ) { return null; } // Simple sites have the preference locally, so read it directly (the // transient is never primed there). if ( ( new Host() )->is_wpcom_simple() && function_exists( '\get_user_attribute' ) ) { $calypso_prefs = \get_user_attribute( $user_id, 'calypso_preferences' ); if ( ! is_array( $calypso_prefs ) ) { return null; } return array( 'agents_manager_open' => (bool) ( $calypso_prefs['agents_manager_open'] ?? false ), 'agents_manager_docked' => (bool) ( $calypso_prefs['agents_manager_docked'] ?? false ), 'agents_manager_minimized' => (bool) ( $calypso_prefs['agents_manager_minimized'] ?? false ), ); } // The cached state is only as good as the connection that produced it. // Without a user connection the frontend cannot fetch or refresh state // (the app never mounts), so a pre-render from a stale transient would // flash a shell nothing ever takes down. if ( ! ( new Connection_Manager() )->is_user_connected( $user_id ) ) { return null; } $cached = get_transient( self::cache_key( $user_id ) ); return is_array( $cached ) ? $cached : null; } /** * Normalize a raw endpoint response into the full state shape. * * @param array $response Raw decoded response. * @return array Normalized state with all DEFAULTS keys present. */ private static function normalize( array $response ): array { return array( 'agents_manager_open' => (bool) ( $response['agents_manager_open'] ?? self::DEFAULTS['agents_manager_open'] ), 'agents_manager_docked' => (bool) ( $response['agents_manager_docked'] ?? self::DEFAULTS['agents_manager_docked'] ), 'agents_manager_minimized' => (bool) ( $response['agents_manager_minimized'] ?? self::DEFAULTS['agents_manager_minimized'] ), 'agents_manager_floating_position' => $response['agents_manager_floating_position'] ?? self::DEFAULTS['agents_manager_floating_position'], 'agents_manager_router_history' => $response['agents_manager_router_history'] ?? self::DEFAULTS['agents_manager_router_history'], 'agents_manager_last_activity' => $response['agents_manager_last_activity'] ?? self::DEFAULTS['agents_manager_last_activity'], ); } /** * Cache the open, docked and minimized bits in a per-user transient. * * Only used on the remote (WoA / self-hosted) path — it's what get_cached() * reads there. Simple sites read `calypso_preferences` directly and skip this. * * @param array $state Normalized state. */ private static function cache( array $state ): void { $user_id = get_current_user_id(); if ( ! $user_id ) { return; } /** * Filter how long the cached open state lives. * * It's refreshed on every read/write through this store, so the TTL mainly * caps how long a value changed elsewhere (e.g. in Calypso) stays stale. * * @since 0.4.0 * * @param int $ttl Cache lifetime in seconds. */ $ttl = (int) apply_filters( 'agents_manager_open_state_cache_ttl', WEEK_IN_SECONDS ); set_transient( self::cache_key( $user_id ), array( 'agents_manager_open' => (bool) ( $state['agents_manager_open'] ?? false ), 'agents_manager_docked' => (bool) ( $state['agents_manager_docked'] ?? false ), 'agents_manager_minimized' => (bool) ( $state['agents_manager_minimized'] ?? false ), ), $ttl ); } /** * Build the per-user transient key. * * @param int $user_id User ID. * @return string */ private static function cache_key( int $user_id ): string { return self::TRANSIENT_PREFIX . $user_id; } } ```