Completed: VaultPress Deprecation

We have reached the end of the VaultPress deprecation process. VaultPress is now disabled across the VIP Platform, and is no longer available for use on VIP environments.

You can continue to access your data through our convenient VIP Dashboard and VIP-CLI features, see below.

What does this mean?

If you’re a customer that has been using the VIP_VAULTPRESS_SKIP_LOAD PHP constant to continue using VaultPress to create backups for your environments, even after the deprecation on the 29th of March, you will no longer be able to do so. VaultPress will no longer be connected to your site environments, which means that no VaultPress backups will be generated. You will also lose access to the VaultPress Dashboard.

Customers that have not been using the VIP_VAULTPRESS_SKIP_LOAD PHP constant will also no longer be able to access the VaultPress Dashboard. VaultPress itself has been disconnected from your site environments since the 29th of March – so there have been no VaultPress backups generated since then.

Manage and export data with VIP tools

There are several ways to export and manage your data from the VIP Platform:

• From the VIP Dashboard – choose to export the entire database, a single network site (for multisites), or specific tables
• Using the  VIP-CLI command vip export sql

Managing data access through the VIP Dashboard and VIP-CLI allows us to provide a clear, simple, and secure service for your team. The VIP Dashboard user management system allows for regulation of access control, enhancing security and easing the workload for onboarding and offboarding processes.

All crucial interactions such as generation and download events are systematically tracked and recorded in the Audit Log, providing a clear record of significant system interactions. 

On-demand database backups

You can now trigger a database backup on-demand before exporting it using the VIP CLI.  The capability to trigger a database backup via the VIP Dashboard will follow soon.

Generating a backup for download will ensure that you are working with the most up to date data and should provide you all the tools needed to efficiently and confidently deploy applications. 

Please reach out to VIP Support with any questions or concerns you may have.

New in Beta: Block Data API

We’re pleased to announce the beta availability of a new Block Data API.  It is now released for you to begin testing.  

What is the Block Data API?

For many use cases, it’s helpful to access blocks in WordPress as pure JSON data instead of HTML.  Doing so eliminates the need to write parsing layers to transform markup into JSON, and to keep those translation layers up to date with every version of Gutenberg.  All of this saves developer time and effort.  

While options have existed for accomplishing this with GraphQL when accessed via REST, translation layers were required. The Block Data API is a new REST API endpoint to retrieve the Gutenberg blocks of a single WordPress post.

What are some use cases for the Block Data API?

There are several known use cases for the Block Data API.  These include:

• Power your Node.js front end with less reliance on dangerouslySetInnerHTML. 
• Send data about your blocks to Machine Learning and AI applications.
• Use blocks in mobile applications with reduced processing.

This is not a comprehensive list.  As we go through the beta period, we’d love your feedback on how you use the Block Data API, what works well for you, and what you’d like to see improved.

While the API is in beta, you can offer that feedback by opening a GitHub issue. When it is released, we can provide support via normal means.

How do I get access to the Block Data API?

To install the plugin, go here and follow the instructions that have been provided

Where can I find more information/documentation?

The project Readme has comprehensive information on the plugin and its functions.

Upcoming: VaultPress Deprecation

Over the next few months, we will be deprecating and then removing VaultPress from the WordPress VIP platform. The VIP Dashboard now supports exporting database backups for all your applications and environments, the primary feature previously provided by VaultPress.

Here’s the timeline for the planned deprecation and removal:

• Tuesday, March 14th, 2023: VaultPress will be disabled on non-production environments
• Tuesday, March 28th, 2023: VaultPress will be disabled on production environments
• Tuesday, July 04th, 2023: VaultPress plugin code will be removed from the VIP Platform’s Must Use (“MU”) plugins and the VIP Platform

Once VaultPress is disabled for an environment, you won’t be able to access database backups from the VaultPress Dashboard. Instead, the VIP Dashboard will provide you an integrated experience for managing exports that fits in with your existing VIP workflows. 

If you’d like to continue leveraging VaultPress until the final removal date in June, you can add the following line to your vip-config.php file:

