Merge pull request #34 from soderlind/php8

Code modernization: Refactored to use PHP 8.0+ features

Author: soderlind

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+### 1.8.0 
+
+> REQUIRE PHP 8.0 OR HIGHER
+
+#### Added
+- New Config class to manage plugin constants
+- Constructor property promotion for better code organization
+- Strict type declarations throughout the codebase
+
+#### Changed
+- Increased default search threshold from 2 to 20 sites
+- Refactored main class to use modern PHP 8.0+ features
+- Improved error handling and null checks
+- Better type safety with more specific type declarations
+- Simplified plugin initialization
+
+#### Developer Notes
+- The Config class now centralizes all plugin constants
+- Removed redundant property declarations in favor of constructor property promotion
+- Added strict typing for better code reliability
+- REST endpoints now use Config class constants
+
 ### 1.7.3
 
 - Fixed search functionality:
@@ -259,3 +281,5 @@
 ### 1.0.x
 
 - Initial release.
+
+

build/index.asset.php

@@ -1 +1 @@
-<?php return array('dependencies' => array('wp-api-fetch', 'wp-i18n'), 'version' => '6df7975b628e4eda2261');
+<?php return array('dependencies' => array('wp-api-fetch', 'wp-i18n'), 'version' => '8a8e912db6e7c0137fcb');

build/index.js

