Takayuki Miyauchi

Okamoto Hidetaka

AMIMOTO

DigitalCube Inc.

wokamoto

John Blackbourn

Bartosz Gadomski

Hinaloe

Sander van Dragt

jepser

<p>This is simple plugin that clear all cloudfront cache if you publish posts.<br />
You can easy use CloudFront in front of WordPress.</p>
<h3>Fixtures</h3>
<ul>
<li>
<p>wp_is_mobile()<br />
Check device viewer type by CloudFront header.<br />
Now supports <code>HTTP_CLOUDFRONT_IS_MOBILE_VIEWER</code> and <code>HTTP_CLOUDFRONT_IS_TABLET_VIEWER</code>.</p>
</li>
<li>
<p>preview url<br />
In preview page, plugin add <code>post_date</code> query to avoid CloudFront cache.<br />
And set <code>wordpress_loginuser_last_visit</code> cookie for avoid CloudFront cache too.</p>
</li>
</ul>
<p>The <code>wordpress_loginuser_last_visit</code> cookie will be removed if user sign out.</p>
<h4>Invalidation(Clear Cache) Page URL</h4>
<p>This plugin send following page url to CloudFront Invalidation API.</p>
<ul>
<li>TOP page URL</li>
<li>Published Post Page URL</li>
<li>Category Archive Page URL</li>
</ul>
<h3>AWS IAM Policy Example</h3>
<pre><code>{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "cloudfront:GetDistribution",
                "cloudfront:ListInvalidations",
                "cloudfront:GetStreamingDistribution",
                "cloudfront:GetDistributionConfig",
                "cloudfront:GetInvalidation",
                "cloudfront:CreateInvalidation"
            ],
            "Effect": "Allow",
            "Resource": "*"
        }
    ]
}
</code></pre>
<p><strong>Note:</strong> The <code>cloudfront:GetInvalidation</code> permission is required for viewing detailed invalidation information. If this permission is not granted, the detail view feature will be disabled gracefully without affecting other plugin functionality.</p>
<h3>Adding your configuration through env vars</h3>
<p>The plugin can be configured by defining the following variables:</p>
<ul>
<li><code>AWS_ACCESS_KEY_ID</code></li>
<li><code>AWS_SECRET_ACCESS_KEY</code></li>
<li><code>C3_DISTRIBUTION_ID</code></li>
</ul>
<p>You can put these variables like the code into the wp-config.php</p>
<pre><code>php
define( 'AWS_ACCESS_KEY_ID', '' );
define( 'AWS_SECRET_ACCESS_KEY', '' );
define( 'C3_DISTRIBUTION_ID', '' );
</code></pre>
<h3>Cookie</h3>
<p>This plugin set a Cookie named <code>wordpress_loginuser_last_visit</code> to the user.<br />
It prevents CDN caching when the user is previewing his posts or contents.<br />
Once logging out from Dashboard, plugin removes this cookie from user.</p>
<h3>7.1.0</h3>
<ul>
<li>[Feature] Add invalidation detail view with modal popup showing invalidation paths, caller reference, and status</li>
<li>[Fix] Fix invalid path returned for post type without archive page</li>
</ul>
<h3>7.0.1</h3>
<ul>
<li>[Update] Improved AWS API call processing for better security and PHP 8.x compatibility</li>
</ul>
<h3>7.0.0</h3>
<ul>
<li>[Breaking Change] Remove AWS SDK dependency and implement custom HTTP CloudFront API client</li>
<li>[Update] Add comprehensive invalidation logging with c3_log_invalidation_list filter</li>
<li>[Update] Add configurable CloudFront region and HTTP timeout settings</li>
</ul>
<h3>6.1.6</h3>
<ul>
<li>[Fix] Fixed PHP 8 syntax errors by adding nullable type hints</li>
<li>[Fix] Fixed deprecation warnings about creation of dynamic properties in Invalidation_Service.php</li>
<li>[Fix] Fixed deprecation warnings about creation of dynamic properties in Cron_Service.php</li>
<li>[Fix] Fixed PHP 7.4 syntax errors in test files</li>
</ul>
<h3>6.1.5</h3>
<ul>
<li>[Fix] Changed to install the AWS SDK using composer instead of aws.phar.</li>
</ul>
<h3>6.1.4</h3>
<ul>
<li>[Update] Support post_type_archive_link</li>
</ul>
<h3>6.1.3</h3>
<ul>
<li>[Fix] Lost filter c3_invalidation_items From v6.0.0</li>
</ul>
<h3>6.1.2</h3>
<ul>
<li>[Fix] php version compare issue</li>
</ul>
<h3>6.1.1</h3>
<ul>
<li>[Fix] Plugin deactivation issue</li>
</ul>
<h3>6.1.0</h3>
<ul>
<li>[Update] Flush cache by post_ids</li>
</ul>
<h3>6.0.0</h3>
<ul>
<li>[Breaking Change] Re-write entire code</li>
<li>[Update] Add <code>c3_log_cron_invalidation_task</code> filter to show cron job Logs</li>
<li>[Update] Add <code>c3_aws_sdk_path</code> filter to change or remove bundled AWS SDK path</li>
</ul>
<h3>5.5.1</h3>
<ul>
<li>[Update] Replace the top level menu with a Settings submenu</li>
</ul>
<h4>5.5.0</h4>
<ul>
<li>[Update] Can use defined variables for AWS Credentials</li>
</ul>
<h4>5.4.2</h4>
<ul>
<li>[Bug fix] Set cookie path in preview page</li>
</ul>
<h4>5.4.1</h4>
<ul>
<li>[Bug fix] Undefined Paths index in invalidation query cron event</li>
</ul>
<h4>5.4.0</h4>
<ul>
<li>[Update] Update preview fix plugin</li>
</ul>
<h4>5.3.4</h4>
<ul>
<li>[Bug fix] Small bug fix</li>
</ul>
<h4>5.3.3</h4>
<ul>
<li>[Change SDK] replace sdk</li>
</ul>
<h4>5.3.2</h4>
<ul>
<li>[Bug fix] Use EC2 role if using as AMIMOTO Managed hosting</li>
</ul>
<h4>5.3.1</h4>
<ul>
<li>[Add filter] Can select AWS SDK version by filter</li>
</ul>
<h4>5.3.0</h4>
<ul>
<li>[Update SDK] Use AWS SDK v3 when you using php 5.6 or later</li>
</ul>
<h4>5.2.1</h4>
<ul>
<li>[For AMIMOTO Managed] bug fix to run by WP-CLI</li>
</ul>
<h4>5.2.0</h4>
<ul>
<li>[Add filter] We can disable to register wp-cron that retry request invalidation.</li>
<li>[Readme] Update readme to see IAM Policy example.</li>
</ul>
<h4>5.1.0</h4>
<ul>
<li>[Update preview fixture] Set cookie to avoid CloudFront cache if user sign in</li>
<li>[Update preview fixture] Unset cookie for avoide CloudFront cache if user sign out</li>
</ul>
<h4>5.0.0</h4>
<ul>
<li>Support CloudFront viewer params on <code>wp_is_mobile()</code>.(4.9.0 or later)</li>
</ul>
<h4>4.4.0</h4>
<ul>
<li>Fix small bug</li>
<li>Add some feature for AMIMOTO Managed hosting user</li>
</ul>
<h4>4.3.1</h4>
<ul>
<li>Fix cron interval</li>
<li>add filters <code>'c3_invalidation_interval</code>, <code>c3_invalidation_cron_interval</code>, <code>c3_invalidation_item_limits</code>.</li>
<li>update default invalidation interval & items.</li>
</ul>
<h4>4.3.0</h4>
<ul>
<li>Schedule cron event if you published many post at the same time</li>
</ul>
<h4>4.2.1</h4>
<ul>
<li>Fix ‘c3_credential’ filter position</li>
</ul>
<h4>4.2.0</h4>
<ul>
<li>Support AMIMOT Dashboard</li>
</ul>
<h4>4.1.0</h4>
<ul>
<li>Show Invalidation Logs</li>
</ul>
<h4>4.0.3</h4>
<ul>
<li>Auto Deploy by Travis</li>
</ul>
<h4>4.0.2</h4>
<ul>
<li>Add WP-CLI param check ( wp c3 flush)</li>
<li>change transient_key</li>
</ul>
<h4>4.0.1</h4>
<ul>
<li>Bug fix ( conflict Nephila Clavata )</li>
</ul>
<h4>4.0.0</h4>
<ul>
<li>Support AWS SDK Version3</li>
<li>Remove action hook -> ‘c3_add_setting_before’<br />
use ‘c3_after_title’ filter hook instead.</li>
<li>Remove action hook -> ‘c3_add_setting_after’<br />
use ‘c3_after_auth_form’ filter hook instead.</li>
</ul>
<h4>3.0.0</h4>
<ul>
<li>Include CF Preview Fix plugin</li>
<li>Rename</li>
</ul>
<h4>2.4.3</h4>
<ul>
<li>Fix Catch Exception BUG</li>
</ul>
<h4>2.4.2</h4>
<ul>
<li>Fix CLI BUG</li>
</ul>
<h4>2.4.1</h4>
<ul>
<li>Fix CLI BUG</li>
</ul>
<h4>2.4.0</h4>
<ul>
<li>Add WP-CLI Command ( Update Settings )</li>
</ul>
<h4>2.3.0</h4>
<ul>
<li>Add WP-CLI Command</li>
</ul>
<h4>2.2.2</h4>
<ul>
<li>Force Invalidation</li>
</ul>
<h4>2.2.1</h4>
<ul>
<li>Fix Typo</li>
</ul>
<h4>2.2.0</h4>
<ul>
<li>Add Filter for using EC2 Instance Role.</li>
<li>Translationable in t.w.org</li>
</ul>
<h4>2.1.1</h4>
<ul>
<li>Fix too many invalidation url error.</li>
</ul>
<h4>2.1.0</h4>
<ul>
<li>Add hook to customize invalidation URL</li>
<li>support new invalidation url, terms.</li>
<li>Manualy invalidation button added</li>
</ul>
<h4>2.0.2</h4>
<ul>
<li>Change AWS SDK</li>
<li>code refactoring by wokamoto</li>
<li>Invalidation URL</li>
</ul>
<h4>2.0.1</h4>
<ul>
<li>Change AWS SDK</li>
<li>code refactoring by wokamoto</li>
<li>Invalidation URL</li>
</ul>
<h4>1.0</h4>
<ul>
<li>Initial released.</li>
</ul>
<h3>6.1.0</h3>
<ul>
<li>[Fix] Plugin deactivation issue</li>
</ul>


