Last active
December 16, 2020 07:15
-
-
Save westonruter/1a63d052beb579842461f6ad837715fb to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
/** | |
* Plugin Name: Basic Site Caching | |
* | |
* @package Basic_Site_Caching | |
* @author Weston Ruter, Google | |
* @license GPL-2.0-or-later | |
* @copyright 2019 Google Inc. | |
* | |
* @wordpress-plugin | |
* Plugin Name: Basic Site Caching | |
* Description: Demonstration of default configuration for how to enable offline support for a theme. | |
* Plugin URI: https://gist.github.com/westonruter/1a63d052beb579842461f6ad837715fb | |
* Version: 0.1.4 | |
* Author: Weston Ruter, Google | |
* Author URI: https://weston.ruter.net/ | |
* License: GNU General Public License v2 (or later) | |
* License URI: http://www.gnu.org/licenses/gpl-2.0.html | |
* Gist Plugin URI: https://gist.github.com/westonruter/1a63d052beb579842461f6ad837715fb | |
*/ | |
namespace Basic_Site_Caching; | |
// Enable network-first caching strategy for navigation requests (i.e. clicking around the site). | |
add_filter( | |
'wp_service_worker_navigation_caching_strategy', | |
function () { | |
return \WP_Service_Worker_Caching_Routes::STRATEGY_NETWORK_FIRST; | |
} | |
); | |
// Hold on to a certain number of navigated pages in the cache. | |
add_filter( | |
'wp_service_worker_navigation_caching_strategy_args', | |
function ( $args ) { | |
$args['cacheName'] = 'pages'; | |
$args['networkTimeoutSeconds'] = 2; | |
$args['plugins']['expiration']['maxEntries'] = 20; | |
return $args; | |
} | |
); | |
// Cache theme assets with runtime network-first caching strategy. This includes both the parent theme and child theme. | |
add_action( | |
'wp_front_service_worker', | |
function ( \WP_Service_Worker_Scripts $scripts ) { | |
$theme_directory_uri_patterns = [ | |
preg_quote( trailingslashit( get_template_directory_uri() ), '/' ), | |
]; | |
if ( get_template() !== get_stylesheet() ) { | |
$theme_directory_uri_patterns[] = preg_quote( trailingslashit( get_stylesheet_directory_uri() ), '/' ); | |
} | |
$scripts->caching_routes()->register( | |
'^(' . implode( '|', $theme_directory_uri_patterns ) . ').*', | |
array( | |
'strategy' => \WP_Service_Worker_Caching_Routes::STRATEGY_NETWORK_FIRST, | |
'cacheName' => 'theme-assets', | |
'plugins' => array( | |
'expiration' => array( | |
'maxEntries' => 25, // Limit the cached entries to the number of files loaded over network, e.g. JS, CSS, and PNG. | |
), | |
), | |
) | |
); | |
} | |
); | |
// Add caching for uploaded images. | |
add_action( | |
'wp_front_service_worker', | |
function ( \WP_Service_Worker_Scripts $scripts ) { | |
$upload_dir = wp_get_upload_dir(); | |
/* | |
* Note that the path alone is used because CDN plugins may load from another domain. For example, given an | |
* uploaded image located at: | |
* https://example.com/wp-content/uploads/2020/04/foo.png | |
* Jetpack can change rewrite the URL to be: | |
* https://i2.wp.com/example.com/wp-content/uploads/2020/04/foo.png?fit=900%2C832&ssl=1 | |
* Therefore, the following will include any URL ending in an image file extension which also is also | |
* preceded by '/wp-content/uploads/'. | |
*/ | |
$scripts->caching_routes()->register( | |
'^(.*' . preg_quote( wp_parse_url( $upload_dir['baseurl'], PHP_URL_PATH ), '/' ) . ').*\.(png|gif|jpg|jpeg|svg|webp)(\?.*)?$', | |
array( | |
'strategy' => \WP_Service_Worker_Caching_Routes::STRATEGY_CACHE_FIRST, | |
'cacheName' => 'uploads', | |
'plugins' => array( | |
'expiration' => array( | |
'maxAgeSeconds' => MONTH_IN_SECONDS, | |
), | |
), | |
) | |
); | |
} | |
); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Proposed for merging into the PWA plugin here: