wescleveland

<h4>OVERVIEW</h4>
The strength of WordPress is in it’s ability to be customized through the use of extensions (plugins and themes).
The WP247 Extension Notification System provides a standard interface for WordPress extension developers to communicate important information about their extension to their extension users.
The Settings page provides you with complete control over which extensions the WP247 Extension Notification System will communicate with and which notices will continue to be displayed.
<h4>NOTICES</h4>
The WP247 Extension Notification System will display notices until they are dismissed. The extension developer assigns one of three dismissibility types to each notice they send:
<ul>
<li>None indicates that the notice is not dismissible. The dismiss button will not appear.</li>
<li>Temporary indicates that the notice will be temporarily dismissed when you click the dismiss button. Once dismissed, the notice will not appear until the next time the Admin page is refreshed.</li>
<li>Permanent indicates that the notice will be permanently dismissed when you click the dismiss button. Once dismissed, the notice will not appear again.</li>
</ul>
Regardless of the dimissibility setting chosen by the extension developer, you can permanently dismiss any notice by clicking the Permanently Dismiss link at the lower right of the notice or by checking the checkbox next to the notice title in the WP247 Extension Notification System‘s Settings section.
<h4>SETTINGS</h4>
The WP247 Extension Notification Server Settings page is where you tell the WP247 Extension Notification Server about your extension and notices.
Extension
The Extension section is where you identify your extension. This information will also be used in your extension’s code (see the API help topic for more information) when polled by the WP247 Extension Notification Client plugin to see which extensions are participating in Extension Notifications. The Extension settings are:
<ul>
<li>Extension Name: The name your extension is known as.</li>
<li>Extension Id: The slug used by your extension. This should match the directory name your extension get installed into.</li>
<li>Extension Type: The type of extention (Plugin or Theme).</li>
<li>Server URL: The URL that will respond to the WP247 Extension Notification Client plugin’s notice update inquiries.</li>
<li>Frequency: How often should the WP247 Extension Notification Client plugin’s inquire about new notice updates. </li>
</ul>
Notice
The Notice section is where you compose the notification message that is to be distributed to your extension’s users. The Notice settings are:
<ul>
<li>Status indicates whether or not the notice should currently be distributed when the WP247 Extension Notification Client plugin inquires about any notice updates.</li>
<li>Notice Title: The title of your notice. This will appear on the first line when the notice is displayed.</li>
<li>Notice Type: The type of notice. This will determine where the notice appears and what color the side border will be.</li>
<li>Dismissability: Whether or not the notice is dismissible and if so, temporarily or permanently. Regardless of this setting, the WP247 Extension Notification Client plugin will allow the client site to permanently dismiss any notice.</li>
<li>Duration: Identifies how long should this notice be displayed to the client.</li>
<li>Notice Content: The message you desire to send.</li>
</ul>
=API=
In order to use the WP247 Extension Notification System you must first configure your extension information. This will then be used in your extension to tell the WP247 Extension Notification System that your extension is participting in extension notifications.
You will then need to modify your extension so that it reaponds to the wp247xns_client_extension_poll filter.
First, you must modify your extension to tell WordPress that you are responding to the wp247xns_client_extension_poll filter:
<pre><code>add_filter( "wp247xns_client_extension_poll_{extension_type}_{extension_id}", "my_routine" );
</code></pre>
Then you must create a function in your extension to respond to the filter:
<pre><code>function my_routine( $extensions ) {
 return array(
 "name" => "Your Extension name",
 "id" => "your-extension-id",
 "type" => "plugin",
 "version" => "", // your extension's version number (not required)
 "server_url" => "http://your-extension-wordpress-url/wp-admin/admin-ajax.php",
 "frequency" => "1 day", // (not required) defaults to "1 day"
 );
}
</code></pre>
That’s it. The WP247 Extension Notification System will take care of the rest!
<h4>Co-requisite</h4>
One final note. In order for your users to receive your notices, they must have installed and activated the WP247 Extension Notification Client plugin. You may want to prompt your users to install and activate this plugin if it is not active at the time your extension is loaded. For your convenience, we have provided a standardized method for accomplishing this.
First, copy the /wp-content/plugins/wp247-extension-notification-server/admin/wp247xns-client-corequisite-notice folder to your extension’s Admin folder.
Next, modify your extension to instantiate the WP247XNS_Client_Corequisite_Notice class. Something like:
<pre><code>require_once 'wp247xns-client-corequisite-notice/wp247xns-client-corequisite-notice.php';
$my_wp247xns_client_corequisite_notice
 = new WP247XNS_Client_Corequisite_Notice( 'Your extension name' );
</code></pre>
The WP247XNS_Client_Corequisite_Notice class constructor takes from one to three parameters:
<pre><code>WP247XNS_Client_Corequisite_Notice(
 $extension_name,
 $nag_frequency = '30 days',
 $text_domain = 'wp247xns-client-corequisite-notice'
);
</code></pre>
This will result in a notice being displayed to your extension’s users when either the WP247 Extension Notification Client plugin is not activated or your particular extension is not enabled to participate in the WP247 Extension Notification System. They will be able to dismiss the nottice, but it will be re-displayed after the nag frequency has passed.
<h4>Privacy Policy</h4>
Rest assured that the WP247 Extension Notification System does not capture any information about your site and does not send any information about your site when servers are polled for new notices.
In addition, the WP247 Extension Notification System does not capture any information from the client’s site.