define( 'VIP_VAULTPRESS_SKIP_LOAD', false );

With this in place, VaultPress will continue working on your environments even after we deprecate it on non-production and production environments. It will continue working until its removal date at the end of June.

Managing exports within the VIP Dashboard

We’re excited to have these and more new features coming soon to WordPress VIP.

• Database exports are optimized for use in development environments and allow for further customization and filtering.
• Security is enhanced by including user access control for backups under the VIP Dashboard user management system, easing onboarding and offboarding workload.
• Tracking generation and download events are available in the Audit Log.
• Backup exports via VIP-CLI (upcoming feature)
• Easier syncing of data into the VIP Local Development Environment (upcoming feature)
• On-demand / ad-hoc backups (upcoming feature)

Please reach out to VIP Support with any questions or concerns you may have. We are happy to accommodate an extension should you need it.

Enterprise Search as default Elasticsearch solution

On Wednesday, May 4, 2022, VIP’s Enterprise Search will be the default search solution for WordPress VIP customers. Enterprise Search utilizes Elasticsearch as a custom performance-enhancing layer, boosting the speed of WordPress searches and queries for the front end, API, and the WordPress admin area. 

For sites that do not need to offload slow MySQL queries or backend searches, Jetpack Instant Search provides a built-in UI for front-end searches. See the table below for a side-by-side feature comparison.

Some WordPress VIP customer sites are using custom indexes for Jetpack Search via the legacy Jetpack Professional plan. If this includes you, you will need to upgrade to Enterprise Search by activating Enterprise Search on your sites. Support for custom Jetpack Search indexes on the VIP Platform will cease on May 4. At that point, Jetpack Search will only be available as Instant Search via the Jetpack Complete plan that includes 100,000 records on all VIP sites. If you believe your usage may be over this threshold or have questions, please reach out to your account team to discuss additional costs considerations.

Do I have to upgrade to Enterprise Search?

Yes, if you are using custom Jetpack Search indexes. Custom Jetpack Search indexes will no longer be supported on the VIP platform as of May 4. You should activate Enterprise Search in your Develop environment first to test the features in a non-production environment before activating it in a production environment. Enabling Enterprise Search will, by default, disable the Jetpack Search module.

How do I know if I’m using custom Jetpack Search indexes?

In your GitHub repository, search for the constant JETPACK_SEARCH_VIP_INDEX. If it is defined as true in your codebase, you are using custom Jetpack Search indexes.

What do I have to do?

If you are using custom Jetpack Search indexes on your site, you will need to activate Enterprise Search by May 4. To get started, please follow our guide to getting started.

If you would like to use Jetpack Instant Search instead, please open a ticket with us.

How do I know which Elasticsearch solution is right for me?

Use the table below to see a comparison of the features offered by both solutions:

Feature	Enterprise Search	Jetpack Instant Search
Offloading of MySQL queries to Elasticsearch	Yes	No
Custom Elasticsearch queries	Yes	No
Customization of what to index	Yes	No
Unlimited records	Yes	No*
Backend search	Yes	No
Powerful built-in front-end search UI	No	Yes
Automatically highlighted search terms on comments and post content	No	Yes
Search as you type	No	Yes
Boosted and prioritized results based on your Jetpack site stats	No	Yes
Real-time indexing	Yes	Yes
Searching across subsites in a multi-site network	Yes	Yes**
Faceted search	Yes	Yes

_{*First 100,000 records are free, additional will be billed
**This feature will be available at the end of March.}

Can I use both Enterprise Search and Jetpack Instant Search?

We recommend using only one search solution to avoid any potential conflicts. Additionally, enabling Enterprise Search will by default disable the Jetpack Search module.

Who can I reach out to if I want more information on this?

Customers can open a support ticket with VIP if they have further questions.

Parse.ly WordPress Plugin 2.5 Release

Fresh on the heels of last month’s 2.4.1 release, we’re now pleased to announce the 2.5.0 release of the wp-parsely plugin.

Parse.ly gives creators, marketers and developers the tools to understand content performance, prove content value, and deliver tailored content experiences that drive meaningful results.

