Skip to content

Latest commit

 

History

History
154 lines (117 loc) · 6.67 KB

README.md

File metadata and controls

154 lines (117 loc) · 6.67 KB
Raw

Super Admin All Sites Menu

Also available at https://wordpress.org/plugins/super-admin-all-sites-menu/

Use | Prerequisite | Install | Filters | Demo | Changelog

For the super admin, replace WP Admin Bar My Sites menu with an All Sites menu.

  • Doesn't use switch_to_blog(), i.e. Super Admin All Sites Menu is faster and uses less resources than the WP Admin Bar My Sites menu.
    • get_blog_details('blogname') use switch_to_blog(), $site->__get( 'blogname' ) doesn't.
    • get_site_url() use switch_to_blog(), $site->__get( 'siteurl' ) doesn't.
  • Subsite menu data are stored locally in IndexedDB (did I say it's fast?). The local storage is updated when;
    • the plugin is activated.
    • a site is added or deleted.
    • you change a blog name.
    • IndexedDB is out of sync with site changes.
    • Restricted Site Access is activated or deactivated.
  • When subsite menu data is updated, REST is used and it's done in increments (100 sites per increment).
  • List all subsites. WP Admin Bar My Sites only list sites you're a local admin on.
  • Mark sites that has Restricted Site Access activated with a red icon.
  • Sites menu is sorted alphabetically.
  • Search filter.
  • Add more menu choices:
    • Under "Network Admin"
      • Add New Site
    • Per subsite.
      • 'New Page'
      • 'Users'
      • 'Plugins'
      • 'Settings'

Inspired by WP REST API vs admin-ajax.php vs Must-Use Plugin: Handling AJAX Requests in WordPress, I wrote a must-use plugin that makes the plugin go from fast to faster (ca 60% faster). Save the file in mu-plugins.

Use

IndexedDB

Menu data are stored locally in IndexedDB.

Prerequisite

  • WordPress Multisite
  • A modern browser, IE 11 isn't supported.

Install

Also available at https://wordpress.org/plugins/super-admin-all-sites-menu/

Also available via composer:

composer require soderlind/super-admin-all-sites-menu

Filters

You can use the following filters to override the defaults:

  • all_sites_menu_order_by
    • Sort menu by. Default value is name, accepts id, url or name 
      add_filter( 'all_sites_menu_order_by', function( string $order_by ) : string {
	return 'url';
} );
  • all_sites_menu_load_increments
    • REST load increments. Default value is 100.
    add_filter( 'all_sites_menu_load_increments', function( int $increments ) : int {
	return 300;
} );
  • all_sites_menu_plugin_trigger
    • Trigger an update of local storage (IndexedDB) when a plugin is (de)activated. Default is [ 'restricted-site-access/restricted_site_access.php' ].

      Note: Must be an array and each element in the array must point to the main plugin file. Syntax 'plugin-dir/plugin-file.php'

     add_filter( 'all_sites_menu_plugin_trigger', function( array $plugins ) : array {
	return [
		'restricted-site-access/restricted_site_access.php',
		'myplugin/myplugin.php',
	];
} );
  • all_sites_menu_search_threshold
    • Don't display search field if there's less than N subsites. Default value is 20.
    add_filter( 'all_sites_menu_search_threshold', function( int $increments ) : int {
	return 40;
} );
  • all_sites_menu_force_refresh_expiration
    • How often a forced refresh should be taken. Default value is 3600. Set the value to 0 to disable forced refresh. 
      add_filter( 'all_sites_menu_force_refresh_expiration', function( int $seconds ) : int {
	return 3600;
} );

Demo

A demo is available in WordPress Playground. It's a bit slow loading, 50 subsites are added.

  • If you disable Super Admin All Sites Menu in the Main Site plugins menu, you'll see the WP Admin Bar My Sites menu doesn't allow you to scroll and see all sites. This is a 14-year-old (!) bug on WordPress.

  • If you activate the Restricted Site Access plugin (included), you'll see a red icon next to the site name. ATM, this only works on the main site due to issues with WordPress Playground.

Flow

sequenceDiagram
	  Actor User
    participant Menu
    participant IndexedDB
    participant WordPress
		User->>Menu: Open the menu
    Menu->>IndexedDB: Check if IndexedDB in sync
		IndexedDB->>Menu: Update sites menu
		Note over Menu,IndexedDB: If in sync.
    IndexedDB->>WordPress: Request sites
		Note over IndexedDB,WordPress: If not in sync.
		WordPress->>IndexedDB: Get sites
		IndexedDB->>IndexedDB: Update IndexedDB
    IndexedDB->>Menu: Update sites menu
		Menu->>User: Read Menu
Loading

Changelog

See CHANGELOG.md

Credits

Copyright and License

Super Admin All Sites Menu is copyright 2021 Per Soderlind

Super Admin All Sites Menu is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

Super Admin All Sites Menu is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with the Extension. If not, see http://www.gnu.org/licenses/.