Skip to content

Clarify docs about toggling opt-in status via a Settings page. #111

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

Open
TimothyBJacobs wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Clarify docs about toggling opt-in status via a Settings page. #111

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
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,8 @@ do_action( 'stellarwp/telemetry/optin', '{stellar_slug}', [ 'plugin_slug' => 'th
## Saving Opt-In Status on a Settings Page
When implementing the library, settings should be available for site administrators to change their opt-in status at any time. The value passed to `set_status()` should be a boolean.

When a user want's to opt in, call the `Opt_In_Subscriber::opt_in` method instead of `Status::set_status` to ensure that the site is registered with the telemetry server.

```php
add_action( 'admin_init', 'save_opt_in_setting_field' );

Expand All @@ -168,11 +170,16 @@ public function save_opt_in_setting_field() {

// Get an instance of the Status class.
$Status = Config::get_container()->get( Status::class );
$opt_in = Config::get_container()->get( Opt_In_Subscriber::class );

// Get the value submitted on the settings page as a boolean.
$value = filter_input( INPUT_POST, 'opt-in-status', FILTER_VALIDATE_BOOL );

$Status->set_status( $value );
if ( $value ) {
$opt_in->opt_in( '{stellar_slug}' );
} else {
$Status->set_status( $value );
}
}
```

Expand Down