Hook into init super early

Author: unfulvio

ChangeLog.md

@@ -1,7 +1,7 @@
 # Changelog
 
 ### 1.5.0 (29 May 2016)
- * Fix: Tries to address an incompatibility between WordPress and PHP Console: "PHP Warning: session_start(): Cannot send session cache limiter - headers already sent"
+ * Fix: Fixes "PHP Warning: session_start(): Cannot send session cache limiter - headers already sent" notice in logs
  * Misc: Internal changes, new Settings class, deprecated methods and properties in main Plugin class
  * Misc: Updated PHP Console Library to 3.1.6
  * Misc: Tested up to WordPress 4.5.2

includes/class-wp-php-console-settings.php

@@ -28,7 +28,6 @@ class Settings {
 	 */
 	private $page = '';
 
-
 	/**
 	 * This plugin's option name.
 	 *
@@ -119,7 +118,7 @@ public function register_settings() {
 				 'callback' => array( $this, 'ip_field' ),
 			),
 			'register' => array(
-				 'label'    => esc_html__( 'Register PC Class ', 'wp-php-console' ),
+				 'label'    => esc_html__( 'Register PC Class',  'wp-php-console' ),
 				 'callback' => array( $this, 'register_field' ),
 			),
 			'stack'    => array(
@@ -156,8 +155,10 @@ public function settings_info() {
 		?>
 		<p><?php
 			/* translators: %s refers to 'PHP Console' Chrome extension, will print download link for the Chrome extension */
-			printf( _x( 'This plugin allows you to use %s within your WordPress installation for testing, debugging and development purposes.', 'PHP Console, the Chrome Extension', 'wp-php-console' ), '<a href="https://github.com/barbushin/php-console" target="_blank">PHP Console</a>' ); ?>
-			<br><?php esc_html_e( 'Usage instructions:', 'wp-php-console' ); ?>
+			printf( _x( 'This plugin allows you to use %s within your WordPress installation for testing, debugging and development purposes.', 'PHP Console, the PHP Library', 'wp-php-console' ),
+				'<a href="https://github.com/barbushin/php-console" target="_blank">PHP Console</a>'
+			); ?><br>
+			<?php esc_html_e( 'Usage instructions:', 'wp-php-console' ); ?>
 		</p>
 		<ol>
 			<?php
@@ -235,7 +236,7 @@ public function ip_field() {
 			<ol>
 				<li><small><?php
 					/* translators: Placeholders: %1$s - a single IP address, %2$s link to Varying Vagrant Vagrants repo */
-					printf( __( 'An IP address (for example %1$s, %2$s default IP address).' ),
+					printf( __( 'An IP address (for example %1$s, %2$s default IP address).', 'wp-php-console' ),
 						'<code>192.168.50.4</code>',
 						'<a href="https://github.com/Varying-Vagrant-Vagrants/VVV">Varying Vagrant Vagrants</a>'
 					); ?></small></li>
@@ -319,12 +320,12 @@ public function short_field() {
 	 * Sanitize user input in settings page.
 	 *
 	 * @since  1.5.0
-	 * @param  array $field user input
+	 * @param  array $option user input
 	 * @return array sanitized input
 	 */
-	public function sanitize_field( $field ) {
+	public function sanitize_field( $option ) {
 
-		$input = wp_parse_args( $field, array(
+		$input = wp_parse_args( $option, array(
 			'ip'       => '',
 			'password' => '',
 			'register' => false,

includes/class-wp-php-console.php

@@ -49,7 +49,7 @@ class Plugin {
 	/**
 	 * Instance of PHP Console connector object.
 	 *
-	 * @since  1.4.1
+	 * @since  1.4.0
 	 * @access public
 	 * @var    PhpConsole\Connector $connector Instance.
 	 */
@@ -81,13 +81,17 @@ public function __construct() {
 		}
 
 		// Connect to PHP Console.
-		$this->connect();
+		add_action( 'init', function() {
+
+			$this->connect();
+
+			// Apply PHP Console options.
+			$this->apply_options();
 
-		// Apply PHP Console options.
-		$this->apply_options();
+		}, -100 );
 
 		// Delay further PHP Console initialisation to have more context during Remote PHP execution.
-		add_action( 'wp_loaded', array( $this, 'init' ) );
+		add_action( 'wp_loaded', array( $this, 'init' ), -100 );
 
 	}
 
@@ -120,26 +124,25 @@ private function connect() {
 		// But there is some problem with frameworks like WordPress that override PHP session handler.
 		// PHP Console has alternative storage drivers for this - we will write to a temporary file:
 
-		// TODO this generates "PHP Warning: session_start(): Cannot send session cache limiter - headers already sent"
-
-		/**
 		$phpcdir  = __DIR__ . '/tmp';
 		$make_dir = wp_mkdir_p( $phpcdir );
 
 		if ( true === $make_dir ) {
 
 			try {
-				$storage = @new PhpConsole\Storage\File( $phpcdir . '/' . md5( __FILE__ ) . '_pc.data' );
+				$storage = new PhpConsole\Storage\File( $phpcdir . '/' . md5( __FILE__ ) . '_pc.data' );
 				PhpConsole\Connector::setPostponeStorage( $storage );
 			} catch( \Exception $e ) {
-				// TODO $storage is under DOCUMENT_ROOT - it's insecure but did not find another solution in WP
-				$this->print_notice_exception( $e );
+				// PHP Console will complain about this: "Path <...> is under DOCUMENT_ROOT. It's insecure!"
+				// but there's nothing we can do at the moment as there doesn't seem to be another solution in WP
+				// nevertheless PHP Console tool is not meant to be used in production so this shouldn't be a concern
+				// $this->print_notice_exception( $e );
 			}
 
 		}
-		**/
 
-		// Perform PHP Console initialisation required asap for other code to be able to output to the JavaScript console.
+		// Perform PHP Console initialisation required asap
+		// for other code to be able to output to the JavaScript console.
 		if ( ! $this->connector instanceof PhpConsole\Connector ) {
 			$this->connector = PhpConsole\Connector::getInstance();
 		}
@@ -171,7 +174,7 @@ protected function get_options() {
 	/**
 	 * Apply options.
 	 *
-	 * @since 1.4.1
+	 * @since 1.4.0
 	 */
 	private function apply_options() {
 
@@ -180,22 +183,22 @@ private function apply_options() {
 			return;
 		}
 
-		// Apply 'register' option to PHP Console
+		// Apply 'register' option to PHP Console...
 		if ( true === $this->options['register'] && ! class_exists( 'PC', false ) ) {
-			// Only if PC not registered yet
+			// ...only if PC not registered yet.
 			try {
 				PhpConsole\Helper::register();
 			} catch( \Exception $e ) {
 				$this->print_notice_exception( $e );
 			}
 		}
 
-		// Apply 'stack' option to PHP Console
+		// Apply 'stack' option to PHP Console.
 		if ( true === $this->options['stack'] ) {
 			$this->connector->getDebugDispatcher()->detectTraceAndSource = true;
 		}
 
-		// Apply 'short' option to PHP Console
+		// Apply 'short' option to PHP Console.
 		if ( true === $this->options['short'] ) {
 			try {
 				$this->connector->setSourcesBasePath( $_SERVER['DOCUMENT_ROOT'] );
@@ -214,7 +217,7 @@ private function apply_options() {
 	 */
 	public function init() {
 
-		// Set PHP Console extension password.
+		// Get PHP Console extension password.
 		$password = $this->options['password'];
 
 		if ( ! $password ) {
@@ -228,17 +231,19 @@ public function init() {
 			$_POST[ PhpConsole\Connector::POST_VAR_NAME ] = stripslashes_deep( $_POST[ PhpConsole\Connector::POST_VAR_NAME ] );
 		}
 
+		// Get PHP Console instance if wasn't set yet.
 		if ( ! $this->connector instanceof PhpConsole\Connector ) {
 			$this->connector = PhpConsole\Connector::getInstance();
 		}
 
+		// Set PHP Console password.
 		try {
 			$this->connector->setPassword( $password );
 		} catch ( \Exception $e ) {
 			$this->print_notice_exception( $e );
 		}
 
-		// PhpConsole instance.
+		// Get PHP Console handler instance.
 		$handler = PhpConsole\Handler::getInstance();
 
 		if ( true !== PhpConsole\Handler::getInstance()->isStarted() ) {
@@ -325,16 +330,14 @@ public function password_notice() {
 
 		?>
 		<div class="update-nag">
-			<?php
-
+			<p><?php
 			/* translators: Placeholders: %1$s - WP Php Console name, %2$s - opening HTML <a> link tag; %3$s closing HTML </a> link tag */
-			printf( __( '%1$s: Please remember to %2$s set a password %3$s if you want to enable the terminal.', 'wp-php-console' ),
+			printf( __( '%1$s: Please remember to %2$sset a password%3$s if you want to enable the terminal.', 'wp-php-console' ),
 				'<strong>' . self::NAME . '</strong>',
 				'<a href="' . esc_url( admin_url( 'options-general.php?page=wp-php-console' ) ) .'">',
 				'</a>'
-			);
-
-			?>
+			); ?>
+			</p>
 		</div>
 		<?php