Weston Ruter

Payton Swick

<p><em>Important note:</em> This project was first started before the Gutenberg feature plugin was started. As such, the JS Widgets plugin should now be considered a <em>prototype</em> which may inform the way that widget <em>blocks</em> get implemented in Gutenberg. This plugin will no longer be actively developed.</p>
<p>Also could be known as Widget Customizer 2.0, Widgets 3.0, or Widgets Next Generation.</p>
<p><em>Warning:</em> The APIs provided by this plugin are still in flux. If creating new widgets that extend the <code>WP_JS_Widget</code> class, please look at the changelog and ensure compatibility with your extended widgets before deploying.</p>
<p>This plugin implements:</p>
<ul>
<li><a href="https://core.trac.wordpress.org/ticket/33507" rel="nofollow ugc">WP-CORE#33507</a>: Allow widget controls to be JS-driven.</li>
<li><a href="https://core.trac.wordpress.org/ticket/35574" rel="nofollow ugc">WP-CORE#35574</a>: Add REST API JSON schema information to WP_Widget.</li>
<li><a href="https://github.com/WP-API/WP-API/issues/19" rel="nofollow ugc">WP-API#19</a>: Add widget endpoints to the WP REST API.</li>
</ul>
<p>Features:</p>
<ul>
<li>Integrates with <a href="https://wordpress.org/plugins/shortcode-ui/" rel="ugc">Shortcake (Shortcode UI)</a> to allow all JS widgets to be made available as Post Elements in the editor.</li>
<li>Widget instance settings in the Customizer are exported from PHP as regular JSON without any PHP-serialized base64-encoded <code>encoded_serialized_instance</code> anywhere to be seen.</li>
<li>Previewing widget changes in the customizer is faster since the <code>update-widget</code> Ajax request can be eliminated since the JS control can directly manipulate the widget instance data.</li>
<li>Widgets control forms use JS content templates instead of PHP to render the markup for each control, reducing the weight of the customizer load, especially when there are a lot of widgets in use.</li>
<li>Widgets that extend <code>WP_JS_Widget</code> will editable from both the customizer and the widgets admin page using the same <code>Form</code> JS interface. This <code>Form</code> is also able to be embedded in other contexts, like on the frontend and as a Shortcake (Shortcode UI) form. See <a href="https://github.com/xwp/wp-js-widgets/issues/11" rel="nofollow ugc">#11</a>.</li>
<li>Widgets employ the JSON Schema from the REST API to define an instance with validation and sanitization of the instance properties, beyond also providing <code>validate</code> and <code>sanitize</code> methods that work on the instance array as a whole.</li>
<li>A widget instance can be blocked from being saved by returning a <code>WP_Error</code> from its <code>validate</code> or <code>sanitize</code> method. For example, the RSS widget will show an error message if the feed URL provided is invalid and the widget will block from saving until the URL is corrected.</li>
<li>Widgets are exposed under the <code>js-widgets/v1</code> namespace, for example to list all Recent Posts widgets via the <code>/js-widgets/v1/widgets/recent-posts</code> or to get the Text widget with the “ID” (number) of 6, <code>/js-widgets/v1/widgets/text/6</code>.</li>
<li>Customizer settings for widget instances (<code>widget_{id_base}[{number}]</code>) are directly mutated via JavaScript instead of needing to do an <code>update-widget</code> Admin Ajax roundtrip; this greatly speeds up previewing.</li>
<li>Widget control forms can be extended to employ any JS framework for managing the UI, allowing Backbone, React, or any other frontend technology to be used.</li>
<li>Compatible with widgets stored in a custom post type instead of options, via the Widget Posts module in the <a href="https://github.com/xwp/wp-customize-widgets-plus" rel="nofollow ugc">Customize Widgets Plus</a> plugin.</li>
<li>Compatible with <a href="https://github.com/xwp/wp-customize-snapshots" rel="nofollow ugc">Customize Snapshots</a>, allowing changes made in the Customizer to be applied to requests for widgets via the REST API.</li>
<li>Includes adaptations of all core widgets using the new <code>WP_JS_Widget</code> API.</li>
<li>The adapted core widgets include additional raw data in their REST API item responses so that JS can render them client-side.</li>
<li>The Notifications API is utilized to display warnings when a user attempts to provide markup in a core widget title or illegal HTML in a Text widget’s content.</li>
<li>The Pages widget in Core is enhanced to make use of <a href="https://wordpress.org/plugins/customize-object-selector/" rel="ugc">Customize Object Selector</a> if available to display a Select2 UI for selecting pages to exclude instead of providing page IDs.</li>
<li>An bonus bundled plugin provides a “Post Collection” widget which, if the <a href="https://wordpress.org/plugins/customize-object-selector/" rel="ugc">Customize Object Selector</a> plugin is installed, will provide a UI for curating an arbitrary list of posts to display.</li>
</ul>
<p>This plugin doesn’t yet implement any widgets that use JS templating for <em>frontend</em> rendering of the widgets. For that, please see the <a href="https://github.com/xwp/wp-next-recent-posts-widget" rel="nofollow ugc">Next Recent Posts Widget</a> plugin.</p>
<p>Limitations/Caveats:</p>
<ul>
<li>Only widgets that extend <code>WP_JS_Widget</code> will be exposed via the REST API. The plugin includes a <code>WP_JS_Widget</code> adapter class which demonstrates how to adapt existing <code>WP_Widget</code> classes for the new widget functionality.</li>
</ul>