@@ -1,7 +1,7 @@
 {
   "name": "soderlind/super-admin-all-sites-menu",
   "description": "For the super admin, replace WP Admin Bar My Sites menu with an All Sites menu.",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "keywords": [
     "wordpress",
     "multisite",

composer.json

@@ -1,6 +1,6 @@
 {
 	"name": "super-admin-all-sites-menu",
-	"version": "1.7.3",
+	"version": "1.8.0",
 	"description": "For the super admin, replace WP Admin Bar My Sites menu with an All Sites menu.",
 	"main": "index.js",
 	"scripts": {

package.json

@@ -1,8 +1,8 @@
 === Super Admin All Sites Menu ===
-Stable tag: 1.7.3
+Stable tag: 1.8.0
 Requires at least: 5.6  
 Tested up to: 6.7  
-Requires PHP: 7.3  
+Requires PHP: 8.0  
 License: GPL v2 or later  
 Tags: superadmin, multisite, management  
 Contributors: PerS  
@@ -108,6 +108,15 @@ You can use the following filters to override the defaults:
 
 == Changelog ==
 
+= 1.8.0 =
+
+REQUIRE PHP 8.0 OR HIGHER
+
+* Code modernization: Refactored to use PHP 8.0+ features
+* Enhancement: Improved type safety and error handling
+* Performance: Better code organization with Config class
+* Enhancement: Increased default search threshold to 20 sites
+
 = 1.7.3 =
 * Fixed search functionality:
   * Improved search performance with better indexing

readme.txt

@@ -12,7 +12,7 @@
  * Plugin URI: https://github.com/soderlind/super-admin-all-sites-menu
  * GitHub Plugin URI: https://github.com/soderlind/super-admin-all-sites-menu
  * Description: For the super admin, replace WP Admin Bar My Sites menu with an All Sites menu.
- * Version:     1.7.3
+ * Version:     1.8.0
  * Author:      Per Soderlind
  * Network:     true
  * Author URI:  https://soderlind.no
@@ -27,79 +27,56 @@
 if ( ! defined( 'ABSPATH' ) ) {
 	wp_die();
 }
-/**
- * Default values for the plugin.
- */
-const LOADINCREMENTS   = 100; // Number of sites to load at a time.
-const SEARCHTHRESHOLD  = 2; // Number of sites before showing the search box.
-const CACHE_EXPIRATION = DAY_IN_SECONDS; // Time to cache the site list.
-const ORDERBY          = 'name'; // Order by name.
-const PLUGINS          = [ 'restricted-site-access/restricted_site_access.php' ]; // Plugins triggering update local storages.
-const REST_NAMESPACE   = 'super-admin-all-sites-menu/v1'; // REST API namespace.
-const REST_BASE        = 'sites'; // REST API route.
-const REST_ENDPOINT    = REST_NAMESPACE . '/' . REST_BASE; // REST API endpoint.
-/**
- * Super Admin All Sites Menu
- */
-class SuperAdminAllSitesMenu {
-
-	/**
-	 * AJAX load increments.
-	 *
-	 * @var [type]
-	 */
-	private $load_increments;
-
-	/**
-	 * Plugins triggering update local storages.
-	 *
-	 * @var array
-	 */
-	private $plugins;
-
-	/**
-	 * Sort menu by site name.
-	 *
-	 * @var string
-	 */
-	private $order_by;
 
+// Configuration constants
+final class Config {
+	public const LOAD_INCREMENTS  = 100;
+	public const SEARCH_THRESHOLD = 20;
+	public const CACHE_EXPIRATION = DAY_IN_SECONDS;
+	public const ORDER_BY         = 'name';
+	public const PLUGINS          = [ 'restricted-site-access/restricted_site_access.php' ];
+	public const REST_NAMESPACE   = 'super-admin-all-sites-menu/v1';
+	public const REST_BASE        = 'sites';
+	public const REST_ENDPOINT    = self::REST_NAMESPACE . '/' . self::REST_BASE;
+}
 
-	/**
-	 * Store number of sites.
-	 *
-	 * @var integer
-	 */
-	private $number_of_sites = 0;
-
-	/**
-	 * Set the search threshold.
-	 *
-	 * @var [type]
-	 */
-	private $search_threshold;
+/**
+ * Super Admin All Sites Menu main class
+ */
+final class SuperAdminAllSitesMenu {
+	private int $number_of_sites = 0;
+
+	public function __construct(
+		private int $load_increments = Config::LOAD_INCREMENTS,
+		private array $plugins = Config::PLUGINS,
+		private string $order_by = Config::ORDER_BY,
+		private int $search_threshold = Config::SEARCH_THRESHOLD,
+		private int $cache_expiration = Config::CACHE_EXPIRATION
+	) {}
+
+	public function init(): void {
+		if ( ! is_multisite() ) {
+			return;
+		}
 
-	/**
-	 * The cache expiration time.
-	 *
-	 * @var integer
-	 */
-	private $cache_expiration;
-	/**
-	 * Constructor.
-	 */
-	public function __construct() {
-		return $this;
+		$this->set_properties();
+		$this->register_hooks();
 	}
 
-	/**
-	 * Initialize the plugin.
-	 */
-	public function init() {
+	private function register_hooks(): void {
 		add_action( 'admin_bar_init', [ $this, 'action_admin_bar_init' ] );
 		add_action( 'rest_api_init', [ $this, 'action_rest_api_init' ] );
 		register_deactivation_hook( __FILE__, [ $this, 'deactivate' ] );
-		$this->set_properties();
+
+		// Site changes
+		add_action( 'wp_insert_site', [ $this, 'update_local_storage' ] );
+		add_action( 'wp_update_site', [ $this, 'update_local_storage' ] );
+		add_action( 'wp_delete_site', [ $this, 'update_local_storage' ] );
+		add_action( 'update_option_blogname', [ $this, 'action_update_option_blogname' ], 10, 3 );
+
+		// Plugin activation/deactivation
+		add_action( 'activated_plugin', [ $this, 'plugin_update_local_storage' ] );
+		add_action( 'deactivated_plugin', [ $this, 'plugin_update_local_storage' ] );
 	}
 
 	/**
@@ -134,28 +111,28 @@ public function action_admin_bar_init(): void {
 	 * @return void
 	 */
 	public function set_properties(): void {
-		$this->plugins = \apply_filters( 'all_sites_menu_plugin_trigger', PLUGINS );
+		$this->plugins = \apply_filters( 'all_sites_menu_plugin_trigger', Config::PLUGINS );
 		if ( ! is_array( $this->plugins ) ) {
-			$this->plugins = PLUGINS;
+			$this->plugins = Config::PLUGINS;
 		}
 
-		$this->order_by = \apply_filters( 'all_sites_menu_order_by', ORDERBY );
+		$this->order_by = \apply_filters( 'all_sites_menu_order_by', Config::ORDER_BY );
 		if ( ! in_array( $this->order_by, [ 'name', 'url', 'id' ], true ) ) {
-			$this->order_by = ORDERBY;
+			$this->order_by = Config::ORDER_BY;
 		}
 
-		$this->load_increments = \apply_filters( 'all_sites_menu_load_increments', LOADINCREMENTS );
+		$this->load_increments = \apply_filters( 'all_sites_menu_load_increments', Config::LOAD_INCREMENTS );
 		if ( ! is_numeric( $this->load_increments ) || $this->load_increments < 1 ) {
-			$this->load_increments = LOADINCREMENTS;
+			$this->load_increments = Config::LOAD_INCREMENTS;
 		}
 
-		$this->search_threshold = \apply_filters( 'all_sites_menu_search_threshold', SEARCHTHRESHOLD );
+		$this->search_threshold = \apply_filters( 'all_sites_menu_search_threshold', Config::SEARCH_THRESHOLD );
 		if ( ! is_numeric( $this->search_threshold ) || $this->search_threshold < 1 ) {
-			$this->search_threshold = SEARCHTHRESHOLD;
+			$this->search_threshold = Config::SEARCH_THRESHOLD;
 		}
-		$this->cache_expiration = \apply_filters( 'all_sites_menu_force_refresh_expiration', CACHE_EXPIRATION );
+		$this->cache_expiration = \apply_filters( 'all_sites_menu_force_refresh_expiration', Config::CACHE_EXPIRATION );
 		if ( ! is_numeric( $this->search_threshold ) || $this->cache_expiration < 0 ) {
-			$this->cache_expiration = CACHE_EXPIRATION;
+			$this->cache_expiration = Config::CACHE_EXPIRATION;
 		}
 	}
 
@@ -312,8 +289,8 @@ public function super_admin_all_sites_menu( \WP_Admin_Bar $wp_admin_bar ): void
 	 */
 	public function action_rest_api_init( \WP_REST_Server $wp_rest_server ): void {
 		$is_route_created = register_rest_route(
-			REST_NAMESPACE,
-			'/' . REST_BASE,
+			Config::REST_NAMESPACE,
+			'/' . Config::REST_BASE,
 			[ 
 				'methods'             => \WP_REST_Server::CREATABLE,
 				'callback'            => [ $this, 'get_sites' ],
@@ -430,7 +407,7 @@ public function action_enqueue_scripts( string $hook_suffix ): void {
 		$data = wp_json_encode(
 			[ 
 				'nonce'          => wp_create_nonce( 'wp_rest' ),
-				'restURL'        => rest_url() . REST_ENDPOINT,
+				'restURL'        => rest_url() . Config::REST_ENDPOINT,
 				'loadincrements' => $this->load_increments,
 				'orderBy'        => $this->order_by,
 				'displaySearch'  => ( $this->number_of_sites > $this->search_threshold ) ? true : false,
@@ -540,7 +517,5 @@ private function remove_timestamp(): void {
 
 }
 
-if ( \is_multisite() ) {
-	$super_admin_menu = new SuperAdminAllSitesMenu();
-	$super_admin_menu->init();
-}
+// Initialize plugin
+( new SuperAdminAllSitesMenu() )->init();