Skip to content

Port r65272: tidy the Secrets API tests and inline documentation #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericmann merged 1 commit into from
Nov 9, 2026
Merged

Port r65272: tidy the Secrets API tests and inline documentation #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 10 additions & 19 deletions docs/reference/classes.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 16 additions & 25 deletions docs/reference/functions.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/reference/hooks.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions secrets-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,12 @@ function wp_secrets_api_notice_conflict(): void {
* userland and is recorded in docs/journal/test-coverage-gaps.md rather than
* silently assumed away.
*
* @global bool $wp_secrets_dropin_loaded Whether a secrets.php drop-in file was found.
* @global bool $wp_secrets_dropin_broken Whether the drop-in failed to load or left an invalid override.
* @global WP_Secrets_Provider $wp_secrets_provider Optional. Provider override set by the drop-in.
* @global WP_Secrets_Store $wp_secrets_store Optional. Store override set by the drop-in.
* @global WP_Secrets_Keyring $wp_secrets_keyring Optional. Keyring override set by the drop-in.
*
* @return void
*/
function wp_secrets_api_load_dropin(): void {
Expand Down
11 changes: 5 additions & 6 deletions src/wp-admin/includes/secrets-site-health.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@
/**
* Registers the Secrets API's Site Health tests.
*
* No settings screen – the proposal defers that to 7.3 – but the health signal an
* operator needs to notice a broken key, a weak key source, or a pending rotation is
* in scope now.
* There is no settings screen for secrets, so these tests are how an operator
* notices a broken key, a weak key source, or a pending rotation.
*
* @since 7.2.0
*
Expand Down Expand Up @@ -74,7 +73,7 @@ function wp_secrets_site_health_result( string $test, string $label, string $sta
}

/**
* Site Health test: is the site key a dedicated constant, or a weaker fallback?
* Tests whether the site key comes from a dedicated constant or a weaker fallback.
*
* @since 7.2.0
*
Expand Down Expand Up @@ -130,7 +129,7 @@ function wp_secrets_site_health_test_key_source(): array {
}

/**
* Site Health test: does every stored secret still decrypt?
* Tests whether every stored secret still decrypts.
*
* Network secrets are included only for a super admin on a multisite install –
* never shown to a site administrator who is not one.
Expand Down Expand Up @@ -218,7 +217,7 @@ function wp_secrets_site_health_find_undecryptable( bool $network ): array {
}

/**
* Site Health test: are any secrets flagged as needing rotation?
* Tests whether any secrets are flagged as needing rotation.
*
* @since 7.2.0
*
Expand Down
Loading
Loading