Add admin how-to guides and update documentation

Added three new how-to guides for extending WPGraphQL Logging admin: adding fields to existing tabs, creating new settings tabs, and adding columns to the logs grid. Updated index and reference docs to link and document these extension points. Added relevant screenshots for each guide.

Author: colinmurphy

plugins/wpgraphql-logging/docs/how-to/admin_add_fields.md

@@ -0,0 +1,66 @@
+## How to add a new field to an existing tab and query it
+
+This guide shows how to add custom fields to the WPGraphQL Logging settings and how to read or query those values.
+
+![WPGraphQL Logging Settings Page](../screenshots/admin_how_to_add_field.png)
+*The WPGraphQL Logging settings page with Basic Configuration and Data Management tabs where custom fields can be added*
+
+
+### Step 1 — Add a field via filter
+
+Add a field to an existing tab using the provided filters. Common tabs are `basic_configuration` and `data_management`.
+
+Example: add a checkbox to Basic Configuration
+
+```php
+add_filter( 'wpgraphql_logging_basic_configuration_fields', function( $fields ) {
+    $fields['my_feature_enabled'] = new \WPGraphQL\Logging\Admin\Settings\Fields\Field\CheckboxField(
+        'my_feature_enabled',
+        'basic_configuration',
+        __( 'Enable My Feature', 'my-plugin' )
+    );
+    return $fields;
+});
+```
+
+Example: add a text input to Data Management
+
+```php
+add_filter( 'wpgraphql_logging_data_management_fields', function( $fields ) {
+    $fields['my_data_region'] = new \WPGraphQL\Logging\Admin\Settings\Fields\Field\TextInputField(
+        'my_data_region',
+        'data_management',
+        __( 'Data Region', 'my-plugin' ),
+        '',
+        __( 'e.g., us-east-1', 'my-plugin' ),
+        __( 'us-east-1', 'my-plugin' )
+    );
+    return $fields;
+});
+```
+
+Notes:
+
+- Field classes available: `CheckboxField`, `TextInputField`, `SelectField`, `TextIntegerField`.
+- The second argument is the tab key (use the tab’s `get_name()`), not the option key.
+
+### Step 2 — Where the value is stored
+
+Values are saved to the option key `wpgraphql_logging_settings` under the tab key and field id, for example:
+
+```php
+$options = get_option( 'wpgraphql_logging_settings', [] );
+// Example structure
+// [
+//   'basic_configuration' => [ 'my_feature_enabled' => true ],
+//   'data_management'     => [ 'my_data_region' => 'us-east-1' ],
+// ]
+```
+
+### Step 3 — Read the value in PHP
+
+```php
+$options          = get_option( 'wpgraphql_logging_settings', [] );
+$is_enabled       = ! empty( $options['basic_configuration']['my_feature_enabled'] );
+$my_data_region   = $options['data_management']['my_data_region'] ?? '';
+```

plugins/wpgraphql-logging/docs/how-to/admin_add_new_tab.md

