Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pantheon-systems/pantheon-mu-plugin
Pantheon's WordPress mu-plugin for all WordPress-based upstreams.
https://github.com/pantheon-systems/pantheon-mu-plugin
hacktoberfest mu-plugin pantheon wordpress
Last synced: 18 days ago
JSON representation
Pantheon's WordPress mu-plugin for all WordPress-based upstreams.
- Host: GitHub
- URL: https://github.com/pantheon-systems/pantheon-mu-plugin
- Owner: pantheon-systems
- License: mit
- Created: 2022-06-03T19:37:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T21:24:07.000Z (4 months ago)
- Last Synced: 2025-01-16T16:17:10.893Z (26 days ago)
- Topics: hacktoberfest, mu-plugin, pantheon, wordpress
- Language: PHP
- Homepage:
- Size: 219 KB
- Stars: 10
- Watchers: 10
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Pantheon Must-Use Plugin
[](https://docs.pantheon.io/oss-support-levels#actively-maintained-support)
[](https://github.com/pantheon-systems/pantheon-mu-plugin/actions/workflows/test.yml)
The Pantheon Must-Use Plugin has been designed to tailor the WordPress CMS experience for Pantheon's platform.
What does that mean? We're glad you asked!
## Features
### WebOps Workflow
**Integrates WordPress with Pantheon Worklow.** Encourages updating plugins and themes in the Development environment and using Pantheon's git-based upstream core updates. Alerts admins if an update is available but disables automatic updates (so those updates can be applied via the upstream).
### Login
**Customized login form.** The login page links back to the Pantheon dashboard on dev, test and live environments that do not have a domain attached.
### Edge Cache (Global CDN)
**Facilitates communication between Pantheon's Edge Cache layer and WordPress.** It allows you to set the default cache age, clear individual pages on demand, and it will automatically clear relevant urls when the site is updated. Authored by [Matthew Boynes](http://www.alleyinteractive.com/).
### WordPress Multisite Support
**Simplified multisite configuration.** The `WP_ALLOW_MULTISITE` is automatically defined on WordPress Multisite-based upstreams. The Network Setup pages and notices have been customized for a Pantheon-specific WordPress multisite experience.
### Maintenance Mode
**Put your site into a maintenance mode.** Prevent users from accessing your sites during major updates by enabling Maintenance Mode either in the WordPress admin or via WP-CLI.
### Compatibility Layer
**Ensure your WordPress website is compatible with Pantheon.** Automatically apply & report status of compatibility fixes for common issues that arise when running WordPress on Pantheon.
## Hooks
The Pantheon Must-Use Plugin provides the following hooks that can be used in your code:
### Filters
#### `pantheon_wp_login_text`
Filter the text displayed on the login page next to the Return to Pantheon button.
**Default Value:** `Log into your WordPress Site`
**Example:**
```php
add_filter( 'pantheon_wp_login_text', function() {
return 'Log into MySite.';
} );
```
#### `pantheon_cache_default_max_age`
Filter the default cache max-age for the Pantheon Edge Cache.
**Default Value:** `WEEK_IN_SECONDS` (604800)
**Example:**
```php
add_filter( 'pantheon_cache_default_max_age', function() {
return 2 * WEEK_IN_SECONDS;
} );
```
#### `pantheon_cache_do_maintenance_mode`
Allows you to modify the maintenance mode behavior with more advanced conditionals.
**Default Value:** Boolean, depending on whether maintenance mode is enabled, user is not on the login page and the action is not happening in WP-CLI.
```php
add_filter( 'pantheon_cache_do_maintenance_mode', function( $do_maintenance_mode ) {
if ( $some_conditional_logic ) {
return false;
}
return $do_maintenance_mode;
} );
```
#### `pantheon_cache_allow_clear_all`
Allows you to disable the ability to clear the entire cache from the WordPress admin. If set to `false`, this removes the "Clear Site Cache" section of the Pantheon Page Cache admin page.
**Default Value:** `true`
**Example:**
```php
add_filter( 'pantheon_cache_allow_clear_all', '__return_false' );
```
#### `pantheon_skip_cache_control`
Allows you to disable the cache control headers that are sent by the Pantheon Page Cache plugin.
**Default Value:** `false`
**Example:**
```php
add_filter( 'pantheon_skip_cache_control', '__return_true' );
```
#### `pantheon_compatibility_known_issues_plugins`
Allows you to filter plugins with known compatibility issues on Pantheon so they are excluded from the Site Health check.
**Default Value:** An array of plugins with known issues, e.g.:
```php
[
'big-file-uploads' => [
'plugin_status' => esc_html__( 'Manual Fix Required', 'pantheon' ),
'plugin_slug' => 'tuxedo-big-file-uploads/tuxedo_big_file_uploads.php',
'plugin_message' => wp_kses_post(
sprintf(
/* translators: %s: the link to relevant documentation. */
__( 'Read more about the issue here.', 'pantheon' ),
'https://docs.pantheon.io/plugins-known-issues#big-file-uploads'
)
),
],
'jetpack' => [
'plugin_status' => esc_html__( 'Manual Fix Required', 'pantheon' ),
'plugin_slug' => 'jetpack/jetpack.php',
'plugin_message' => wp_kses_post(
sprintf(
/* translators: %s: the link to relevant documentation. */
__( 'Read more about the issue here.', 'pantheon' ),
'https://docs.pantheon.io/plugins-known-issues#jetpack'
)
),
],
'wordfence' => [
'plugin_status' => esc_html__( 'Manual Fix Required', 'pantheon' ),
'plugin_slug' => 'wordfence/wordfence.php',
'plugin_message' => wp_kses_post(
sprintf(
/* translators: %s: the link to relevant documentation. */
__( 'Read more about the issue here.', 'pantheon' ),
'https://docs.pantheon.io/plugins-known-issues#wordfence'
)
),
],
]
```
**Example:**
```php
// Filter a specific plugin out of the known issues list.
add_filter( 'pantheon_compatibility_known_issues_plugins', function( $plugins ) {
if ( isset( $plugins['plugin-slug'] ) ) {
unset( $plugins['plugin-slug'] );
}
return $plugins;
} );
```
### Actions
#### `pantheon_cache_settings_page_top`
Runs at the top of the Pantheon Page Cache settings page.
**Example:**
```php
add_action( 'pantheon_cache_settings_page_top', function() {
echo '
My Custom Heading
';
} );
```
#### `pantheon_cache_settings_page_bottom`
Runs at the bottom of the Pantheon Page Cache settings page.
**Example:**
```php
add_action( 'pantheon_cache_settings_page_bottom', function() {
echo '
My Custom Footer
';
} );
```
## Install With Composer
**Built for Composer.** While Pantheon automation ensures that the latest version of the MU plugin are pushed with every update to WordPress, the Composer-based project ensures that you can manage it alongside your other WordPress mu-plugins, plugins and themes in your `composer.json`.
```bash
composer require pantheon-systems/pantheon-mu-plugin
```
--
Maintained by [Pantheon](https://pantheon.io) and built by the [community](https://github.com/pantheon-systems/pantheon-mu-plugin/graphs/contributors).
[Releases and Changelogs](https://github.com/pantheon-systems/pantheon-mu-plugin/releases)