Prepare for block-editor control

automatically-paginate-posts.php

@@ -24,8 +24,12 @@
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * @package automatically-paginate-posts
  */
 
+require_once dirname( __FILE__ ) . '/inc/class-block-editor.php';
+
 /**
  * Class Automatically_Paginate_Posts.
  */
@@ -132,12 +136,22 @@ class Automatically_Paginate_Posts {
 	private $meta_key_disable_autopaging = '_disable_autopaging';
 
 	/**
-	 * Register hooks.
+	 * Class constructor.
 	 *
-	 * @uses add_action, register_uninstall_hook, add_filter
 	 * @return void
 	 */
 	public function __construct() {
+		$this->setup_hooks();
+
+		new Automatically_Paginate_Posts\Block_Editor( $this );
+	}
+
+	/**
+	 * Register hooks.
+	 *
+	 * @return void
+	 */
+	protected function setup_hooks() {
 		add_action( 'plugins_loaded', array( $this, 'load_textdomain' ) );
 		add_action( 'init', array( $this, 'action_init' ) );
 
@@ -151,6 +165,65 @@ class Automatically_Paginate_Posts {
 		add_action( 'save_post', array( $this, 'action_save_post' ) );
 		add_filter( 'the_posts', array( $this, 'filter_the_posts' ) );
 	}
+	/**
+	 * Allow access to meta key for disabling autopaging.
+	 *
+	 * @param string $name Property name.
+	 * @return array|string|null
+	 */
+	public function __get( $name ) {
+		if ( 'meta_key' === $name ) {
+			return $this->meta_key_disable_autopaging;
+		}
+
+		if ( 'post_types' === $name ) {
+			if ( ! did_action( 'init' ) ) {
+				_doing_it_wrong(
+					__METHOD__,
+					__(
+						'Post types can only be retrieved after the "init" hook.',
+						'autopaging'
+					),
+					'0.3'
+				);
+
+				return null;
+			}
+
+			return $this->post_types;
+		}
+
+		return null;
+	}
+
+	/**
+	 * Prevent setting properties.
+	 *
+	 * @param string $name  Property name.
+	 * @param string $value Property value.
+	 * @return false
+	 */
+	public function __set( $name, $value ) {
+		return false;
+	}
+
+	/**
+	 * Indicate if a property is set.
+	 *
+	 * @param string $name Property name.
+	 * @return bool
+	 */
+	public function __isset( $name ) {
+		if ( 'meta_key' === $name ) {
+			return true;
+		}
+
+		if ( 'post_types' === $name ) {
+			return did_action( 'init' );
+		}
+
+		return false;
+	}
 
 	/**
 	 * Load plugin translations.
@@ -428,6 +501,13 @@ class Automatically_Paginate_Posts {
 	 */
 	public function action_add_meta_boxes() {
 		foreach ( $this->post_types as $post_type ) {
+			if (
+				function_exists( 'use_block_editor_for_post_type' ) &&
+				use_block_editor_for_post_type( $post_type )
+			) {
+				continue;
+			}
+
 			add_meta_box( 'autopaging', __( 'Post Autopaging', 'autopaging' ), array( $this, 'meta_box_autopaging' ), $post_type, 'side' );
 		}
 	}
@@ -475,6 +555,13 @@ class Automatically_Paginate_Posts {
 			return;
 		}
 
+		if (
+			function_exists( 'use_block_editor_for_post' )
+			&& use_block_editor_for_post( $post_id )
+		) {
+			return;
+		}
+
 		if ( isset( $_POST[ $this->meta_key_disable_autopaging . '_wpnonce' ] ) && wp_verify_nonce( $_POST[ $this->meta_key_disable_autopaging . '_wpnonce' ], $this->meta_key_disable_autopaging ) ) {
 			$disable = isset( $_POST[ $this->meta_key_disable_autopaging ] ) ? true : false;
 

inc/class-block-editor.php

+<?php
+/**
+ * Block Editor support.
+ *
+ * @package automatically-paginate-posts
+ */
+
+namespace Automatically_Paginate_Posts;
+
+/**
+ * Block_Editor class.
+ */
+class Block_Editor {
+	/**
+	 * Instance of plugin's main class.
+	 *
+	 * For legacy reasons, this is not a singleton, so it cannot be accessed
+	 * without passing the instance directly.
+	 *
+	 * @var \Automatically_Paginate_Posts
+	 */
+	protected $autopaging_instance;
+
+	/**
+	 * Class constructor.
+	 *
+	 * @param \Automatically_Paginate_Posts $autopaging_instance Instance of
+	 *                                                           plugin's main
+	 *                                                           class.
+	 */
+	public function __construct( $autopaging_instance ) {
+		if ( ! $autopaging_instance instanceof \Automatically_Paginate_Posts ) {
+			return;
+		}
+
+		$this->autopaging_instance = $autopaging_instance;
+
+		add_action( 'rest_api_init', array( $this, 'register_meta' ) );
+		add_filter( 'is_protected_meta', array( $this, 'allow_meta_updates' ), 10, 3 );
+		add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue' ) );
+	}
+
+	/**
+	 * Register meta for access in Gutenberg.
+	 *
+	 * @return void
+	 */
+	public function register_meta() {
+		global $wp_version;
+
+		if (
+			! function_exists( 'register_meta' )
+			|| version_compare( $wp_version, '4.6.0', '<' )
+		) {
+			return;
+		}
+
+		foreach ( $this->autopaging_instance->post_types as $post_type ) {
+			register_meta(
+				'post',
+				$this->autopaging_instance->meta_key,
+				array(
+					'object_subtype' => $post_type,
+					'default'           => false,
+					'description'       => __(
+						'Whether or not to disable pagination for this post.',
+						'autopaging'
+					),
+					'type'              => 'boolean',
+					'sanitize_callback' => static function ( $value ) {
+						return (bool) $value;
+					},
+					'show_in_rest'      => true,
+					'single'            => true,
+				)
+			);
+		}
+	}
+
+	/**
+	 * Allow access to plugin's meta key via the REST API.
+	 *
+	 * @param bool   $is_protected If meta key is protected.
+	 * @param string $meta_key     Meta key nane.
+	 * @param string $meta_type    Meta key type.
+	 * @return bool
+	 */
+	public function allow_meta_updates( $is_protected, $meta_key, $meta_type ) {
+		if ( 'post' !== $meta_type ) {
+			return $is_protected;
+		}
+
+		if ( $meta_key === $this->autopaging_instance->meta_key ) {
+			return false;
+		}
+
+		return $is_protected;
+	}
+
+	/**
+	 * Enqueue block-editor assets.
+	 *
+	 * @return void
+	 */
+	public function enqueue() {
+		$asset_handle = 'automatically-paginate-posts-block-editor';
+
+		$plugin_base_dir = dirname( dirname( __FILE__ ) );
+
+		$asset_data = require $plugin_base_dir
+			. '/assets/build/index.asset.php';
+
+		wp_enqueue_script(
+			$asset_handle,
+			plugins_url( 'assets/build/index.js', dirname( __FILE__ ) ),
+			$asset_data['dependencies'],
+			$asset_data['version'],
+			true
+		);
+
+		wp_set_script_translations(
+			$asset_handle,
+			'autopaging',
+			$plugin_base_dir . '/languages'
+		);
+	}
+}

package.json

@@ -4,8 +4,25 @@
   "main": "Gruntfile.js",
   "author": "Erick Hitter & Oomph, Inc.",
   "devDependencies": {
+    "@wordpress/scripts": "^23.3.0",
     "grunt": "^1.5.3",
     "grunt-wp-i18n": "^1.0.3",
     "grunt-wp-readme-to-markdown": "^2.1.0"
+  },
+  "scripts": {
+    "build": "wp-scripts build",
+    "check-engines": "wp-scripts check-engines",
+    "check-licenses": "wp-scripts check-licenses",
+    "format": "wp-scripts format",
+    "grunt": "grunt",
+    "lint:css": "wp-scripts lint-style",
+    "lint:js": "wp-scripts lint-js",
+    "lint:md:docs": "wp-scripts lint-md-docs",
+    "lint:pkg-json": "wp-scripts lint-pkg-json",
+    "packages-update": "wp-scripts packages-update",
+    "start": "wp-scripts start",
+    "test": "npm run test:e2e && npm run test:unit",
+    "test:e2e": "wp-scripts test-e2e --passWithNoTests",
+    "test:unit": "wp-scripts test-unit-js --passWithNoTests"
   }
 }

webpack.config.js

+const config = require( './node_modules/@wordpress/scripts/config/webpack.config' );
+const { resolve } = require( 'path' );
+
+config.entry = {
+	index: './assets/src/index.js',
+};
+
+config.output.path = resolve( process.cwd(), 'assets/build' );
+
+module.exports = config;