Merge branch 'release/1.2.0'

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 1.2.0
+
+### Added
+- `kill` method allowing to display the requirement message as a content of `wp_die`.
+
 ## 1.1.3
 
 ### Fixed

src/Requirements.php

@@ -225,28 +225,68 @@ public function satisfied() {
 	}
 
 	/**
-	 * Prints notice
+	 * Returns message with requirements info if any of them is not met.
 	 *
-	 * @since  1.0.0
+	 * @since 1.2.0
 	 * @param string|null $message Message to display.
-	 * @return void
+	 * @return string|null Message or null if requirements are met.
 	 */
-	public function print_notice( $message = null ) {
+	protected function get_message( $message = null ) {
 		if ( $this->satisfied() ) {
-			return;
+			return null;
 		}
 
-		if ( null === $message ) {
-			$message = sprintf(
+		if ( ! is_string( $message ) || '' === $message ) {
+			return sprintf(
 				// Translators: Plugin name.
 				__( 'The plugin: <strong>%s</strong> cannot be activated.', self::$textdomain ),
 				esc_html( $this->plugin_name )
 			);
 		}
 
+		return $message;
+	}
+
+	/**
+	 * Prints notice
+	 *
+	 * @since  1.0.0
+	 * @param string|null $message Message to display.
+	 * @return void
+	 */
+	public function print_notice( $message = null ) {
+		$message = $this->get_message( $message );
+
+		if ( null === $message ) {
+			return;
+		}
+
 		add_action( 'admin_notices', function() use ( $message ) {
 			include __DIR__ . '/notice.php';
 		} );
 	}
 
+	/**
+	 * Runs wp_die with proper message if any of the checks failed.
+	 * This method shoudl be used interchangeably with `print_notice`.
+	 *
+	 * @since 1.2.0
+	 * @param string|null $message Message to display.
+	 * @return void
+	 */
+	public function kill( $message = null ) {
+		$message = $this->get_message( $message );
+
+		if ( null === $message ) {
+			return;
+		}
+
+		ob_start();
+
+		include __DIR__ . '/die-message.php';
+
+		// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+		wp_die( ob_get_clean(), wp_strip_all_tags( $message ) );
+	}
+
 }

src/die-message.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * `wp_die` message template
+ *
+ * @package micropackage/requirements
+ */
+
+?>
+<h1><?php echo wp_kses_post( $message ); ?></h1>
+
+<ul>
+	<?php foreach ( $this->errors as $error ) : ?>
+		<li><?php echo esc_html( $error ); ?></li>
+	<?php endforeach; ?>
+</ul>

src/notice.php

@@ -5,8 +5,6 @@
  * @package micropackage/requirements
  */
 
-use Micropackage\Requirements\Requirements;
-
 ?>
 <div class="error">
 	<p><?php echo wp_kses_post( $message ); ?></p>