JS Widgets

A prototype of next generation of widgets in core, embracing JS for UI and powering the Widgets REST API.

miniorange

<p><strong>WordPress REST API endpoints</strong> are <strong>open and unsecured by default</strong> through which anyone can access your site data. With our <strong><a href="https://plugins.miniorange.com/wordpress-rest-api-authentication" rel="nofollow ugc">REST API Authentication for WP plugin</a></strong>, secure your WordPress APIs from unauthorized users.</p>
<p><strong>Protect WP REST API endpoints</strong> from public access by:<br />
– <a href="https://plugins.miniorange.com/wordpress-rest-api-jwt-authentication-method" rel="nofollow ugc">JWT Authentication</a><br />
– <a href="https://plugins.miniorange.com/wordpress-rest-api-basic-authentication-method" rel="nofollow ugc">Basic Authentication</a><br />
– <a href="https://plugins.miniorange.com/rest-api-key-authentication-method" rel="nofollow ugc">API Key Authentication</a><br />
– <a href="https://plugins.miniorange.com/wordpress-rest-api-oauth-2-0-authentication-method" rel="nofollow ugc">OAuth 2.0 Authentication</a><br />
– External Token based Authentication 2.0/OIDC/JWT/<a href="https://firebase.google.com/docs/auth/admin/create-custom-tokens" rel="nofollow ugc">Firebase</a> provider’s token authentication methods.</p>
<h3>Benefits of Refresh Token</h3>
<ul>
<li>Enhances security by keeping access tokens short-lived.</li>
<li>Improves user experience with uninterrupted sessions.</li>
<li>Reduces login frequency.</li>
</ul>
<h3>Benefits of Revoke Token</h3>
<ul>
<li>Protects against token misuse if a device is lost or compromised.</li>
<li>Enables admin-triggered logouts or session control.</li>
<li>Useful for complying with stricter session policies.</li>
</ul>
<p>This plugin will make sure that only after successful authentication, the user is allowed to access your site’s resources. REST API Authentication will make your <strong>WordPress endpoints secure from unauthorized access.</strong></p>
<p>Along with the default and standard WordPress REST API endpoints, with REST API Authentication for WP, you can authenticate custom-developed REST endpoints and third-party plugin REST API endpoints like that of <a href="https://wordpress.org/plugins/woocommerce/" rel="ugc">Woocommerce</a>, <a href="https://www.learndash.com/" rel="nofollow ugc">Learndash</a>, <a href="https://wordpress.org/plugins/buddypress/" rel="ugc">Buddypress</a>, <a href="https://www.gravityforms.com/" rel="nofollow ugc">Gravity Forms</a>, <a href="https://wordpress.org/plugins/cart-rest-api-for-woocommerce/" rel="ugc">CoCart</a>, etc.</p>
<span class="embed-youtube" style="text-align:center; display: block;"><iframe loading="lazy" class="youtube-player" width="750" height="422" src="https://www.youtube.com/embed/IsyKI7eEV-I?version=3&rel=1&showsearch=0&showinfo=1&iv_load_policy=1&fs=1&hl=en-US&autohide=2&start=2&wmode=transparent" allowfullscreen="true" style="border:0;" sandbox="allow-scripts allow-same-origin allow-popups allow-presentation allow-popups-to-escape-sandbox"></iframe></span>
<h3>REST API Authentication Methods in our WordPress plugin</h3>
<ul>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-jwt-authentication-method#step_a1" rel="nofollow ugc">JWT Authentication</a><br />
To maintain a seamless user experience without frequent logins needed due to token expiry, you can use our Refresh and Revoke token mechanisms feature.<br />
When the access token expires, instead of forcing the user to log in again, the client can request a new access token using a valid refresh token.</li>
<li><a href="https://plugins.miniorange.com/rest-api-key-authentication-method#step_a" rel="nofollow ugc">API Key Authentication</a></li>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-basic-authentication-method" rel="nofollow ugc">Basic Authentication</a>:<br />
        – 1. <strong>Username: Password</strong><br />
        – 2. <strong>Client-ID: Client-Secret</strong></li>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-oauth-2-0-authentication-method#step_a" rel="nofollow ugc">OAuth 2.0 Authentication</a> <em><strong>[Most Secure]</strong></em><br />
        – 1. <strong>Password Grant</strong><br />
            – 2. <strong>Client Credentials Grant</strong></li>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-authentication-using-third-party-provider#step_a" rel="nofollow ugc">Third Party Provider Authentication</a></li>