We encourage everyone using the plugin to update to the latest version.

If you have any questions about how WPVIP + Parse.ly can help you deliver meaningful customer experiences, please get in touch.

What is being added or changed?

Added

• Refreshed contributor documentation into a new CONTRIBUTING.md file.
• Introduce a build step for front-end and admin page JavaScript assets which leverages the @wordpress/scripts package. Scripts are now separately enqueued and browser-cacheable.
• Allow for select HTML tags and attributes in the Recommended Content widget title.
• Add a “No boost” option for scores in the widget.
• Add filter wp_parsely_post_type to override the type of content Parse.ly attributes to an article.
• Add support for custom post status slugs via the wp_parsely_trackable_statuses filter (to allow for those other than publish to be tracked).
• Make $post_id available to the wp_parsely_permalink filter.

Changed

• Refactor printed markup into template “views.”
• Refactor plugin entry file to perform minimal initialization and separately load the Parsely class file.
• Improve the README file (which populates the copy in the plugin repository page).
• Expand test coverage (PHP and JavaScript).
• Expanded string localization and consolidate into a single text domain.
• Adjust HTML heading levels for improved usability and accessibility.
• Improve accessibility of radio inputs on the admin page.
• Improve the widget user interface to make it more consistent with core styles.
• Better load Widget CSS and use plugin version for cache busting.
• Replace widget form and hide front-end output when API values are missing.
• Prevent printing of admin page CSS outside the specific admin page for this plugin.
• Switch to XHRs for /profile calls (instead of using JSONP).
• Remove jQuery dependency from the API and Admin scripts.
• Stop using protocol-relative URL for the tracking script.
• Register the package at Packagist for easier install via Composer.

Fixed

• Fix the “requires a recrawl” notices to limit to specific admin page settings.
• Fix inconsistent ports in canonical URLs.

Deprecated

• Deprecate filter after_set_parsely_page — use new name wp_parsely_metadata instead.
• Deprecate filter parsely_filter_insert_javascript — use new name wp_parsely_load_js_tracker instead.

Questions?

If you have any questions, related to this release, please open a support ticket and we will be happy to assist.

Parse.ly WordPress Plugin 2.4 Release

Since we announced Parse.ly joining forces with WPVIP, we’ve been working on improving the WordPress integration. The first collaborative release of the Parse.ly plugin is here!

Parse.ly gives creators, marketers and developers the tools to understand content performance, prove content value, and deliver tailored content experiences that drive meaningful results.

We encourage all of our customers using the plugin to update to the latest version, particularly if it’s being managed in code.

If you have any questions about how WPVIP + Parse.ly can help you deliver meaningful customer experiences, please get in touch.

We’ve got lots of planned enhancements coming soon!

What is being added or changed?

Changed

• Improve WordPress.org assets (screenshots, icons, readme).

Fixed

• Fix metadata for home pages, including pages of older posts.
• Fix metadata for category archives.

Removed

• Remove Parse.ly metadata from search result pages.

For more detailed information, please check out the changelog.

Questions?

If you have any questions, related to this release, please open a support ticket and we will be happy to assist.

Updated Timeline – Removing Gutenberg Ramp

As shared in our November 2020 announcement, VIP is actively working to deprecate the Gutenberg Ramp plugin. To facilitate this, we have proactively opened Pull Requests against individual customer repos and branches for each environment, which replaces the Gutenberg Ramp functionality with simplified WordPress Core filters. 

During testing of these Pull Requests, we have identified a bug in the Core filter (details below). While we are actively working to mitigate this issue, both on the VIP platform, and within Core, we are delaying the deprecation from February 3 to February 22, 2021. This includes delaying the previously planned merging of outstanding Pull Requests to February 17.

Identified Issue Affecting Certain Post Types

We have identified an issue affecting any post types that do not support the Block Editor, such as attachments, and certain custom post types. The current Core Filter, use_block_editor_for_post, will attempt to use the Block Editor for all post types, and does not check for Block Editor support. This results in an error on the WordPress Dashboard when attempting to edit these posts. This issue does not affect front-end display.

Solutions in Progress