WP247 Extension Notification Server

Provides the ability for WordPress extension developers to send notification messages to their users

<h4>OVERVIEW</h4>
The strength of WordPress is in it’s ability to be customized through the use of extensions (plugins and themes).
The WP247 Extension Notification System provides a standard interface for WordPress extension developers to communicate important information about their extension to their extension users.
The Settings page provides you with complete control over which extensions the WP247 Extension Notification System will communicate with and which notices will continue to be displayed.
<h4>NOTICES</h4>
The WP247 Extension Notification System will display notices until they are dismissed. The extension developer assigns one of three dismissibility types to each notice they send:
<ul>
<li>None indicates that the notice is not dismissible. The dismiss button will not appear.</li>
<li>Temporary indicates that the notice will be temporarily dismissed when you click the dismiss button. Once dismissed, the notice will not appear until the next time the Admin page is refreshed.</li>
<li>Permanent indicates that the notice will be permanently dismissed when you click the dismiss button. Once dismissed, the notice will not appear again.</li>
</ul>
Regardless of the dimissibility setting chosen by the extension developer, you can permanently dismiss any notice by clicking the Permanently Dismiss link at the lower right of the notice or by checking the checkbox next to the notice title in the WP247 Extension Notification Client‘s Settings section.
<h4>SETTINGS</h4>
Use the Settings page to control how the WP247 Extension Notification System operates on your site.
Site-wide Extension Notifications
Checking the Disable Extension Notifications for the entire site checkbox will stop the WP247 Extension Notification System from checking for new notices and from displaying any notices that have not been dismissed.
New Extensions
As a security measure, by default, new extensions are disabled from using the WP247 Extension Notification System. You may opt-in to allowing new extensions to be enabled to use the WP247 Extension Notification System at the time they are activated by checking the Automatically enable Extension Notifications for new extensions when they are activated checkbox. Otherwise, each individual extension may be enabled or disabled as you choose by unchecking or checking the Disable extension notifications for… checkbox within the individual extension’s settings.
Individual Extension Notifications
Each plugin or theme that uses the WP247 Extension Notification System is listed in the Individual Extension Notifications section. For each extension you can:
<ul>
<li>Immediately cease the periodic checking for new notices, and discontinue displaying any notices that have not already been dismissed by checking the Disable extension notifications for… checkbox.</li>
<li>View the extension’s status by clicking the Status link under the extension name.</li>
<li>Refresh the extension’s notices by clicking the Refresh link under the extension name. This will result in the deletion of all notices and then calling the extension’s server to retrieve any outstanding notices if the extension is enabled to use the WP247 Extension Notification System.</li>
<li>Reset the extension by clicking the Reset link under the extension name. This will result in the deletion of the extension from within the WP247 Extension Notification System‘s settings. The extension will then be re-added using default settings and, if the Automatically enable Extension Notifications for new extensions when they are activated checkbox is checked, the extension will be re-enabled to use the WP247 Extension Notification System.</li>
<li>Change the frequency that periodic checking for new notices will be performed by entering a new value in the box under the Override how often to check for new notices label. You can enter values like:
<ul>
<li>“8 hours” to check once every 8 hours</li>
<li>“2 days” to check once every other day</li>
<li>“1 week” to check once each week</li>
</ul>
</li>
<li>Permanently dismiss individual notices that have not already been dismissed by checking the checkbox next to the notice title.</li>
<li>View individual notices by clicking the View Notice link under the notice title.</li>
<li>Refresh all extensions’ notices by clicking the Refresh All button. This will result in the deletion of all notices for all extensions and then calling all extensions’ servers to retrieve any outstanding notices for those extensions that are enabled to use the WP247 Extension Notification System.</li>
<li>Reset all extensions by clicking the Reset All button. This will result in the deletion of all extensions from within the WP247 Extension Notification System‘s settings. The extensions will then be re-added using default settings and, if the Automatically enable Extension Notifications for new extensions when they are activated checkbox is checked, the extensions will be re-enabled to use the WP247 Extension Notification System.</li>
</ul>
<h4>PRIVACY POLICY</h4>
Occasionally, the WP247 Extension Notification System will contact participating extension’s servers in order to see if they have any new notices for your review. The only data sent to their server is the ID of their extension, and the last time we contacted their server. As an example, the WP247 Extension Notification Client‘s extension id is wp247-extension-notification-client.
Rest assured that the WP247 Extension Notification System does not capture any information about your site and does not send any information about your site when servers are polled for new notices.
In addition, you can control which extensions that use the WP247 Extension Notification System may or may not be enabled to participate in issuing you notices.

WP247 Extension Notification Server vs WP247 Extension Notification Client