@@ -0,0 +1,112 @@
+## How to add a new Settings tab to WPGraphQL Logging
+
+This guide shows how to add your own settings tab and fields to the WPGraphQL Logging Admin using the `wpgraphql_logging_settings_field_collection_init` action.
+
+
+![Add New Settings Tab](../screenshots/admin_how_to_add_tab.png)
+*Example of a custom settings tab added to WPGraphQL Logging admin interface*
+
+
+
+### Step 1 — Create a Tab class implementing `SettingsTabInterface`
+
+Create a new class that implements the required static methods and returns the fields you want to render/save.
+
+```php
+<?php
+
+namespace MyPlugin\Admin\Settings\Fields\Tab;
+
+use WPGraphQL\Logging\Admin\Settings\Fields\Field\CheckboxField;
+use WPGraphQL\Logging\Admin\Settings\Fields\Field\TextInputField;
+use WPGraphQL\Logging\Admin\Settings\Fields\Tab\SettingsTabInterface;
+
+class MyCustomTab implements SettingsTabInterface {
+	public const ENABLE_FEATURE = 'my_custom_enable_feature';
+	public const API_ENDPOINT   = 'my_custom_api_endpoint';
+
+	public static function get_name(): string {
+		return 'my_custom_tab';
+	}
+
+	public static function get_label(): string {
+		return __( 'My Custom Tab', 'my-plugin' );
+	}
+
+	public function get_fields(): array {
+		$fields = [];
+
+		$fields[ self::ENABLE_FEATURE ] = new CheckboxField(
+			self::ENABLE_FEATURE,
+			self::get_name(),
+			__( 'Enable Feature', 'my-plugin' ),
+			'',
+			__( 'Turn on a custom behavior for WPGraphQL Logging.', 'my-plugin' ),
+	);
+
+	$fields[ self::API_ENDPOINT ] = new TextInputField(
+		self::API_ENDPOINT,
+		self::get_name(),
+		__( 'API Endpoint', 'my-plugin' ),
+		'',
+		__( 'Your service endpoint for processing log data.', 'my-plugin' ),
+		__( 'https://api.example.com/logs', 'my-plugin' )
+	);
+
+		return $fields;
+	}
+}
+```
+
+Notes:
+
+- `get_name()` is the tab identifier (slug).
+- `get_label()` is the tab title shown in the UI.
+- `get_fields()` returns an array of field objects keyed by a unique field ID. Available field types include `CheckboxField`, `TextInputField`, `SelectField`, and `TextIntegerField`.
+
+### Step 2 — Register the tab via the action
+
+Hook into the field collection and add your tab instance. The collection automatically registers your tab’s fields.
+
+```php
+add_action( 'wpgraphql_logging_settings_field_collection_init', function ( $collection ) {
+	// Ensure your class is autoloaded or required before this runs
+	$collection->add_tab( new \MyPlugin\Admin\Settings\Fields\Tab\MyCustomTab() );
+}, 10, 1 );
+```
+
+### Step 3 — Reading saved values
+
+Values are stored with the plugin’s option key (filterable via `wpgraphql_logging_settings_group_option_key`). A simple way to access them:
+
+```php
+namespace MyPlugin\Admin\Settings\Fields\Tab\MyCustomTab;
+namespace WPGraphQL\Logging\Admin\Settings\ConfigurationHelper;
+// You could also do this
+// $options = get_option( 'wpgraphql_logging_settings', [] );
+// $enabled = ! empty( $options['my_custom_tab']['enable_feature'] );
+// $api_url = $options['my_custom_tab']['api_endpoint'] ?? '';
+
+// Example: Show an admin notice based on the setting
+add_action( 'admin_notices', function() use ( $enabled, $apiUrl ) {
+	$helper  = ConfigurationHelper::get_instance();
+	$tab 	 = 'my_custom_tab';
+	$enabled = $helper->get_setting($tab, MyCustomTab::ENABLE_FEATURE, false);
+	$api_url = $helper->get_setting($tab), MyCustomTab::API_ENDPOINT, '');
+
+
+	if ( $enabled && empty( $api_url ) ) {
+		echo '<div class="notice notice-warning"><p>';
+		echo __( 'Custom feature is enabled but no API endpoint is configured.', 'my-plugin' );
+		echo '</p></div>';
+	} else {
+		echo '<div class="notice notice-info"><p>';
+		if ( $enabled ) {
+			echo sprintf( __( 'Custom feature is enabled. API URL: %s', 'my-plugin' ), esc_html( $api_url ) );
+		} else {
+			echo __( 'Custom feature is disabled.', 'my-plugin' );
+		}
+		echo '</p></div>';
+	}
+});
+```

plugins/wpgraphql-logging/docs/how-to/admin_add_view_column.md

@@ -0,0 +1,63 @@
+## How to add a new column to the Logs admin grid
+
+This guide shows how to add a custom column to the Logs list table using the provided filters. We’ll add a Memory Peak Usage column sourced from the log entry’s `extra.memory_peak_usage`. 
+
+
+![Add New Column to Logs Table](../screenshots/admin_how_to_add_column_to_grid.png)
+*Example of a custom Memory Peak Usage column added to the WPGraphQL Logging admin table*
+
+
+### Hooks overview
+
+- `wpgraphql_logging_logs_table_column_headers`: modify the visible columns and sortable metadata
+- `wpgraphql_logging_logs_table_column_value`: control how each column’s value is rendered
+
+Source: `src/Admin/View/List/ListTable.php`
+
+### Step 1 — Add the column header
+
+```php
+add_filter( 'wpgraphql_logging_logs_table_column_headers', function( $headers ) {
+    if ( isset( $headers[0] ) && is_array( $headers[0] ) ) {
+        $headers[0]['peak_memory_usage'] = __( 'Memory Peak (MB)', 'my-plugin' );
+        // Optionally make it sortable by a DB column
+        // $headers[2]['peak_memory_usage'] = [ 'memory_peak_usage', false ];
+        return $headers;
+    }
+
+    // Fallback when filter is called for get_columns()
+    $headers['peak_memory_usage'] = __( 'Memory Peak (MB)', 'my-plugin' );
+    return $headers;
+}, 10, 1 );
+```
+
+### Step 2 — Provide the cell value
+
+Each row item is a `\WPGraphQL\Logging\Logger\Database\DatabaseEntity`. Memory data is stored in `$item->get_extra()['memory_peak_usage']`.
+
+```php
+add_filter( 'wpgraphql_logging_logs_table_column_value', function( $value, $item, $column_name ) {
+    if ( 'peak_memory_usage' !== $column_name ) {
+        return $value;
+    }
+
+    if ( ! $item instanceof \WPGraphQL\Logging\Logger\Database\DatabaseEntity ) {
+        return $value;
+    }
+
+    $extra = $item->get_extra();
+    $raw   = $extra['memory_peak_usage'] ?? '';
+    if ( '' === $raw ) {
+        return '';
+    }
+
+    // Normalize to MB if the stored value is in bytes
+    if ( is_numeric( $raw ) ) {
+        $mb = round( (float) $raw / 1048576, 2 );
+        return sprintf( '%s MB', number_format_i18n( $mb, 2 ) );
+    }
+
+    // If already formatted (e.g., "24 MB"), just escape and return
+    return esc_html( (string) $raw );
+}, 10, 3 );
+```

