WIP: 2.0.0

[cameronterry]

VERY MUCH STILL A WORK IN PROGRESS AND NOT COMPLETE BY ANY MEANS.

Complete rebuild of the plugin.

New Features

• Implements a new suite of WP CLI commands, see below. (https://github.com/cameronterry/dark-matter/issues/2)
• Includes a feature for setting up Restricted domains, preventing use. (https://github.com/cameronterry/dark-matter/issues/13)
• Field is_active is now included in the logic, allowed Sites to be prepped with a primary domain but activated at a later time. (https://github.com/cameronterry/dark-matter/issues/13)
• REST API content now updates to use the primary domain (if set). Previously the domain used in the content would be the admin domain, regardless of whether the called endpoint was the admin domain or primary domain.
  • This also apples to XMLRPC endpoints.
• Implemented the use of Object Cache API to significantly reduce database queries and improve performance.
  • For instance; even with a full page cache solution such as Batcache, at least two database queries - one to populate $current_blog (Site) and $current_site (Network) - on every request.
  • Once the cache is primed for the domains, the number of queries from Dark Matter should be nil 99.9% of the time.
• Dark Matter is now available to be adjusted through custom REST API endpoints.
  • Covers both Domains and Restricted domains.
  • Domains has endpoints for retrieving all domains and domains for a specific website, as well as, adding, removing, and, updating domains.
  • Restricted domains has endpoints for retrieving Restricted domains, as well as, adding and removing Restricted domains.
  • All endpoints required authentication by a user who has Super Admin permissions.
• Domain mapping logic now resides in its own folder.
• All new admin user interface per Site to manage domains.
  • Built in React and uses the new REST API.
  • Can be disabled and hidden using the constant define( 'DARKMATTER_HIDE_UI', true );.
• Allow Logins on Primary Domain option has been replaced with a filter, darkmatter_allow_logins.
  • Auto-detects bbPress plugin if it is installed and active.
  • Auto-detects WooCommerce plugin if it is installed and active.
• Added a suite of actions and filters to enable extensibility of the Dark Matter plugin.
  • darkmatter_domain_add - fires after a domain is successfully added to the database and object cache.
  • darkmatter_domain_basic_check - fires at the end of the checks for a domain. Enables additional checks which are environment specific.
  • darkmatter_domain_delete - fires after a domain is successfully deleted from the database and object cace.
  • darkmatter_domain_updated - fires after a domain is successfully updated.
  • darkmatter_primary_set - Fires after a domain is set as the primary domain for a site.
  • darkmatter_primary_unset - Fires after a domain is unset as the primary domain for a site.
  • darkmatter_restrict_add - Fires after a domain is successfully added to the Restricted list.
  • darkmatter_restrict_get - Fires between the Restricted domains being returned from Object Cache and then going to the database.
  • darkmatter_restrict_delete - Fires after a domain is successfully deleted to the Restricted list.

Improvements over 1.x.x

• Domains are now sanitized to ensure that is purely a domain and not a URL. (https://github.com/cameronterry/dark-matter/issues/29)
• Priming the $current_blog now utilises WP_Site. (https://github.com/cameronterry/dark-matter/issues/17)
• Better code structure in general.
• Ensured that the mapping to the primary domain does not occur whilst the site is viewed through Customizer UI.
• Streamlined the number of filters used to map the primary domain.
• Mapping on the the_content filter now occurs later, to catch all URLs, including those from additional implementations such as srcset.
• Better handling of differences between HTTP and HTTPS settings for admin and mapped domains.
  • For HTTPS mapped domains and HTTP admin domain, third party cookie authentication doesn't engage. But will for HTTPS admin domain and HTTP domains.
• General Domain Mapping improvements.
  • Home URL (get_home_url() and home_url()) now map appropriately within the context of switch_to_blog() (https://github.com/cameronterry/dark-matter/issues/3).
  • "Visit" link on the Network Admin > Sites page now maps to the primary domain for each site.
  • "Visit Site" link on Admin Bar now maps to primary domain for the current site.
  • "My Sites" on Admin Bar now maps to primary domain for each website in the dropdown.
• Redirects now occur at the muplugins_loaded action, much earlier in the process lowering the amount of WordPress which is loaded before sending a redirect header.
  • Logic for determining redirects to the primary domain has been streamlined.
• Support for Gutenberg editor.

Backward Compatibility Notices

• 2.0.0 will no longer find the first available domain if no primary domain is set.
  • Previously Dark Matter would utilise the next available secondary domain.
  • New version in the case of the Admin domain will not redirect and in the case of a domain found but not primary, will redirect to the Admin domain.
  • Some edge cases, Dark Matter may not engage and WordPress will redirect to the root website on the Network.
• 1.x.x version of sunrise.php will error on update as the require path has changed in the new folder structure of 2.0.0.

CLI Commands

Add / Update / Remove Domains

Examples of adding, removing and updating a domain for a Site.

wp --url="sites.my.com/siteone" darkmatter domain add www.example.com --primary --https
wp --url="sites.my.com/siteone" darkmatter domain remove www.example.com
wp --url="sites.my.com/siteone" darkmatter domain remove www.example.com --force
wp --url="sites.my.com/siteone" darkmatter domain set www.example.com --primary
wp --url="sites.my.com/siteone" darkmatter domain set www.example.com --secondary

Listing Domains

Examples of listing domains for a Site.

wp --url="sites.my.com/siteone" darkmatter domain list
wp --url="sites.my.com/siteone" darkmatter domain list --format=json

Examples of listing domains for the entire Network.

wp darkmatter domain list
wp darkmatter domain list --format=csv

Retrieve all the primary domains for the Network.

wp darkmatter domain list --primary

Reserving Domains

Reserving a domain. This allows an administrator to setup the primary and / or secondary domains but stop Dark Matter performing redirects and rewrites. Please note; domains are enabled by default.

wp --url="sites.my.com/siteone" darkmatter domain add www.example.com --primary --https --disable
wp --url="sites.my.com/siteone" darkmatter domain set www.example.com --enable
wp --url="sites.my.com/siteone" darkmatter domain set www.example.com --disable

Restricting Domains

Examples of adding and removing a restricted domains for a Network. This permits administrators to stop domains from being used for a WordPress website; useful for organisations which use multiple CMS.

wp darkmatter restrict add www.example.com
wp darkmatter restrict remove www.example.com

Examples of retrieving a list of all restricted domains for a Network.

wp darkmatter restrict list
wp darkmatter restrict list --format=json
wp darkmatter restrict list --format=ids

Check / Upgrade Sunrise Dropin plugin

The following commands can be used to check if the Sunrise Dropin plugin (sunrise.php) matches the version contained with the Dark Matter plugin. You can also use the update command to install or update Sunrise Dropin.

Check if the Sunrise Dropin plugin matches the version within the installed version of Dark Matter.

wp darkmatter dropin check

Install the Sunrise Dropin plugin (this command will error if a sunrise.php file already exists).

wp darkmatter dropin update

Update and / or replace the Sunrise Dropin plugin with the version within the installed version of Dark Matter.

wp darkmatter dropin update --force

[svandragt]

The following syntax would make more sense to me conceptually:

# add and enable
wp --url="sites.my.com/siteone" darkmatter domain add www.example.com --primary --https --enable
# reserve and enable
wp --url="sites.my.com/siteone" darkmatter domain add www2.example.com 
wp --url="sites.my.com/siteone" darkmatter domain set www2.example.com --enable
wp --url="sites.my.com/siteone" darkmatter domain set www2.example.com --disable

[svandragt]

Grats