|
| 1 | +### Admin and Settings |
| 2 | + |
| 3 | +This document explains how the WPGraphQL Logging admin settings UI is built and how to extend it with your own tabs and fields. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## Architecture Overview |
| 8 | + |
| 9 | +- **Settings page entry**: `WPGraphQL\Logging\Admin\Settings_Page` |
| 10 | + - Registers the submenu page and orchestrates fields and tabs |
| 11 | + - Hooks added: `init` (init fields), `admin_menu` (page), `admin_init` (fields), `admin_enqueue_scripts` (assets) |
| 12 | +- **Menu page**: `WPGraphQL\Logging\Admin\Settings\Menu\Menu_Page` |
| 13 | + - Adds a submenu under Settings → WPGraphQL Logging (`wpgraphql-logging`) |
| 14 | + - Renders template `src/Admin/Settings/Templates/admin.php` |
| 15 | +- **Form manager**: `WPGraphQL\Logging\Admin\Settings\Settings_Form_Manager` |
| 16 | + - Registers the settings (`register_setting`) and sections/fields per tab |
| 17 | + - Sanitizes and saves values per tab; unknown fields are pruned |
| 18 | +- **Field collection**: `WPGraphQL\Logging\Admin\Settings\Fields\Settings_Field_Collection` |
| 19 | + - Holds all tabs and fields. A default `Basic_Configuration_Tab` is registered |
| 20 | +- **Tabs**: Implement `Settings_Tab_Interface` with `get_name()`, `get_label()`, `get_fields()` |
| 21 | +- **Fields**: Implement `Settings_Field_Interface` or use built-ins: |
| 22 | + - `Field\Checkbox_Field` |
| 23 | + - `Field\Text_Input_Field` |
| 24 | + - `Field\Select_Field` |
| 25 | + |
| 26 | +Settings are stored in an array option. Keys are filterable: |
| 27 | + |
| 28 | +- Option key: `wpgraphql_logging_settings` (filter `wpgraphql_logging_settings_group_option_key`) |
| 29 | +- Settings group: `wpgraphql_logging_settings_group` (filter `wpgraphql_logging_settings_group_settings_group`) |
| 30 | + |
| 31 | +To read values at runtime, use `WPGraphQL\Logging\Admin\Settings\Logging_Settings_Service`: |
| 32 | + |
| 33 | +```php |
| 34 | +use WPGraphQL\Logging\Admin\Settings\Logging_Settings_Service; |
| 35 | + |
| 36 | +$settings = new Logging_Settings_Service(); |
| 37 | +$enabled = $settings->get_setting('basic_configuration', 'enabled', false); |
| 38 | +``` |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +## Hooks Reference (Admin) |
| 43 | + |
| 44 | +- Action: `wpgraphql_logging_settings_init( Settings_Page $instance )` |
| 45 | + - Fired after the settings page is initialized |
| 46 | +- Action: `wpgraphql_logging_settings_field_collection_init( Settings_Field_Collection $collection )` |
| 47 | + - Fired after default tabs/fields are registered; primary extension point to add tabs/fields |
| 48 | +- Action: `wpgraphql_logging_settings_form_manager_init( Settings_Form_Manager $manager )` |
| 49 | + - Fired when the form manager is constructed |
| 50 | +- Filter: `wpgraphql_logging_settings_group_option_key( string $option_key )` |
| 51 | + - Change the option key used to store settings |
| 52 | +- Filter: `wpgraphql_logging_settings_group_settings_group( string $group )` |
| 53 | + - Change the settings group name used in `register_setting` |
| 54 | + |
| 55 | +- Filter: `wpgraphql_logging_basic_configuration_fields( array $fields )` |
| 56 | + - Modify the default fields rendered in the `basic_configuration` tab. You can add, remove, or replace fields by returning a modified associative array of `field_id => Settings_Field_Interface`. |
| 57 | + - Example: |
| 58 | + ```php |
| 59 | + use WPGraphQL\Logging\Admin\Settings\Fields\Field\Checkbox_Field; |
| 60 | + |
| 61 | + add_filter('wpgraphql_logging_basic_configuration_fields', function(array $fields): array { |
| 62 | + // Add a custom toggle into the Basic Configuration tab |
| 63 | + $fields['enable_feature_x'] = new Checkbox_Field( |
| 64 | + 'enable_feature_x', |
| 65 | + 'basic_configuration', |
| 66 | + 'Enable Feature X', |
| 67 | + '', |
| 68 | + 'Turn on extra logging for Feature X.' |
| 69 | + ); |
| 70 | + |
| 71 | + // Optionally remove an existing field |
| 72 | + // unset($fields[ WPGraphQL\Logging\Admin\Settings\Fields\Tab\Basic_Configuration_Tab::DATA_SAMPLING ]); |
| 73 | + |
| 74 | + return $fields; |
| 75 | + }); |
| 76 | + ``` |
| 77 | + |
| 78 | +Related (non-admin) hooks for context: |
| 79 | + |
| 80 | +- Action: `wpgraphql_logging_init( Plugin $instance )` (plugin initialized) |
| 81 | +- Action: `wpgraphql_logging_activate` / `wpgraphql_logging_deactivate` |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +## Add a New Tab |
| 86 | + |
| 87 | +Create a tab class implementing `Settings_Tab_Interface` and register it during `wpgraphql_logging_settings_field_collection_init`. |
| 88 | + |
| 89 | +```php |
| 90 | +<?php |
| 91 | +namespace MyPlugin\WPGraphQLLogging; |
| 92 | + |
| 93 | +use WPGraphQL\Logging\Admin\Settings\Fields\Settings_Field_Collection; |
| 94 | +use WPGraphQL\Logging\Admin\Settings\Fields\Tab\Settings_Tab_Interface; |
| 95 | +use WPGraphQL\Logging\Admin\Settings\Fields\Field\Text_Input_Field; |
| 96 | + |
| 97 | +class My_Custom_Tab implements Settings_Tab_Interface { |
| 98 | + public function get_name(): string { |
| 99 | + return 'my_custom_tab'; |
| 100 | + } |
| 101 | + |
| 102 | + public function get_label(): string { |
| 103 | + return 'My Custom Tab'; |
| 104 | + } |
| 105 | + |
| 106 | + public function get_fields(): array { |
| 107 | + return [ |
| 108 | + 'my_setting' => new Text_Input_Field( |
| 109 | + 'my_setting', |
| 110 | + $this->get_name(), |
| 111 | + 'My Setting', |
| 112 | + '', |
| 113 | + 'Describe what this setting does.', |
| 114 | + 'e.g., value' |
| 115 | + ), |
| 116 | + ]; |
| 117 | + } |
| 118 | +} |
| 119 | + |
| 120 | +add_action('wpgraphql_logging_settings_field_collection_init', function (Settings_Field_Collection $collection): void { |
| 121 | + $collection->add_tab(new My_Custom_Tab()); |
| 122 | +}); |
| 123 | +``` |
| 124 | + |
| 125 | +Notes: |
| 126 | + |
| 127 | +- `get_name()` must be a unique slug; it is used in the admin page URL (`tab` query arg) and section IDs |
| 128 | +- Fields returned by `get_fields()` must set their `tab` to this slug so they render on the tab |
| 129 | + |
| 130 | +--- |
| 131 | + |
| 132 | +## Add a Field to an Existing Tab |
| 133 | + |
| 134 | +You can add fields directly to the shared field collection. Ensure the field’s `tab` matches the target tab name. |
| 135 | + |
| 136 | +```php |
| 137 | +<?php |
| 138 | +namespace MyPlugin\WPGraphQLLogging; |
| 139 | + |
| 140 | +use WPGraphQL\Logging\Admin\Settings\Fields\Settings_Field_Collection; |
| 141 | +use WPGraphQL\Logging\Admin\Settings\Fields\Field\Checkbox_Field; |
| 142 | + |
| 143 | +add_action('wpgraphql_logging_settings_field_collection_init', function (Settings_Field_Collection $collection): void { |
| 144 | + $collection->add_field( |
| 145 | + 'enable_feature_x', |
| 146 | + new Checkbox_Field( |
| 147 | + 'enable_feature_x', |
| 148 | + 'basic_configuration', // target the built-in Basic Configuration tab |
| 149 | + 'Enable Feature X', |
| 150 | + '', |
| 151 | + 'Turn on extra logging for Feature X.' |
| 152 | + ) |
| 153 | + ); |
| 154 | +}); |
| 155 | +``` |
| 156 | + |
| 157 | +Tips: |
| 158 | + |
| 159 | +- Only fields present in the collection are saved; unknown keys are pruned during sanitize |
| 160 | +- Field input names follow: `{$option_key}[{$tab}][{$field_id}]` |
| 161 | + |
| 162 | +--- |
| 163 | + |
| 164 | +## Reading/Saving Behavior |
| 165 | + |
| 166 | +- Each submit saves only the current tab’s fields |
| 167 | +- Sanitization is delegated to each field via `sanitize_field($value)` |
| 168 | +- Unknown fields or tabs are ignored/pruned |
| 169 | + |
| 170 | +Example of reading a value elsewhere: |
| 171 | + |
| 172 | +```php |
| 173 | +use WPGraphQL\Logging\Admin\Settings\Logging_Settings_Service; |
| 174 | + |
| 175 | +$settings = new Logging_Settings_Service(); |
| 176 | +$thresholdSeconds = (float) $settings->get_setting('basic_configuration', 'performance_metrics', '0'); |
| 177 | +``` |
| 178 | + |
| 179 | +--- |
| 180 | + |
| 181 | +## Common Use Cases |
| 182 | + |
| 183 | +- Add organization-specific logging toggles (privacy, PII redaction) |
| 184 | +- Integrate with other plugins by exposing their settings under a new tab |
| 185 | +- Provide presets for log points (e.g., only log slow queries) via a custom select field |
| 186 | + |
| 187 | +--- |
| 188 | + |
| 189 | +## Admin Page Details |
| 190 | + |
| 191 | +- Menu: Settings → WPGraphQL Logging (`admin.php?page=wpgraphql-logging`) |
| 192 | +- Tabs: `admin.php?page=wpgraphql-logging&tab={tab_slug}` |
| 193 | +- Sections and fields are rendered with `do_settings_sections('wpgraphql-logging-{tab_slug}')` |
0 commit comments