includes/Admin/class-rest-settings.php
REST settings service — settings save/import/snapshot/restore + sandbox staging handlers.
Class Rest_Settings
Class Rest_Settings
final class Rest_SettingsProperties
| Property | Visibility | Type | Default | Line |
|---|---|---|---|---|
$owner | private | Rest | — | 69 |
public __construct()
public function __construct(Rest $owner)Constructor. Parameter Type Default Description $ownerRest— Owning registrar (shared-infra owner).
public update_settings()
public function update_settings(\\WP_REST_Request $request)Updates the settings for the plugin. Parameter Type Default Description $request\\WP_REST_Request— The request object.
Return: \\WP_REST_Response — The response object.
public import_settings()
public function import_settings(\\WP_REST_Request $request)Imports settings via the REST API. Parameter Type Default Description $request\\WP_REST_Request— The request object.
Return: \\WP_REST_Response — The response object.
public get_settings_snapshot()
public function get_settings_snapshot(\\WP_REST_Request $request): \\WP_REST_ResponseReport whether a prior-settings snapshot exists for one-click undo. Parameter Type Default Description $request\\WP_REST_Request— The request object.
Return: \\WP_REST_Response — The response object.
public restore_settings()
public function restore_settings(\\WP_REST_Request $request): \\WP_REST_ResponseRestore `wppo_settings` from the prior-settings snapshot (one-click undo). Parameter Type Default Description $request\\WP_REST_Request— The request object.
Return: \\WP_REST_Response — The response object.
public get_sandbox_preview()
public function get_sandbox_preview(\\WP_REST_Request $_request): \\WP_REST_ResponseGet sandbox preview status (issue #1163). Parameter Type Default Description $_request\\WP_REST_Request— The request object.
Return: \\WP_REST_Response — The response object.
public save_sandbox_preview()
public function save_sandbox_preview(\\WP_REST_Request $request): \\WP_REST_ResponseSave staged sandbox settings (issue #1163). Parameter Type Default Description $request\\WP_REST_Request— The request object.
Return: \\WP_REST_Response — The response object.
public promote_sandbox_preview()
public function promote_sandbox_preview(\\WP_REST_Request $_request): \\WP_REST_ResponsePromote staged sandbox settings to production (issue #1163). Parameter Type Default Description $_request\\WP_REST_Request— The request object.
Return: \\WP_REST_Response — The response object.
public discard_sandbox_preview()
public function discard_sandbox_preview(\\WP_REST_Request $_request): \\WP_REST_ResponseDiscard staged sandbox settings (issue #1163). Parameter Type Default Description $_request\\WP_REST_Request— The request object.
Return: \\WP_REST_Response — The response object.
private sanitize_settings_recursively()
private function sanitize_settings_recursively(array $settings): arraySanitizes the settings array recursively. Parameter Type Default Description $settingsarray— The settings array.
Return: array — The sanitized settings array.
private remove_sensitive_settings_from_response()
private function remove_sensitive_settings_from_response(array& $settings): voidRemoves sensitive settings from the response array. Parameter Type Default Description $settingsarray&— The settings array passed by reference.
Return: void.