-
Notifications
You must be signed in to change notification settings - Fork 41
example inject shell config
github-actions[bot] edited this page Aug 25, 2026
·
1 revision
Add a feature flag + REST endpoint to the shell config so your TypeScript can read it without another rest_url() round-trip.
<?php
/**
* Plugin Name: My Feature Flags
*/
defined( 'ABSPATH' ) || exit;
add_filter( 'openstation_shell_config', function ( $config ) {
$config['myFeature'] = array(
'enabled' => (bool) get_option( 'my_ext_feature_enabled' ),
'endpoint' => esc_url_raw( rest_url( 'my-ext/v1/stats' ) ),
'role' => wp_get_current_user()->roles[0] ?? 'subscriber',
);
return $config;
} );document.addEventListener( 'os-init', () => {
const cfg = window.openStationConfig;
if ( ! cfg.myFeature?.enabled ) {
return;
}
fetch( cfg.myFeature.endpoint, {
credentials: 'same-origin',
} )
.then( ( r ) => r.json() )
.then( ( data ) => console.log( 'stats', data ) );
} );-
Namespace your keys. Use
myFeature,myExtSomething— avoid generic names likeflagsorconfigthat could collide with another plugin. -
Always JSON-safe. The config is JSON-encoded into a
<script>block. Don't put resources, closures, or unserializable objects in it. - Don't put secrets. The config is readable by anyone with access to the page. Use nonces for REST calls rather than trying to embed API keys.
- Keep it small. Everything here ships on every shell page-load.
This wiki is generated from the docs/ directory — edits made here are overwritten by the next sync.
To change a page, open a pull request against docs/.
Guides
- Development guide
- Releasing openstation
- Agents security model
- API Index
- Architecture
- Bridge protocol — wiring overview
- <os-*> component reference
- Native Desktop Host — Experimental
- Desktop themes
- Dock customization — two registries, one mental model
- The event-driven framework
- Files on the Desktop
- Folder sharing
- Getting Started
- Hooks Reference
- Icons
- JavaScript Reference
- The Living Tree — algorithm definition
- Mio
- Native Windows & Framework Interop
- Plugin compatibility layer
- Progressive Web App (PWA)
- Station Home
- Using openstation from your own plugin
Migration notes
- Migration: built-in activity channels move to the os/ namespace
- Migration: window, wallpaper and widget bundles load on demand
- Migration — the navigation model
- Migration: a native window's tabs move to the window chrome
All examples
- AI Agents — extend and invoke from a plugin
- wp.os.ai.ask() — programmatic AI Copilot
- Tune the AI model config
- Custom arrange-menu action
- Open a child window its owner can't cover
- Style a specific admin page inside the iframe
- Code Blue — register your plugin's log file
- Open a file in the Code editor (deep-link from any window)
- Connect to a window — title-bar button + iframe pub/sub
- Content changes — live-refresh every window listing your type
- Custom window chrome (Experimental)
- Register a custom unfocused-window effect
- Example: render a data table
- Real file storage — react to uploads, gate policy, share from PHP
- React to a window being set free onto the real desktop
- Cross-window devtools — instrumentation primitives
- Add a dock item with a badge
- Decorate the dock without forking the renderer
- Replace the dock rail entirely
- Retune the Drafts widget's AI writing assistant
- Gate OpenStation by role
- Iframe-initiated window opens
- Build a feed reader without the bookkeeping
- Inject data into openStationConfig
- Render a list without losing clicks — renderKeyedList()
- Example: layout primitives (body → panel → row → col)
- Use <os-*> components from a plugin that ships as a zip
- Restyle and drive Mio
- Add an action that works on a whole selection
- WP Explorer — custom post types and their folder
- Add an action button to a WP Explorer preview pane
- Example: native Posts window
- Example: native window with tabs
- Native windows
- Customize note → post conversion
- Send a notification
- OAuth relay — connect to an external service
- OS-file drop
- <os-flyout> — window-scoped sliding card
- Plugins window — extras
- Track who's around — wp.os.presence
- Example: progress bar
- PWA install — surface your own button
- React to window events
- Example: extend the Trash
- Register a slash-command
- Register a desktop theme from a plugin
- Register a game
- Example: register a desktop icon (Jorvy)
- Register a wallpaper
- Register a widget
- Related entities — extend the title bar's "Related" menu
- The native-window render ctx
- Programmatic folder sharing
- Share state across multi-bundle plugins — wp.os.createSharedStore()
- Example: loading spinner
- Add an opt-in card to Station Home
- Accept drops on your desktop icon
- Give a tile two icons, one per state
- Add a row to a window's ⋯ menu
- Example: window activity & the status ring
- Window controls
- Subscribe to window lifecycle events
- Window links — relate windows and restyle the ties (Experimental)
- Window loading state — spinner overlay & ready signal
- Show a banner at the top of a window
- Pulse a window's icon — Window.requestAttention()
- Register a custom window reveal
- Window slots
- Window themes
- Native window with bundle-bound config