C3 Cloudfront Cache Controller

This is simple plugin that clear all cloudfront cache if you publish posts.

Kevin Burkholder

<p><em>{eac}SimpleCDN</em> is an <a href="https://eacDoojigger.earthasylum.com/" rel="nofollow ugc">{eac}Doojigger</a> extension which rewrites the URLs on your site’s front-end pages so that specific content is loaded from your Content Delivery Network rather than your WordPress server.</p>
<blockquote>
<p>What is a CDN?<br />
  A content delivery network, or content distribution network, is a geographically distributed network of proxy servers and their data centers. The goal is to provide high availability and performance by distributing the service spatially relative to end users. <a href="https://en.wikipedia.org/wiki/Content_delivery_network" rel="nofollow ugc">Wikipedia</a></p>
</blockquote>
<p>{eac}SimpleCDN is not a content delivery network. What it does is filter your web pages replacing local http addresses with the address of your CDN so that your site assets (images, scripts, etc.) are served from your CDN rather than directly from your web server.</p>
<p>You can specify what file types should be served from the CDN and add url string exclusions to prevent specific urls from being served from the CDN.</p>
<p>{eac}SimpleCDN works with Amazon CloudFront, KeyCDN, Akamai ION, RocketCDN, StackPath, Rackspace, Azure CDN<br />
and many other Content Delivery Networks as well as many cloud storage services such as Amazon S3 or Google Cloud Storage.</p>
<p>If you’re using CloudFront and you have the <a href="https://dev.earthasylum.net/eacsimpleaws/" rel="nofollow ugc">{eac}SimpleAWS</a> extension enabled, you can flush the CDN cache (invalidate the distribution) by providing your CloudFront distribution id.</p>
<p>If you’re using any other supported CDN, you can flush the CDN cache by providing your API credentials specific to the CDN you’re using.</p>
<p>Unsupported, or <em>Universal</em> CDNs will work just as well with {eac}SimpleCDN provided that the CDN will store and serve all cacheable site content in a directory structure matching your web server. The only difference is that the API to purge the CDN cache has not been implemented (yet).</p>
<p>If the CDN service does not automatically retrieve files from your origin server, you will need to upload all cacheable files from your web server to the CDN storage or use some other method to synchronize your files.</p>
<h4>Extra Options</h4>
<p>The extra options include:</p>
<ul>
<li><em>Additional Domains</em> treated as local domain(s), useful with multi-site and/or when your CDN has multiple origins.</li>
<li><em>Cacheable Downloads</em> additional file type(s) to be rewitten with the CDN host.</li>
<li><em>Page Inclusions</em> to only include specific page URIs based on string(s) in the URI.</li>
<li><em>URL Inclusions</em> to limit URLs on the page to be rewritten by string(s) in the URL.</li>
</ul>
<p>To enable the extra options, first enable the <em>SimpleCDN Menu</em> option, then select <em>Enable Extra Options</em> from the <em>SimpleCDN</em> menu.</p>
<h4>Network/Multisite</h4>
<p>On a multi-site server, when {eac}SimpleCDN is <em>network enabled</em>, the network administrator has the option to push settings to all individual sites. The individual site administrators have the option to pull settings from the network administrator.</p>
<h4>Available Methods</h4>
<pre><code>flush_cdn_cache() tells {eac}SimpleCDN to flush the cdn cache (if supported).
</code></pre>
<h4>Available Filters</h4>
<pre><code>SimpleCDN_page_enabled enable/disable use of cdn on current page.

