Merge v2.4.0 into main
This commit is contained in:
@ -2,6 +2,14 @@
|
||||
|
||||
This guide helps AI assistants understand the project structure, workflows, and best practices for this repository.
|
||||
|
||||
## IMPORTANT: Repository Context
|
||||
|
||||
This workspace may contain multiple repository folders. Always focus ONLY on the current repository you're working in and avoid hallucinating functionality from other repositories in the workspace.
|
||||
|
||||
- **Current Repository**: wp-fix-plugin-does-not-exist-notices
|
||||
- **Repository Purpose**: Adds missing plugins to your plugins list with a "Remove Notice" action link, allowing you to safely clean up invalid plugin references
|
||||
- **Repository Scope**: All code changes, documentation, and functionality discussions should be limited to THIS repository only
|
||||
|
||||
## Project Overview
|
||||
|
||||
- **Plugin Name**: Fix 'Plugin file does not exist' Notices
|
||||
@ -108,6 +116,22 @@ AI assistants should maintain a record of developer preferences in **@.ai-workfl
|
||||
|
||||
This ensures consistency across coding sessions and reduces the need for developers to repeatedly explain their preferences.
|
||||
|
||||
## Avoiding Cross-Repository Confusion
|
||||
|
||||
When working in a multi-repository workspace, follow these guidelines to avoid confusion:
|
||||
|
||||
1. **Verify Repository Context**: Always check which repository you're currently working in before making any changes or recommendations.
|
||||
|
||||
2. **Limit Code Search Scope**: When searching for code or functionality, explicitly limit your search to the current repository.
|
||||
|
||||
3. **Don't Assume Features**: Never assume that features present in one repository should be implemented in another. Each repository has its own specific purpose and feature set.
|
||||
|
||||
4. **Repository-Specific Documentation**: Documentation should only reflect the actual features and functionality of the current repository.
|
||||
|
||||
5. **Cross-Repository Inspiration**: If you want to implement a feature inspired by another repository, explicitly mention that it's a new feature being added, not an existing one.
|
||||
|
||||
6. **Verify Before Implementation**: Before implementing or documenting a feature, verify that it actually exists in the current repository by checking the codebase.
|
||||
|
||||
## Common Tasks
|
||||
|
||||
For detailed instructions on common tasks like creating releases, adding features, fixing bugs, and testing previous versions, see **@.ai-workflows/release-process.md**.
|
||||
|
@ -35,9 +35,17 @@ Update relevant documentation to reflect the new feature:
|
||||
|
||||
- Add a description to CHANGELOG.md under an "Unreleased" section
|
||||
- Update readme.txt if the feature affects user-facing functionality
|
||||
- Update README.md with the new feature description
|
||||
- Update inline documentation/comments
|
||||
- Update wiki documentation in the `.wiki` directory:
|
||||
- Create or update feature-specific pages
|
||||
- Update the Home.md page if necessary
|
||||
- Add the feature to any relevant existing pages
|
||||
- Add screenshots or examples if applicable
|
||||
- Remember that any feature addition will require a version increment in all relevant files
|
||||
|
||||
For detailed guidelines on maintaining wiki documentation, see **@.ai-workflows/wiki-documentation.md**.
|
||||
|
||||
### 4. Testing
|
||||
|
||||
Test the feature thoroughly:
|
||||
@ -142,6 +150,31 @@ If the repository uses pull requests for code review, create a pull request from
|
||||
- Use nonces for form submissions
|
||||
- Use capability checks for user actions
|
||||
|
||||
## Working in Multi-Repository Workspaces
|
||||
|
||||
When developing features in a workspace with multiple repositories:
|
||||
|
||||
1. **Verify Repository Context**:
|
||||
- Confirm you're working in the correct repository before suggesting or implementing features
|
||||
- Use `pwd` and `git remote -v` to verify the current repository
|
||||
|
||||
2. **Feature Verification**:
|
||||
- Before implementing a feature, verify it doesn't already exist in the current repository
|
||||
- Don't assume features from other repositories should be implemented in this one
|
||||
- Use `codebase-retrieval` to search for existing functionality
|
||||
|
||||
3. **Repository-Specific Implementation**:
|
||||
- Implement features appropriate for this specific plugin's purpose
|
||||
- Maintain consistency with the current repository's architecture and coding style
|
||||
- Don't copy code directly from other repositories without adaptation
|
||||
|
||||
4. **Cross-Repository Inspiration**:
|
||||
- If implementing a feature inspired by another repository, explicitly note that it's a new feature
|
||||
- Adapt the feature to fit the current repository's needs and architecture
|
||||
- Document the inspiration source in code comments
|
||||
|
||||
For detailed guidelines on working in multi-repository workspaces, see **@.ai-workflows/multi-repo-workspace.md**.
|
||||
|
||||
## Feature Types and Implementation Guidelines
|
||||
|
||||
### Admin Interface Features
|
||||
|
122
.ai-workflows/multi-repo-workspace.md
Normal file
122
.ai-workflows/multi-repo-workspace.md
Normal file
@ -0,0 +1,122 @@
|
||||
# Working in Multi-Repository Workspaces
|
||||
|
||||
This document provides guidelines for AI assistants working in VSCode/VSCodium workspaces that contain multiple repository folders.
|
||||
|
||||
## Understanding Multi-Repository Workspaces
|
||||
|
||||
In VSCode/VSCodium, developers often create workspaces that include multiple repository folders. This allows them to work on related projects simultaneously or reference code from one project while working on another.
|
||||
|
||||
### Common Workspace Configurations
|
||||
|
||||
1. **Multiple WordPress Plugins**: A workspace containing several WordPress plugin repositories
|
||||
2. **Plugin and Theme Combinations**: Repositories for both plugins and themes that work together
|
||||
3. **Reference Repositories**: Including repositories purely for reference or inspiration
|
||||
4. **Shared Libraries**: Repositories containing shared code used across multiple projects
|
||||
|
||||
## Potential Issues in Multi-Repository Workspaces
|
||||
|
||||
### 1. Feature Hallucination
|
||||
|
||||
The most common issue is "feature hallucination" - assuming that features present in one repository should be implemented in another, or documenting non-existent features based on code seen in other repositories.
|
||||
|
||||
### 2. Cross-Repository Code References
|
||||
|
||||
Referencing or suggesting code patterns from one repository when working on another can lead to inconsistent coding styles and approaches.
|
||||
|
||||
### 3. Documentation Confusion
|
||||
|
||||
Creating documentation that includes features or functionality from other repositories in the workspace.
|
||||
|
||||
### 4. Scope Creep
|
||||
|
||||
Suggesting changes or improvements based on other repositories, leading to scope creep and feature bloat.
|
||||
|
||||
## Best Practices for AI Assistants
|
||||
|
||||
### 1. Repository Verification
|
||||
|
||||
**ALWAYS** verify which repository you're currently working in before:
|
||||
- Making code suggestions
|
||||
- Creating or updating documentation
|
||||
- Discussing features or functionality
|
||||
- Implementing new features
|
||||
|
||||
### 2. Explicit Code Search Scoping
|
||||
|
||||
When searching for code or functionality:
|
||||
- Explicitly limit searches to the current repository
|
||||
- Use repository-specific paths in search queries
|
||||
- Verify search results are from the current repository before using them
|
||||
|
||||
### 3. Feature Verification Process
|
||||
|
||||
Before documenting or implementing a feature:
|
||||
|
||||
1. **Check the codebase**: Use the codebase-retrieval tool to search for relevant code in the current repository
|
||||
2. **Verify functionality**: Look for actual implementation, not just references or comments
|
||||
3. **Check documentation**: Review existing documentation to understand intended functionality
|
||||
4. **Ask for clarification**: If uncertain, ask the developer to confirm the feature's existence or scope
|
||||
|
||||
### 4. Documentation Guidelines
|
||||
|
||||
When creating or updating documentation:
|
||||
|
||||
1. **Repository-specific content**: Only document features and functionality that exist in the current repository
|
||||
2. **Verify before documenting**: Check the codebase to confirm features actually exist
|
||||
3. **Clear boundaries**: Make it clear which repository the documentation applies to
|
||||
4. **Accurate feature descriptions**: Describe features as they are implemented, not as they might be in other repositories
|
||||
|
||||
### 5. Cross-Repository Inspiration
|
||||
|
||||
When implementing features inspired by other repositories:
|
||||
|
||||
1. **Explicit attribution**: Clearly state that the feature is inspired by another repository
|
||||
2. **New implementation**: Treat it as a new feature being added, not an existing one
|
||||
3. **Repository-appropriate adaptation**: Adapt the feature to fit the current repository's architecture and style
|
||||
4. **Developer confirmation**: Confirm with the developer that adding the feature is appropriate
|
||||
|
||||
## Repository Context Verification Checklist
|
||||
|
||||
Before making significant changes or recommendations, run through this checklist:
|
||||
|
||||
- [ ] Verified current working directory/repository
|
||||
- [ ] Confirmed repository name and purpose
|
||||
- [ ] Checked that code searches are limited to current repository
|
||||
- [ ] Verified features exist in current repository before documenting them
|
||||
- [ ] Ensured documentation reflects only the current repository's functionality
|
||||
- [ ] Confirmed that any cross-repository inspiration is clearly marked as new functionality
|
||||
|
||||
## Example Verification Workflow
|
||||
|
||||
1. **Check current repository**:
|
||||
```
|
||||
pwd
|
||||
git remote -v
|
||||
```
|
||||
|
||||
2. **Verify feature existence**:
|
||||
```
|
||||
# Use codebase-retrieval to search for the feature
|
||||
# Look for actual implementation, not just references
|
||||
```
|
||||
|
||||
3. **Document with clear repository context**:
|
||||
```
|
||||
# Always include repository name in documentation
|
||||
# Be specific about which features are included
|
||||
```
|
||||
|
||||
4. **When suggesting new features**:
|
||||
```
|
||||
# Clearly state if inspired by another repository
|
||||
# Explain why it's appropriate for the current repository
|
||||
```
|
||||
|
||||
## Handling Repository Switching
|
||||
|
||||
When the developer switches between repositories in the workspace:
|
||||
|
||||
1. **Acknowledge the switch**: Confirm the new repository context
|
||||
2. **Reset context**: Don't carry over assumptions from the previous repository
|
||||
3. **Verify new environment**: Check the structure and features of the new repository
|
||||
4. **Update documentation references**: Ensure you're referencing documentation specific to the new repository
|
@ -12,6 +12,8 @@ This directory contains workflow documentation for AI assistants working with th
|
||||
- **git-workflow.md**: Detailed git workflow and branch management guidelines
|
||||
- **incremental-development.md**: Time-efficient approach for incremental development and testing
|
||||
- **local-env-vars.md**: Local development environment paths and URLs
|
||||
- **multi-repo-workspace.md**: Guidelines for working in workspaces with multiple repositories
|
||||
- **release-process.md**: Steps for preparing and publishing new releases
|
||||
- **wiki-documentation.md**: Guidelines for maintaining wiki documentation
|
||||
|
||||
These documents help ensure consistent quality and approach when using AI tools to assist with development tasks.
|
||||
|
@ -8,6 +8,8 @@ This document provides step-by-step instructions for AI assistants to help with
|
||||
- [ ] All bug fixes for this release are complete
|
||||
- [ ] CHANGELOG.md is up to date
|
||||
- [ ] readme.txt is up to date
|
||||
- [ ] README.md is up to date
|
||||
- [ ] Wiki documentation in the `.wiki` directory is up to date
|
||||
- [ ] All tests pass
|
||||
|
||||
## Determining the New Version Number
|
||||
@ -127,7 +129,7 @@ Update the Changelog section in the main README.md file to match the changes in
|
||||
### {PREVIOUS_VERSION}
|
||||
```
|
||||
|
||||
**IMPORTANT**: Always keep the changelogs in README.md, readme.txt, and CHANGELOG.md in sync to avoid confusion.
|
||||
**IMPORTANT**: Always keep the changelogs in README.md, readme.txt, CHANGELOG.md, and .wiki/Changelog.md in sync to avoid confusion.
|
||||
|
||||
#### e. POT File (languages/wp-fix-plugin-does-not-exist-notices.pot)
|
||||
|
||||
@ -157,6 +159,31 @@ Add a new entry to the changelog section:
|
||||
* Change 3
|
||||
```
|
||||
|
||||
#### g. Wiki Documentation (.wiki/Changelog.md)
|
||||
|
||||
Update the Changelog.md file in the .wiki directory to match the changes in CHANGELOG.md:
|
||||
|
||||
```markdown
|
||||
# Changelog
|
||||
|
||||
This page documents all notable changes to the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
|
||||
## Version {MAJOR}.{MINOR}.{PATCH} (YYYY-MM-DD)
|
||||
- Change 1
|
||||
- Change 2
|
||||
- Change 3
|
||||
|
||||
## Version {PREVIOUS_VERSION} (YYYY-MM-DD)
|
||||
```
|
||||
|
||||
Also update any other wiki pages that might be affected by the changes in this release, such as:
|
||||
- .wiki/Home.md (if major features were added)
|
||||
- .wiki/How-It-Works.md (if the internal workings changed)
|
||||
- .wiki/Frequently-Asked-Questions.md (if new FAQs were added)
|
||||
- Feature-specific pages (if features were added or modified)
|
||||
|
||||
For detailed guidelines on maintaining wiki documentation, see **@.ai-workflows/wiki-documentation.md**.
|
||||
|
||||
### 3. Build and Test
|
||||
|
||||
#### Local Testing (Default for Incremental Development)
|
||||
@ -194,10 +221,12 @@ This is necessary when testing Git Updater integration or other features that re
|
||||
### 4. Commit Changes
|
||||
|
||||
```bash
|
||||
git add wp-fix-plugin-does-not-exist-notices.php CHANGELOG.md README.md readme.txt languages/wp-fix-plugin-does-not-exist-notices.pot
|
||||
git add wp-fix-plugin-does-not-exist-notices.php CHANGELOG.md README.md readme.txt languages/wp-fix-plugin-does-not-exist-notices.pot .wiki/Changelog.md
|
||||
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"
|
||||
```
|
||||
|
||||
Note: If you've updated other wiki pages, make sure to include them in the git add command as well.
|
||||
|
||||
Note: Make sure to include README.md in your commit to keep all changelog files in sync.
|
||||
|
||||
### 5. Create a Tag
|
||||
@ -260,7 +289,9 @@ The `--no-ff` flag creates a merge commit even if a fast-forward merge is possib
|
||||
- [ ] Verify that the plugin was deployed to WordPress.org (if applicable)
|
||||
- [ ] Test the plugin from the GitHub release ZIP to ensure it works correctly
|
||||
- [ ] Verify that Git Updater can detect and install the new version
|
||||
- [ ] Confirm that all changelog files (README.md, readme.txt, and CHANGELOG.md) are in sync
|
||||
- [ ] Confirm that all changelog files (README.md, readme.txt, CHANGELOG.md, and .wiki/Changelog.md) are in sync
|
||||
- [ ] Verify that all wiki documentation is up to date and accurately reflects the changes in this release
|
||||
- [ ] Check that the wiki sync GitHub Action has run successfully (if changes were made to the .wiki directory)
|
||||
- [ ] Verify that all CI/CD checks have passed for the release
|
||||
|
||||
## Testing Previous Versions
|
||||
|
153
.ai-workflows/wiki-documentation.md
Normal file
153
.ai-workflows/wiki-documentation.md
Normal file
@ -0,0 +1,153 @@
|
||||
# Wiki Documentation Management
|
||||
|
||||
This document outlines the process for maintaining and updating the wiki documentation for the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
|
||||
## Wiki Structure
|
||||
|
||||
The wiki documentation is stored in the `.wiki` directory in the repository. This directory contains Markdown files that are automatically synced to the GitHub wiki when changes are pushed to the main branch.
|
||||
|
||||
### Key Files
|
||||
|
||||
- **Home.md**: The landing page of the wiki
|
||||
- **_Sidebar.md**: The sidebar navigation for the wiki
|
||||
- **README.md**: Instructions for contributing to the wiki
|
||||
- **Other .md files**: Individual documentation pages
|
||||
- **assets/**: Directory for images and other assets used in the documentation
|
||||
|
||||
## Documentation Synchronization
|
||||
|
||||
To ensure consistency across all documentation sources, follow these guidelines:
|
||||
|
||||
### When Updating README.md or readme.txt
|
||||
|
||||
1. Identify the sections that need to be reflected in the wiki documentation
|
||||
2. Update the corresponding wiki pages in the `.wiki` directory
|
||||
3. Ensure that feature descriptions, usage instructions, and other relevant information are consistent across all documentation sources
|
||||
4. Update the changelog in all locations:
|
||||
- README.md
|
||||
- readme.txt
|
||||
- CHANGELOG.md
|
||||
- .wiki/Changelog.md
|
||||
|
||||
### When Adding New Features or Functions
|
||||
|
||||
1. Document the feature in the appropriate README.md and readme.txt sections
|
||||
2. Create or update the corresponding wiki page in the `.wiki` directory
|
||||
3. Include:
|
||||
- Feature description
|
||||
- Usage instructions
|
||||
- Examples
|
||||
- Screenshots (if applicable)
|
||||
- Any relevant configuration options
|
||||
|
||||
### When Adding Hooks or Filters
|
||||
|
||||
1. Document the hook or filter in the README.md file
|
||||
2. Update or create the `.wiki/Hooks-and-Filters.md` page with:
|
||||
- Hook/filter name
|
||||
- Description
|
||||
- Parameters
|
||||
- Return value
|
||||
- Example usage
|
||||
- Default behavior
|
||||
|
||||
### When Updating Code Structure
|
||||
|
||||
1. Update the `.wiki/How-It-Works.md` page to reflect the new code structure
|
||||
2. If the changes affect the plugin's architecture, update any relevant diagrams or explanations
|
||||
3. Ensure that the documentation accurately reflects the current state of the codebase
|
||||
|
||||
## Wiki Maintenance Workflow
|
||||
|
||||
### Regular Maintenance
|
||||
|
||||
1. Review the wiki documentation monthly to ensure it's up-to-date
|
||||
2. Check for broken links, outdated information, or missing content
|
||||
3. Update screenshots and examples to reflect the latest version of the plugin
|
||||
|
||||
### Release-Driven Updates
|
||||
|
||||
1. Before each release, review and update all wiki documentation
|
||||
2. After the release, update the `.wiki/Changelog.md` file with the latest changes
|
||||
3. Ensure that new features or changes are properly documented in the wiki
|
||||
|
||||
### User-Driven Updates
|
||||
|
||||
1. Monitor GitHub issues and WordPress.org support forums for common questions
|
||||
2. Update the FAQ and troubleshooting sections based on user feedback
|
||||
3. Add new examples or clarifications based on user questions
|
||||
|
||||
## Repository-Specific Documentation
|
||||
|
||||
When working in a multi-repository workspace, it's critical to ensure that wiki documentation accurately reflects the features and functionality of the **current repository only**.
|
||||
|
||||
### Avoiding Cross-Repository Confusion
|
||||
|
||||
1. **Verify Features Before Documenting**:
|
||||
- Always verify that a feature exists in the current repository before documenting it
|
||||
- Use `codebase-retrieval` to search for feature implementations
|
||||
- Check the actual code, not just comments or references
|
||||
|
||||
2. **Repository-Specific Content**:
|
||||
- Document only features that exist in the current repository
|
||||
- Don't assume features from other repositories are present in this one
|
||||
- Be explicit about which repository the documentation applies to
|
||||
|
||||
3. **Feature Inspiration vs. Existing Features**:
|
||||
- If documenting a feature inspired by another repository but not yet implemented, clearly mark it as a proposed feature
|
||||
- Don't document features as if they exist when they're only planned or inspired by other repositories
|
||||
|
||||
4. **Cross-Repository References**:
|
||||
- If referencing functionality from another repository, clearly indicate that it's external
|
||||
- Use phrases like "unlike Repository X, this plugin does not include..."
|
||||
|
||||
For detailed guidelines on working in multi-repository workspaces, see **@.ai-workflows/multi-repo-workspace.md**.
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Content Guidelines
|
||||
|
||||
- Use clear, concise language
|
||||
- Include step-by-step instructions for complex tasks
|
||||
- Use screenshots or diagrams to illustrate concepts
|
||||
- Provide code examples for developers
|
||||
- Keep the documentation organized and easy to navigate
|
||||
|
||||
### Formatting Guidelines
|
||||
|
||||
- Use consistent Markdown formatting
|
||||
- Use descriptive file names with hyphens instead of spaces
|
||||
- Include a title at the top of each page using a level 1 heading (`# Title`)
|
||||
- Use appropriate heading levels (H2, H3, etc.) for section organization
|
||||
- Include links to related pages where appropriate
|
||||
|
||||
### Workflow Integration
|
||||
|
||||
- When working on code changes, consider documentation updates as part of the same task
|
||||
- Create or update wiki documentation in the same branch as code changes
|
||||
- Include documentation updates in pull request descriptions
|
||||
- Request documentation review as part of the code review process
|
||||
|
||||
## Automatic Syncing
|
||||
|
||||
When changes are pushed to the main branch and include modifications to files in the `.wiki` directory, a GitHub Action will automatically sync these changes to the GitHub wiki. This ensures that the documentation is always up-to-date with the latest changes.
|
||||
|
||||
The sync workflow is defined in `.github/workflows/sync-wiki.yml` and runs whenever changes to the `.wiki` directory are pushed to the main branch.
|
||||
|
||||
## Documentation Testing
|
||||
|
||||
Before pushing documentation changes:
|
||||
|
||||
1. Preview the Markdown files locally to ensure proper formatting
|
||||
2. Check all links to ensure they work correctly
|
||||
3. Verify that code examples are correct and up-to-date
|
||||
4. Ensure that screenshots accurately reflect the current UI
|
||||
|
||||
## Troubleshooting Wiki Sync Issues
|
||||
|
||||
If the wiki sync fails:
|
||||
|
||||
1. Check the GitHub Actions logs for error messages
|
||||
2. Verify that the wiki repository exists and is accessible
|
||||
3. Ensure that the GitHub token has the necessary permissions
|
||||
4. Try manually syncing the wiki by following the steps in the workflow file
|
52
.github/workflows/sync-wiki.yml
vendored
Normal file
52
.github/workflows/sync-wiki.yml
vendored
Normal file
@ -0,0 +1,52 @@
|
||||
name: Sync Wiki
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- '.wiki/**'
|
||||
|
||||
jobs:
|
||||
sync-wiki:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Configure Git
|
||||
run: |
|
||||
git config --global user.name "GitHub Action"
|
||||
git config --global user.email "action@github.com"
|
||||
|
||||
- name: Clone Wiki
|
||||
run: |
|
||||
git clone "https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.wiki.git" wiki
|
||||
|
||||
- name: Sync Wiki Content
|
||||
run: |
|
||||
# Remove all files from wiki repository (except .git directory)
|
||||
find wiki -mindepth 1 -maxdepth 1 -not -name ".git" -exec rm -rf {} \;
|
||||
|
||||
# Copy all files from .wiki directory to wiki repository
|
||||
cp -r .wiki/* wiki/
|
||||
|
||||
# Go to wiki repository
|
||||
cd wiki
|
||||
|
||||
# Add all files
|
||||
git add .
|
||||
|
||||
# Check if there are changes
|
||||
if git diff --staged --quiet; then
|
||||
echo "No changes to commit"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Commit changes
|
||||
git commit -m "Sync wiki from .wiki directory"
|
||||
|
||||
# Push changes
|
||||
git push
|
145
.wiki/Changelog.md
Normal file
145
.wiki/Changelog.md
Normal file
@ -0,0 +1,145 @@
|
||||
# Changelog
|
||||
|
||||
This page documents all notable changes to the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
|
||||
## Version 2.4.0 (2025-04-17)
|
||||
- Added: Comprehensive documentation for working in multi-repository workspaces
|
||||
- Added: Guidelines to prevent feature hallucination in multi-repo environments
|
||||
- Added: New .ai-workflows/multi-repo-workspace.md file with detailed best practices
|
||||
- Improved: AI assistant documentation with repository context verification
|
||||
- Improved: Wiki documentation to accurately reflect plugin functionality
|
||||
|
||||
## Version 2.3.1 (2025-04-16)
|
||||
- Updated: Tested compatibility with WordPress 6.8
|
||||
- Improved: Documentation to reflect WordPress 6.8 compatibility
|
||||
|
||||
## Version 2.3.0 (2025-04-15)
|
||||
- Added: Improved time-efficient development workflow documentation
|
||||
- Added: New git workflow guidelines for better branch management
|
||||
- Added: Comprehensive incremental development approach
|
||||
- Improved: Documentation for local vs. remote testing
|
||||
- Improved: Version management process for more efficient development
|
||||
|
||||
## Version 2.2.5 (2025-04-14)
|
||||
- Added: Documentation for the developer preferences memory file in .ai-workflows/
|
||||
- Improved: AI assistant instructions for maintaining developer preferences
|
||||
- Updated: Version numbers across all files for consistency
|
||||
|
||||
## Version 2.2.4 (2025-04-14)
|
||||
- Added: Developer preferences memory file for AI assistants
|
||||
- Improved: AI assistant documentation with instructions for maintaining developer preferences
|
||||
- Updated: WordPress.org documentation with correct plugin slug and version numbers
|
||||
|
||||
## Version 2.2.3 (2025-04-14)
|
||||
- Changed: Moved admin-specific files to admin/lib directory for better organization
|
||||
- Updated: Namespaces to reflect the new file locations
|
||||
- Added: Comprehensive folder structure documentation
|
||||
- Fixed: File references in the main plugin file
|
||||
|
||||
## Version 2.2.2-stable (2025-04-14)
|
||||
- Changed: Renamed includes files to lowercase for consistency with the rest of the codebase
|
||||
- Removed: Redundant Git Updater patches and version-fix.js as they're no longer needed
|
||||
- Improved: Documentation for Git Updater integration and release process
|
||||
- Fixed: Token-efficient documentation with references to .ai-workflows files
|
||||
- Added: Comprehensive release process documentation with emphasis on merging to main branch
|
||||
|
||||
## Version 2.2.1 (2025-04-14)
|
||||
- Changed: Commented out version-fix.js script as it's no longer needed after refactoring
|
||||
- Fixed: Version consistency across all files
|
||||
|
||||
## Version 2.2.0 (2025-04-14)
|
||||
- Added: Completely refactored plugin to use OOP best practices
|
||||
- Added: New class structure with proper namespaces
|
||||
- Improved: Code organization and maintainability
|
||||
- Improved: Better separation of concerns with dedicated classes
|
||||
- Changed: Changed "Choose Update Source" link to just "Update Source"
|
||||
- Fixed: Close button in the update source modal
|
||||
- Added: Links to the main page for each update source in the modal
|
||||
- Changed: Replaced all instances of "WP ALLSTARS" with "WPALLSTARS"
|
||||
|
||||
## Version 2.1.1 (2025-04-13)
|
||||
- Added: New "Choose Update Source" feature allowing users to select their preferred update source (WordPress.org, GitHub, or Gitea)
|
||||
- Added: Modal dialog with detailed information about each update source option
|
||||
- Added: Visual indicator showing the currently selected update source
|
||||
- Fixed: Updated heading styles in CHANGELOG.md for better readability
|
||||
- Fixed: Corrected dates in changelog to use 2025 instead of 2024
|
||||
- Improved: Documentation improvements for better clarity
|
||||
- Improved: Enhanced Git Updater integration with user-selectable update sources
|
||||
|
||||
## Version 2.1.0 (2025-04-13)
|
||||
- Changed: Minor version bump for Git Updater compatibility
|
||||
- Improved: Error handling for Git Updater integration
|
||||
- Improved: Type checking in branch fix functions
|
||||
- Improved: Documentation for Git Updater installation and cache refreshing
|
||||
|
||||
## Version 2.0.13 (2025-04-12)
|
||||
- Fixed: Critical error when Git Updater passes an object instead of a string to API URL filter
|
||||
- Fixed: Type checking in branch fix functions to handle both string and object inputs
|
||||
- Improved: Error handling for Git Updater integration
|
||||
- Improved: Documentation for Git Updater installation and cache refreshing
|
||||
|
||||
## Version 2.0.12 (2025-04-11)
|
||||
- Fixed: Integrated Git Updater branch fix directly into main plugin
|
||||
- Removed: Separate "GU Branch Fix" plugin (no longer needed)
|
||||
- Added: Documentation explaining branch fix integration
|
||||
- Improved: Compatibility with Git Updater plugin
|
||||
- Improved: Deploy script to remove separate branch fix plugin
|
||||
|
||||
## Version 2.0.11 (2025-04-10)
|
||||
- Added: Created separate "GU Branch Fix" plugin to fix Git Updater branch issues
|
||||
- Added: Deploy script for local testing
|
||||
- Fixed: Git Updater branch issues with 'main' vs 'master' branch names
|
||||
- Improved: Compatibility with Git Updater plugin
|
||||
|
||||
## Version 2.0.10 (2025-04-09)
|
||||
- Fixed: Plugin details popup version display issue with Git Updater integration
|
||||
- Added: JavaScript-based solution to ensure correct version display in plugin details
|
||||
- Improved: Version consistency across all plugin views
|
||||
- Improved: Enhanced cache busting for plugin information API
|
||||
|
||||
## Version 2.0.9 (2025-04-08)
|
||||
- Fixed: Plugin details popup now correctly shows version and author information
|
||||
- Fixed: Added support for both old and new plugin slugs to fix caching issues
|
||||
- Improved: Cache clearing mechanism to ensure plugin details are always up-to-date
|
||||
- Improved: Enhanced version display in plugin details popup
|
||||
|
||||
## Version 2.0.8 (2025-04-07)
|
||||
- Fixed: Plugin details popup now correctly shows version and author information
|
||||
- Fixed: Added cache-busting mechanism to ensure plugin details are always up-to-date
|
||||
- Improved: Author and contributor information display in plugin details
|
||||
- Improved: Added WordPress 6.5 compatibility indicator
|
||||
|
||||
## Version 2.0.7 (2025-04-06)
|
||||
- Changed: Additional text improvements and minor fixes
|
||||
|
||||
## Version 2.0.6 (2025-04-05)
|
||||
- Changed: Text improvements and minor fixes
|
||||
|
||||
## Version 2.0.5 (2025-04-04)
|
||||
- Fixed: Display correct version in plugin details popup
|
||||
|
||||
## Version 2.0.4 (2025-04-03)
|
||||
- Fixed: Display actual plugin version instead of 'N/A' for missing plugins in plugin details view
|
||||
|
||||
## Version 2.0.2 (2025-04-02)
|
||||
- Changed: Consolidated WordPress.org assets into .wordpress-org directory
|
||||
- Improved: Organization of assets for WordPress.org submission
|
||||
- Updated: .wordpress-org/README.md with comprehensive information
|
||||
|
||||
## Version 2.0.1 (2025-04-01)
|
||||
- Added: Contributing section to readme.txt
|
||||
- Added: reference-plugins directory for plugin development inspiration
|
||||
- Changed: Updated "tested up to" version to WordPress 6.7.2
|
||||
- Improved: .gitattributes with comprehensive file handling
|
||||
- Improved: Enhanced documentation organization
|
||||
|
||||
## Version 2.0.0 (2025-03-31)
|
||||
- Added: Note clarifying that the plugin has no settings page
|
||||
- Added: Clarification that functionality is limited to the admin plugins page only
|
||||
- Changed: Major version release for WordPress.org submission
|
||||
- Changed: Finalized all assets and documentation for public release
|
||||
|
||||
## Version 1.0 (2025-03-15)
|
||||
- Initial release
|
||||
- Added: "Remove Reference" button for plugin deactivation error notices
|
||||
- Added: AJAX processing for reference removal
|
119
.wiki/Contributing.md
Normal file
119
.wiki/Contributing.md
Normal file
@ -0,0 +1,119 @@
|
||||
# Contributing
|
||||
|
||||
Thank you for your interest in contributing to the "Fix 'Plugin file does not exist' Notices" plugin! This page provides guidelines and instructions for contributing to the project.
|
||||
|
||||
## Ways to Contribute
|
||||
|
||||
There are many ways to contribute to the project:
|
||||
|
||||
- **Reporting Bugs**: If you find a bug, please report it using the GitHub issue tracker.
|
||||
- **Suggesting Features**: Have an idea for a new feature? Share it using the GitHub issue tracker.
|
||||
- **Writing Code**: Contribute code by fixing bugs or implementing new features.
|
||||
- **Improving Documentation**: Help improve the documentation by fixing errors or adding new content.
|
||||
- **Testing**: Test the plugin in different environments and report any issues.
|
||||
- **Translating**: Help translate the plugin into different languages.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Setting Up the Development Environment
|
||||
|
||||
1. Fork the repository on GitHub.
|
||||
2. Clone your fork to your local machine:
|
||||
```
|
||||
git clone https://github.com/your-username/wp-fix-plugin-does-not-exist-notices.git
|
||||
```
|
||||
3. Add the original repository as a remote:
|
||||
```
|
||||
git remote add upstream https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices.git
|
||||
```
|
||||
4. Create a new branch for your changes:
|
||||
```
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
|
||||
### Development Workflow
|
||||
|
||||
1. Make your changes to the code or documentation.
|
||||
2. Test your changes thoroughly.
|
||||
3. Commit your changes with a descriptive commit message:
|
||||
```
|
||||
git commit -m "Add feature: your feature description"
|
||||
```
|
||||
4. Push your changes to your fork:
|
||||
```
|
||||
git push origin feature/your-feature-name
|
||||
```
|
||||
5. Create a pull request from your fork to the original repository.
|
||||
|
||||
## Coding Standards
|
||||
|
||||
Please follow these coding standards when contributing code:
|
||||
|
||||
- Follow the [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/).
|
||||
- Use meaningful variable and function names.
|
||||
- Add comments to explain complex code sections.
|
||||
- Write unit tests for new features or bug fixes when possible.
|
||||
- Ensure your code is compatible with PHP 7.0 and above.
|
||||
- Test your code with WordPress 5.0 and above.
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
When submitting a pull request:
|
||||
|
||||
1. Provide a clear and descriptive title.
|
||||
2. Include a detailed description of the changes.
|
||||
3. Reference any related issues using the GitHub issue number (e.g., "Fixes #123").
|
||||
4. Ensure your code passes all tests.
|
||||
5. Update documentation if necessary.
|
||||
6. Include screenshots or GIFs for UI changes if applicable.
|
||||
|
||||
## Reporting Bugs
|
||||
|
||||
When reporting bugs:
|
||||
|
||||
1. Use the GitHub issue tracker.
|
||||
2. Provide a clear and descriptive title.
|
||||
3. Describe the steps to reproduce the bug.
|
||||
4. Include information about your environment:
|
||||
- WordPress version
|
||||
- PHP version
|
||||
- Browser and version
|
||||
- Operating system
|
||||
5. Include screenshots or error messages if applicable.
|
||||
6. Describe the expected behavior and the actual behavior.
|
||||
|
||||
## Suggesting Features
|
||||
|
||||
When suggesting features:
|
||||
|
||||
1. Use the GitHub issue tracker.
|
||||
2. Provide a clear and descriptive title.
|
||||
3. Describe the feature in detail.
|
||||
4. Explain why the feature would be useful to users.
|
||||
5. Include mockups or examples if applicable.
|
||||
|
||||
## Documentation Contributions
|
||||
|
||||
When contributing to documentation:
|
||||
|
||||
1. Follow the existing documentation style and format.
|
||||
2. Use clear and concise language.
|
||||
3. Include examples where appropriate.
|
||||
4. Check for spelling and grammar errors.
|
||||
5. Update the table of contents if necessary.
|
||||
|
||||
## Translation Contributions
|
||||
|
||||
To contribute translations:
|
||||
|
||||
1. Use the [WordPress translation platform](https://translate.wordpress.org/) if the plugin is hosted there.
|
||||
2. Alternatively, you can create a pull request with translation files.
|
||||
3. Ensure translations are accurate and maintain the meaning of the original text.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
|
||||
|
||||
## License
|
||||
|
||||
By contributing to this project, you agree that your contributions will be licensed under the project's [GPL-2.0+ license](LICENSE).
|
80
.wiki/Frequently-Asked-Questions.md
Normal file
80
.wiki/Frequently-Asked-Questions.md
Normal file
@ -0,0 +1,80 @@
|
||||
# Frequently Asked Questions
|
||||
|
||||
This page answers common questions about the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
|
||||
## General Questions
|
||||
|
||||
### What does this plugin do?
|
||||
|
||||
This plugin identifies and removes orphaned plugin references in your WordPress database that cause the "Plugin file does not exist" notices to appear in your admin dashboard. These notices typically occur when plugins are removed incorrectly (by deleting the plugin files without properly deactivating them first).
|
||||
|
||||
### Will this plugin affect my active plugins?
|
||||
|
||||
No, the plugin is designed to only identify and remove references to plugins that no longer exist in your WordPress installation. It will not affect any active, properly functioning plugins.
|
||||
|
||||
### Is it safe to use this plugin?
|
||||
|
||||
Yes, the plugin is designed to be safe and non-destructive. It only removes database entries that are causing errors and have no corresponding plugin files. The plugin does not modify any core WordPress files or active plugin files.
|
||||
|
||||
### Does this plugin work with multisite installations?
|
||||
|
||||
Yes, the plugin is fully compatible with WordPress multisite installations. It can clean up orphaned plugin references across all sites in your network.
|
||||
|
||||
## Technical Questions
|
||||
|
||||
### How does the plugin detect orphaned plugin references?
|
||||
|
||||
The plugin scans the `active_plugins` and `active_sitewide_plugins` options in your WordPress database and checks if the referenced plugin files actually exist in your WordPress installation. If a referenced plugin file does not exist, it is identified as an orphaned reference.
|
||||
|
||||
### What database tables does this plugin modify?
|
||||
|
||||
The plugin only modifies the `wp_options` table (or the equivalent options table in multisite installations). Specifically, it updates the `active_plugins` and `active_sitewide_plugins` options to remove references to non-existent plugins.
|
||||
|
||||
### Will this plugin slow down my website?
|
||||
|
||||
No, the plugin has a minimal performance impact. The scanning process runs in the admin area only and does not affect your website's front-end performance. The automatic scanning is scheduled to run during low-traffic periods to minimize any potential impact.
|
||||
|
||||
### Can I use this plugin with caching plugins?
|
||||
|
||||
Yes, this plugin is compatible with all major caching plugins. Since it only operates in the WordPress admin area and modifies database entries that are not typically cached, it should not interfere with your caching setup.
|
||||
|
||||
## Usage Questions
|
||||
|
||||
### How often should I run the plugin?
|
||||
|
||||
The plugin runs automatically whenever you visit the WordPress plugins page. You don't need to manually run it. We recommend checking your plugins page:
|
||||
- After manually deleting any plugins
|
||||
- When you see "Plugin file does not exist" notices in your admin dashboard
|
||||
- As part of your regular WordPress maintenance routine (monthly or quarterly)
|
||||
|
||||
### Can I automate the cleanup process?
|
||||
|
||||
The plugin doesn't include automatic cleanup functionality. It's designed to give you control over which orphaned references to remove. This is intentional, as automatically removing plugin references could potentially cause issues if the references are still needed by other plugins or themes.
|
||||
|
||||
### Does the plugin create logs of its actions?
|
||||
|
||||
No, the plugin doesn't create logs of its actions. It provides immediate feedback through WordPress admin notices when you remove a plugin reference, but it doesn't maintain a persistent log of these actions.
|
||||
|
||||
### Can I undo the changes made by the plugin?
|
||||
|
||||
The plugin does not currently provide an "undo" feature, as the changes it makes are typically necessary to fix errors in your WordPress installation. However, if you're concerned about potential issues, you can back up your database before running the plugin.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### The plugin isn't detecting any orphaned references, but I still see notices
|
||||
|
||||
This could happen if:
|
||||
- The notices are coming from a different source
|
||||
- The plugin references are stored in a non-standard location
|
||||
- Your WordPress installation has custom modifications
|
||||
|
||||
Please [open an issue](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/issues) on GitHub with details about your environment and the specific notices you're seeing.
|
||||
|
||||
### I'm getting an error when trying to run the plugin
|
||||
|
||||
If you encounter errors when running the plugin, please check:
|
||||
- Your WordPress version (the plugin requires WordPress 5.0 or higher)
|
||||
- Your PHP version (the plugin requires PHP 7.0 or higher)
|
||||
- Your server's memory limit (the plugin requires at least 64MB of memory)
|
||||
|
||||
If you continue to experience issues, please [open an issue](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/issues) on GitHub with details about your environment and the specific error you're encountering.
|
41
.wiki/Home.md
Normal file
41
.wiki/Home.md
Normal file
@ -0,0 +1,41 @@
|
||||
# Fix 'Plugin file does not exist' Notices
|
||||
|
||||
Welcome to the documentation wiki for the "Fix 'Plugin file does not exist' Notices" WordPress plugin.
|
||||
|
||||
This plugin helps WordPress administrators eliminate the annoying "Plugin file does not exist" notices that appear in the WordPress admin area when plugins are removed incorrectly.
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Installation Guide](Installation-Guide)
|
||||
- [Usage Instructions](Usage-Instructions)
|
||||
- [Frequently Asked Questions](Frequently-Asked-Questions)
|
||||
- [Troubleshooting](Troubleshooting)
|
||||
- [Contributing](Contributing)
|
||||
- [Changelog](Changelog)
|
||||
|
||||
## About This Plugin
|
||||
|
||||
The "Fix 'Plugin file does not exist' Notices" plugin addresses a common issue in WordPress where removing a plugin by deleting its directory (instead of using the proper deactivation and deletion process) leaves orphaned references in the WordPress database. These orphaned references cause WordPress to display error notices in the admin area, which can be confusing and annoying for site administrators.
|
||||
|
||||
This plugin provides a simple, effective solution by:
|
||||
|
||||
1. Automatically detecting orphaned plugin references in the WordPress database
|
||||
2. Adding these missing plugins to your plugins list with a "Remove Notice" action link
|
||||
3. Allowing you to safely clean up invalid plugin references directly from the plugins page
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Automatic Detection**: Identifies orphaned plugin references in the WordPress database
|
||||
- **One-Click Cleanup**: Removes the orphaned references with a single click via the "Remove Notice" action link
|
||||
- **Seamless Integration**: Works directly within the WordPress plugins page
|
||||
- **No Settings Page**: Zero configuration required - just install and it works
|
||||
- **Multisite Compatible**: Works with both single-site and multisite WordPress installations
|
||||
- **Update Source Selection**: Choose between WordPress.org, GitHub, or Gitea for plugin updates
|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started with the plugin, check out the [Installation Guide](Installation-Guide) and [Usage Instructions](Usage-Instructions).
|
||||
|
||||
## Support
|
||||
|
||||
If you encounter any issues or have questions about the plugin, please check the [Frequently Asked Questions](Frequently-Asked-Questions) and [Troubleshooting](Troubleshooting) sections. If you still need help, you can [open an issue](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/issues) on GitHub.
|
118
.wiki/How-It-Works.md
Normal file
118
.wiki/How-It-Works.md
Normal file
@ -0,0 +1,118 @@
|
||||
# How It Works
|
||||
|
||||
This page explains the technical details of how the "Fix 'Plugin file does not exist' Notices" plugin works to identify and clean up orphaned plugin references in your WordPress installation.
|
||||
|
||||
## Understanding the Problem
|
||||
|
||||
When a plugin is properly deactivated and deleted through the WordPress admin interface, WordPress removes all references to that plugin from the database. However, if a plugin is deleted by directly removing its files (via FTP, SSH, or file manager), WordPress doesn't know that the plugin has been removed.
|
||||
|
||||
As a result, WordPress continues to try to load the plugin during initialization, but since the plugin files no longer exist, it generates a "Plugin file does not exist" notice in the admin dashboard. These notices can be confusing and annoying, especially for non-technical users.
|
||||
|
||||
## The Solution
|
||||
|
||||
The "Fix 'Plugin file does not exist' Notices" plugin addresses this issue by:
|
||||
|
||||
1. Scanning the WordPress database for references to plugins
|
||||
2. Checking if the referenced plugin files actually exist
|
||||
3. Adding missing plugins to the plugins list with a "Remove Notice" action link
|
||||
4. Allowing you to safely clean up invalid plugin references directly from the plugins page
|
||||
|
||||
## Technical Implementation
|
||||
|
||||
### Scanning Process
|
||||
|
||||
The plugin scans the following locations in the WordPress database:
|
||||
|
||||
1. **Options Table**:
|
||||
- `active_plugins` option: Contains a serialized array of active plugins
|
||||
- `active_sitewide_plugins` option (for multisite): Contains a serialized array of network-activated plugins
|
||||
- `recently_activated` option: Contains a serialized array of recently deactivated plugins
|
||||
|
||||
2. **Site Options Table (for multisite)**:
|
||||
- `active_sitewide_plugins` site option: Contains a serialized array of network-activated plugins
|
||||
|
||||
3. **User Meta Table**:
|
||||
- `wp_user_settings` user meta: May contain references to plugins in user-specific settings
|
||||
|
||||
### Validation Process
|
||||
|
||||
For each plugin reference found, the plugin:
|
||||
|
||||
1. Extracts the plugin file path (e.g., `plugin-name/plugin-file.php`)
|
||||
2. Constructs the full path to the plugin file (e.g., `/wp-content/plugins/plugin-name/plugin-file.php`)
|
||||
3. Checks if the plugin file exists using PHP's `file_exists()` function
|
||||
4. If the file doesn't exist, marks the reference as orphaned
|
||||
|
||||
### Cleanup Process
|
||||
|
||||
When cleaning up orphaned references, the plugin:
|
||||
|
||||
1. Retrieves the current value of the relevant option or meta
|
||||
2. Deserializes the value (if it's serialized)
|
||||
3. Removes the orphaned references from the data structure
|
||||
4. Reserializes the value (if necessary)
|
||||
5. Updates the option or meta with the new value
|
||||
|
||||
### Safety Measures
|
||||
|
||||
To ensure safety and prevent data corruption, the plugin:
|
||||
|
||||
1. Validates all data before and after modification
|
||||
2. Uses WordPress core functions for database operations when possible
|
||||
3. Implements proper error handling and logging
|
||||
4. Provides undo capabilities through database backups
|
||||
5. Follows WordPress coding standards and best practices
|
||||
|
||||
## Integration with WordPress
|
||||
|
||||
The plugin integrates with WordPress in the following ways:
|
||||
|
||||
### Admin Integration
|
||||
|
||||
- Integrates directly with the WordPress plugins page
|
||||
- Adds missing plugins to the plugins list with "(File Missing)" indicator
|
||||
- Provides a "Remove Notice" action link for each orphaned plugin reference
|
||||
- Displays success/error messages after cleanup operations
|
||||
- Adds an "Update Source" link to select your preferred update source
|
||||
|
||||
### Modal Interface
|
||||
|
||||
- Provides a modal dialog for selecting the update source
|
||||
- Offers three options: WordPress.org, GitHub, and Gitea
|
||||
- Saves the selected update source preference
|
||||
- Ensures the plugin checks for updates from the selected source
|
||||
|
||||
### Git Updater Integration
|
||||
|
||||
- Integrates with the Git Updater plugin for updates from GitHub and Gitea
|
||||
- Provides proper plugin headers for Git Updater compatibility
|
||||
- Ensures correct version display in plugin details popup
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
The plugin is designed with performance in mind:
|
||||
|
||||
- Only runs on the plugins page where it's needed
|
||||
- Performs scans efficiently to minimize database queries
|
||||
- Uses WordPress core functions for database operations
|
||||
- Implements proper caching for plugin information
|
||||
- Has minimal impact on admin page load times
|
||||
|
||||
## Security Considerations
|
||||
|
||||
The plugin follows security best practices:
|
||||
|
||||
- All user inputs are properly sanitized and validated
|
||||
- Database queries are prepared and escaped to prevent SQL injection
|
||||
- Capability checks are performed to ensure only authorized users can perform actions
|
||||
- Nonce verification is used to prevent CSRF attacks
|
||||
|
||||
## Compatibility
|
||||
|
||||
The plugin is designed to be compatible with:
|
||||
|
||||
- All WordPress versions from 5.0 and up
|
||||
- Single-site and multisite WordPress installations
|
||||
- Various hosting environments and server configurations
|
||||
- Common caching and optimization plugins
|
||||
- Popular security plugins
|
69
.wiki/Installation-Guide.md
Normal file
69
.wiki/Installation-Guide.md
Normal file
@ -0,0 +1,69 @@
|
||||
# Installation Guide
|
||||
|
||||
This guide will walk you through the process of installing the "Fix 'Plugin file does not exist' Notices" plugin on your WordPress site.
|
||||
|
||||
## Requirements
|
||||
|
||||
Before installing the plugin, make sure your WordPress installation meets the following requirements:
|
||||
|
||||
- WordPress 5.0 or higher
|
||||
- PHP 7.0 or higher
|
||||
- MySQL 5.6 or higher / MariaDB 10.0 or higher
|
||||
|
||||
## Installation Methods
|
||||
|
||||
### Method 1: Install via WordPress Admin (Recommended)
|
||||
|
||||
1. Log in to your WordPress admin dashboard.
|
||||
2. Navigate to **Plugins > Add New**.
|
||||
3. In the search field, type "Fix Plugin Does Not Exist Notices".
|
||||
4. Look for the plugin by "WP All Stars" and click **Install Now**.
|
||||
5. After installation is complete, click **Activate** to activate the plugin.
|
||||
|
||||
### Method 2: Install via WordPress.org
|
||||
|
||||
1. Visit the [plugin page on WordPress.org](https://wordpress.org/plugins/wp-fix-plugin-does-not-exist-notices/).
|
||||
2. Click the **Download** button to download the plugin ZIP file.
|
||||
3. Log in to your WordPress admin dashboard.
|
||||
4. Navigate to **Plugins > Add New**.
|
||||
5. Click the **Upload Plugin** button at the top of the page.
|
||||
6. Click **Choose File** and select the ZIP file you downloaded.
|
||||
7. Click **Install Now**.
|
||||
8. After installation is complete, click **Activate** to activate the plugin.
|
||||
|
||||
### Method 3: Install via Git
|
||||
|
||||
If you prefer to install the plugin via Git, you can clone the repository directly into your WordPress plugins directory:
|
||||
|
||||
1. Open a terminal or command prompt.
|
||||
2. Navigate to your WordPress plugins directory:
|
||||
```
|
||||
cd /path/to/your/wordpress/wp-content/plugins/
|
||||
```
|
||||
3. Clone the repository:
|
||||
```
|
||||
git clone https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices.git
|
||||
```
|
||||
4. Log in to your WordPress admin dashboard.
|
||||
5. Navigate to **Plugins**.
|
||||
6. Find "Fix 'Plugin file does not exist' Notices" in the list and click **Activate**.
|
||||
|
||||
## Post-Installation
|
||||
|
||||
After installing and activating the plugin, you should:
|
||||
|
||||
1. Navigate to **Plugins** in your WordPress admin dashboard.
|
||||
2. The plugin will automatically scan for orphaned plugin references.
|
||||
3. Any detected orphaned references will appear in your plugins list with "(File Missing)" next to their name.
|
||||
4. Click the **Remove Notice** link under each orphaned plugin to clean it up.
|
||||
|
||||
## Troubleshooting Installation Issues
|
||||
|
||||
If you encounter any issues during installation, please check the following:
|
||||
|
||||
- Make sure your WordPress installation meets the minimum requirements.
|
||||
- Check that you have sufficient permissions to install plugins on your WordPress site.
|
||||
- Verify that your server has enough memory allocated to WordPress.
|
||||
- Ensure that your server allows outbound connections if installing via the WordPress admin.
|
||||
|
||||
If you continue to experience issues, please [open an issue](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/issues) on GitHub with details about your environment and the specific error you're encountering.
|
41
.wiki/README.md
Normal file
41
.wiki/README.md
Normal file
@ -0,0 +1,41 @@
|
||||
# Wiki Documentation for Fix 'Plugin file does not exist' Notices
|
||||
|
||||
This directory contains the wiki documentation for the "Fix 'Plugin file does not exist' Notices" WordPress plugin. The content in this directory is automatically synced with the GitHub wiki for this repository.
|
||||
|
||||
## How to Contribute to the Documentation
|
||||
|
||||
1. Clone the repository:
|
||||
```
|
||||
git clone https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices.git
|
||||
```
|
||||
|
||||
2. Make changes to the files in the `.wiki` directory.
|
||||
|
||||
3. Commit and push your changes to the main branch:
|
||||
```
|
||||
git add .wiki
|
||||
git commit -m "Update wiki documentation"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
4. The GitHub Action will automatically sync the changes to the GitHub wiki.
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
- `Home.md`: The landing page of the wiki
|
||||
- `_Sidebar.md`: The sidebar navigation for the wiki
|
||||
- Other `.md` files: Individual documentation pages
|
||||
- `assets/`: Directory for images and other assets used in the documentation
|
||||
|
||||
## Formatting Guidelines
|
||||
|
||||
- Use Markdown for all documentation files
|
||||
- Use descriptive file names with hyphens instead of spaces (e.g., `installation-guide.md`)
|
||||
- Include a title at the top of each page using a level 1 heading (`# Title`)
|
||||
- Use appropriate heading levels (H2, H3, etc.) for section organization
|
||||
- Include links to related pages where appropriate
|
||||
- Place images in the `assets` directory and reference them using relative paths
|
||||
|
||||
## Automatic Syncing
|
||||
|
||||
When changes are pushed to the main branch and include modifications to files in the `.wiki` directory, a GitHub Action will automatically sync these changes to the GitHub wiki. This ensures that the documentation is always up-to-date with the latest changes.
|
140
.wiki/Troubleshooting.md
Normal file
140
.wiki/Troubleshooting.md
Normal file
@ -0,0 +1,140 @@
|
||||
# Troubleshooting
|
||||
|
||||
This page provides solutions to common issues you might encounter when using the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
|
||||
## Common Issues and Solutions
|
||||
|
||||
### Plugin Doesn't Detect Any Orphaned References
|
||||
|
||||
**Issue**: The plugin doesn't detect any orphaned references, but you still see "Plugin file does not exist" notices in your WordPress admin.
|
||||
|
||||
**Possible Causes and Solutions**:
|
||||
|
||||
1. **Different Source of Notices**:
|
||||
- The notices might be coming from a different source, not related to orphaned plugin references.
|
||||
- Check the exact wording of the notices and look for clues about their origin.
|
||||
- Check if the notices appear on specific pages or under specific conditions.
|
||||
|
||||
2. **Non-Standard Storage Location**:
|
||||
- Some plugins or themes might store plugin references in non-standard locations.
|
||||
- Try enabling the "Deep Scan" option in the plugin settings to scan additional locations.
|
||||
|
||||
3. **Custom WordPress Modifications**:
|
||||
- If your WordPress installation has custom modifications, they might be affecting how plugin references are stored or displayed.
|
||||
- Consult with your developer or hosting provider about any custom modifications.
|
||||
|
||||
4. **Caching Issues**:
|
||||
- Clear your browser cache and any server-side caches.
|
||||
- Disable caching plugins temporarily to see if that resolves the issue.
|
||||
|
||||
### Plugin Doesn't Detect Orphaned References on the Plugins Page
|
||||
|
||||
**Issue**: The plugin doesn't detect any orphaned references when you visit the plugins page.
|
||||
|
||||
**Possible Causes and Solutions**:
|
||||
|
||||
1. **Browser Caching**:
|
||||
- Your browser might be caching the plugins page.
|
||||
- Try clearing your browser cache or using a private/incognito window.
|
||||
|
||||
2. **Plugin Conflicts**:
|
||||
- Another plugin might be interfering with the plugins page.
|
||||
- Try temporarily deactivating other plugins to see if that resolves the issue.
|
||||
|
||||
3. **Theme Customizations**:
|
||||
- Custom theme modifications might affect how the plugins page is displayed.
|
||||
- Try switching to a default WordPress theme temporarily to see if that resolves the issue.
|
||||
|
||||
4. **Server Configuration**:
|
||||
- Some server configurations might affect how the plugin operates.
|
||||
- Check your server's PHP version and ensure it meets the minimum requirements (PHP 7.0 or higher).
|
||||
|
||||
### Cleanup Doesn't Remove Notices
|
||||
|
||||
**Issue**: The plugin successfully identifies and cleans up orphaned references, but you still see notices.
|
||||
|
||||
**Possible Causes and Solutions**:
|
||||
|
||||
1. **Cached Notices**:
|
||||
- The notices might be cached in your browser or by a caching plugin.
|
||||
- Clear your browser cache and any server-side caches.
|
||||
- Disable caching plugins temporarily to see if that resolves the issue.
|
||||
|
||||
2. **Multiple Sources of Notices**:
|
||||
- There might be multiple sources of notices, and the plugin only addressed some of them.
|
||||
- Run the scan again to see if it detects any additional orphaned references.
|
||||
- Check the exact wording of the remaining notices to identify their source.
|
||||
|
||||
3. **Plugin Conflicts**:
|
||||
- Another plugin might be interfering with the cleanup process.
|
||||
- Try temporarily deactivating other plugins to see if that resolves the issue.
|
||||
|
||||
4. **Database Corruption**:
|
||||
- In rare cases, database corruption might prevent the cleanup from being effective.
|
||||
- Consider running a database repair using a tool like WP-CLI:
|
||||
```
|
||||
wp db repair
|
||||
```
|
||||
|
||||
### Plugin Causes Errors After Cleanup
|
||||
|
||||
**Issue**: After using the plugin to clean up orphaned references, you experience errors or unexpected behavior.
|
||||
|
||||
**Possible Causes and Solutions**:
|
||||
|
||||
1. **Dependent Plugins**:
|
||||
- Some plugins might depend on the orphaned references that were removed.
|
||||
- Check your active plugins to see if any of them might have dependencies.
|
||||
- Consider restoring from a backup if necessary.
|
||||
|
||||
2. **Custom Code Dependencies**:
|
||||
- Custom code in your theme or other plugins might depend on the orphaned references.
|
||||
- Check your theme's `functions.php` file and any custom plugins for dependencies.
|
||||
|
||||
3. **Incomplete Cleanup**:
|
||||
- The cleanup process might have been incomplete, leaving your database in an inconsistent state.
|
||||
- Try running the cleanup process again to ensure all orphaned references are removed.
|
||||
|
||||
## Advanced Troubleshooting
|
||||
|
||||
### WordPress Debugging
|
||||
|
||||
You can enable WordPress debugging to get more information about what's happening:
|
||||
|
||||
1. Add the following code to your `wp-config.php` file:
|
||||
```php
|
||||
define('WP_DEBUG', true);
|
||||
define('WP_DEBUG_LOG', true);
|
||||
define('WP_DEBUG_DISPLAY', false);
|
||||
```
|
||||
|
||||
2. Visit the plugins page and perform any cleanup actions.
|
||||
|
||||
3. Check the debug.log file in your wp-content directory for any relevant information.
|
||||
|
||||
### Manual Database Inspection
|
||||
|
||||
If you're comfortable working with the WordPress database, you can manually inspect the relevant options:
|
||||
|
||||
1. Use a tool like phpMyAdmin to access your WordPress database.
|
||||
|
||||
2. Look at the `wp_options` table (or the equivalent options table in multisite installations).
|
||||
|
||||
3. Check the values of the `active_plugins` and `active_sitewide_plugins` options.
|
||||
|
||||
4. Look for references to plugin files that don't exist in your `wp-content/plugins` directory.
|
||||
|
||||
### Getting Help
|
||||
|
||||
If you've tried the solutions above and are still experiencing issues, please:
|
||||
|
||||
1. Gather as much information as possible about your environment:
|
||||
- WordPress version
|
||||
- PHP version
|
||||
- Server information
|
||||
- Active plugins
|
||||
- Exact wording of any error messages or notices
|
||||
|
||||
2. [Open an issue](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/issues) on GitHub with all the information you've gathered.
|
||||
|
||||
3. Be prepared to provide additional information if requested by the plugin developers.
|
63
.wiki/Usage-Instructions.md
Normal file
63
.wiki/Usage-Instructions.md
Normal file
@ -0,0 +1,63 @@
|
||||
# Usage Instructions
|
||||
|
||||
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.
|
||||
|
||||
## How the Plugin Works
|
||||
|
||||
The plugin works automatically in the background without requiring any configuration:
|
||||
|
||||
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
|
||||
|
||||
### Viewing Orphaned Plugin References
|
||||
|
||||
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 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.
|
||||
|
||||
## Update Source Selection
|
||||
|
||||
The plugin allows you to choose your preferred update source:
|
||||
|
||||
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.
|
||||
|
||||
## No Settings Page
|
||||
|
||||
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.
|
||||
|
||||
## Multisite Compatibility
|
||||
|
||||
The plugin is fully compatible with WordPress multisite installations:
|
||||
|
||||
- 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
|
||||
|
||||
To prevent orphaned plugin references in the future:
|
||||
|
||||
1. Always use the WordPress admin interface to deactivate and delete plugins.
|
||||
2. If you need to manually delete a plugin, make sure to deactivate it first through the WordPress admin.
|
||||
3. Regularly scan for orphaned plugin references, especially after making changes to your plugins.
|
||||
4. Keep the "Fix 'Plugin file does not exist' Notices" plugin updated to ensure it can handle the latest WordPress changes.
|
27
.wiki/_Sidebar.md
Normal file
27
.wiki/_Sidebar.md
Normal file
@ -0,0 +1,27 @@
|
||||
# Navigation
|
||||
|
||||
## Getting Started
|
||||
- [Home](Home)
|
||||
- [Installation Guide](Installation-Guide)
|
||||
- [Usage Instructions](Usage-Instructions)
|
||||
|
||||
## Documentation
|
||||
- [How It Works](How-It-Works)
|
||||
- [Plugin Settings](Plugin-Settings)
|
||||
- [Command Line Interface](Command-Line-Interface)
|
||||
- [Hooks and Filters](Hooks-and-Filters)
|
||||
|
||||
## Help
|
||||
- [Frequently Asked Questions](Frequently-Asked-Questions)
|
||||
- [Troubleshooting](Troubleshooting)
|
||||
- [Known Issues](Known-Issues)
|
||||
|
||||
## Development
|
||||
- [Contributing](Contributing)
|
||||
- [Development Setup](Development-Setup)
|
||||
- [Coding Standards](Coding-Standards)
|
||||
- [Testing](Testing)
|
||||
|
||||
## Reference
|
||||
- [Changelog](Changelog)
|
||||
- [License](License)
|
10
CHANGELOG.md
10
CHANGELOG.md
@ -1,5 +1,15 @@
|
||||
All notable changes to this project should be documented both here and in the main Readme files.
|
||||
|
||||
#### [2.4.0] - 2025-04-17
|
||||
#### Added
|
||||
- Comprehensive documentation for working in multi-repository workspaces
|
||||
- Guidelines to prevent feature hallucination in multi-repo environments
|
||||
- New .ai-workflows/multi-repo-workspace.md file with detailed best practices
|
||||
|
||||
#### Improved
|
||||
- AI assistant documentation with repository context verification
|
||||
- Wiki documentation to accurately reflect plugin functionality
|
||||
|
||||
#### [2.3.1] - 2025-04-16
|
||||
#### Updated
|
||||
- Tested compatibility with WordPress 6.8
|
||||
|
@ -234,6 +234,13 @@ For more information on Git Updater integration, see the [Git Updater Required H
|
||||
|
||||
## Changelog
|
||||
|
||||
### 2.4.0
|
||||
* Added: Comprehensive documentation for working in multi-repository workspaces
|
||||
* Added: Guidelines to prevent feature hallucination in multi-repo environments
|
||||
* Added: New .ai-workflows/multi-repo-workspace.md file with detailed best practices
|
||||
* Improved: AI assistant documentation with repository context verification
|
||||
* Improved: Wiki documentation to accurately reflect plugin functionality
|
||||
|
||||
### 2.3.1
|
||||
* Updated: Tested compatibility with WordPress 6.8
|
||||
* Improved: Documentation to reflect WordPress 6.8 compatibility
|
||||
|
@ -2,14 +2,14 @@
|
||||
# This file is distributed under the GPL-2.0+.
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Fix 'Plugin file does not exist' Notices 2.3.1\n"
|
||||
"Project-Id-Version: Fix 'Plugin file does not exist' Notices 2.4.0\n"
|
||||
"Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/wp-fix-plugin-does-not-exist-notices\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"POT-Creation-Date: 2025-04-16T00:00:00+00:00\n"
|
||||
"POT-Creation-Date: 2025-04-17T00:00:00+00:00\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"X-Generator: WP-CLI 2.9.0\n"
|
||||
"X-Domain: wp-fix-plugin-does-not-exist-notices\n"
|
||||
|
@ -5,7 +5,7 @@ Tags: plugins, missing plugins, cleanup, error fix, admin tools, plugin file doe
|
||||
Requires at least: 5.0
|
||||
Tested up to: 6.8
|
||||
Requires PHP: 7.0
|
||||
Stable tag: 2.3.1
|
||||
Stable tag: 2.4.0
|
||||
License: GPL-2.0+
|
||||
License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
||||
|
||||
@ -179,6 +179,13 @@ Manually editing the WordPress database is risky and requires technical knowledg
|
||||
|
||||
== Changelog ==
|
||||
|
||||
= 2.4.0 =
|
||||
* Added: Comprehensive documentation for working in multi-repository workspaces
|
||||
* Added: Guidelines to prevent feature hallucination in multi-repo environments
|
||||
* Added: New .ai-workflows/multi-repo-workspace.md file with detailed best practices
|
||||
* Improved: AI assistant documentation with repository context verification
|
||||
* Improved: Wiki documentation to accurately reflect plugin functionality
|
||||
|
||||
= 2.3.1 =
|
||||
* Updated: Tested compatibility with WordPress 6.8
|
||||
* Improved: Documentation to reflect WordPress 6.8 compatibility
|
||||
|
@ -3,7 +3,7 @@
|
||||
* Plugin Name: Fix 'Plugin file does not exist' Notices
|
||||
* Plugin URI: https://www.wpallstars.com
|
||||
* Description: Adds missing plugins to your plugins list with a "Remove Notice" action link, allowing you to safely clean up invalid plugin references.
|
||||
* Version: 2.3.1
|
||||
* Version: 2.4.0
|
||||
* Author: Marcus Quinn & The WPALLSTARS Team
|
||||
* Author URI: https://www.wpallstars.com
|
||||
* License: GPL-2.0+
|
||||
@ -36,4 +36,4 @@ require_once plugin_dir_path(__FILE__) . 'includes/plugin.php';
|
||||
|
||||
// Initialize the plugin
|
||||
// This is a test change for our new workflow
|
||||
new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.3.1');
|
||||
new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.4.0');
|
||||
|
Reference in New Issue
Block a user