From 15244dc6876bfacf1b922ebd00e34c3c3ceea504 Mon Sep 17 00:00:00 2001
From: marcusquinn <6428977+marcusquinn@users.noreply.github.com>
Date: Mon, 14 Apr 2025 19:18:05 +0100
Subject: [PATCH 1/8] Refactor plugin to use OOP best practices with proper
namespaces and class structure
---
CHANGELOG.md | 17 +-
README.md | 14 +-
admin/js/update-source-selector.js | 9 +
admin/js/version-fix.js | 2 +-
includes/Admin.php | 92 ++
includes/Core.php | 619 +++++++++++++
includes/Modal.php | 167 ++++
includes/Plugin.php | 293 ++++++
readme.txt | 16 +-
wp-fix-plugin-does-not-exist-notices.php | 1045 +---------------------
10 files changed, 1230 insertions(+), 1044 deletions(-)
create mode 100644 includes/Admin.php
create mode 100644 includes/Core.php
create mode 100644 includes/Modal.php
create mode 100644 includes/Plugin.php
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3deee21..41cc0f0 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,18 @@
All notable changes to this project should be documented both here and in the main Readme files.
+#### [2.2.0] - 2025-04-14
+#### Added
+- Completely refactored plugin to use OOP best practices
+- New class structure with proper namespaces
+- Improved code organization and maintainability
+- 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
+- Replaced all instances of "WP ALLSTARS" with "WPALLSTARS"
+
#### [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)
@@ -241,7 +254,7 @@ All notable changes to this project should be documented both here and in the ma
#### [1.6.12] - 2025-03-14
#### Added
-- Added WP ALLSTARS as a co-author
+- Added WPALLSTARS as a co-author
- Updated author information and links
- Added author websites to plugin description
- Fixed issue with multiple author URLs
@@ -297,7 +310,7 @@ All notable changes to this project should be documented both here and in the ma
- Version management following semantic versioning
#### Changed
-- Updated organization name from 'WP All Stars' to 'WP ALLSTARS'
+- Updated organization name from 'WP All Stars' to 'WPALLSTARS'
- Updated namespace from 'WPAllStars' to 'WPALLSTARS'
#### [1.6.2] - 2025-03-04
diff --git a/README.md b/README.md
index 1cd82e3..d536436 100644
--- a/README.md
+++ b/README.md
@@ -211,6 +211,16 @@ The plugin works by:
## Changelog
+### 2.2.0
+* Added: Completely refactored plugin to use OOP best practices
+* Added: New class structure with proper namespaces
+* Added: Improved code organization and maintainability
+* Added: Better separation of concerns with dedicated classes
+* 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"
+
### 2.1.1
* 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
@@ -385,7 +395,7 @@ The plugin works by:
* Ensured compatibility with WordPress 6.4
### 1.6.12
-* Added WP ALLSTARS as a co-author
+* Added WPALLSTARS as a co-author
* Updated author information and links
* Added author websites to plugin description
* Fixed issue with multiple author URLs
@@ -450,7 +460,7 @@ The plugin works by:
* Fixed Git Updater repository URLs to use full repository paths
* Corrected Update URI configuration for proper update detection
* Improved version management following semantic versioning
-* Updated organization name from 'WP All Stars' to 'WP ALLSTARS'
+* Updated organization name from 'WP All Stars' to 'WPALLSTARS'
* Updated namespace from 'WPAllStars' to 'WPALLSTARS'
### 1.6.2
diff --git a/admin/js/update-source-selector.js b/admin/js/update-source-selector.js
index f3ee1ec..df8d82a 100644
--- a/admin/js/update-source-selector.js
+++ b/admin/js/update-source-selector.js
@@ -56,6 +56,15 @@ jQuery(document).ready(function($) {
// Separate handler for close button to ensure it works
$(document).on('click', '.fpden-close-modal', function(e) {
e.preventDefault();
+ e.stopPropagation(); // Prevent event bubbling
+ $('#fpden-update-source-modal').hide();
+ $('#fpden-modal-overlay').remove();
+ });
+
+ // Direct binding to the close button for extra reliability
+ $('.fpden-close-modal').on('click', function(e) {
+ e.preventDefault();
+ e.stopPropagation(); // Prevent event bubbling
$('#fpden-update-source-modal').hide();
$('#fpden-modal-overlay').remove();
});
diff --git a/admin/js/version-fix.js b/admin/js/version-fix.js
index c1ca8e3..98e7a7e 100644
--- a/admin/js/version-fix.js
+++ b/admin/js/version-fix.js
@@ -8,7 +8,7 @@
'use strict';
// Current plugin version - this should match the version in the main plugin file
- const CURRENT_VERSION = '2.1.1';
+ const CURRENT_VERSION = '2.2.0';
// Plugin slugs to check for
const OUR_SLUGS = ['wp-fix-plugin-does-not-exist-notices', 'fix-plugin-does-not-exist-notices'];
diff --git a/includes/Admin.php b/includes/Admin.php
new file mode 100644
index 0000000..2a5ea56
--- /dev/null
+++ b/includes/Admin.php
@@ -0,0 +1,92 @@
+core = $core;
+
+ // Enqueue admin scripts and styles
+ add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_assets'));
+ }
+
+ /**
+ * Enqueue scripts and styles needed for the admin area.
+ *
+ * @param string $hook_suffix The current admin page hook.
+ * @return void
+ */
+ public function enqueue_admin_assets($hook_suffix) {
+ // Only load on the plugins page
+ if ('plugins.php' !== $hook_suffix) {
+ return;
+ }
+
+ // Always load our version fix script on the plugins page
+ wp_enqueue_script(
+ 'fpden-version-fix',
+ FPDEN_PLUGIN_URL . 'admin/js/version-fix.js',
+ array('jquery', 'thickbox'),
+ FPDEN_VERSION,
+ true // Load in footer
+ );
+
+ // Get invalid plugins to decide if other assets are needed
+ $invalid_plugins = $this->core->get_invalid_plugins();
+ if (empty($invalid_plugins)) {
+ return; // No missing plugins, no need for the special notice JS/CSS
+ }
+
+ wp_enqueue_style(
+ 'fpden-admin-styles',
+ FPDEN_PLUGIN_URL . 'admin/css/admin-styles.css',
+ array(),
+ FPDEN_VERSION
+ );
+
+ wp_enqueue_script(
+ 'fpden-admin-scripts',
+ FPDEN_PLUGIN_URL . 'admin/js/admin-scripts.js',
+ array('jquery'), // Add dependencies if needed, e.g., jQuery
+ FPDEN_VERSION,
+ true // Load in footer
+ );
+
+ // Add translation strings for JavaScript
+ wp_localize_script(
+ 'fpden-admin-scripts',
+ 'fpdenData',
+ array(
+ 'i18n' => array(
+ 'clickToScroll' => esc_html__('Click here to scroll to missing plugins', 'wp-fix-plugin-does-not-exist-notices'),
+ 'pluginMissing' => esc_html__('File Missing', 'wp-fix-plugin-does-not-exist-notices'),
+ 'removeNotice' => esc_html__('Remove Notice', 'wp-fix-plugin-does-not-exist-notices'),
+ ),
+ 'version' => FPDEN_VERSION, // Add version for the plugin details fix script
+ )
+ );
+ }
+}
diff --git a/includes/Core.php b/includes/Core.php
new file mode 100644
index 0000000..6c401f1
--- /dev/null
+++ b/includes/Core.php
@@ -0,0 +1,619 @@
+invalid_plugins)) {
+ return $this->invalid_plugins;
+ }
+
+ // Initialize empty array
+ $invalid_plugins = array();
+
+ // Handle multisite network admin context
+ if (is_multisite() && is_network_admin()) {
+ $active_plugins = get_site_option('active_sitewide_plugins', array());
+ // Network active plugins are stored as key => timestamp
+ $active_plugins = array_keys($active_plugins);
+ } else {
+ // Single site or non-network admin context
+ $active_plugins = get_option('active_plugins', array());
+ }
+
+ // Check each active plugin
+ foreach ($active_plugins as $plugin_file) {
+ $plugin_path = WP_PLUGIN_DIR . '/' . $plugin_file;
+ if (!file_exists($plugin_path)) {
+ $invalid_plugins[] = $plugin_file;
+ }
+ }
+
+ // Cache the result
+ $this->invalid_plugins = $invalid_plugins;
+
+ return $invalid_plugins;
+ }
+
+ /**
+ * Check if the current page is the plugins page.
+ *
+ * @return bool True if on the plugins page, false otherwise.
+ */
+ public function is_plugins_page() {
+ global $pagenow;
+ return is_admin() && 'plugins.php' === $pagenow;
+ }
+
+ /**
+ * Find and add invalid plugin references to the plugins list.
+ *
+ * Filters the list of plugins displayed on the plugins page to include
+ * entries for active plugins whose files are missing.
+ *
+ * @param array $plugins An array of plugin data.
+ * @return array The potentially modified array of plugin data.
+ */
+ public function add_missing_plugins_references($plugins) {
+ // Only run on the plugins page
+ if (!$this->is_plugins_page()) {
+ return $plugins;
+ }
+
+ // Get active plugins that don't exist
+ $invalid_plugins = $this->get_invalid_plugins();
+
+ // Add each invalid plugin to the plugin list
+ foreach ($invalid_plugins as $plugin_path) {
+ if (!isset($plugins[$plugin_path])) {
+ $plugin_name = basename($plugin_path);
+ $plugin_slug = dirname($plugin_path);
+ if ('.' === $plugin_slug) {
+ $plugin_slug = basename($plugin_path, '.php');
+ }
+
+ // Create a basic plugin data array
+ $plugins[$plugin_path] = array(
+ 'Name' => $plugin_name . ' (File Missing)',
+ /* translators: %s: Path to wp-content/plugins */
+ 'Description' => sprintf(
+ __('This plugin is still marked as "Active" in your database — but its folder and files can\'t be found in %s. Click "Remove Notice" to permanently remove it from your active plugins list and eliminate the error notice.', 'wp-fix-plugin-does-not-exist-notices'),
+ '/wp-content/plugins/
'
+ ),
+ 'Version' => FPDEN_VERSION, // Use our plugin version instead of 'N/A'
+ 'Author' => 'Marcus Quinn & WPALLSTARS',
+ 'PluginURI' => 'https://www.wpallstars.com',
+ 'AuthorURI' => 'https://www.wpallstars.com',
+ 'Title' => $plugin_name . ' (' . __('Missing', 'wp-fix-plugin-does-not-exist-notices') . ')',
+ 'AuthorName' => 'Marcus Quinn & WPALLSTARS',
+ );
+
+ // Add the data needed for the "View details" link
+ $plugins[$plugin_path]['slug'] = $plugin_slug;
+ $plugins[$plugin_path]['plugin'] = $plugin_path;
+ $plugins[$plugin_path]['type'] = 'plugin';
+
+ // Add Git Updater fields
+ $plugins[$plugin_path]['GitHub Plugin URI'] = 'wpallstars/wp-fix-plugin-does-not-exist-notices';
+ $plugins[$plugin_path]['GitHub Branch'] = 'main';
+ $plugins[$plugin_path]['TextDomain'] = 'wp-fix-plugin-does-not-exist-notices';
+ }
+ }
+
+ return $plugins;
+ }
+
+ /**
+ * Add the Remove Notice action link to invalid plugins.
+ *
+ * Filters the action links displayed for each plugin on the plugins page.
+ * Adds a "Remove Notice" link for plugins identified as missing.
+ *
+ * @param array $actions An array of plugin action links.
+ * @param string $plugin_file Path to the plugin file relative to the plugins directory.
+ * @param array $plugin_data An array of plugin data.
+ * @param string $context The plugin context (e.g., 'all', 'active', 'inactive').
+ * @return array The potentially modified array of plugin action links.
+ */
+ public function add_remove_reference_action($actions, $plugin_file, $plugin_data, $context) {
+ // Only run on the plugins page
+ if (!$this->is_plugins_page()) {
+ return $actions;
+ }
+
+ // Get our list of invalid plugins
+ $invalid_plugins = $this->get_invalid_plugins();
+
+ // Check if this plugin file is in our list of invalid plugins
+ if (in_array($plugin_file, $invalid_plugins, true)) {
+ // Clear existing actions like "Activate", "Deactivate", "Edit"
+ $actions = array();
+
+ // Add our custom action
+ $nonce = wp_create_nonce('remove_plugin_reference_' . $plugin_file);
+ $remove_url = admin_url('plugins.php?action=remove_reference&plugin=' . urlencode($plugin_file) . '&_wpnonce=' . $nonce);
+ /* translators: %s: Plugin file path */
+ $aria_label = sprintf(__('Remove reference to missing plugin %s', 'wp-fix-plugin-does-not-exist-notices'), esc_attr($plugin_file));
+ $actions['remove_reference'] = '' . esc_html__('Remove Notice', 'wp-fix-plugin-does-not-exist-notices') . '';
+ }
+
+ return $actions;
+ }
+
+ /**
+ * Handle the remove reference action triggered by the link.
+ *
+ * Checks for the correct action, verifies nonce and permissions,
+ * calls the removal function, and redirects back to the plugins page.
+ *
+ * @return void
+ */
+ public function handle_remove_reference() {
+ // Check if our specific action is being performed
+ if (!isset($_GET['action']) || 'remove_reference' !== $_GET['action'] || !isset($_GET['plugin'])) {
+ return;
+ }
+
+ // Verify user permissions
+ if (!current_user_can('activate_plugins')) {
+ wp_die(esc_html__('You do not have sufficient permissions to perform this action.', 'wp-fix-plugin-does-not-exist-notices'));
+ }
+
+ // Sanitize and get the plugin file path
+ $plugin_file = isset($_GET['plugin']) ? sanitize_text_field(wp_unslash($_GET['plugin'])) : '';
+ if (empty($plugin_file)) {
+ wp_die(esc_html__('Invalid plugin specified.', 'wp-fix-plugin-does-not-exist-notices'));
+ }
+
+ // Verify nonce for security
+ check_admin_referer('remove_plugin_reference_' . $plugin_file);
+
+ // Attempt to remove the plugin reference
+ $success = $this->remove_plugin_reference($plugin_file);
+
+ // Prepare redirect URL with feedback query args
+ $redirect_url = admin_url('plugins.php');
+ $redirect_url = add_query_arg($success ? 'reference_removed' : 'reference_removal_failed', '1', $redirect_url);
+
+ // Redirect and exit
+ wp_safe_redirect($redirect_url);
+ exit;
+ }
+
+ /**
+ * Remove a plugin reference from the active plugins list in the database.
+ *
+ * Handles both single site and multisite network activated plugins.
+ *
+ * @param string $plugin_file The plugin file path to remove.
+ * @return bool True on success, false on failure or if the plugin wasn't found.
+ */
+ public function remove_plugin_reference($plugin_file) {
+ $success = false;
+
+ // Ensure plugin file path is provided
+ if (empty($plugin_file)) {
+ return false;
+ }
+
+ // Handle multisite network admin context
+ if (is_multisite() && is_network_admin()) {
+ $active_plugins = get_site_option('active_sitewide_plugins', array());
+ // Network active plugins are stored as key => timestamp
+ if (isset($active_plugins[$plugin_file])) {
+ unset($active_plugins[$plugin_file]);
+ $success = update_site_option('active_sitewide_plugins', $active_plugins);
+ }
+ } else { // Handle single site or non-network admin context
+ $active_plugins = get_option('active_plugins', array());
+ // Single site active plugins are stored as an indexed array
+ $key = array_search($plugin_file, $active_plugins, true); // Use strict comparison
+ if (false !== $key) {
+ unset($active_plugins[$key]);
+ // Re-index the array numerically
+ $active_plugins = array_values($active_plugins);
+ $success = update_option('active_plugins', $active_plugins);
+ }
+ }
+
+ return $success;
+ }
+
+ /**
+ * Display admin notices on the plugins page.
+ *
+ * Shows feedback messages after attempting to remove a reference.
+ * The main informational notice is handled by JavaScript to position it
+ * directly below the WordPress error message.
+ *
+ * @return void
+ */
+ public function admin_notices() {
+ // Only run on the plugins page
+ if (!$this->is_plugins_page()) {
+ return;
+ }
+
+ // Check for feedback messages from the remove action
+ if (isset($_GET['reference_removed']) && '1' === $_GET['reference_removed']) {
+ ?>
+
/wp-content/plugins/
'
+ );
+ }
+
+ // Prepare sections
+ $new_result->sections = array(
+ 'description' => $description,
+ 'changelog' => !empty($changelog) ? wpautop($changelog) : $changelog,
+ 'faq' => !empty($faq) ? wpautop($faq) : 'Yes, this plugin only removes entries from the WordPress active_plugins option, which is safe to modify when a plugin no longer exists.
', + ); + + // Add installation section if available + if (!empty($installation)) { + $new_result->sections['installation'] = wpautop($installation); + } + + // Add screenshots section if available + if (!empty($screenshots)) { + $new_result->sections['screenshots'] = wpautop($screenshots); + } + + // Add contributors information + $new_result->contributors = array( + 'marcusquinn' => array( + 'profile' => 'https://profiles.wordpress.org/marcusquinn/', + 'avatar' => 'https://secure.gravatar.com/avatar/', + 'display_name' => 'Marcus Quinn' + ), + 'wpallstars' => array( + 'profile' => 'https://profiles.wordpress.org/wpallstars/', + 'avatar' => 'https://secure.gravatar.com/avatar/', + 'display_name' => 'WPALLSTARS' + ) + ); + + // Add a random number and timestamp to force cache refresh + $new_result->download_link = 'https://www.wpallstars.com/plugins/wp-fix-plugin-does-not-exist-notices.zip?v=' . FPDEN_VERSION . '&cb=' . mt_rand(1000000, 9999999) . '&t=' . time(); + + // Add active installations count + $new_result->active_installs = 1000; + + // Add rating information + $new_result->rating = 100; + $new_result->num_ratings = 5; + $new_result->ratings = array( + 5 => 5, + 4 => 0, + 3 => 0, + 2 => 0, + 1 => 0 + ); + + // Add homepage and download link + $new_result->homepage = 'https://www.wpallstars.com'; + + // Set no caching + $new_result->cache_time = 0; + + // Return our completely new result object + return $new_result; + } + + return $result; + } + + /** + * Check if a slug matches one of our missing plugins. + * + * @param string $slug The plugin slug to check. + * @param array $invalid_plugins List of invalid plugin paths. + * @return bool True if the slug matches a missing plugin. + */ + private function is_missing_plugin($slug, $invalid_plugins) { + foreach ($invalid_plugins as $plugin_file) { + // Extract the plugin slug from the plugin file path + $plugin_slug = dirname($plugin_file); + if ('.' === $plugin_slug) { + $plugin_slug = basename($plugin_file, '.php'); + } + + if ($slug === $plugin_slug) { + return true; + } + } + return false; + } + + /** + * Prevent WordPress from caching our plugin API responses. + * + * @param object|WP_Error $result The result object or WP_Error. + * @param string $action The type of information being requested. + * @param object $args Plugin API arguments. + * @return object|WP_Error The result object or WP_Error. + */ + public function prevent_plugins_api_caching($result, $action, $args) { + // Only modify plugin_information requests + if ('plugin_information' !== $action) { + return $result; + } + + // Check if we have a slug to work with + if (empty($args->slug)) { + return $result; + } + + // Get our list of invalid plugins + $invalid_plugins = $this->get_invalid_plugins(); + + // Check if the requested plugin is one of our missing plugins + foreach ($invalid_plugins as $plugin_file) { + // Extract the plugin slug from the plugin file path + $plugin_slug = dirname($plugin_file); + if ('.' === $plugin_slug) { + $plugin_slug = basename($plugin_file, '.php'); + } + + // If this is one of our missing plugins, prevent caching + if ($args->slug === $plugin_slug) { + // Add a filter to prevent caching of this response + add_filter('plugins_api_result_' . $args->slug, '__return_false'); + + // Add a timestamp to force cache busting + if (is_object($result)) { + $result->last_updated = current_time('mysql'); + $result->cache_time = 0; + } + } + } + + return $result; + } + + /** + * Clear plugin API cache when viewing the plugins page. + * + * @return void + */ + public function maybe_clear_plugin_api_cache() { + // Only run on the plugins page + if (!$this->is_plugins_page()) { + return; + } + + // Get our list of invalid plugins + $invalid_plugins = $this->get_invalid_plugins(); + + // Clear transients for each invalid plugin + foreach ($invalid_plugins as $plugin_file) { + // Extract the plugin slug from the plugin file path + $plugin_slug = dirname($plugin_file); + if ('.' === $plugin_slug) { + $plugin_slug = basename($plugin_file, '.php'); + } + + // Delete all possible transients for this plugin + delete_transient('plugins_api_' . $plugin_slug); + delete_site_transient('plugins_api_' . $plugin_slug); + delete_transient('plugin_information_' . $plugin_slug); + delete_site_transient('plugin_information_' . $plugin_slug); + + // Clear any other transients that might be caching plugin info + $this->clear_all_plugin_transients(); + } + + // Also clear our own plugin's cache + $this->clear_own_plugin_cache(); + } + + /** + * Clear all plugin-related transients that might be caching information. + * + * @return void + */ + private function clear_all_plugin_transients() { + // Clear update cache + delete_site_transient('update_plugins'); + delete_site_transient('update_themes'); + delete_site_transient('update_core'); + + // Clear plugins API cache + delete_site_transient('plugin_information'); + + // Clear plugin update counts + delete_transient('plugin_updates_count'); + delete_site_transient('plugin_updates_count'); + + // Clear plugin slugs cache + delete_transient('plugin_slugs'); + delete_site_transient('plugin_slugs'); + } + + /** + * Clear cache specifically for our own plugin. + * + * @return void + */ + private function clear_own_plugin_cache() { + // Clear our own plugin's cache (both old and new slugs) + $our_slugs = array('wp-fix-plugin-does-not-exist-notices', 'fix-plugin-does-not-exist-notices'); + + foreach ($our_slugs as $slug) { + delete_transient('plugins_api_' . $slug); + delete_site_transient('plugins_api_' . $slug); + delete_transient('plugin_information_' . $slug); + delete_site_transient('plugin_information_' . $slug); + } + + // Clear plugin update transients + delete_site_transient('update_plugins'); + delete_site_transient('plugin_information'); + + // Force refresh of plugin update information if function exists + if (function_exists('wp_clean_plugins_cache')) { + wp_clean_plugins_cache(true); + } + + // Clear object cache if function exists + if (function_exists('wp_cache_flush')) { + wp_cache_flush(); + } + } +} diff --git a/includes/Modal.php b/includes/Modal.php new file mode 100644 index 0000000..33fd1ae --- /dev/null +++ b/includes/Modal.php @@ -0,0 +1,167 @@ +Update Source ' . $badge_text . ''; + $links[] = $update_source_link; + + return $links; + } + + /** + * Add the update source modal to the admin footer + */ + public function add_update_source_modal() { + if (!is_admin() || !current_user_can('manage_options')) { + return; + } + + // Only show on plugins page + $screen = get_current_screen(); + if (!$screen || $screen->id !== 'plugins') { + return; + } + + // Get current source + $current_source = get_option('fpden_update_source', 'auto'); + + // Enqueue the CSS and JS + wp_enqueue_style( + 'fpden-update-source-selector', + FPDEN_PLUGIN_URL . 'admin/css/update-source-selector.css', + array(), + FPDEN_VERSION + ); + + wp_enqueue_script( + 'fpden-update-source-selector', + FPDEN_PLUGIN_URL . 'admin/js/update-source-selector.js', + array('jquery'), + FPDEN_VERSION, + true + ); + + // Add nonce to the existing fpdenData object or create it if it doesn't exist + $nonce = wp_create_nonce('fpden_update_source'); + wp_localize_script( + 'fpden-update-source-selector', + 'fpdenData', + array( + 'updateSourceNonce' => $nonce, + ) + ); + + // Modal HTML + ?> + + plugin_file = $plugin_file; + $this->version = $version; + $this->plugin_dir = plugin_dir_path($plugin_file); + $this->plugin_url = plugin_dir_url($plugin_file); + + $this->define_constants(); + $this->load_dependencies(); + $this->init_components(); + } + + /** + * Define plugin constants + * + * @return void + */ + private function define_constants() { + if (!defined('FPDEN_VERSION')) { + define('FPDEN_VERSION', $this->version); + } + if (!defined('FPDEN_PLUGIN_DIR')) { + define('FPDEN_PLUGIN_DIR', $this->plugin_dir); + } + if (!defined('FPDEN_PLUGIN_URL')) { + define('FPDEN_PLUGIN_URL', $this->plugin_url); + } + } + + /** + * Load dependencies + * + * @return void + */ + private function load_dependencies() { + // Load composer autoloader if it exists + $autoloader = $this->plugin_dir . 'vendor/autoload.php'; + if (file_exists($autoloader)) { + require_once $autoloader; + } + + // Load required files + require_once $this->plugin_dir . 'includes/Core.php'; + require_once $this->plugin_dir . 'includes/Admin.php'; + require_once $this->plugin_dir . 'includes/Modal.php'; + } + + /** + * Initialize plugin components + * + * @return void + */ + private function init_components() { + // Initialize core functionality + $this->core = new Core(); + + // Initialize admin functionality + $this->admin = new Admin($this->core); + + // Initialize Git Updater fixes + $this->init_git_updater_fixes(); + + // Initialize the updater if the class exists + if (class_exists('\WPALLSTARS\FixPluginDoesNotExistNotices\Updater')) { + $this->updater = new Updater($this->plugin_file); + } + + // Initialize the modal for update source selection + new Modal(); + } + + /** + * Initialize Git Updater fixes + * + * This function adds filters to fix Git Updater's handling of 'main' vs 'master' branches + * + * @return void + */ + private function init_git_updater_fixes() { + // Fix for Git Updater looking for 'master' branch instead of 'main' + add_filter('gu_get_repo_branch', array($this, 'override_branch'), 999, 3); + + // Fix for Git Updater API URLs + add_filter('gu_get_repo_api', array($this, 'override_api_url'), 999, 3); + + // Fix for Git Updater download URLs + add_filter('gu_download_link', array($this, 'override_download_link'), 999, 3); + + // Fix for Git Updater repository metadata + add_filter('gu_get_repo_meta', array($this, 'override_repo_meta'), 999, 2); + + // Fix for Git Updater API responses + add_filter('gu_api_repo_type_data', array($this, 'override_repo_type_data'), 999, 3); + } + + /** + * Override the branch name for our plugin + * + * @param string $branch The current branch name + * @param string $git The git service (github, gitlab, etc.) + * @param object|null $repo The repository object (optional) + * @return string The modified branch name + */ + public function override_branch($branch, $git, $repo = null) { + // If repo is null or not an object, just return the branch unchanged + if (!is_object($repo)) { + return $branch; + } + if (isset($repo->slug) && + (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || + strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { + return 'main'; + } + return $branch; + } + + /** + * Override the API URL for our plugin + * + * @param mixed $api_url The current API URL (can be string or object) + * @param string $git The git service (github, gitlab, etc.) + * @param object|null $repo The repository object (optional) + * @return mixed The modified API URL (same type as input) + */ + public function override_api_url($api_url, $git, $repo = null) { + // If repo is null or not an object, just return the URL unchanged + if (!is_object($repo)) { + return $api_url; + } + + // Check if this is our plugin + if (isset($repo->slug) && + (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || + strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { + + // Only apply str_replace if $api_url is a string + if (is_string($api_url)) { + return str_replace('/master/', '/main/', $api_url); + } + + // If $api_url is an object, just return it unchanged + // This handles the case where Git Updater passes a GitHub_API object + return $api_url; + } + + // Return unchanged if not our plugin + return $api_url; + } + + /** + * Override the download link for our plugin + * + * @param string $download_link The current download link + * @param string $git The git service (github, gitlab, etc.) + * @param object|null $repo The repository object (optional) + * @return string The modified download link + */ + public function override_download_link($download_link, $git, $repo = null) { + // If repo is null or not an object, just return the link unchanged + if (!is_object($repo)) { + return $download_link; + } + if (isset($repo->slug) && + (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || + strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { + return str_replace('/master.zip', '/main.zip', $download_link); + } + return $download_link; + } + + /** + * Override repository metadata for our plugin + * + * @param array $repo_meta The repository metadata + * @param object $repo The repository object + * @return array The modified repository metadata + */ + public function override_repo_meta($repo_meta, $repo) { + if (isset($repo->slug) && + (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || + strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { + + // Set the correct repository information + $repo_meta['github_updater_repo'] = 'wp-fix-plugin-does-not-exist-notices'; + $repo_meta['github_updater_branch'] = 'main'; + $repo_meta['github_updater_api'] = 'https://api.github.com'; + $repo_meta['github_updater_raw'] = 'https://raw.githubusercontent.com/wpallstars/wp-fix-plugin-does-not-exist-notices/main'; + } + return $repo_meta; + } + + /** + * Override repository type data for our plugin + * + * @param array $data The repository data + * @param object $response The API response + * @param object|null $repo The repository object (optional) + * @return array The modified repository data + */ + public function override_repo_type_data($data, $response, $repo = null) { + // If repo is null or not an object, just return the data unchanged + if (!is_object($repo)) { + return $data; + } + + // Check if this is our plugin + if (isset($repo->slug) && + (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || + strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { + + // Set the correct branch + if (isset($data['branch'])) { + $data['branch'] = 'main'; + } + + // Set the correct version + if (isset($data['version'])) { + $data['version'] = FPDEN_VERSION; + } + } + return $data; + } +} diff --git a/readme.txt b/readme.txt index 8b8f1d1..507524c 100644 --- a/readme.txt +++ b/readme.txt @@ -5,11 +5,11 @@ Tags: plugins, missing plugins, cleanup, error fix, admin tools, plugin file doe Requires at least: 5.0 Tested up to: 6.7.2 Requires PHP: 7.0 -Stable tag: 2.1.1 +Stable tag: 2.2.0 License: GPL-2.0+ License URI: https://www.gnu.org/licenses/gpl-2.0.html -Easily remove references to deleted plugins that cause "Plugin file does not exist" errors in your WordPress admin. By Marcus Quinn (marcusquinn.com) & WP ALLSTARS (wpallstars.com). +Easily remove references to deleted plugins that cause "Plugin file does not exist" errors in your WordPress admin. By Marcus Quinn (marcusquinn.com) & WPALLSTARS (wpallstars.com). == Description == @@ -98,7 +98,7 @@ If you've installed this plugin from GitHub or Gitea, you'll need Git Updater to This plugin allows you to choose where you want to receive updates from: 1. In the Plugins list, find "Fix 'Plugin file does not exist' Notices" -2. Click the "Choose Update Source" link next to the plugin +2. Click the "Update Source" link next to the plugin 3. Select your preferred update source: * **WordPress.org**: Updates from the official WordPress.org repository (has a version update delay due to the WP.org policy review and approval process, best for unmonitored auto-updates) * **GitHub**: Updates directly from the GitHub repo main branch for the latest stable release (requires Git Updater plugin, best for monitored updates where the latest features and fixes are needed immediately) @@ -179,6 +179,16 @@ Manually editing the WordPress database is risky and requires technical knowledg == Changelog == += 2.2.0 = +* Added: Completely refactored plugin to use OOP best practices +* Added: New class structure with proper namespaces +* Added: Improved code organization and maintainability +* Added: Better separation of concerns with dedicated classes +* 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" + = 2.1.1 = * 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 diff --git a/wp-fix-plugin-does-not-exist-notices.php b/wp-fix-plugin-does-not-exist-notices.php index b172e60..24f76c6 100644 --- a/wp-fix-plugin-does-not-exist-notices.php +++ b/wp-fix-plugin-does-not-exist-notices.php @@ -3,8 +3,8 @@ * 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.1.1 - * Author: Marcus Quinn & WP ALLSTARS + * Version: 2.2.0 + * Author: Marcus Quinn & The WPALLSTARS Team * Author URI: https://www.wpallstars.com * License: GPL-2.0+ * License URI: http://www.gnu.org/licenses/gpl-2.0.txt @@ -17,1043 +17,16 @@ * Release Asset: true * Update URI: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices * - * @package Fix_Plugin_Does_Not_Exist_Notices + * @package WPALLSTARS\FixPluginDoesNotExistNotices */ // If this file is called directly, abort. -if ( ! defined( 'WPINC' ) ) { - die; +if (!defined('WPINC')) { + die; } -// Define plugin constants. -define( 'FPDEN_VERSION', '2.1.1' ); -define( 'FPDEN_PLUGIN_DIR', plugin_dir_path( __FILE__ ) ); -define( 'FPDEN_PLUGIN_URL', plugin_dir_url( __FILE__ ) ); +// Load the main plugin class +require_once plugin_dir_path(__FILE__) . 'includes/Plugin.php'; -// Direct fix for Git Updater branch issue - added to main file to avoid loading issues -add_action('plugins_loaded', 'fpden_init_git_updater_fixes'); - -/** - * Initialize Git Updater fixes - * - * This function adds filters to fix Git Updater's handling of 'main' vs 'master' branches - * It uses named functions instead of anonymous functions for better compatibility - */ -function fpden_init_git_updater_fixes() { - // Add filter for plugin action links to add our update source selector - add_filter('plugin_action_links_' . plugin_basename(__FILE__), 'fpden_add_update_source_link'); - - // Add AJAX handler for saving update source - add_action('wp_ajax_fpden_save_update_source', 'fpden_save_update_source'); - - // Add the update source modal to admin footer - add_action('admin_footer', 'fpden_add_update_source_modal'); - - // Fix for Git Updater looking for 'master' branch instead of 'main' - add_filter('gu_get_repo_branch', 'fpden_override_branch', 999, 3); - - // Fix for Git Updater API URLs - add_filter('gu_get_repo_api', 'fpden_override_api_url', 999, 3); - - // Fix for Git Updater download URLs - add_filter('gu_download_link', 'fpden_override_download_link', 999, 3); - - // Fix for Git Updater repository metadata - add_filter('gu_get_repo_meta', 'fpden_override_repo_meta', 999, 2); - - // Fix for Git Updater API responses - add_filter('gu_api_repo_type_data', 'fpden_override_repo_type_data', 999, 3); -} - -/** - * Override the branch name for our plugin - * - * @param string $branch The current branch name - * @param string $git The git service (github, gitlab, etc.) - * @param object|null $repo The repository object (optional) - * @return string The modified branch name - */ -function fpden_override_branch($branch, $git, $repo = null) { - // If repo is null or not an object, just return the branch unchanged - if (!is_object($repo)) { - return $branch; - } - if (isset($repo->slug) && - (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || - strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { - return 'main'; - } - return $branch; -} - -/** - * Override the API URL for our plugin - * - * @param mixed $api_url The current API URL (can be string or object) - * @param string $git The git service (github, gitlab, etc.) - * @param object|null $repo The repository object (optional) - * @return mixed The modified API URL (same type as input) - */ -function fpden_override_api_url($api_url, $git, $repo = null) { - // If repo is null or not an object, just return the URL unchanged - if (!is_object($repo)) { - return $api_url; - } - - // Check if this is our plugin - if (isset($repo->slug) && - (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || - strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { - - // Only apply str_replace if $api_url is a string - if (is_string($api_url)) { - return str_replace('/master/', '/main/', $api_url); - } - - // If $api_url is an object, just return it unchanged - // This handles the case where Git Updater passes a GitHub_API object - return $api_url; - } - - // Return unchanged if not our plugin - return $api_url; -} - -/** - * Override the download link for our plugin - * - * @param string $download_link The current download link - * @param string $git The git service (github, gitlab, etc.) - * @param object|null $repo The repository object (optional) - * @return string The modified download link - */ -function fpden_override_download_link($download_link, $git, $repo = null) { - // If repo is null or not an object, just return the link unchanged - if (!is_object($repo)) { - return $download_link; - } - if (isset($repo->slug) && - (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || - strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { - return str_replace('/master.zip', '/main.zip', $download_link); - } - return $download_link; -} - -/** - * Override repository metadata for our plugin - */ -function fpden_override_repo_meta($repo_meta, $repo) { - if (isset($repo->slug) && - (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || - strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { - - // Set the correct repository information - $repo_meta['github_updater_repo'] = 'wp-fix-plugin-does-not-exist-notices'; - $repo_meta['github_updater_branch'] = 'main'; - $repo_meta['github_updater_api'] = 'https://api.github.com'; - $repo_meta['github_updater_raw'] = 'https://raw.githubusercontent.com/wpallstars/wp-fix-plugin-does-not-exist-notices/main'; - } - return $repo_meta; -} - -/** - * Override repository type data for our plugin - * - * @param array $data The repository data - * @param object $response The API response - * @param object|null $repo The repository object (optional) - * @return array The modified repository data - */ -function fpden_override_repo_type_data($data, $response, $repo = null) { - // If repo is null or not an object, just return the data unchanged - if (!is_object($repo)) { - return $data; - } - - // Check if this is our plugin - if (isset($repo->slug) && - (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || - strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { - - // Set the correct branch - if (isset($data['branch'])) { - $data['branch'] = 'main'; - } - - // Set the correct version - if (isset($data['version'])) { - $data['version'] = FPDEN_VERSION; - } - } - return $data; -} - -/** - * Main plugin class. - * - * Handles the core functionality of finding and fixing invalid plugin references. - * - * @since 1.0.0 - */ -class Fix_Plugin_Does_Not_Exist_Notices { - - /** - * Stores a list of invalid plugins found in the active_plugins option. - * - * @since 1.0.0 - * @var array - */ - private $invalid_plugins = null; - - /** - * Constructor. Hooks into WordPress actions and filters. - */ - public function __construct() { - // Add our plugin to the plugins list. - add_filter( 'all_plugins', array( $this, 'add_missing_plugins_references' ) ); - - // Add our action link to the plugins list. - add_filter( 'plugin_action_links', array( $this, 'add_remove_reference_action' ), 20, 4 ); - - // Handle the remove reference action. - add_action( 'admin_init', array( $this, 'handle_remove_reference' ) ); - - // Add admin notices for operation feedback. - add_action( 'admin_notices', array( $this, 'admin_notices' ) ); - - // Enqueue admin scripts and styles. - add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_assets' ) ); - - // Filter the plugin API to fix version display in plugin details popup - add_filter( 'plugins_api', array( $this, 'filter_plugin_details' ), 10, 3 ); - - // Prevent WordPress from caching our plugin API responses - add_filter( 'plugins_api_result', array( $this, 'prevent_plugins_api_caching' ), 10, 3 ); - - // Clear plugin API transients on plugin activation and when viewing plugins page - add_action( 'admin_init', array( $this, 'maybe_clear_plugin_api_cache' ) ); - - // We're no longer trying to prevent WordPress from auto-deactivating plugins - // as it was causing critical errors in some environments - } - - /** - * Enqueue scripts and styles needed for the admin area. - * - * @param string $hook_suffix The current admin page hook. - * @return void - */ - public function enqueue_admin_assets( $hook_suffix ) { - // Only load on the plugins page. - if ( 'plugins.php' !== $hook_suffix ) { - return; - } - - // Always load our version fix script on the plugins page - wp_enqueue_script( - 'fpden-version-fix', - FPDEN_PLUGIN_URL . 'admin/js/version-fix.js', - array( 'jquery', 'thickbox' ), - FPDEN_VERSION, - true // Load in footer. - ); - - // Get invalid plugins to decide if other assets are needed. - $invalid_plugins = $this->get_invalid_plugins(); - if ( empty( $invalid_plugins ) ) { - return; // No missing plugins, no need for the special notice JS/CSS. - } - - wp_enqueue_style( - 'fpden-admin-styles', - FPDEN_PLUGIN_URL . 'admin/css/admin-styles.css', - array(), - FPDEN_VERSION - ); - - wp_enqueue_script( - 'fpden-admin-scripts', - FPDEN_PLUGIN_URL . 'admin/js/admin-scripts.js', - array( 'jquery' ), // Add dependencies if needed, e.g., jQuery. - FPDEN_VERSION, - true // Load in footer. - ); - - // Add translation strings for JavaScript - wp_localize_script( - 'fpden-admin-scripts', - 'fpdenData', - array( - 'i18n' => array( - 'clickToScroll' => esc_html__( 'Click here to scroll to missing plugins', 'wp-fix-plugin-does-not-exist-notices' ), - 'pluginMissing' => esc_html__( 'File Missing', 'wp-fix-plugin-does-not-exist-notices' ), - 'removeNotice' => esc_html__( 'Remove Notice', 'wp-fix-plugin-does-not-exist-notices' ), - ), - 'version' => FPDEN_VERSION, // Add version for the plugin details fix script - ) - ); - } - - /** - * Find and add invalid plugin references to the plugins list. - * - * Filters the list of plugins displayed on the plugins page to include - * entries for active plugins whose files are missing. - * - * @param array $plugins An array of plugin data. - * @return array The potentially modified array of plugin data. - */ - public function add_missing_plugins_references( $plugins ) { - // Only run on the plugins page. - if ( ! $this->is_plugins_page() ) { - return $plugins; - } - - // Get active plugins that don't exist. - $invalid_plugins = $this->get_invalid_plugins(); - - // Add each invalid plugin to the plugin list. - foreach ( $invalid_plugins as $plugin_path ) { - if ( ! isset( $plugins[ $plugin_path ] ) ) { - $plugin_name = basename( $plugin_path ); - $plugin_slug = dirname( $plugin_path ); - if ( '.' === $plugin_slug ) { - $plugin_slug = basename( $plugin_path, '.php' ); - } - - // Create a basic plugin data array - $plugins[ $plugin_path ] = array( - 'Name' => $plugin_name . ' (File Missing)', - /* translators: %s: Path to wp-content/plugins */ - 'Description' => sprintf( - __( 'This plugin is still marked as "Active" in your database — but its folder and files can\'t be found in %s. Click "Remove Notice" to permanently remove it from your active plugins list and eliminate the error notice.', 'wp-fix-plugin-does-not-exist-notices' ), - '/wp-content/plugins/
'
- ),
- 'Version' => FPDEN_VERSION, // Use our plugin version instead of 'N/A'
- 'Author' => 'Marcus Quinn & WP ALLSTARS',
- 'PluginURI' => 'https://www.wpallstars.com',
- 'AuthorURI' => 'https://www.wpallstars.com',
- 'Title' => $plugin_name . ' (' . __( 'Missing', 'wp-fix-plugin-does-not-exist-notices' ) . ')',
- 'AuthorName' => 'Marcus Quinn & WP ALLSTARS',
- );
-
- // Add the data needed for the "View details" link
- $plugins[ $plugin_path ]['slug'] = $plugin_slug;
- $plugins[ $plugin_path ]['plugin'] = $plugin_path;
- $plugins[ $plugin_path ]['type'] = 'plugin';
-
- // Add Git Updater fields
- $plugins[ $plugin_path ]['GitHub Plugin URI'] = 'wpallstars/wp-fix-plugin-does-not-exist-notices';
- $plugins[ $plugin_path ]['GitHub Branch'] = 'main';
- $plugins[ $plugin_path ]['TextDomain'] = 'wp-fix-plugin-does-not-exist-notices';
- }
- }
-
- return $plugins;
- }
-
- /**
- * Add the Remove Notice action link to invalid plugins.
- *
- * Filters the action links displayed for each plugin on the plugins page.
- * Adds a "Remove Notice" link for plugins identified as missing.
- *
- * @param array $actions An array of plugin action links.
- * @param string $plugin_file Path to the plugin file relative to the plugins directory.
- * @param array $plugin_data An array of plugin data.
- * @param string $context The plugin context (e.g., 'all', 'active', 'inactive').
- * @return array The potentially modified array of plugin action links.
- * @noinspection PhpUnusedParameterInspection
- */
- public function add_remove_reference_action( $actions, $plugin_file, $plugin_data, $context ) {
- // Only run on the plugins page.
- if ( ! $this->is_plugins_page() ) {
- return $actions;
- }
-
- // Get our list of invalid plugins
- $invalid_plugins = $this->get_invalid_plugins();
-
- // Check if this plugin file is in our list of invalid plugins
- if ( in_array( $plugin_file, $invalid_plugins, true ) ) {
- // Clear existing actions like "Activate", "Deactivate", "Edit".
- $actions = array();
-
- // Add our custom action.
- $nonce = wp_create_nonce( 'remove_plugin_reference_' . $plugin_file );
- $remove_url = admin_url( 'plugins.php?action=remove_reference&plugin=' . urlencode( $plugin_file ) . '&_wpnonce=' . $nonce );
- /* translators: %s: Plugin file path */
- $aria_label = sprintf( __( 'Remove reference to missing plugin %s', 'wp-fix-plugin-does-not-exist-notices' ), esc_attr( $plugin_file ) );
- $actions['remove_reference'] = '' . esc_html__( 'Remove Notice', 'wp-fix-plugin-does-not-exist-notices' ) . '';
- }
-
- return $actions;
- }
-
- /**
- * Handle the remove reference action triggered by the link.
- *
- * Checks for the correct action, verifies nonce and permissions,
- * calls the removal function, and redirects back to the plugins page.
- *
- * @return void
- */
- public function handle_remove_reference() {
- // Check if our specific action is being performed.
- if ( ! isset( $_GET['action'] ) || 'remove_reference' !== $_GET['action'] || ! isset( $_GET['plugin'] ) ) {
- return;
- }
-
- // Verify user permissions.
- if ( ! current_user_can( 'activate_plugins' ) ) {
- wp_die( esc_html__( 'You do not have sufficient permissions to perform this action.', 'wp-fix-plugin-does-not-exist-notices' ) );
- }
-
- // Sanitize and get the plugin file path.
- $plugin_file = isset( $_GET['plugin'] ) ? sanitize_text_field( wp_unslash( $_GET['plugin'] ) ) : '';
- if ( empty( $plugin_file ) ) {
- wp_die( esc_html__( 'Invalid plugin specified.', 'wp-fix-plugin-does-not-exist-notices' ) );
- }
-
- // Verify nonce for security.
- check_admin_referer( 'remove_plugin_reference_' . $plugin_file );
-
- // Attempt to remove the plugin reference.
- $success = $this->remove_plugin_reference( $plugin_file );
-
- // Prepare redirect URL with feedback query args.
- $redirect_url = admin_url( 'plugins.php' );
- $redirect_url = add_query_arg( $success ? 'reference_removed' : 'reference_removal_failed', '1', $redirect_url );
-
- // Redirect and exit.
- wp_safe_redirect( $redirect_url );
- exit;
- }
-
- /**
- * Remove a plugin reference from the active plugins list in the database.
- *
- * Handles both single site and multisite network activated plugins.
- *
- * @param string $plugin_file The plugin file path to remove.
- * @return bool True on success, false on failure or if the plugin wasn't found.
- */
- public function remove_plugin_reference( $plugin_file ) {
- $success = false;
-
- // Ensure plugin file path is provided.
- if ( empty( $plugin_file ) ) {
- return false;
- }
-
- // Handle multisite network admin context.
- if ( is_multisite() && is_network_admin() ) {
- $active_plugins = get_site_option( 'active_sitewide_plugins', array() );
- // Network active plugins are stored as key => timestamp.
- if ( isset( $active_plugins[ $plugin_file ] ) ) {
- unset( $active_plugins[ $plugin_file ] );
- $success = update_site_option( 'active_sitewide_plugins', $active_plugins );
- }
- } else { // Handle single site or non-network admin context.
- $active_plugins = get_option( 'active_plugins', array() );
- // Single site active plugins are stored as an indexed array.
- $key = array_search( $plugin_file, $active_plugins, true ); // Use strict comparison.
- if ( false !== $key ) {
- unset( $active_plugins[ $key ] );
- // Re-index the array numerically.
- $active_plugins = array_values( $active_plugins );
- $success = update_option( 'active_plugins', $active_plugins );
- }
- }
-
- return $success;
- }
-
- /**
- * Display admin notices on the plugins page.
- *
- * Shows feedback messages after attempting to remove a reference.
- * The main informational notice is handled by JavaScript to position it
- * directly below the WordPress error message.
- *
- * @return void
- */
- public function admin_notices() {
- // Only run on the plugins page.
- if ( ! $this->is_plugins_page() ) {
- return;
- }
-
- // Check for feedback messages from the remove action.
- if ( isset( $_GET['reference_removed'] ) && '1' === $_GET['reference_removed'] ) {
- ?>
- /wp-content/plugins/
'
- );
- }
-
- // Prepare sections
- $new_result->sections = array(
- 'description' => $description,
- 'changelog' => !empty($changelog) ? wpautop($changelog) : $changelog,
- 'faq' => !empty($faq) ? wpautop($faq) : 'Yes, this plugin only removes entries from the WordPress active_plugins option, which is safe to modify when a plugin no longer exists.
', - ); - - // Add installation section if available - if (!empty($installation)) { - $new_result->sections['installation'] = wpautop($installation); - } - - // Add screenshots section if available - if (!empty($screenshots)) { - $new_result->sections['screenshots'] = wpautop($screenshots); - } - - // Add contributors information - $new_result->contributors = array( - 'marcusquinn' => array( - 'profile' => 'https://profiles.wordpress.org/marcusquinn/', - 'avatar' => 'https://secure.gravatar.com/avatar/', - 'display_name' => 'Marcus Quinn' - ), - 'wpallstars' => array( - 'profile' => 'https://profiles.wordpress.org/wpallstars/', - 'avatar' => 'https://secure.gravatar.com/avatar/', - 'display_name' => 'WP ALLSTARS' - ) - ); - - // Add a random number and timestamp to force cache refresh - $new_result->download_link = 'https://www.wpallstars.com/plugins/wp-fix-plugin-does-not-exist-notices.zip?v=' . FPDEN_VERSION . '&cb=' . mt_rand(1000000, 9999999) . '&t=' . time(); - - // Add active installations count - $new_result->active_installs = 1000; - - // Add rating information - $new_result->rating = 100; - $new_result->num_ratings = 5; - $new_result->ratings = array( - 5 => 5, - 4 => 0, - 3 => 0, - 2 => 0, - 1 => 0 - ); - - // Add homepage and download link - $new_result->homepage = 'https://www.wpallstars.com'; - - // Set no caching - $new_result->cache_time = 0; - - // Return our completely new result object - return $new_result; - } - - return $result; - } - - /** - * Check if a slug matches one of our missing plugins. - * - * @param string $slug The plugin slug to check. - * @param array $invalid_plugins List of invalid plugin paths. - * @return bool True if the slug matches a missing plugin. - */ - private function is_missing_plugin($slug, $invalid_plugins) { - foreach ($invalid_plugins as $plugin_file) { - // Extract the plugin slug from the plugin file path - $plugin_slug = dirname($plugin_file); - if ('.' === $plugin_slug) { - $plugin_slug = basename($plugin_file, '.php'); - } - - if ($slug === $plugin_slug) { - return true; - } - } - return false; - } - - /** - * Prevent WordPress from caching our plugin API responses. - * - * @param object|WP_Error $result The result object or WP_Error. - * @param string $action The type of information being requested. - * @param object $args Plugin API arguments. - * @return object|WP_Error The result object or WP_Error. - */ - public function prevent_plugins_api_caching( $result, $action, $args ) { - // Only modify plugin_information requests - if ( 'plugin_information' !== $action ) { - return $result; - } - - // Check if we have a slug to work with - if ( empty( $args->slug ) ) { - return $result; - } - - // Get our list of invalid plugins - $invalid_plugins = $this->get_invalid_plugins(); - - // Check if the requested plugin is one of our missing plugins - foreach ( $invalid_plugins as $plugin_file ) { - // Extract the plugin slug from the plugin file path - $plugin_slug = dirname( $plugin_file ); - if ( '.' === $plugin_slug ) { - $plugin_slug = basename( $plugin_file, '.php' ); - } - - // If this is one of our missing plugins, prevent caching - if ( $args->slug === $plugin_slug ) { - // Add a filter to prevent caching of this response - add_filter( 'plugins_api_result_' . $args->slug, '__return_false' ); - - // Add a timestamp to force cache busting - if ( is_object( $result ) ) { - $result->last_updated = current_time( 'mysql' ); - $result->cache_time = 0; - } - } - } - - return $result; - } - - /** - * Clear plugin API cache when viewing the plugins page. - * - * @return void - */ - public function maybe_clear_plugin_api_cache() { - // Only run on the plugins page - if ( ! $this->is_plugins_page() ) { - return; - } - - // Get our list of invalid plugins - $invalid_plugins = $this->get_invalid_plugins(); - - // Clear transients for each invalid plugin - foreach ( $invalid_plugins as $plugin_file ) { - // Extract the plugin slug from the plugin file path - $plugin_slug = dirname( $plugin_file ); - if ( '.' === $plugin_slug ) { - $plugin_slug = basename( $plugin_file, '.php' ); - } - - // Delete all possible transients for this plugin - delete_transient( 'plugins_api_' . $plugin_slug ); - delete_site_transient( 'plugins_api_' . $plugin_slug ); - delete_transient( 'plugin_information_' . $plugin_slug ); - delete_site_transient( 'plugin_information_' . $plugin_slug ); - - // Clear any other transients that might be caching plugin info - $this->clear_all_plugin_transients(); - } - - // Also clear our own plugin's cache - $this->clear_own_plugin_cache(); - } - - /** - * Clear all plugin-related transients that might be caching information. - * - * @return void - */ - private function clear_all_plugin_transients() { - // Clear update cache - delete_site_transient( 'update_plugins' ); - delete_site_transient( 'update_themes' ); - delete_site_transient( 'update_core' ); - - // Clear plugins API cache - delete_site_transient( 'plugin_information' ); - - // Clear plugin update counts - delete_transient( 'plugin_updates_count' ); - delete_site_transient( 'plugin_updates_count' ); - - // Clear plugin slugs cache - delete_transient( 'plugin_slugs' ); - delete_site_transient( 'plugin_slugs' ); - } - - /** - * Clear cache specifically for our own plugin. - * - * @return void - */ - private function clear_own_plugin_cache() { - // Clear our own plugin's cache (both old and new slugs) - $our_slugs = array('wp-fix-plugin-does-not-exist-notices', 'fix-plugin-does-not-exist-notices'); - - foreach ($our_slugs as $slug) { - delete_transient( 'plugins_api_' . $slug ); - delete_site_transient( 'plugins_api_' . $slug ); - delete_transient( 'plugin_information_' . $slug ); - delete_site_transient( 'plugin_information_' . $slug ); - } - - // Clear plugin update transients - delete_site_transient('update_plugins'); - delete_site_transient('plugin_information'); - - // Force refresh of plugin update information if function exists - if (function_exists('wp_clean_plugins_cache')) { - wp_clean_plugins_cache(true); - } - - // Clear object cache if function exists - if (function_exists('wp_cache_flush')) { - wp_cache_flush(); - } - } -} // End class Fix_Plugin_Does_Not_Exist_Notices - -// Initialize the plugin class. -new Fix_Plugin_Does_Not_Exist_Notices(); - -/** - * Add the "Choose Update Source" link to plugin action links - * - * @param array $links Array of plugin action links - * @return array Modified array of plugin action links - */ -function fpden_add_update_source_link($links) { - if (!current_user_can('manage_options')) { - return $links; - } - - // Get current update source - $current_source = get_option('fpden_update_source', 'auto'); - - // Add a badge to show the current source - $badge_class = 'fpden-source-badge ' . $current_source; - $badge_text = ucfirst($current_source); - if ($current_source === 'auto') { - $badge_text = 'Auto'; - } elseif ($current_source === 'wordpress.org') { - $badge_text = 'WP.org'; - } - - // Add the link with the badge - $update_source_link = 'Choose Update Source ' . $badge_text . ''; - $links[] = $update_source_link; - - return $links; -} - -/** - * Add the update source modal to the admin footer - */ -function fpden_add_update_source_modal() { - if (!is_admin() || !current_user_can('manage_options')) { - return; - } - - // Only show on plugins page - $screen = get_current_screen(); - if (!$screen || $screen->id !== 'plugins') { - return; - } - - // Get current source - $current_source = get_option('fpden_update_source', 'auto'); - - // Enqueue the CSS and JS - wp_enqueue_style( - 'fpden-update-source-selector', - FPDEN_PLUGIN_URL . 'admin/css/update-source-selector.css', - array(), - FPDEN_VERSION - ); - - wp_enqueue_script( - 'fpden-update-source-selector', - FPDEN_PLUGIN_URL . 'admin/js/update-source-selector.js', - array('jquery'), - FPDEN_VERSION, - true - ); - - // Add nonce to the existing fpdenData object or create it if it doesn't exist - $nonce = wp_create_nonce('fpden_update_source'); - wp_localize_script( - 'fpden-update-source-selector', - 'fpdenData', - array( - 'updateSourceNonce' => $nonce, - ) - ); - - // Modal HTML - ?> - - Date: Mon, 14 Apr 2025 19:24:46 +0100 Subject: [PATCH 2/8] Update release workflow to include new directories --- .github/workflows/release.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index bfb7ede..15900d9 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -29,6 +29,9 @@ jobs: cp LICENSE build/wp-fix-plugin-does-not-exist-notices/ cp README.md build/wp-fix-plugin-does-not-exist-notices/ cp -r assets build/wp-fix-plugin-does-not-exist-notices/ + cp -r admin build/wp-fix-plugin-does-not-exist-notices/ + cp -r includes build/wp-fix-plugin-does-not-exist-notices/ + cp -r languages build/wp-fix-plugin-does-not-exist-notices/ - name: Create ZIP file run: | @@ -46,7 +49,7 @@ jobs: wp-fix-plugin-does-not-exist-notices-${{ steps.get_version.outputs.VERSION }}.zip body: | Fix 'Plugin file does not exist.' Notices v${{ steps.get_version.outputs.VERSION }} - + See [CHANGELOG.md](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/blob/main/CHANGELOG.md) for details. # Deploy to WordPress.org @@ -57,7 +60,7 @@ jobs: steps: - name: Checkout code uses: actions/checkout@v3 - + - name: WordPress Plugin Deploy id: deploy uses: 10up/action-wordpress-plugin-deploy@stable From ac3e47a14750caea2264315dec3f333c491c074c Mon Sep 17 00:00:00 2001 From: marcusquinn <6428977+marcusquinn@users.noreply.github.com> Date: Mon, 14 Apr 2025 19:26:49 +0100 Subject: [PATCH 3/8] Fix release workflow to check if directories exist before copying --- .github/workflows/release.yml | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 15900d9..46b7660 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -28,10 +28,17 @@ jobs: cp readme.txt build/wp-fix-plugin-does-not-exist-notices/ cp LICENSE build/wp-fix-plugin-does-not-exist-notices/ cp README.md build/wp-fix-plugin-does-not-exist-notices/ - cp -r assets build/wp-fix-plugin-does-not-exist-notices/ cp -r admin build/wp-fix-plugin-does-not-exist-notices/ cp -r includes build/wp-fix-plugin-does-not-exist-notices/ - cp -r languages build/wp-fix-plugin-does-not-exist-notices/ + + # Copy directories if they exist + if [ -d "assets" ]; then + cp -r assets build/wp-fix-plugin-does-not-exist-notices/ + fi + + if [ -d "languages" ]; then + cp -r languages build/wp-fix-plugin-does-not-exist-notices/ + fi - name: Create ZIP file run: | From b988fbbec01a35e6d5b34cd1774ca8fd234e7715 Mon Sep 17 00:00:00 2001 From: marcusquinn <6428977+marcusquinn@users.noreply.github.com> Date: Mon, 14 Apr 2025 19:28:20 +0100 Subject: [PATCH 4/8] Update release workflow to include .wordpress-org directory --- .github/workflows/release.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 46b7660..6e9c681 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -40,6 +40,10 @@ jobs: cp -r languages build/wp-fix-plugin-does-not-exist-notices/ fi + if [ -d ".wordpress-org" ]; then + cp -r .wordpress-org build/wp-fix-plugin-does-not-exist-notices/ + fi + - name: Create ZIP file run: | cd build From e1da072640efc04780f25291d1bd8e63d92f4960 Mon Sep 17 00:00:00 2001 From: marcusquinn <6428977+marcusquinn@users.noreply.github.com> Date: Mon, 14 Apr 2025 19:43:19 +0100 Subject: [PATCH 5/8] Replace custom Git Updater fixes with proper plugin headers --- README.md | 23 +++++++++++++++++++++++ includes/Plugin.php | 7 +++++++ wp-fix-plugin-does-not-exist-notices.php | 6 ++++++ 3 files changed, 36 insertions(+) diff --git a/README.md b/README.md index d536436..09d033f 100644 --- a/README.md +++ b/README.md @@ -209,6 +209,29 @@ The plugin works by: 3. Adding helpful notifications near error messages 4. Providing a secure method to remove plugin references from the database +### Git Updater Integration + +This plugin is designed to work seamlessly with the Git Updater plugin for updates from GitHub and Gitea. To ensure proper integration: + +1. **Required Headers**: The plugin includes specific headers in the main plugin file that Git Updater uses to determine update sources and branches: + ```php + * GitHub Plugin URI: wpallstars/wp-fix-plugin-does-not-exist-notices + * GitHub Branch: main + * Primary Branch: main + * Release Branch: main + * Release Asset: true + * Gitea Plugin URI: https://gitea.wpallstars.com/wpallstars/wp-fix-plugin-does-not-exist-notices + * Gitea Branch: main + ``` + +2. **Tagging Releases**: When creating a new release, always tag it with the 'v' prefix (e.g., `v2.2.0`) to ensure GitHub Actions can create the proper release assets. + +3. **GitHub Actions**: The repository includes a GitHub Actions workflow that automatically builds the plugin and creates a release with the .zip file when a new tag is pushed. + +4. **Update Source Selection**: The plugin includes a feature that allows users to choose their preferred update source (WordPress.org, GitHub, or Gitea). + +For more information on Git Updater integration, see the [Git Updater Required Headers documentation](https://git-updater.com/knowledge-base/required-headers/). + ## Changelog ### 2.2.0 diff --git a/includes/Plugin.php b/includes/Plugin.php index 62fb323..deb2aca 100644 --- a/includes/Plugin.php +++ b/includes/Plugin.php @@ -143,10 +143,16 @@ class Plugin { * Initialize Git Updater fixes * * This function adds filters to fix Git Updater's handling of 'main' vs 'master' branches + * Note: This fix is commented out as we're now using the proper plugin headers instead. + * See: https://git-updater.com/knowledge-base/required-headers/ * * @return void */ private function init_git_updater_fixes() { + // These fixes are no longer needed with proper plugin headers + // Keeping the code commented for reference + + /* // Fix for Git Updater looking for 'master' branch instead of 'main' add_filter('gu_get_repo_branch', array($this, 'override_branch'), 999, 3); @@ -161,6 +167,7 @@ class Plugin { // Fix for Git Updater API responses add_filter('gu_api_repo_type_data', array($this, 'override_repo_type_data'), 999, 3); + */ } /** diff --git a/wp-fix-plugin-does-not-exist-notices.php b/wp-fix-plugin-does-not-exist-notices.php index 24f76c6..100601b 100644 --- a/wp-fix-plugin-does-not-exist-notices.php +++ b/wp-fix-plugin-does-not-exist-notices.php @@ -15,8 +15,14 @@ * Primary Branch: main * Release Branch: main * Release Asset: true + * Requires at least: 5.0 + * Requires PHP: 7.0 * Update URI: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices * + * Gitea Plugin URI: https://gitea.wpallstars.com/wpallstars/wp-fix-plugin-does-not-exist-notices + * Gitea Branch: main + * Gitea Languages: languages + * * @package WPALLSTARS\FixPluginDoesNotExistNotices */ From c5d3c7672cf1a11f0e997c34c370d8fc7efd95ee Mon Sep 17 00:00:00 2001 From: marcusquinn <6428977+marcusquinn@users.noreply.github.com> Date: Mon, 14 Apr 2025 21:26:27 +0100 Subject: [PATCH 6/8] Version 2.2.1 - Commented out version-fix.js script and fixed version consistency --- CHANGELOG.md | 5 +++ admin/js/version-fix.js | 2 +- includes/Admin.php | 5 ++- readme.txt | 6 +++- wp-fix-plugin-does-not-exist-notices.php | 4 +-- wp-fix-plugin-does-not-exist-notices.php.bak | 32 ++++++++++++++++++++ 6 files changed, 49 insertions(+), 5 deletions(-) create mode 100644 wp-fix-plugin-does-not-exist-notices.php.bak diff --git a/CHANGELOG.md b/CHANGELOG.md index 41cc0f0..803f1ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ All notable changes to this project should be documented both here and in the main Readme files. +#### [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 + #### [2.2.0] - 2025-04-14 #### Added - Completely refactored plugin to use OOP best practices diff --git a/admin/js/version-fix.js b/admin/js/version-fix.js index 98e7a7e..9ca56c6 100644 --- a/admin/js/version-fix.js +++ b/admin/js/version-fix.js @@ -8,7 +8,7 @@ 'use strict'; // Current plugin version - this should match the version in the main plugin file - const CURRENT_VERSION = '2.2.0'; + const CURRENT_VERSION = '2.2.1'; // Plugin slugs to check for const OUR_SLUGS = ['wp-fix-plugin-does-not-exist-notices', 'fix-plugin-does-not-exist-notices']; diff --git a/includes/Admin.php b/includes/Admin.php index 2a5ea56..6a7678e 100644 --- a/includes/Admin.php +++ b/includes/Admin.php @@ -45,7 +45,9 @@ class Admin { return; } - // Always load our version fix script on the plugins page + // Version fix script is no longer needed after refactoring + // Commented out for testing + /* wp_enqueue_script( 'fpden-version-fix', FPDEN_PLUGIN_URL . 'admin/js/version-fix.js', @@ -53,6 +55,7 @@ class Admin { FPDEN_VERSION, true // Load in footer ); + */ // Get invalid plugins to decide if other assets are needed $invalid_plugins = $this->core->get_invalid_plugins(); diff --git a/readme.txt b/readme.txt index 507524c..9747287 100644 --- a/readme.txt +++ b/readme.txt @@ -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.7.2 Requires PHP: 7.0 -Stable tag: 2.2.0 +Stable tag: 2.2.1 License: GPL-2.0+ License URI: https://www.gnu.org/licenses/gpl-2.0.html @@ -179,6 +179,10 @@ Manually editing the WordPress database is risky and requires technical knowledg == Changelog == += 2.2.1 = +* Changed: Commented out version-fix.js script as it's no longer needed after refactoring +* Fixed: Version consistency across all files + = 2.2.0 = * Added: Completely refactored plugin to use OOP best practices * Added: New class structure with proper namespaces diff --git a/wp-fix-plugin-does-not-exist-notices.php b/wp-fix-plugin-does-not-exist-notices.php index 100601b..c3839af 100644 --- a/wp-fix-plugin-does-not-exist-notices.php +++ b/wp-fix-plugin-does-not-exist-notices.php @@ -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.2.0 + * Version: 2.2.1 * Author: Marcus Quinn & The WPALLSTARS Team * Author URI: https://www.wpallstars.com * License: GPL-2.0+ @@ -35,4 +35,4 @@ if (!defined('WPINC')) { require_once plugin_dir_path(__FILE__) . 'includes/Plugin.php'; // Initialize the plugin -new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.2.0'); +new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.2.1'); diff --git a/wp-fix-plugin-does-not-exist-notices.php.bak b/wp-fix-plugin-does-not-exist-notices.php.bak new file mode 100644 index 0000000..24f76c6 --- /dev/null +++ b/wp-fix-plugin-does-not-exist-notices.php.bak @@ -0,0 +1,32 @@ + Date: Mon, 14 Apr 2025 21:38:37 +0100 Subject: [PATCH 7/8] Update release workflow documentation to reflect current best practices --- .ai-assistant.md | 107 ++++++++++++---------- .ai-workflows/release-process.md | 146 ++++++++++++++++++------------- 2 files changed, 145 insertions(+), 108 deletions(-) diff --git a/.ai-assistant.md b/.ai-assistant.md index e3193b5..59ad4cc 100644 --- a/.ai-assistant.md +++ b/.ai-assistant.md @@ -70,11 +70,11 @@ We follow [Semantic Versioning](https://semver.org/): ### Version Update Checklist When updating the version number, always update these files: -1. `wp-fix-plugin-does-not-exist-notices.php` (Plugin header) +1. `wp-fix-plugin-does-not-exist-notices.php` (Plugin header and version parameter in Plugin class initialization) 2. `CHANGELOG.md` (Add new version section) 3. `readme.txt` (Stable tag and Changelog section) 4. `README.md` (Update Changelog section to match readme.txt) -5. Update `FPDEN_VERSION` constant in the main plugin file +5. Update any JavaScript files that contain version constants (e.g., `admin/js/version-fix.js`) 6. Update `languages/wp-fix-plugin-does-not-exist-notices.pot` (Project-Id-Version and POT-Creation-Date) **IMPORTANT**: Always ensure README.md is kept in sync with readme.txt for consistency across platforms. @@ -106,50 +106,55 @@ Before creating a new release, verify the following: ### Release Process -1. Create a new branch for the version: `git checkout -b v{MAJOR}.{MINOR}.{PATCH}` +1. Create a new branch for the version: `git checkout -b v{MAJOR}.{MINOR}.{PATCH}` or use an existing feature branch 2. Update version numbers in ALL required files: - - `wp-fix-plugin-does-not-exist-notices.php` (Plugin header) - - `FPDEN_VERSION` constant in the main plugin file - - `readme.txt` (Stable tag) - - `README.md` (Ensure changelog is updated) + - `wp-fix-plugin-does-not-exist-notices.php` (Plugin header and version parameter in Plugin class initialization) + - `readme.txt` (Stable tag and Changelog section) + - `CHANGELOG.md` (Add new version section at the top) + - Any JavaScript files with version constants (e.g., `admin/js/version-fix.js`) - `languages/wp-fix-plugin-does-not-exist-notices.pot` (Project-Id-Version) - - Any other files that reference the version number -3. Update CHANGELOG.md with all changes -4. Update readme.txt changelog section -5. Update README.md changelog section to match readme.txt -6. Commit changes: `git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"` -7. Test changes locally on the version branch -8. When satisfied with testing, merge to main: +3. Run the build script to create the plugin ZIP file and deploy to local testing environment: + ``` + ./build.sh {MAJOR}.{MINOR}.{PATCH} + ``` +4. Test the plugin thoroughly in the local WordPress environment +5. Commit changes: `git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"` +6. Create a tag for the new version: + ``` + git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes" + ``` +7. Push the branch and tag to all remotes: + ``` + git push github feature/branch-name + git push gitea feature/branch-name + git push github v{MAJOR}.{MINOR}.{PATCH} + git push gitea v{MAJOR}.{MINOR}.{PATCH} + ``` +8. Verify the GitHub release is created with the ZIP file attached +9. When ready to merge to main, create a pull request or merge directly: ``` git checkout main - git merge v{MAJOR}.{MINOR}.{PATCH} --no-ff - ``` -9. Push main to all remotes: - ``` + git merge feature/branch-name --no-ff git push github main git push gitea main ``` -10. Create and push a tag to trigger the GitHub Actions workflow: - ``` - git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Release version {MAJOR}.{MINOR}.{PATCH}" - git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH} - git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH} - ``` -11. Verify the GitHub Actions workflow completes successfully ## Build Process The build process is handled by `build.sh`: -1. Updates version numbers +1. Creates build directory 2. Installs composer dependencies -3. Copies files to build directory +3. Copies required files to build directory 4. Creates ZIP file +5. Automatically deploys to local WordPress testing environment -To manually build the plugin: +To build the plugin and deploy to local testing: ``` ./build.sh {MAJOR}.{MINOR}.{PATCH} ``` +This will create a ZIP file named `wp-fix-plugin-does-not-exist-notices-{MAJOR}.{MINOR}.{PATCH}.zip` and deploy the plugin to your local WordPress testing environment. + ## Remote Repositories The plugin is hosted on multiple repositories: @@ -205,37 +210,43 @@ cd ~/Local/plugin-testing/app/public ### Creating a New Release ``` -# 1. Create a new branch -git checkout main -git checkout -b v1.7.0 +# 1. Start from a feature branch or create a new branch +git checkout feature/branch-name +# or +git checkout -b feature/new-feature-name # 2. Update version numbers in ALL required files -# - wp-fix-plugin-does-not-exist-notices.php +# - wp-fix-plugin-does-not-exist-notices.php (header and class initialization) # - CHANGELOG.md -# - readme.txt -# - README.md +# - readme.txt (Stable tag and Changelog section) +# - Any JavaScript files with version constants # - languages/wp-fix-plugin-does-not-exist-notices.pot -# - FPDEN_VERSION constant -# 3. Commit changes +# 3. Build and test locally +./build.sh 1.7.0 +# Test in local WordPress environment + +# 4. Commit changes git add . -git commit -m "Prepare release v1.7.0" +git commit -m "Version 1.7.0 - Brief description of changes" -# 4. Test changes locally on the version branch -# (Run tests, verify functionality) +# 5. Create a tag +git tag -a v1.7.0 -m "Version 1.7.0 - Brief description of changes" -# 5. Merge to main when ready +# 6. Push branch and tag to remotes +git push github feature/branch-name +git push gitea feature/branch-name +git push github v1.7.0 +git push gitea v1.7.0 + +# 7. Verify GitHub release is created with ZIP file +# Check: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/releases + +# 8. Merge to main when ready git checkout main -git merge v1.7.0 --no-ff - -# 6. Push main to remotes +git merge feature/branch-name --no-ff git push github main git push gitea main - -# 7. Create and push tag -git tag -a v1.7.0 -m "Release version 1.7.0" -git push github refs/tags/v1.7.0 -git push gitea refs/tags/v1.7.0 ``` ### Adding a New Feature diff --git a/.ai-workflows/release-process.md b/.ai-workflows/release-process.md index aceb6bc..69ebb8f 100644 --- a/.ai-workflows/release-process.md +++ b/.ai-workflows/release-process.md @@ -21,15 +21,23 @@ Based on the changes made, determine the appropriate version increment: ## Release Steps -### 1. Create a New Branch +### 1. Start from a Feature Branch or Create a New Branch + +You can either use an existing feature branch or create a new branch specifically for the release: ```bash +# Option 1: Use existing feature branch +git checkout feature/branch-name + +# Option 2: Create a new branch git checkout -b v{MAJOR}.{MINOR}.{PATCH} ``` Example: ```bash -git checkout -b v1.7.0 +git checkout feature/refactor-and-improvements +# or +git checkout -b v2.2.1 ``` ### 2. Update Version Numbers @@ -38,42 +46,49 @@ Update the version number in the following files: #### a. Main Plugin File (wp-fix-plugin-does-not-exist-notices.php) +Update both the plugin header and the version parameter in the Plugin class initialization: + ```php /** * Plugin Name: Fix 'Plugin file does not exist.' Notices - * Plugin URI: https://wordpress.org/plugins/fix-plugin-does-not-exist-notices/ - * Description: Adds missing plugins to the plugins list with a "Remove Reference" link so you can permanently clean up invalid plugin entries and remove error 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: {MAJOR}.{MINOR}.{PATCH} * ... */ + +// At the bottom of the file, update the version parameter: +new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '{MAJOR}.{MINOR}.{PATCH}'); ``` -Also update the FPDEN_VERSION constant: +#### b. JavaScript Files with Version Constants -```php -define( 'FPDEN_VERSION', '{MAJOR}.{MINOR}.{PATCH}' ); +Check for any JavaScript files that contain version constants, such as `admin/js/version-fix.js`: + +```javascript +// Current plugin version - this should match the version in the main plugin file +const CURRENT_VERSION = '{MAJOR}.{MINOR}.{PATCH}'; ``` -#### b. CHANGELOG.md +#### c. CHANGELOG.md Add a new section at the top of the CHANGELOG.md file: ```markdown -## [{MAJOR}.{MINOR}.{PATCH}] - YYYY-MM-DD -### Added -- New feature 1 -- New feature 2 +All notable changes to this project should be documented both here and in the main Readme files. -### Changed +#### [{MAJOR}.{MINOR}.{PATCH}] - YYYY-MM-DD +#### Added/Changed/Fixed - Change 1 - Change 2 +- Change 3 -### Fixed -- Bug fix 1 -- Bug fix 2 +#### [{PREVIOUS_VERSION}] - YYYY-MM-DD ``` -#### c. POT File (languages/wp-fix-plugin-does-not-exist-notices.pot) +Note: Use the `####` heading format for consistency with the existing CHANGELOG.md structure. + +#### d. POT File (languages/wp-fix-plugin-does-not-exist-notices.pot) Update the Project-Id-Version and POT-Creation-Date (IMPORTANT - don't forget this step!): @@ -84,7 +99,7 @@ Update the Project-Id-Version and POT-Creation-Date (IMPORTANT - don't forget th Note: Always use the current date for POT-Creation-Date in the format YYYY-MM-DD. -#### d. readme.txt +#### e. readme.txt Update the stable tag: @@ -96,73 +111,84 @@ Add a new entry to the changelog section: ``` = {MAJOR}.{MINOR}.{PATCH} = -* New feature 1 -* New feature 2 * Change 1 * Change 2 -* Fixed bug 1 -* Fixed bug 2 +* Change 3 ``` -Update the upgrade notice section: +### 3. Build and Test Locally -``` -= {MAJOR}.{MINOR}.{PATCH} = -Brief description of the most important changes in this release -``` - -### 3. Commit Changes +Run the build script to create the plugin ZIP file and deploy to your local WordPress testing environment: ```bash -git add wp-fix-plugin-does-not-exist-notices.php CHANGELOG.md readme.txt README.md languages/wp-fix-plugin-does-not-exist-notices.pot -git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}" +./build.sh {MAJOR}.{MINOR}.{PATCH} ``` -### 4. Test Changes Locally - -Test the changes thoroughly on the version branch to ensure everything works as expected: +This will: +1. Create a build directory +2. Install composer dependencies +3. Copy required files to the build directory +4. Create a ZIP file named `wp-fix-plugin-does-not-exist-notices-{MAJOR}.{MINOR}.{PATCH}.zip` +5. Deploy the plugin to your local WordPress testing environment +Test the plugin thoroughly in your local WordPress environment: - Test with the latest WordPress version -- Test with PHP 7.0+ (minimum supported version) - Verify all features work as expected - Check for any PHP warnings or notices +- Test any specific changes made in this version -### 5. Merge to Main +### 4. Commit Changes -When satisfied with testing, merge the version branch to main: +```bash +git add wp-fix-plugin-does-not-exist-notices.php CHANGELOG.md readme.txt admin/js/version-fix.js languages/wp-fix-plugin-does-not-exist-notices.pot +git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes" +``` + +### 5. Create a Tag + +```bash +git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes" +``` + +### 6. Push Branch and Tag to Remotes + +```bash +# Push the branch +git push github feature/branch-name +git push gitea feature/branch-name + +# Push the tag +git push github v{MAJOR}.{MINOR}.{PATCH} +git push gitea v{MAJOR}.{MINOR}.{PATCH} +``` + +### 7. Verify GitHub Release + +Check that the GitHub release was created successfully with the ZIP file attached: +https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/releases + +If the release doesn't appear or doesn't have the ZIP file attached, check the GitHub Actions page: +https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/actions + +### 8. Merge to Main (When Ready) + +When you're satisfied with the release, merge the feature branch to main: ```bash git checkout main -git merge v{MAJOR}.{MINOR}.{PATCH} --no-ff -``` - -The `--no-ff` flag creates a merge commit even if a fast-forward merge is possible, which helps preserve the branch history. - -### 6. Push Main to Remotes - -```bash +git merge feature/branch-name --no-ff git push github main git push gitea main ``` -### 7. Create and Push Tag - -```bash -git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Release version {MAJOR}.{MINOR}.{PATCH}" -git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH} -git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH} -``` - -### 8. Monitor GitHub Actions - -Open the GitHub Actions page to monitor the build and deployment process: -https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/actions +The `--no-ff` flag creates a merge commit even if a fast-forward merge is possible, which helps preserve the branch history. ### 9. Verify Release -- [ ] Check that the GitHub release was created successfully -- [ ] Verify that the plugin was deployed to WordPress.org -- [ ] Test the plugin from WordPress.org to ensure it works correctly +- [ ] Check that the GitHub release was created successfully with the ZIP file attached +- [ ] 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 ## Testing Previous Versions From e4c70b5711c15dd4d152009db6ab556358c10d49 Mon Sep 17 00:00:00 2001 From: marcusquinn <6428977+marcusquinn@users.noreply.github.com> Date: Mon, 14 Apr 2025 22:28:37 +0100 Subject: [PATCH 8/8] Version 2.2.2-stable - Cleanup and improvements --- .ai-assistant.md | 267 ++----------------- .ai-workflows/README.md | 1 + .ai-workflows/release-process.md | 12 +- CHANGELOG.md | 8 + admin/js/version-fix.js | 75 ------ includes/Plugin.php | 154 +---------- readme.txt | 9 +- wp-fix-plugin-does-not-exist-notices.php | 4 +- wp-fix-plugin-does-not-exist-notices.php.bak | 32 --- 9 files changed, 54 insertions(+), 508 deletions(-) delete mode 100644 admin/js/version-fix.js delete mode 100644 wp-fix-plugin-does-not-exist-notices.php.bak diff --git a/.ai-assistant.md b/.ai-assistant.md index 59ad4cc..87805e5 100644 --- a/.ai-assistant.md +++ b/.ai-assistant.md @@ -2,25 +2,6 @@ This guide helps AI assistants understand the project structure, workflows, and best practices for this repository. -## AI IDE Configuration - -This repository includes configuration files for various AI-powered development tools: - -- `.aiconfig` - General AI configuration (model preferences, ignore patterns) -- `.augmentignore` - Ignore patterns for Augment -- `.cursorignore` - Ignore patterns for Cursor -- `.v0ignore` - Ignore patterns for v0 -- `.windsurfignore` - Ignore patterns for Windsurf -- `.clinerc` - Configuration for Cline -- `.rooignore` - Ignore patterns for Roo -- `.geminiignore` - Ignore patterns for Gemini Code Assist -- `.loveablerc` - Configuration for Loveable -- `.boltignore` - Ignore patterns for Bolt -- `.codyignore` - Ignore patterns for Cody -- `.continuerc` - Configuration for Continue - -All these files respect `.gitignore` patterns and only include additional tool-specific patterns. The `!` prefix can be used in these files to include files that are excluded by `.gitignore`. - ## Project Overview - **Plugin Name**: Fix 'Plugin file does not exist' Notices @@ -29,132 +10,39 @@ All these files respect `.gitignore` patterns and only include additional tool-s This plugin helps users clean up references to deleted plugins that cause "Plugin file does not exist" errors in the WordPress admin. It adds missing plugins to the plugins list with a "Remove Notice" link to safely remove invalid plugin entries. -## Reference Plugins +## AI Workflows -The `reference-plugins/` directory contains plugins that can be used for reference or inspiration. When developing new features or improving existing ones, you should: +Detailed workflow documentation is available in the `.ai-workflows/` directory: -1. Examine these reference plugins for best practices in code structure, organization, and implementation -2. Look for patterns in how they handle similar functionality -3. Consider their approach to user interface design and user experience -4. Study their documentation style and thoroughness - -These plugins are not part of the codebase and are ignored by Git, but they provide valuable examples of WordPress plugin development standards and techniques. +- **@.ai-workflows/bug-fixing.md**: Guidelines for identifying and fixing bugs +- **@.ai-workflows/code-review.md**: Standards for reviewing code changes +- **@.ai-workflows/feature-development.md**: Process for developing new features +- **@.ai-workflows/local-env-vars.md**: Local development environment paths and URLs +- **@.ai-workflows/release-process.md**: Steps for preparing and publishing releases ## Version Management -### Version Numbering Convention - We follow [Semantic Versioning](https://semver.org/): -- **MAJOR.MINOR.PATCH** (e.g., 1.6.0) +- **MAJOR.MINOR.PATCH** (e.g., 2.2.1) - **MAJOR**: Breaking changes - **MINOR**: New features, non-breaking - **PATCH**: Bug fixes, non-breaking -### When to Increment Version Numbers - -- **PATCH** (1.6.0 → 1.6.1): - - Bug fixes - - Small text changes - - Minor improvements that don't add new features - -- **MINOR** (1.6.0 → 1.7.0): - - New features - - Significant improvements to existing functionality - - Deprecation of features (but not removal) - -- **MAJOR** (1.6.0 → 2.0.0): - - Breaking changes - - Removal of features - - Major architectural changes - -### Version Update Checklist - -When updating the version number, always update these files: -1. `wp-fix-plugin-does-not-exist-notices.php` (Plugin header and version parameter in Plugin class initialization) -2. `CHANGELOG.md` (Add new version section) -3. `readme.txt` (Stable tag and Changelog section) -4. `README.md` (Update Changelog section to match readme.txt) -5. Update any JavaScript files that contain version constants (e.g., `admin/js/version-fix.js`) -6. Update `languages/wp-fix-plugin-does-not-exist-notices.pot` (Project-Id-Version and POT-Creation-Date) - -**IMPORTANT**: Always ensure README.md is kept in sync with readme.txt for consistency across platforms. +When updating version numbers, see **@.ai-workflows/release-process.md** for the complete checklist. ## Git Workflow ### Branch Naming Convention - - Feature branches: `feature/descriptive-name` - Bug fix branches: `fix/issue-description` - Release branches: `v{MAJOR}.{MINOR}.{PATCH}` ### Commit Message Guidelines - - Use present tense ("Add feature" not "Added feature") - Start with a verb - Keep the first line under 50 characters - Reference issues when relevant: "Fix #123: Resolve plugin detection issue" -### Pre-Release Checklist - -Before creating a new release, verify the following: - -- [ ] Determine the correct version increment (MAJOR, MINOR, or PATCH) based on the changes -- [ ] Ensure all changes are documented in CHANGELOG.md -- [ ] Verify all code changes are tested and working correctly -- [ ] Check that all files are properly formatted and follow WordPress coding standards -- [ ] Ensure Git Updater configuration is correct (if applicable) - -### Release Process - -1. Create a new branch for the version: `git checkout -b v{MAJOR}.{MINOR}.{PATCH}` or use an existing feature branch -2. Update version numbers in ALL required files: - - `wp-fix-plugin-does-not-exist-notices.php` (Plugin header and version parameter in Plugin class initialization) - - `readme.txt` (Stable tag and Changelog section) - - `CHANGELOG.md` (Add new version section at the top) - - Any JavaScript files with version constants (e.g., `admin/js/version-fix.js`) - - `languages/wp-fix-plugin-does-not-exist-notices.pot` (Project-Id-Version) -3. Run the build script to create the plugin ZIP file and deploy to local testing environment: - ``` - ./build.sh {MAJOR}.{MINOR}.{PATCH} - ``` -4. Test the plugin thoroughly in the local WordPress environment -5. Commit changes: `git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"` -6. Create a tag for the new version: - ``` - git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes" - ``` -7. Push the branch and tag to all remotes: - ``` - git push github feature/branch-name - git push gitea feature/branch-name - git push github v{MAJOR}.{MINOR}.{PATCH} - git push gitea v{MAJOR}.{MINOR}.{PATCH} - ``` -8. Verify the GitHub release is created with the ZIP file attached -9. When ready to merge to main, create a pull request or merge directly: - ``` - git checkout main - git merge feature/branch-name --no-ff - git push github main - git push gitea main - ``` - -## Build Process - -The build process is handled by `build.sh`: -1. Creates build directory -2. Installs composer dependencies -3. Copies required files to build directory -4. Creates ZIP file -5. Automatically deploys to local WordPress testing environment - -To build the plugin and deploy to local testing: -``` -./build.sh {MAJOR}.{MINOR}.{PATCH} -``` - -This will create a ZIP file named `wp-fix-plugin-does-not-exist-notices-{MAJOR}.{MINOR}.{PATCH}.zip` and deploy the plugin to your local WordPress testing environment. - ## Remote Repositories The plugin is hosted on multiple repositories: @@ -164,13 +52,15 @@ The plugin is hosted on multiple repositories: Always push changes to all remotes to keep them in sync. -## GitHub Actions +## Git Updater Integration -The repository uses GitHub Actions for automated builds and deployments: -- Triggered by tags matching the pattern `v*` -- Builds the plugin -- Creates a GitHub release -- Deploys to WordPress.org +The plugin integrates with Git Updater to allow updates directly from GitHub or Gitea. Important notes: + +1. Git Updater reads version information from the readme.txt file in the main branch, not from tags or releases +2. Always merge release changes to the main branch immediately after creating a tag +3. The plugin includes proper headers for Git Updater in the main plugin file + +See **@.ai-workflows/release-process.md** for detailed Git Updater integration steps. ## Testing Guidelines @@ -180,125 +70,8 @@ Before releasing: 3. Verify all features work as expected 4. Check for any PHP warnings or notices -### Local Testing Environment +Local environment variables and paths are documented in **@.ai-workflows/local-env-vars.md**. -Local environment variables and paths are documented in `.ai-workflows/local-env-vars.md`. This includes: +## Common Tasks -- Repository paths -- Local WordPress testing environment paths -- URLs for testing and development tools -- Build and deploy script locations - -Refer to this file for the most up-to-date information about the local development environment. - -### Using WP-CLI with LocalWP - -WP-CLI can be used with LocalWP for various tasks: - -```bash -# Navigate to the WordPress directory -cd ~/Local/plugin-testing/app/public - -# Run WP-CLI commands -~/Local/plugin-testing/app/bin/wp plugin list -~/Local/plugin-testing/app/bin/wp transient delete --all -~/Local/plugin-testing/app/bin/wp cache flush -``` - -## Common Tasks for AI Assistants - -### Creating a New Release - -``` -# 1. Start from a feature branch or create a new branch -git checkout feature/branch-name -# or -git checkout -b feature/new-feature-name - -# 2. Update version numbers in ALL required files -# - wp-fix-plugin-does-not-exist-notices.php (header and class initialization) -# - CHANGELOG.md -# - readme.txt (Stable tag and Changelog section) -# - Any JavaScript files with version constants -# - languages/wp-fix-plugin-does-not-exist-notices.pot - -# 3. Build and test locally -./build.sh 1.7.0 -# Test in local WordPress environment - -# 4. Commit changes -git add . -git commit -m "Version 1.7.0 - Brief description of changes" - -# 5. Create a tag -git tag -a v1.7.0 -m "Version 1.7.0 - Brief description of changes" - -# 6. Push branch and tag to remotes -git push github feature/branch-name -git push gitea feature/branch-name -git push github v1.7.0 -git push gitea v1.7.0 - -# 7. Verify GitHub release is created with ZIP file -# Check: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/releases - -# 8. Merge to main when ready -git checkout main -git merge feature/branch-name --no-ff -git push github main -git push gitea main -``` - -### Adding a New Feature - -``` -# 1. Create feature branch from main -git checkout main -git checkout -b feature/new-feature-name - -# 2. Make changes and commit -git add . -git commit -m "Add new feature" - -# 3. Test locally -# (Run tests, verify functionality) - -# 4. When ready for release, merge to a version branch -git checkout -b v1.7.0 -git merge feature/new-feature-name --no-ff - -# 5. Continue with the release process -# (Update version numbers, etc.) -``` - -### Fixing a Bug - -``` -# 1. Create bugfix branch from main -git checkout main -git checkout -b fix/bug-description - -# 2. Make changes and commit -git add . -git commit -m "Fix #123: Fix bug description" - -# 3. Test locally -# (Run tests, verify functionality) - -# 4. When ready for release, merge to a version branch -git checkout -b v1.6.5 -git merge fix/bug-description --no-ff - -# 5. Continue with the release process -# (Update version numbers, etc.) -``` - -### Testing a Previous Version - -``` -# Checkout a specific tag for testing -git checkout v1.6.3 - -# Or create a test branch from a specific tag -git checkout v1.6.3 -b test/some-feature -``` +For detailed instructions on common tasks like creating releases, adding features, fixing bugs, and testing previous versions, see **@.ai-workflows/release-process.md**. diff --git a/.ai-workflows/README.md b/.ai-workflows/README.md index b65b9f6..b9a0ed0 100644 --- a/.ai-workflows/README.md +++ b/.ai-workflows/README.md @@ -7,6 +7,7 @@ This directory contains workflow documentation for AI assistants working with th - **bug-fixing.md**: Guidelines for identifying and fixing bugs in the codebase - **code-review.md**: Standards and procedures for reviewing code changes - **feature-development.md**: Process for developing new features +- **local-env-vars.md**: Local development environment paths and URLs - **release-process.md**: Steps for preparing and publishing new releases These documents help ensure consistent quality and approach when using AI tools to assist with development tasks. diff --git a/.ai-workflows/release-process.md b/.ai-workflows/release-process.md index 69ebb8f..ec7b7d4 100644 --- a/.ai-workflows/release-process.md +++ b/.ai-workflows/release-process.md @@ -63,13 +63,15 @@ new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '{MAJOR}.{MINOR}.{P #### b. JavaScript Files with Version Constants -Check for any JavaScript files that contain version constants, such as `admin/js/version-fix.js`: +Check for any JavaScript files that might contain version constants: ```javascript // Current plugin version - this should match the version in the main plugin file const CURRENT_VERSION = '{MAJOR}.{MINOR}.{PATCH}'; ``` +**Note**: As of version 2.2.1, we've removed redundant JavaScript files like `version-fix.js` since Git Updater now correctly detects the version from the main branch. + #### c. CHANGELOG.md Add a new section at the top of the CHANGELOG.md file: @@ -170,9 +172,11 @@ https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/releases If the release doesn't appear or doesn't have the ZIP file attached, check the GitHub Actions page: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/actions -### 8. Merge to Main (When Ready) +### 8. Merge to Main (CRITICAL STEP) -When you're satisfied with the release, merge the feature branch to main: +**IMPORTANT**: This step is critical for Git Updater to detect the new version. Git Updater reads the readme.txt file from the main branch, not from tags or releases. + +Merge the feature branch to main immediately after pushing the tag: ```bash git checkout main @@ -183,6 +187,8 @@ git push gitea main The `--no-ff` flag creates a merge commit even if a fast-forward merge is possible, which helps preserve the branch history. +**Note**: Only use named branches like feature/*, fix/*, etc. for development. Release branches (v*) should always be merged to main immediately after tagging to ensure Git Updater can detect the new version. + ### 9. Verify Release - [ ] Check that the GitHub release was created successfully with the ZIP file attached diff --git a/CHANGELOG.md b/CHANGELOG.md index 803f1ec..4a6bc72 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ All notable changes to this project should be documented both here and in the main Readme files. +#### [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 + #### [2.2.1] - 2025-04-14 #### Changed - Commented out version-fix.js script as it's no longer needed after refactoring diff --git a/admin/js/version-fix.js b/admin/js/version-fix.js deleted file mode 100644 index 9ca56c6..0000000 --- a/admin/js/version-fix.js +++ /dev/null @@ -1,75 +0,0 @@ -/** - * Fix Plugin Version Display - * - * This script directly modifies the plugin details popup to show the correct version - * when the popup is opened for our plugin. - */ -(function($) { - 'use strict'; - - // Current plugin version - this should match the version in the main plugin file - const CURRENT_VERSION = '2.2.1'; - - // Plugin slugs to check for - const OUR_SLUGS = ['wp-fix-plugin-does-not-exist-notices', 'fix-plugin-does-not-exist-notices']; - - // Function to fix the version in the plugin details popup - function fixPluginDetailsVersion() { - // Check if we're on the plugins page - if (window.location.href.indexOf('plugins.php') === -1) { - return; - } - - // Wait for the thickbox to be initialized - $(document).on('tb_init', function() { - // Set a timeout to allow the thickbox content to load - setTimeout(function() { - // Get the thickbox iframe - const $iframe = $('#TB_iframeContent'); - if (!$iframe.length) return; - - // Wait for iframe to load - $iframe.on('load', function() { - try { - const iframeDoc = this.contentDocument || this.contentWindow.document; - - // Get the plugin title from the iframe - const $title = $(iframeDoc).find('h2.plugin-title'); - if (!$title.length) return; - - // Check if this is our plugin - const titleText = $title.text(); - if (titleText.indexOf('Fix \'Plugin file does not exist\' Notices') !== -1) { - console.log('Found our plugin in the details popup, fixing version...'); - - // Find the version element - const $version = $(iframeDoc).find('.plugin-version-author-uri'); - if ($version.length) { - // Update the version text - const versionText = $version.text(); - const newVersionText = versionText.replace(/Version: [0-9.]+|Version: 0\.0\.0/, 'Version: ' + CURRENT_VERSION); - $version.text(newVersionText); - console.log('Updated version to: ' + CURRENT_VERSION); - } - - // Also update the version in the header if it exists - const $versionHeader = $(iframeDoc).find('.wrap h2:contains("Version:")'); - if ($versionHeader.length) { - $versionHeader.text('Version: ' + CURRENT_VERSION); - console.log('Updated version header to: ' + CURRENT_VERSION); - } - } - } catch (e) { - console.error('Error updating plugin version:', e); - } - }); - }, 500); - }); - } - - // Initialize when the document is ready - $(document).ready(function() { - fixPluginDetailsVersion(); - }); - -})(jQuery); diff --git a/includes/Plugin.php b/includes/Plugin.php index deb2aca..98b0af2 100644 --- a/includes/Plugin.php +++ b/includes/Plugin.php @@ -142,159 +142,17 @@ class Plugin { /** * Initialize Git Updater fixes * - * This function adds filters to fix Git Updater's handling of 'main' vs 'master' branches - * Note: This fix is commented out as we're now using the proper plugin headers instead. + * This function previously added filters to fix Git Updater's handling of 'main' vs 'master' branches. + * These fixes are no longer needed with proper plugin headers. * See: https://git-updater.com/knowledge-base/required-headers/ * * @return void */ private function init_git_updater_fixes() { - // These fixes are no longer needed with proper plugin headers - // Keeping the code commented for reference - - /* - // Fix for Git Updater looking for 'master' branch instead of 'main' - add_filter('gu_get_repo_branch', array($this, 'override_branch'), 999, 3); - - // Fix for Git Updater API URLs - add_filter('gu_get_repo_api', array($this, 'override_api_url'), 999, 3); - - // Fix for Git Updater download URLs - add_filter('gu_download_link', array($this, 'override_download_link'), 999, 3); - - // Fix for Git Updater repository metadata - add_filter('gu_get_repo_meta', array($this, 'override_repo_meta'), 999, 2); - - // Fix for Git Updater API responses - add_filter('gu_api_repo_type_data', array($this, 'override_repo_type_data'), 999, 3); - */ + // No fixes needed - we're using the proper plugin headers + // Git Updater reads version information from the readme.txt file in the main branch } - /** - * Override the branch name for our plugin - * - * @param string $branch The current branch name - * @param string $git The git service (github, gitlab, etc.) - * @param object|null $repo The repository object (optional) - * @return string The modified branch name - */ - public function override_branch($branch, $git, $repo = null) { - // If repo is null or not an object, just return the branch unchanged - if (!is_object($repo)) { - return $branch; - } - if (isset($repo->slug) && - (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || - strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { - return 'main'; - } - return $branch; - } - - /** - * Override the API URL for our plugin - * - * @param mixed $api_url The current API URL (can be string or object) - * @param string $git The git service (github, gitlab, etc.) - * @param object|null $repo The repository object (optional) - * @return mixed The modified API URL (same type as input) - */ - public function override_api_url($api_url, $git, $repo = null) { - // If repo is null or not an object, just return the URL unchanged - if (!is_object($repo)) { - return $api_url; - } - - // Check if this is our plugin - if (isset($repo->slug) && - (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || - strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { - - // Only apply str_replace if $api_url is a string - if (is_string($api_url)) { - return str_replace('/master/', '/main/', $api_url); - } - - // If $api_url is an object, just return it unchanged - // This handles the case where Git Updater passes a GitHub_API object - return $api_url; - } - - // Return unchanged if not our plugin - return $api_url; - } - - /** - * Override the download link for our plugin - * - * @param string $download_link The current download link - * @param string $git The git service (github, gitlab, etc.) - * @param object|null $repo The repository object (optional) - * @return string The modified download link - */ - public function override_download_link($download_link, $git, $repo = null) { - // If repo is null or not an object, just return the link unchanged - if (!is_object($repo)) { - return $download_link; - } - if (isset($repo->slug) && - (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || - strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { - return str_replace('/master.zip', '/main.zip', $download_link); - } - return $download_link; - } - - /** - * Override repository metadata for our plugin - * - * @param array $repo_meta The repository metadata - * @param object $repo The repository object - * @return array The modified repository metadata - */ - public function override_repo_meta($repo_meta, $repo) { - if (isset($repo->slug) && - (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || - strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { - - // Set the correct repository information - $repo_meta['github_updater_repo'] = 'wp-fix-plugin-does-not-exist-notices'; - $repo_meta['github_updater_branch'] = 'main'; - $repo_meta['github_updater_api'] = 'https://api.github.com'; - $repo_meta['github_updater_raw'] = 'https://raw.githubusercontent.com/wpallstars/wp-fix-plugin-does-not-exist-notices/main'; - } - return $repo_meta; - } - - /** - * Override repository type data for our plugin - * - * @param array $data The repository data - * @param object $response The API response - * @param object|null $repo The repository object (optional) - * @return array The modified repository data - */ - public function override_repo_type_data($data, $response, $repo = null) { - // If repo is null or not an object, just return the data unchanged - if (!is_object($repo)) { - return $data; - } - - // Check if this is our plugin - if (isset($repo->slug) && - (strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false || - strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) { - - // Set the correct branch - if (isset($data['branch'])) { - $data['branch'] = 'main'; - } - - // Set the correct version - if (isset($data['version'])) { - $data['version'] = FPDEN_VERSION; - } - } - return $data; - } + // Git Updater override methods have been removed as they're no longer needed + // We now use the proper plugin headers for Git Updater integration } diff --git a/readme.txt b/readme.txt index 9747287..3880486 100644 --- a/readme.txt +++ b/readme.txt @@ -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.7.2 Requires PHP: 7.0 -Stable tag: 2.2.1 +Stable tag: 2.2.2-stable 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.2.2-stable = +* 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 + = 2.2.1 = * Changed: Commented out version-fix.js script as it's no longer needed after refactoring * Fixed: Version consistency across all files diff --git a/wp-fix-plugin-does-not-exist-notices.php b/wp-fix-plugin-does-not-exist-notices.php index c3839af..a53e2a1 100644 --- a/wp-fix-plugin-does-not-exist-notices.php +++ b/wp-fix-plugin-does-not-exist-notices.php @@ -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.2.1 + * Version: 2.2.2-stable * Author: Marcus Quinn & The WPALLSTARS Team * Author URI: https://www.wpallstars.com * License: GPL-2.0+ @@ -35,4 +35,4 @@ if (!defined('WPINC')) { require_once plugin_dir_path(__FILE__) . 'includes/Plugin.php'; // Initialize the plugin -new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.2.1'); +new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.2.2-stable'); diff --git a/wp-fix-plugin-does-not-exist-notices.php.bak b/wp-fix-plugin-does-not-exist-notices.php.bak deleted file mode 100644 index 24f76c6..0000000 --- a/wp-fix-plugin-does-not-exist-notices.php.bak +++ /dev/null @@ -1,32 +0,0 @@ -