Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hypeventures/woocommerce-memcached-full-page-cache
WooCommerce full page cache plugin based on Memcached.
https://github.com/hypeventures/woocommerce-memcached-full-page-cache
full-page-cache memcached woocommerce woocommerce-plugin wordpress
Last synced: 17 days ago
JSON representation
WooCommerce full page cache plugin based on Memcached.
- Host: GitHub
- URL: https://github.com/hypeventures/woocommerce-memcached-full-page-cache
- Owner: hypeventures
- License: gpl-3.0
- Created: 2019-04-15T15:07:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-25T13:27:05.000Z (over 3 years ago)
- Last Synced: 2024-08-01T12:18:02.350Z (4 months ago)
- Topics: full-page-cache, memcached, woocommerce, woocommerce-plugin, wordpress
- Language: PHP
- Size: 534 KB
- Stars: 3
- Watchers: 9
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# WooCommerce Memcached Full Page Cache
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://wordpress.org)
[](https://wordpress.org/news/category/releases/)
[](https://wordpress.org)
[](https://php.net)
[](https://www.php.net/manual/de/book.memcached.php)
WooCommerce full page cache plugin using Memcached. Allows full control which Products, Categories, Pages should be cleared without flushing the cache.
__CREDITS:__ This plugin is the spiritual successor of [WP-FFPC](https://github.com/petermolnar/wp-ffpc)
by [Peter Molnar](https://github.com/petermolnar).
## Table of contents
- [Copyright](#copyright)
- [License](#license)
- [Requirements](#requirements)
- [Installation](#installation)
- [Settings](#settings)
- [Customization](#customization)
- [Constants](#constants)
- [Globals](#globals)
- [Filter Hooks](#filter-hooks)
- [Action Hooks](#action-hooks)
- [Drop-In 'advanced-cache.php'](#example-default-advanced-cachephp)
- [NGINX](#nginx)
## Copyright
```text
WooCommerce Memcached Full Page Cache - FPC specialized for WooCommerece via PHP-Memcached.
Copyright (C) 2019 Achim Galeski ( [email protected] )
Based on: WP-FFPC - A fast, memory based full page cache plugin supporting APC or memcached.
Copyright (C) 2010-2017 Peter Molnar ( [email protected] )
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 3, as
published by the Free Software Foundation.
This program 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 General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA02110-1301USA
```
## License
GPL v3 - Please view [LICENSE](LICENSE.txt) document.
[](https://www.gnu.org/licenses/gpl-3.0)
## Requirements
__Requried:__
- A server running Memcached-Server.
- `libmemcached` on the Server that runs WordPress/WooCommerce.
- `php-memcached` on the Server that runs WordPress/WooCommerce.
- `PHP 7.x` any version 7 of PHP will do. I have not tested 5.6 yet.
__Optional:__
- `SASL` For authentication [SASL](https://github.com/memcached/memcached/wiki/SASLHowto) must be enabled.
## Installation
1. Upload contents of `woocommerce-memcached-full-page-cache.zip` (_OR clone this repository_) to the
`/wp-content/plugins/` directory of your wordpress installation.
2. Enable WordPress caching via adding `define('WP_CACHE', true);` in the file `wp-config.php`
3. Activate the plugin in WordPress
4. Check the settings in `WooCommerce` => `Full Page Cache` menu in your Wordpress admin backend.
5. __(!) Save the settings (!)__ to generate `/wp-content/advanced-cache.php` and activate caching.
As a side note: [How to install Memcached](https://www.techrepublic.com/article/how-to-install-and-enable-memcached-on-ubuntu-and-centos/)
## Settings
__Settings link:__ yourdomain.xyz/wp-admin/admin.php?page=wc-settings&tab=advanced§ion=full_page_cache
OR
__WP Admin__ => __WooCommerce__ => __Settings__ => _Advanced_ => _Full Page Cache_
Defaults:
```php
[
'hosts' => '127.0.0.1:11211',
'memcached_binary' => 'yes',
'authpass' => '',
'authuser' => '',
'expire' => '86400',
'browsercache' => '14400',
'prefix_meta' => 'meta-',
'prefix_data' => 'data-',
'charset' => 'utf-8',
'cache_loggedin' => 'yes',
'nocache_cookies' => '',
'nocache_woocommerce_url' => '^/DYNAMIC/|^/DYNAMIC/|^/DYNAMIC/|^/wc\\-api|^/\\?wc\\-api=',
'nocache_url' => '^/wc\\-|^/wp\\-|addons|removed|gdsr|wp_rg|wp_session|wc_session',
'response_header' => 'yes',
'comments_invalidate' => 'yes',
'pingback_header' => '0',
]
```
__hosts__
_Memcached server list Ip:Port,Ip2:Port2,Ip3:Port_
__memcached_binary__
_Enables binary connection mode (faster). However, in some cases this is not possible to use. Unchecked the plugin will
fall back to a ASCII mode (slower)._
__authpass__
_Stores the password for authentication with all hosts in the list. (!) SASL must be enabled._
__authuser__
_Stores the user for authentication with all hosts in the list. (!) SASL must be enabled._
__expire__
_The expire time of the cached entries in Memcached._
__browsercache__
_Used to determine modified since and when the Browser-cache of a given page should expire._
__prefix_meta__
_The prefix for meta-data keys in memcached. (!) Must be different than the data prefix or entries will be overwritten._
__prefix_data__
_The prefix for page content keys in memcached. (!) Must be different than the meta prefix or entries will be overwritten._
__charset__
_Used to set the charset header when a page is loaded from cache._
__cache_loggedin__
_Enable to load cached pages even for logged in customers/users. (!) Does NOT use cache for Admins._
__nocache_cookies__
_The place to define custom cookies which should prevent caching for users with the cookies provided here._
__nocache_woocommerce_url__
_Contains the regex to exclude WooCommerce API & default dynamic pages like checkout and cart. (!) Generated on save._
__nocache_url__
_Enter your own regex to exclude matches from caching._
__response_header__
_Enable to add the X-Cache response header if cache is loaded._
__comments_invalidate__
_Enable to trigger cache clearing on comment actions._
__pingback_header__
_Enable to preserve the PingBack header for cached pages._
## Customization
You can use hooks to customize the behaviour of this plugin.
### Constants:
- `WC_MFPC_PLUGIN_DIR`
- `WC_MFPC_PLUGIN_URL`
- `WC_MFPC_PLUGIN_FILE`
### Globals:
- `$wc_mfpc_config_array`
_Config array loaded via advanced-cache.php_
- `$wc_mfpc_memcached`
_Instance of [Memcached::class](src/Memcached.php) initiated in [wc-mfpc-advanced-cache.php](wc-mfpc-advanced-cache.php)_
- `$wcMfpcConfig`
_Instance of [WcMfpcConfig::class](src/Config.php) initiated in
[woocommerce-memcached-full-page-cache.php](woocommerce-memcached-full-page-cache.php)_
### Filter Hooks:
[wc-mfpc-advanced-cache.php](wc-mfpc-advanced-cache.php) :
- [wc_mfpc_custom_skip_load_from_cache](#hook-custom-skiploadfromcache)
- [wc_mfpc_custom_skip_caching](#hook-custom-skipcaching)
- [wc_mfpc_custom_cache_content](#hook-custom-cachecontent)
- [wc_mfpc_custom_cache_meta](#hook-custom-cachemeta)
[Memcached::class](src/Memcached.php) :
- [wc_mfpc_custom_build_url](#hook:-custom-buildurl)
- [wc_mfpc_custom_build_key](#hook:-custom-buildkey)
- [wc_mfpc_custom_build_keys](#hook:-custom-buildkeys)
- [wc_mfpc_custom_expire](#hook-custom-expire)
[Admin::class](src/Admin.php) :
- [wc_mfpc_custom_advanced_cache_config](#hook:-custom-advancedcacheconfig)
### Action Hooks:
[AdminView::class](src/AdminView.php) :
- `wc_mfpc_settings_form_top`
Lets you add your own fieldset at the beginning of the admin settings form.
- `wc_mfpc_settings_form_bottom`
Lets you add your own fieldset at the end of the adming settings form.
- `wc_mfpc_settings_form_memcached_connection`
Lets you add your own form fields to the fieldset of the memcached connection settings.
- `wc_mfpc_settings_form_cache`
Lets you add your own form fields to the fieldset of the cache settings.
- `wc_mfpc_settings_form_exception`
Lets you add your own form fields to the fieldset of the exception settings.
- `wc_mfpc_settings_form_debug`
Lets you add your own form fields to the fieldset of the debug settings.
---
#### Hook: Custom SkipLoadFromCache
* `wc_mfpc_custom_skip_load_from_cache`
This hook gives you control if a given uri should be processed by the advanced-cache or rather not.
Example #1:
```php
'))) {
$skip = true;
}
return $skip;
}
add_filter('wc_mfpc_custom_skip_caching', 'cust_wc_mfpc_set_skip_caching')
```
Example #2:
```php
')) {
$insertion = "\n\n";
$index = stripos($buffer, '