We have reported the bug within WordPress Core and have provided a patch to implement a check for Block Editor support. 

As an immediate fix, we are implementing the following patch to vip-go-mu-plugins:

add_filter('use_block_editor_for_post', function( $can_edit, $post ) { if ( ! post_type_supports( $post->post_type, 'editor' ) ) { return false; } return $can_edit; }, 999, 2 );

What if I’ve already merged the Pull Requests?

For those customers who have proactively tested and merged the Pull Requests, no additional action is needed. The above immediate fix will mitigate any potential conflicts.

What If I haven’t merged the Pull Requests?

For those who have not yet acted on the Pull Requests, we will be opening follow-up tickets via Zendesk both as a reminder, and to help answer any question you may have about this deprecation. We do still ask that you test and action these changes according to your development workflows. This is required in order to maintain current functionality when Gutenberg Ramp has been removed.

According to our updated timeline, all outstanding Pull Requests will be merged on February 17, 2021. Deprecation will follow on February 22, 2021.

---

Thank you so much to those who have had the opportunity to test and action the changes, and helped to identify this bug. As always, if you have any questions or concerns please feel free to open a support ticket.

Update on environment types

A few days after the release of WordPress 5.5, we added support for environment types on VIP Go.

Calling the method wp_get_environment_type() will return the name of the VIP environment, exactly as you can see it in the dashboard. 

This has changed with the release of WordPress 5.5.1, as this version has dropped support for custom environment types, only allowing one of the following types to be set: production, staging, development, local.

Following this change, we are now mapping the VIP environment names to one of the standardized environment types. This means that calling wp_get_environment_type() will return an environment type as follows:

VIP environment name	WP environment type
production	production
develop development	development
any other (preprod, staging, uat…)	staging

If you have any questions about this change and how to use environment types in our code, please open a support ticket, and we’ll be happy to assist.

Environment type support

Edit (2020-09-01): WordPress 5.5.1 removed the ability to define arbitrary labels for environments, and instead requires your to choose from one of four types. The information below is retained for posterity but is no longer valid.

You can learn about the new behavior on VIP on our update post.

---

In WordPress 5.5, environment types were introduced to allow plugins to target specific environments for specific functionality. All the details about this new functionality can be found here.

We have now added support for environment types in VIP Go, so this feature can be used to determine the environment where the code is running.

Calling the method wp_get_environment_type() will return the name of the VIP environment, exactly as you can see it in the dashboard. This is an example when run on a typical VIP development env:

<?php
$environment = wp_get_environment_type();
print( $environment );

Result:

development

This allows you to use a standard WordPress method to run different code depending on whether you are running in production, development, or any other environment type you have configured for your application.

If you have any questions about environment types, please open a support ticket, and we’ll be happy to assist.

Notice: Bitly API v3 to be deactivated

On March 1st, 2020, Bitly will deactivate v3 of their API:

API V3 will be deactivated on March 1, 2020. If you are currently using V3, migrate to V4 as soon as possible to avoid a breakdown of your integrations. See all the changes in our updated documentation for API V4.

VIP clients utilizing a plugin to generate Bitly shortlinks should ensure their plugin supports the new v4 API. Custom shortlink creation for Bitly plugins using the older v3 API will not be supported as of March 1st, 2020.

To follow operational updates, visit Bitly’s status page.

Updating to Bitly API v4

WordPress.com VIP clients who are using the Bitly plugin from the WordPress.com VIP Shared Plugin repository will find a new Access Token field on the settings page for the plugin.

VIP Go clients using the Bitly plugin from the WordPress.com VIP Shared Plugin repository are urged to update their plugin to the new version to support the Bitly v4 API. Also note that if you have code filtering bitly_http_options, you’ll need to update your filter to use bitly_request_args when using the updated plugin.

To start using the Bitly API v4, visit your Bitly account dashboard to generate an Access Token and then add that token to the Bitly settings page inside your WordPress Dashboard. Once an Access Token has been added to the settings page, the plugin will switch to using the new v4 API.

If you have any questions, please open a support ticket and we’ll be happy to assist.