alleyinteractive / wp-irving

WordPress companion plugin to develop on Irving.

WP Irving

Contributors: alleyinteractive
Tags: irving, headless
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

WP Irving contains everything needed to power an Irving headless app with WordPress.

Description

WP Irving is the companion WordPress plugin to Irving. Included are various APIs, plugin integrations, and other customizations/helpers to streamline Irving development when using WordPress as the CMS. It registers the API endpoints that Irving Core expects, which you can build upon to pass your data from WordPress to the frontend.

While WP Irving contains a few basic plugin integrations (and we hope to support more in the plugin in the future), overall the plugin is rather lightweight. It provides the tools you need to structure your API data appropriately for Irving, but it is up to you to build out the responses.

Installation

1. Upload /wp-irving/ folder to the /wp-content/plugins/ directory
2. Activate the plugin through the 'Plugins' menu in WordPress

Changelog

0.12.0

• Update: Frequency of Coral comment count cron to every 5 minutes (#345)
• Add: Action hook for logging Pico API errors (#346)
• Fix: Registration of Coral user post type (#350)
• Update: Modify Coral setup to help accommodate avatar implementation (#351)
• Add: Support for Jetpack's Site Verification Tools module (#353)
• Fix: Don't camel case CSS custom properties (#354)
• Add: Coral comment count threshold setting (#355)
• Update: Refactor application passwords integration (#348)
• Fix: Incorrect dockblock types (#349)

0.11.0

• Fix: Allow filter to handle generic objects instead of WP_Term objects (#340)
• Add: Ability to fetch Coral comment counts for posts via cron and related component (#341)
• Add: Support for additional Coral config and account for API fetch limit of 25 (#342)
• Fix: Only update story URL in Coral for posts (#343)

0.10.0

• Fix: Handle question mark edge case in usernames (#333)
• Update: Refactor Post List to deduplicate posts more performantly (#335)
• Update: Improve Coral integration to account for permalink modifications (#336)
• Fix: Filter content type for Coral email (#337)
• Fix: Only send Story ID for published posts (#338)

0.9.0

• Fix: Update the site theme to work for child themes
• Fix: Remove check for page context in block library styles
• Fix: Update New Relic integration to better typecast
• Add: Integrate Application Passswords
• Add: Initial support for FB Instant Articles
• Fix: Bypass auth errors and return unauthenticated data if app pass is incorrect
• Add: Display a message to users with an invalid auth token
• Fix: Update WP Irving integration to only delete Irving app passwords
• Remove: Feat/deprecate theme options

0.8.0

• Add: Display a Welcome to Irving message when template files do not exist (#305)
• Fix: Ensure children site-menu items are appended, not overwritten (#306)
• Fix: Update recursive site theme loop so non-string values are skipped (#309)
• Fix: Update site-menu component to allow explicitly setting the menu name (#307)
• Fix: Cache full site theme value to improve performance (#310)
• Add: Add script for drafting changelogs (#304)
• Update: Update Pico staging URL in our integration (#311)
• Fix: Decode HTML entities for title in social sharing component (#312)

0.7.0

• Add: CODEOWNERS file to the repo (#291)
• Add: Implement redirect logic for old post slugs (#295)
• Add: Support setting the theme in the component config object (#296)
• Add: Backend functionality of new Parse.ly component (#297)
• Fix: Don't unset theme config for the site-theme component (#298)
• Update: Make Jetpack script async and deferred (#299)
• Add: Ability to disable camel casing via filter (#300)
• Update: Optimize Travis-CI builds (#301)
• Fix: Ensure nonexistent URLs return a 404 (#302)
• Fix: Ability to override theme in a config callback (#303)

0.6.0

• Add irving/template-part component (#281)
• Fix redirects and improve performance (#283)
• Update AMP integration (#284)
• Update Alley Coding Standards (#285)
• Update Localize sitetheme when enqueueing editor styles (#286)
• Update caching in the Coral integration (#287)
• Change default branch from 'master' to 'main' (#288)
• Improve handling of empty paths by the component API (#289)
• Fix WPCom Legacy Redirector integration (#290)
• Add default analytics data to components (#276)
• Add multi-key context support (#292)
• Update Travis configuration (#293)

0.5.1

• Update: Change coding standard to Alley Interactive

0.5.0

• Limit Pico paywall to posts by default (#279)
• Changes related to new @irvingjs/wordpress package (#278)
• Ensure pre_get_posts fires for empty queries (#277)
• Add support for body classes (#273)
• Fix setting global WordPress properties (#267)
• Update Travis config (#275)
• Add support for nested site theme values (#270)
• GTM: Escape the site path in the data layer (#269)
• Add HTML encoding to menu name (#268)
• Refactor site-info component (#266)
• Add options for camel casing keys (#265)
• Pico: Add support for using the staging widget URL (#263)
• Add class_name and style as default configs (#262)
• Add checkbox for Pico staging URLs (#261)

0.4.0

• Update social share component. (#259)
• Add fragment property to post permalink component config. (#258)
• Add support for a fallback image in the customizer. (#257)
• Add initial data layer to GTM integrations. (#255)
• Add banned usernames field for Coral. (#256)
• Add allowed tiers input for Pico/Coral SSO to Irving Integrations settings page. (#254)
• Allow user to set custom username through Pico/Coral integration. (#241)
• Add image performance enhancements in irving/post-featured-image. (#251)
• Add post_ids_to_skip config to the irving/post-list component. (#250)
• Implement local WP username storage for Coral users. (#249)
• Support item overrides in irving/post-list components. (#247)
• Hydrate WordPress data for images. (#244)
• Improvements to management, and block library support. (#246)
• Ensure post previews do not use the homepage template. (#248)
• Enqueue block library styles. (#243)
• Add share links config to social sharing component. (#242)
• Remove unnecessary second param for VIP cache purge filter. (#240)
• Add support to the pagination component for post type archives. (#239)
• Define component for Coral to be included in template JSON. (#222)
• Allow use_context in templates. (#223)

0.3.0

• Fix: Cache clearing redirect
• Fix: Page title in the head component
• Fix: Menu URL
• Add: Integrations Manager
• Fix: Add permissions callbacks to REST API endpoints for WP 5.5
• Add: Yoast schema set through integrations manager
• Fix: Duplicates in post list component.
• Add: Pico integration
• Add: Coral component
• Add: Post meta component
• Fix: Yoast integration data formatting
• Add: Interstitial support to the post-list component
• Add: Term helper components
• Add: Set base URL automatically in query-pagination component on term archive pages
• Add: Jetpack site stats integration
• Add: Google Tag Manager integration
• Add: Back-end for handling SSO between Pico and Coral
• Add: Coral comment count component
• Fix: Byline component improvements
• Add: Social links component
• Fix: Safe Redirect Manager integration

0.2.0

This update includes major improvements to the way developers can build layouts for Irving sites using WordPress.

See release notes

0.1.0

First stable release of the WP-Irving plugin.

wp-irving's Issues

Improve handling of `is_home` flag when setting up the WP_Query object.

When setting up the WP_Query object in Components_Endpoint::build_query(), the is_home flag is not being set correctly because internally, when WP_Query::parse_query() sets those flags, it explicitly includes a condition that the current request is not a REST request.

Since we are always setting up the WP_Query object in the context of a REST request, this will always be false. Annoyingly, the is_home flag is also then used in the logic to set up several other flags, which are now unreliable as well.

Our two options are to either manually set the is_home flag using the same basic logic as WordPress on the parse_query action and then rerun parse_query_vars() to fix inconsistencies, or we need to fork all of the logic that relies on the is_home flag and fix them all manually.

Add token invalidation to JWT integration

Right now, there's no logic running on every admin page hit that validates the JWT token stored in the user's cookie is valid. We should check/validate this more frequently to ensure auth works as expected.

HomePage Admin Bar Irving API button

Have a homepage Irving API button on the dashboard for quick access to the endpoint. Just like a single post has a WP-Irving API button on the WP bar.

Filter for namespace and version

Allow devs to filter the namespace and the endpoint version.

Base support for Yoast SEO

Add API post row action for all post statues.

Refactor admin bar and API shortcut links into its' own class

The components endpoint has a lot of admin related code that can and should be moved into its' own class.

What query vars should be allow-listed in WP Irving?

The bug fix in #131 uses WP core's list off query vars to allow-list.

Should that list be reduced at all?

Taxonomy Single Admin Bar Irving API button

Singular taxonomy pages don't have the Irving API button at the moment.

Fix deprecated tag_list_actions warning.

Since WP 5.4, a deprecation notice is being shown on taxonomy list tables when the tag_list_actions hook is in use. See: https://core.trac.wordpress.org/ticket/49808

In the mean time, we need to loop through all taxonomies and hook individually to {$taxonomy}_row_actions instead.

Couldn't get the host and port from the REDIS_MASTER environment variable

Hello!

I'm seeing the following error when trying to run npm run dev:

Mon, 30 Mar 2020 15:46:02 GMT irving:redis [error] Couldn't get the host and port from the REDIS_MASTER environment variable. Please pass a valid REDIS_MASTER environment variable in the form of a host:port string
this error is preventing me from spinning up Irving locally. Any ideas what may be causing this?

Thanks!
Hughie