Description
Fullworks Support Diagnostics makes it easier for plugin developers to troubleshoot issues by automatically collecting diagnostic information and providing powerful debugging tools. It discovers installed plugins and provides a framework for plugin-specific diagnostic data collection.
This plugin should only be activated when instructed by plugin support personnel for diagnostic purposes.
Key Features
- Automatic plugin discovery – Detects compatible plugins with support-config.json files
- System information collection – Gathers essential WordPress environment data
- wp-config.php debug management – Safely modify debug constants with automatic backups
- Shortcode scanning – Identifies shortcodes used across your site
- Freemius integration – Collects license status and Freemius state for premium plugins
- REST API endpoints – Allows secure remote diagnostics with temporary access links
- Sensitive data protection – Masks API keys and other confidential information
- Debug log monitoring – Checks and displays the most recent log entries
Debug Management
The plugin can safely manage debug constants in wp-config.php:
- Enable/disable WordPress debugging with a single click
- Automatically creates backups of wp-config.php before any modifications
- Clearly marks all changes with comment blocks for easy identification
- Safely removes all modifications when the feature is disabled
- Monitors debug log files for recent entries
Security Considerations
- All wp-config.php modifications require explicit admin confirmation
- Access keys can be regenerated at any time
- Temporary access links expire after 24 hours
- API keys and sensitive data are masked in diagnostic reports
- REST API endpoint can be disabled if not needed
Usage Instructions
For Site Owners
- Only install when directed by support personnel
- Go to Tools Plugin Support Diagnostics in your WordPress admin
- If instructed, enable debug management and select appropriate debug constants
- Click « Generate Diagnostic Data »
- Share the diagnostic information with support using one of these methods:
- Copy to clipboard
- Download as JSON
- Use the temporary direct access link (valid for 24 hours)
- When troubleshooting is complete, disable any debug options and consider deactivating the plugin
For Plugin Developers
To make your plugin compatible with Support Diagnostics, create a support-config.json
file in your plugin’s root directory. See the example-support-config.json file included in the plugin for reference.
Installation
- Upload the plugin files to the
/wp-content/plugins/fullworks-support-diagnostics
directory, or install the plugin through the WordPress plugins screen directly. - Activate the plugin through the ‘Plugins’ screen in WordPress
- Use the Tools->Plugin Support Diagnostics screen to configure the plugin
- IMPORTANT: Only activate and use this plugin when instructed by plugin support personnel
FAQ
-
Is it safe to modify wp-config.php?
-
Yes, with appropriate caution. The plugin:
1. Creates a backup of wp-config.php before any changes
2. Uses the WordPress filesystem API for all operations
3. Clearly marks all changes with comment blocks
4. Provides a UI that clearly explains all modifications
5. Automatically removes changes when disabled
6. Requires admin privileges to make any changes -
What information is collected?
-
The plugin collects:
* Basic WordPress environment information
* Plugin-specific data as configured in support-config.json files
* Current status of debug constants
* Shortcode usage across the site
* Database table information for specific plugins
* License/activation status for premium plugins (via Freemius)
* Recent debug log entries when available -
How do I integrate this with my plugin?
-
Add a support-config.json file to your plugin directory with specific diagnostics configuration. See example-support-config.json for reference.
-
The plugin provides three methods:
1. Copy the data to your clipboard
2. Download the data as a JSON file
3. Generate a temporary access link (valid for 24 hours) that support personnel can use to access the diagnostics remotely -
Can I disable remote access to diagnostics?
-
Yes, the REST API endpoint can be disabled in the plugin settings. You can also regenerate access keys at any time for security.
Avis
Il n’y a aucun avis pour cette extension.
Contributeurs/contributrices & développeurs/développeuses
« Fullworks Support Diagnostics » est un logiciel libre. Les personnes suivantes ont contribué à cette extension.
ContributeursTraduisez « Fullworks Support Diagnostics » dans votre langue.
Le développement vous intéresse ?
Parcourir le code, consulter le SVN dépôt, ou s’inscrire au journal de développement par RSS.
Journal des modifications
1.0.0
- Initial release
- Added wp-config.php debug constant management with safety features
- Implemented Freemius module detection and data collection
- Added REST API endpoints for remote diagnostics