SimpleCDN_file_types filter string of included file types (delimited by '|').

SimpleCDN_include_strings filter string of included strings (delimited by '|').

SimpleCDN_exclude_strings filter string of excluded strings (delimited by '|').
</code></pre>
<h4>Available Actions</h4>
<pre><code>SimpleCDN_flush_cache tells SimpleCDN to flush the cdn cache (if supported).

SimpleCDN_cache_flushed triggered when SimpleCDN has flushed the cdn cache.
</code></pre>
<p><strong>Universal CDNs</strong></p>
<p>A <em>Universal</em> CDN is a CDN not fully supported by {eac}SimpleCDN and is treated universally. No additional options, no purge API is included.</p>
<p>With your custom code and the following filters, additional options and purging may be added.</p>
<pre><code>SimpleCDN_add_settings add additional option fields to the settings page.

SimpleCDN_add_help add additional contextual help.

SimpleCDN_purge_cdn_cache adds support for and custom method to flush (purge) the CDN cache.
</code></pre>
<p>This is a special-use case for <em>Universal</em> CDNs where custom code can be added to both indicate that the cache can be purged and to provide the method for doing the purge. When this hook has an action, the “Purge” button and menu items are automatically added. The hook should be added on or before the <code>admin_init</code> action.</p>
<p>See the <a href="#examples" rel="nofollow ugc">examples</a> for more detail.</p>
<h4>HTTP Headers</h4>
<p>An http request may include a header to disable the CDN…</p>
<pre><code>x-Simple-CDN: off
</code></pre>
<p>{eac}SimpleCDN includes an http response header…</p>
<pre><code>x-Simple-CDN: on
</code></pre>
<h4>Important Notes</h4>
<ul>
<li>
<p><em>Time To First Byte (TTFB) may be slightly longer.</em> Your pages are not being served by your CDN and {eac}SimpleCDN captures and buffers the page, then rewrites the asset URLs in the page, before any content is delivered to the browser. Although {eac}SimpleCDN endevores to do this as quickly and efficiently as possible, doing it takes a little more time than not doing it.</p>
</li>
<li>
<p><em>Load time may be deceiving.</em> For example, my business network and my web server are in the same zone as the closest CDN edge server (maybe in the same datacenter). Checking load times with and without the CDN from my location produces negligible difference. However, the CDN produces significant load time reduction in more distant zones.</p>
</li>
</ul>
<h4>Results</h4>
<p>You can test your results here: <a href="https://pagespeed.web.dev/" rel="nofollow ugc">PageSpeed Insights</a></p>
</p>
<h3>Examples</h3>
<h4>All CDNs</h4>
<pre><code>// disable CDN use
\add_filter('SimpleCDN_page_enabled','__return_false');


// flush the cdn cache (if supported)
\do_action('SimpleCDN_flush_cache');
// or...
if ($cdn = $this->getExtension('Simple_CDN')) {
    $cdn->flush_cdn_cache();
}


// do action whenever the cdn cache is flushed
\add_action('SimpleCDN_cache_flushed', 'my_cdn_flushed', 10, 2);

/**
 * After purging the CDN cache
 *
 * @param   object      $cdn        provider object
 *          object      $cdn->parent    the SimpleCDN class object
 *          string      $cdn->endpoint  e.g. c2nnnn.r10.cf1.rackcdn.com/path
 *          string      $cdn->hostname  e.g. c2nnnn.r10.cf1.rackcdn.com
 *          string      $cdn->bucket    e.g. c2nnnn
 *          string      $cdn->host      e.g. r10.cf1.rackcdn.com
 *          string      $cdn->domain    e.g. rackcdn.com
 *          string      $cdn->provider  e.g. Rackspace
 * @param   string|bool $context    context ('purge_button'|'purge_menu') or false (non-interactive)
 */
function my_cdn_flushed($cdn,$context)
{
    $cdn->admin_success($context,"Success: The CDN purge is in progress");
}


// limit the file types being cached by the CDN
\add_filter('SimpleCDN_file_types', function($types)
    {
        return '.css|.jpeg|.jpg|.js|.png|.webp';
    }
);


