Add filter for preview interstitial markup (#12463)

WordPress · Jan 4, 2019 · 2575d23 · 2575d23
1 parent 5d34eb9
commit 2575d23
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/docs/designers-developers/developers/filters/editor-filters.md b/docs/designers-developers/developers/filters/editor-filters.md
@@ -16,3 +16,17 @@ var withImageSize = function( size, mediaId, postId ) {
 wp.hooks.addFilter( 'editor.PostFeaturedImage.imageSize', 'my-plugin/with-image-size', withImageSize );
 ```
 
+### `editor.PostPreview.interstitialMarkup`
+
+Filters the interstitial message shown when generating previews.
+
+_Example:_
+
+```js
+var customPreviewMessage = function() {
+    return '<b>Post preview is being generated!</b>';
+};
+
+wp.hooks.addFilter( 'editor.PostPreview.interstitialMarkup', 'my-plugin/custom-preview-message', customPreviewMessage );
+```
+
diff --git a/packages/editor/src/components/post-preview-button/index.js b/packages/editor/src/components/post-preview-button/index.js
@@ -12,6 +12,7 @@ import { __, _x } from '@wordpress/i18n';
 import { withSelect, withDispatch } from '@wordpress/data';
 import { DotTip } from '@wordpress/nux';
 import { ifCondition, compose } from '@wordpress/compose';
+import { applyFilters } from '@wordpress/hooks';
 
 function writeInterstitialMessage( targetDocument ) {
 	let markup = renderToString(
@@ -79,6 +80,13 @@ function writeInterstitialMessage( targetDocument ) {
 		</style>
 	`;
 
+	/**
+	 * Filters the interstitial message shown when generating previews.
+	 *
+	 * @param {String} markup The preview interstitial markup.
+	 */
+	markup = applyFilters( 'editor.PostPreview.interstitialMarkup', markup );
+
 	targetDocument.write( markup );
 	targetDocument.title = __( 'Generating preview…' );
 	targetDocument.close();