plugins/wpgraphql-logging/docs/index.md

@@ -179,6 +179,10 @@ The plugin is developer focussed and can be extended in multiple ways.
 ## Admin - (admin configuration, view and functionality)
 
 - [Actions/Filters](reference/admin.md)
+- [How to add a new Settings tab to WPGraphQL Logging](how-to/admin_add_new_tab.md)
+- [How to add a new field to an existing tab and query it](how-to/admin_add_fields.md)
+- [How to add a new column to the Logs admin grid](how-to/admin_add_view_column.md)
+
 
 @TODO - How to guides
 
@@ -193,110 +197,4 @@ The plugin is developer focussed and can be extended in multiple ways.
 @TODO - How to guides
 
 
----- 
-
-# Old Notes
-
-- Need to be refactored.
-
-
-
-
-
-
-### Developer Hooks
-
-Customize sanitization behavior using WordPress filters:
-
-```php
-// Enable/disable sanitization programmatically
-add_filter( 'wpgraphql_logging_data_sanitization_enabled', function( $enabled ) {
-	return current_user_can( 'manage_options' ) ? false : $enabled;
-});
-
-// Modify recommended rules
-add_filter( 'wpgraphql_logging_data_sanitization_recommended_rules', function( $rules ) {
-	$rules['custom.sensitive.field'] = 'remove';
-	return $rules;
-});
-
-// Modify all sanitization rules
-add_filter( 'wpgraphql_logging_data_sanitization_rules', function( $rules ) {
-	// Add additional rules or modify existing ones
-	$rules['request.custom_header'] = 'anonymize';
-	return $rules;
-});
-
-// Modify the final log record after sanitization
-add_filter( 'wpgraphql_logging_data_sanitization_record', function( $record ) {
-	// Additional processing after sanitization
-	return $record;
-});
-```
-
-### Performance Considerations
-
-- Sanitization runs on every log record when enabled
-- Complex nested field paths may impact performance on high-traffic sites
-- Consider using recommended rules for optimal performance
-- Test custom rules thoroughly to ensure they target the intended fields
-
-### Security Best Practices
-
-1. **Review logs regularly** to ensure sanitization is working as expected
-2. **Test field paths** in a development environment before applying to production
-3. **Use remove over anonymize** for highly sensitive data
-4. **Monitor performance impact** when implementing extensive custom rules
-5. **Keep rules updated** as your GraphQL schema evolves
-
----
-
-## Usage
-
-WPGraphQL Logging Plugin is highly configurable and extendable and built with developers in mind to allow them to modify, change or add data, loggers etc to this plugin. Please read the docs below:
-
-
-The following documentation is available in the `docs/` directory:
-
-- [Events](docs/Events.md):
-  Learn about the event system, available events, and how to subscribe, transform, or listen to WPGraphQL Logging events.
-
-- [Logging](docs/Logging.md):
-  Learn about the logging system, Monolog integration, handlers, processors, and how to use or extend the logger.
-
-- [Admin](docs/admin.md):
-  Learn how the admin settings page works, all available hooks, and how to add tabs/fields via actions and filters.
-
----
-
-
-
----
-
-## Admin & Settings
-
-See `docs/admin.md` for a full overview of the admin/settings architecture, hooks, and examples for adding tabs and fields.
-
-## Testing
-
-See [Testing.md](TESTING.md) for details on how to test the plugin.
-
-## Screenshots
-
-@TODO - When before BETA release.
-
-
-
-### Manual Data Cleanup
-
-If you prefer to manually clean up data without defining the constant, you can:
-
-1. Use the plugin's admin interface to clear logs (when available)
-2. Manually drop the database table: `{$wpdb->prefix}wpgraphql_logging`
-3. Remove plugin options from the WordPress options table
-
----
-
-@TODO add more info once we have configuration setup.
-
-@TODO add more info once we have configuration setup.
+----