</ul>
<h3>Following are some of the integrations that are possible with REST API Authentication:</h3>
<h3>Learndash API Authentication</h3>
<ul>
<li>This plugin allows you to securely access Learndash user profiles, courses, groups & other Learndash API endpoints.</li>
</ul>
<h3>Custom Built REST API Endpoints Authentication</h3>
<ul>
<li>The plugin <strong>supports authentication for your own built custom REST API routes/endpoints</strong>. You can secure these API endpoints using the plugin’s highly secured authentication methods.</li>
</ul>
<h3>BuddyPress API Authentication</h3>
<ul>
<li><strong>Securely access BuddyPress REST API endpoints</strong> via authentication using different authentication methods like JWT token (JSON Web Token), API Keys etc.</li>
</ul>
<h3>WooCommerce API Authentication</h3>
<ul>
<li><strong>REST API Authentication for WP</strong> allows you to authenticate the WooCommerce store APIs with your mobile or desktop application & extend the features and functionality of your eCommerce store.</li>
</ul>
<h3>Gravity Form API Authentication</h3>
<ul>
<li>This plugin supports interaction with Gravity Forms from an external client application which can be your Android/iOS application.</li>
</ul>
<h3>External/Third-party plugin API endpoints integration in WordPress</h3>
<ul>
<li>These integrations can be used to fetch/update the data from the third-party side into WordPress that can be used to display it on the WordPress site as well, and this data can be processed further to use with any other plugin or WordPress events.</li>
</ul>
<h3>FEATURES</h3>
<p>FREE PLAN</p>
<ul>
<li>Authenticate only default WordPress REST API endpoints.</li>
<li>Basic Authentication with username and password.</li>
<li>JWT Authentication (JSON Web Token Authentication).</li>
<li>Selective API protection.</li>
<li>Restrict non-logged-in users to access REST API endpoints.</li>
</ul>
<p>PREMIUM PLANS</p>
<ul>
<li>Authenticate all REST API endpoints (Default WP, Custom APIs,Third-Party plugins)</li>
<li><strong>JWT Token Authentication</strong> (JSON Web Token Authentication)</li>
<li>**Refresh and Revoke token endpoints</li>
<li><strong>API Key Authentication</strong></li>
<li><strong>Basic Authentication</strong> (username/password and email/password)</li>
<li><strong>OAuth 2.0 Authentication</strong></li>
<li>Universal API key and User-specific API key for authentication</li>
<li>Selective API protection.</li>
<li>Time-based token expiry</li>
<li>Role-based authentication</li>
<li>Custom Header support rather than just <em>Authorization</em> to increase security.</li>
<li>Create users in WordPress based on third-party provider access tokens (JWT tokens) authentication.</li>
</ul>
<h3>Our Other Popular REST API Integrations</h3>
<ul>
<li>
<p><a href="https://wordpress.org/plugins/custom-api-for-wp/" rel="ugc">Custom API for WP plugin</a> to create and connect external APIs to your WordPress site.</p>
</li>
<li>
<p><a href="https://wordpress.org/plugins/products-sync-for-woocommerce" rel="ugc">Sync products to WooCommerce | Import WooCommerce products using API</a> to connect to your Supplier, Inventory, ERP, and CRM APIs to sync the products to your <a href="https://wordpress.org/plugins/woocommerce/" rel="ugc">WooCommerce</a> store with all the product data automatically.</p>
</li>
<li>
<p><a href="https://plugins.miniorange.com/wordpress-sync-posts-from-api" rel="nofollow ugc">Sync Custom Posts using External API</a> to automatically sync the data to custom posts in WordPress from the external REST API data.</p>
</li>
<li>
<p><a href="https://wordpress.org/plugins/login-register-using-jwt/" rel="ugc">WordPress JWT Single Sign-On (SSO) Auto login</a> to sync user sessions or auto-login to WordPress and other connected sites</p>
</li>
</ul>
<h3>Privacy</h3>
<p>This plugin does not store any user data.</p>


REST API Authentication for WP – JWT Auth and more

This was the plugin that I was looking for. It is just plug and play!

Great plugin, does as it says!

Secure and protect your REST API endpoints from unauthorized access using JWT token, Basic Authentication, API Key, OAuth 2, or external token.

JS Widgets vs REST API Authentication for WP – JWT Auth and more