Update wiki documentation to accurately reflect plugin functionality
This commit is contained in:
@ -2,101 +2,56 @@
|
||||
|
||||
This page provides detailed instructions on how to use the "Fix 'Plugin file does not exist' Notices" plugin to clean up orphaned plugin references in your WordPress installation.
|
||||
|
||||
## Accessing the Plugin
|
||||
## How the Plugin Works
|
||||
|
||||
After installing and activating the plugin, you can access it by navigating to **Tools > Fix Plugin Notices** in your WordPress admin dashboard.
|
||||
The plugin works automatically in the background without requiring any configuration:
|
||||
|
||||
## Plugin Interface
|
||||
|
||||
The plugin interface consists of the following sections:
|
||||
|
||||
### Dashboard
|
||||
|
||||
The dashboard provides an overview of:
|
||||
|
||||
- Number of orphaned plugin references detected
|
||||
- Last scan date and time
|
||||
- Quick action buttons for common tasks
|
||||
|
||||
### Scan Results
|
||||
|
||||
This section displays a list of all detected orphaned plugin references, including:
|
||||
|
||||
- Plugin name (if available)
|
||||
- Plugin file path
|
||||
- Status (active/inactive)
|
||||
- Action buttons for each entry
|
||||
|
||||
### Settings
|
||||
|
||||
The settings section allows you to configure:
|
||||
|
||||
- Automatic scanning frequency
|
||||
- Notification preferences
|
||||
- Logging options
|
||||
- Advanced cleanup options
|
||||
1. It detects orphaned plugin references in your WordPress database
|
||||
2. It adds these missing plugins to your plugins list with a "Remove Notice" action link
|
||||
3. It allows you to safely clean up invalid plugin references directly from the plugins page
|
||||
|
||||
## Basic Usage
|
||||
|
||||
### Scanning for Orphaned Plugin References
|
||||
### Viewing Orphaned Plugin References
|
||||
|
||||
1. Navigate to **Tools > Fix Plugin Notices**.
|
||||
2. Click the **Scan Now** button.
|
||||
3. The plugin will scan your WordPress database for orphaned plugin references.
|
||||
4. Once the scan is complete, the results will be displayed in the Scan Results section.
|
||||
1. After installing and activating the plugin, navigate to **Plugins** in your WordPress admin dashboard.
|
||||
2. The plugin automatically scans for orphaned plugin references.
|
||||
3. Any detected orphaned references will appear in your plugins list with "(File Missing)" next to their name.
|
||||
4. Each orphaned plugin will have a description explaining that it's still marked as active in your database but its files can't be found.
|
||||
|
||||
### Cleaning Up Orphaned References
|
||||
|
||||
#### Individual Cleanup
|
||||
|
||||
1. In the Scan Results section, locate the orphaned plugin reference you want to clean up.
|
||||
2. Click the **Fix** button next to the entry.
|
||||
1. In the plugins list, locate the orphaned plugin reference you want to clean up (marked with "File Missing").
|
||||
2. Click the **Remove Notice** link under the plugin name.
|
||||
3. The plugin will remove the orphaned reference from your WordPress database.
|
||||
4. A success message will be displayed once the cleanup is complete.
|
||||
5. The plugin reference will no longer appear in your plugins list, and the error notice will be eliminated.
|
||||
|
||||
#### Bulk Cleanup
|
||||
## Update Source Selection
|
||||
|
||||
1. In the Scan Results section, check the boxes next to the orphaned plugin references you want to clean up.
|
||||
2. Select "Fix Selected" from the Bulk Actions dropdown.
|
||||
3. Click the **Apply** button.
|
||||
4. The plugin will remove all selected orphaned references from your WordPress database.
|
||||
5. A success message will be displayed once the cleanup is complete.
|
||||
The plugin allows you to choose your preferred update source:
|
||||
|
||||
#### Automatic Cleanup
|
||||
1. In the plugins list, find the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
2. Click the **Update Source** link under the plugin name.
|
||||
3. A modal dialog will appear with three options:
|
||||
- **WordPress.org**: Get updates from the official WordPress plugin repository
|
||||
- **GitHub**: Get updates from the GitHub repository
|
||||
- **Gitea**: Get updates from the Gitea repository
|
||||
4. Select your preferred update source and click **Save**.
|
||||
5. The plugin will now check for updates from your selected source.
|
||||
|
||||
You can configure the plugin to automatically clean up orphaned plugin references:
|
||||
## No Settings Page
|
||||
|
||||
1. Navigate to the Settings section.
|
||||
2. Enable the "Automatic Cleanup" option.
|
||||
3. Configure the frequency and conditions for automatic cleanup.
|
||||
4. Click **Save Changes**.
|
||||
This plugin intentionally has no settings page or admin menu. It works automatically in the background and provides all functionality directly on the plugins page where it's needed most.
|
||||
|
||||
## Advanced Usage
|
||||
## Multisite Compatibility
|
||||
|
||||
### Command Line Interface
|
||||
The plugin is fully compatible with WordPress multisite installations:
|
||||
|
||||
The plugin provides a WP-CLI command for scanning and cleaning up orphaned plugin references:
|
||||
|
||||
```
|
||||
wp fix-plugin-notices scan
|
||||
wp fix-plugin-notices cleanup
|
||||
wp fix-plugin-notices cleanup --all
|
||||
```
|
||||
|
||||
For more information on using the command line interface, see the [Command Line Interface](Command-Line-Interface) documentation.
|
||||
|
||||
### Hooks and Filters
|
||||
|
||||
The plugin provides several hooks and filters that allow you to customize its behavior:
|
||||
|
||||
```php
|
||||
// Example: Customize the scan frequency
|
||||
add_filter('wpfpden_scan_frequency', function($frequency) {
|
||||
return 'daily'; // Options: hourly, daily, weekly
|
||||
});
|
||||
```
|
||||
|
||||
For more information on available hooks and filters, see the [Hooks and Filters](Hooks-and-Filters) documentation.
|
||||
- In a network admin context, it detects and fixes orphaned network-activated plugin references
|
||||
- In a site admin context, it detects and fixes orphaned site-activated plugin references
|
||||
|
||||
## Best Practices
|
||||
|
||||
|
||||
Reference in New Issue
Block a user