Hooks

Last updatedView as Markdown

Actions

HookArgumentsWhen
before_psst_init, after_psst_initAround bootstrap on plugins_loaded
psst_readyBootstrapAfter every controller registered its hooks
psst_activatedEnd of activation
psst_secret_createdint $post_id, string $public_idAfter a secret is stored
psst_secret_revealedstring $public_idAfter the one-time reveal
psst_secret_shreddedstring $public_id, string $actorsender or admin
psst_secret_expiredint $post_idScheduled expiry ran
psst_secret_destroyedint $post_id, string $reason, string $public_idBefore any deletion
psst_secrets_sweptint $countAfter the daily sweep

No hook ever receives an envelope or plaintext.

Filters

HookDefaultPurpose
psst_secret_args, psst_secret_labelsPost type registration
psst_schedule_optionsthe enabled choicesMinutes => label
psst_slug_length16Bytes of entropy in an id (floor 16)
psst_date_time_formatsite date @ timeExpiry label
psst_url_basesThe link prefix
psst_create_page_urlthe create page permalinkWhere "create your own" links go
psst_client_configConfiguration handed to the blocks
psst_create_responseThe create response body
psst_create_challengetrueReturn a WP_Error to refuse a create
psst_rate_limitper scopeHits per hour, 0 disables
psst_client_ipThe address used for rate limiting
psst_max_plaintext_bytessettingPlaintext cap
psst_max_request_bytes65536Request body cap
psst_min_kdf_iterations600000PBKDF2 floor
psst_sweep_batch_size200Rows per sweep pass
psst_frame_optionsDENYX-Frame-Options on secret pages
psst_disable_page_cachetrueDefine DONOTCACHEPAGE on secret pages
psst_content_security_policy''Opt-in CSP header on secret pages

Have a question about this page?

Linchpin assistant

Was this helpful?