// add plugins folder to excluded strings
\add_filter('SimpleCDN_exclude_strings', function($exclude)
    {
        return $exclude . '|/plugins/';
    }
);
</code></pre>
<h4>Universal CDNs</h4>
<pre><code>// add additional settings fields
\add_filter( 'SimpleCDN_add_settings', 'my_add_cdn_fields', 10, 2 );

/**
 * Add custom options/settings
 *
 * @param   array       $options    array()
 * @param   object      $cdn        provider object
 *          object      $cdn->parent    the SimpleCDN class object
 *          string      $cdn->endpoint  e.g. c2nnnn.r10.cf1.rackcdn.com/path
 *          string      $cdn->hostname  e.g. c2nnnn.r10.cf1.rackcdn.com
 *          string      $cdn->bucket    e.g. c2nnnn
 *          string      $cdn->host      e.g. r10.cf1.rackcdn.com
 *          string      $cdn->domain    e.g. rackcdn.com
 *          string      $cdn->provider  e.g. Rackspace
 */
function my_add_cdn_fields($options,$cdn)
{
    $options['simple_cdn_universal_key'] = array(
            'type'      =>  'text',
            'label'     =>  'API Key',
            'info'      =>  'Your '.$cdn->provider.' API key',
    );
    return $options;
}


// add custom code to flush/purge the CDN
\add_action( 'admin_init',  function()
{
    \add_action( 'SimpleCDN_purge_cdn_cache', 'my_purge_cdn_cache', 10, 2 );
});

/**
 * Purge the CDN cache (custom)
 *
 * @param   object      $cdn        provider object
 *          object      $cdn->parent    the SimpleCDN class object
 *          string      $cdn->endpoint  e.g. c2nnnn.r10.cf1.rackcdn.com/path
 *          string      $cdn->hostname  e.g. c2nnnn.r10.cf1.rackcdn.com
 *          string      $cdn->bucket    e.g. c2nnnn
 *          string      $cdn->host      e.g. r10.cf1.rackcdn.com
 *          string      $cdn->domain    e.g. rackcdn.com
 *          string      $cdn->provider  e.g. Rackspace
 * @param   string|bool $context    context ('purge_button'|'purge_menu') or false (non-interactive)
 */
function my_purge_cdn_cache($cdn,$context)
{
    if ($apiKey = $cdn->get_option('simple_cdn_universal_key'))
    {
        /* code to purge the cdn cache */
    }

    if (/* error condition */)
    {
        $cdn->admin_error($context,"Error: status {$status}, " . $message);
    }
    else
    {
        $cdn->admin_success($context,"Success: The CDN purge is in progress");
    }
}= Additional Information =
</code></pre>
<ul>
<li>{eac}SimpleCDN is an extension plugin to and requires installation and registration of <a href="https://eacDoojigger.earthasylum.com/" rel="nofollow ugc">{eac}Doojigger</a>.</li>
</ul>
<h3>Copyright</h3>
<h4>Copyright © 2023-2025, EarthAsylum Consulting, distributed under the terms of the GNU GPL.</h4>
<p>This program 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 3 of the License, or (at your option) any later version.</p>
<p>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.</p>
<p>You should receive a copy of the GNU General Public License along with this program. If not, see <a href="https://www.gnu.org/licenses/" rel="nofollow ugc">https://www.gnu.org/licenses/</a>.</p>


{eac}Doojigger Simple CDN Extension for WordPress

{eac}SimpleCDN enables the use of Content Delivery Network assets on your WordPress site, significantly decreasing your page load times and improving  …

C3 Cloudfront Cache Controller vs {eac}Doojigger Simple CDN Extension for WordPress