insideout10 / wordlift-plugin

src/admin/class-wordlift-admin-page.php

Indentation +145 added lines, -145 removed lines

@@ -18,150 +18,150 @@
  */
 abstract class Wordlift_Admin_Page {
 
-	/**
-	 * Define the {@link Wordlift_Admin_Page} constructor.
-	 *
-	 * @since 3.20.0
-	 */
-	public function __construct() {
-
-		/**
-		 * Filter: wl_feature__enable__screens.
-		 *
-		 * @param bool whether the screens needed to be registered, defaults to true.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__screens', true ) ) {
-			add_action( 'admin_menu', array( $this, 'admin_menu' ), 10, 0 );
-		}
-
-	}
-
-	/**
-	 * Get the parent slug.
-	 *
-	 * @return string The parent slug (default 'wl_admin_menu').
-	 * @since 3.11.0
-	 *
-	 */
-	protected function get_parent_slug() {
-
-		return 'wl_admin_menu';
-	}
-
-	/**
-	 * Get the required capability.
-	 *
-	 * @return string The capability (default 'manage_options').
-	 * @since 3.11.0
-	 *
-	 */
-	protected function get_capability() {
-
-		return 'manage_options';
-	}
-
-	/**
-	 * Get the page title. Will be translated.
-	 *
-	 * @return string The page title.
-	 * @since 3.11.0
-	 *
-	 */
-	abstract function get_page_title();
-
-	/**
-	 * Get the menu title. Will be translated.
-	 *
-	 * @return string The menu title.
-	 * @since 3.11.0
-	 *
-	 */
-	abstract function get_menu_title();
-
-	/**
-	 * Get the menu slug.
-	 *
-	 * @return string The menu slug.
-	 * @since 3.11.0
-	 *
-	 */
-	abstract function get_menu_slug();
-
-	/**
-	 * Get the page url.
-	 *
-	 * @return string The escaped url of the admin page
-	 * @since 3.14.0
-	 *
-	 */
-	function get_url() {
-
-		// ideally should have used menu_page_url, but it is loaded later than some usages.
-		$url = admin_url( 'admin.php?page=' . $this->get_menu_slug() );
-
-		return esc_url( $url );
-	}
-
-	/**
-	 * Get the partial file name, used in the {@link render} function.
-	 *
-	 * @return string The partial file name.
-	 * @since 3.11.0
-	 *
-	 */
-	abstract function get_partial_name();
-
-	/**
-	 * The `admin_menu` callback. Will call {@link add_submenu_page} to add the
-	 * page to the admin menu.
-	 *
-	 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
-	 * @since 3.11.0
-	 *
-	 */
-	public function admin_menu() {
-		// Add the sub-menu page.
-		//
-		// See http://codex.wordpress.org/Function_Reference/add_submenu_page
-		$page = add_submenu_page(
-			$this->get_parent_slug(),
-			$this->get_page_title(),
-			$this->get_menu_title(),
-			$this->get_capability(),                   // The required capability, provided by the calling hook.
-			$this->get_menu_slug(),
-			array( $this, 'render' )
-		);
-
-		// Set a hook to enqueue scripts only when the settings page is displayed.
-		add_action( 'admin_print_scripts-' . $page, array(
-			$this,
-			'enqueue_scripts',
-		) );
-
-		// Finally return the page hook_suffix.
-		return $page;
-	}
-
-	/**
-	 * Enqueue scripts for the specific page. Subclasses can override this function
-	 * to provide their own styles/scripts.
-	 *
-	 * @since 3.11.0
-	 */
-	public function enqueue_scripts() {
-	}
-
-	/**
-	 * Render the page.
-	 */
-	public function render() {
-
-		// Include the partial.
-		include( plugin_dir_path( __FILE__ ) . 'partials/' . $this->get_partial_name() );
-
-	}
+    /**
+     * Define the {@link Wordlift_Admin_Page} constructor.
+     *
+     * @since 3.20.0
+     */
+    public function __construct() {
+
+        /**
+         * Filter: wl_feature__enable__screens.
+         *
+         * @param bool whether the screens needed to be registered, defaults to true.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__screens', true ) ) {
+            add_action( 'admin_menu', array( $this, 'admin_menu' ), 10, 0 );
+        }
+
+    }
+
+    /**
+     * Get the parent slug.
+     *
+     * @return string The parent slug (default 'wl_admin_menu').
+     * @since 3.11.0
+     *
+     */
+    protected function get_parent_slug() {
+
+        return 'wl_admin_menu';
+    }
+
+    /**
+     * Get the required capability.
+     *
+     * @return string The capability (default 'manage_options').
+     * @since 3.11.0
+     *
+     */
+    protected function get_capability() {
+
+        return 'manage_options';
+    }
+
+    /**
+     * Get the page title. Will be translated.
+     *
+     * @return string The page title.
+     * @since 3.11.0
+     *
+     */
+    abstract function get_page_title();
+
+    /**
+     * Get the menu title. Will be translated.
+     *
+     * @return string The menu title.
+     * @since 3.11.0
+     *
+     */
+    abstract function get_menu_title();
+
+    /**
+     * Get the menu slug.
+     *
+     * @return string The menu slug.
+     * @since 3.11.0
+     *
+     */
+    abstract function get_menu_slug();
+
+    /**
+     * Get the page url.
+     *
+     * @return string The escaped url of the admin page
+     * @since 3.14.0
+     *
+     */
+    function get_url() {
+
+        // ideally should have used menu_page_url, but it is loaded later than some usages.
+        $url = admin_url( 'admin.php?page=' . $this->get_menu_slug() );
+
+        return esc_url( $url );
+    }
+
+    /**
+     * Get the partial file name, used in the {@link render} function.
+     *
+     * @return string The partial file name.
+     * @since 3.11.0
+     *
+     */
+    abstract function get_partial_name();
+
+    /**
+     * The `admin_menu` callback. Will call {@link add_submenu_page} to add the
+     * page to the admin menu.
+     *
+     * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
+     * @since 3.11.0
+     *
+     */
+    public function admin_menu() {
+        // Add the sub-menu page.
+        //
+        // See http://codex.wordpress.org/Function_Reference/add_submenu_page
+        $page = add_submenu_page(
+            $this->get_parent_slug(),
+            $this->get_page_title(),
+            $this->get_menu_title(),
+            $this->get_capability(),                   // The required capability, provided by the calling hook.
+            $this->get_menu_slug(),
+            array( $this, 'render' )
+        );
+
+        // Set a hook to enqueue scripts only when the settings page is displayed.
+        add_action( 'admin_print_scripts-' . $page, array(
+            $this,
+            'enqueue_scripts',
+        ) );
+
+        // Finally return the page hook_suffix.
+        return $page;
+    }
+
+    /**
+     * Enqueue scripts for the specific page. Subclasses can override this function
+     * to provide their own styles/scripts.
+     *
+     * @since 3.11.0
+     */
+    public function enqueue_scripts() {
+    }
+
+    /**
+     * Render the page.
+     */
+    public function render() {
+
+        // Include the partial.
+        include( plugin_dir_path( __FILE__ ) . 'partials/' . $this->get_partial_name() );
+
+    }
 
 }

Spacing +9 added lines, -9 removed lines

@@ -33,8 +33,8 @@ 
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__screens', true ) ) {
-			add_action( 'admin_menu', array( $this, 'admin_menu' ), 10, 0 );
+		if (apply_filters('wl_feature__enable__screens', true)) {
+			add_action('admin_menu', array($this, 'admin_menu'), 10, 0);
 		}
 
 	}
@@ -100,9 +100,9 @@ 
 	function get_url() {
 
 		// ideally should have used menu_page_url, but it is loaded later than some usages.
-		$url = admin_url( 'admin.php?page=' . $this->get_menu_slug() );
+		$url = admin_url('admin.php?page='.$this->get_menu_slug());
 
-		return esc_url( $url );
+		return esc_url($url);
 	}
 
 	/**
@@ -130,16 +130,16 @@ 
 			$this->get_parent_slug(),
 			$this->get_page_title(),
 			$this->get_menu_title(),
-			$this->get_capability(),                   // The required capability, provided by the calling hook.
+			$this->get_capability(), // The required capability, provided by the calling hook.
 			$this->get_menu_slug(),
-			array( $this, 'render' )
+			array($this, 'render')
 		);
 
 		// Set a hook to enqueue scripts only when the settings page is displayed.
-		add_action( 'admin_print_scripts-' . $page, array(
+		add_action('admin_print_scripts-'.$page, array(
 			$this,
 			'enqueue_scripts',
-		) );
+		));
 
 		// Finally return the page hook_suffix.
 		return $page;
@@ -160,7 +160,7 @@ 
 	public function render() {
 
 		// Include the partial.
-		include( plugin_dir_path( __FILE__ ) . 'partials/' . $this->get_partial_name() );
+		include(plugin_dir_path(__FILE__).'partials/'.$this->get_partial_name());
 
 	}
 

src/widgets/wordlift_widget_geo.php

Indentation +61 added lines, -61 removed lines

@@ -7,57 +7,57 @@ 
  * Class WordLift_Geo_Widget
  */
 class WordLift_Geo_Widget extends WP_Widget {
-	/**
-	 * Sets up the widgets name etc
-	 */
-	public function __construct() {
-		// Initialize the Widget.
-		parent::__construct(
-			'wl_geo_widget', // Base ID
-			__( 'Geo Widget', 'wordlift' ), // Name
-			array( 'description' => __( 'Geo Widget description', 'wordlift' ), ) // Args
-		);
-	}
+    /**
+     * Sets up the widgets name etc
+     */
+    public function __construct() {
+        // Initialize the Widget.
+        parent::__construct(
+            'wl_geo_widget', // Base ID
+            __( 'Geo Widget', 'wordlift' ), // Name
+            array( 'description' => __( 'Geo Widget description', 'wordlift' ), ) // Args
+        );
+    }
 
-	/**
-	 * Outputs the content of the widget
-	 *
-	 * @param array $args
-	 * @param array $instance
-	 */
-	public function widget( $args, $instance ) {
-		// Get the widget's title.
-		$title = apply_filters( 'widget_title', $instance['title'] );
+    /**
+     * Outputs the content of the widget
+     *
+     * @param array $args
+     * @param array $instance
+     */
+    public function widget( $args, $instance ) {
+        // Get the widget's title.
+        $title = apply_filters( 'widget_title', $instance['title'] );
 
-		// Print the HTML output.
-		echo $args['before_widget'];
-		if ( ! empty( $title ) ) {
-			echo $args['before_title'] . $title . $args['after_title'];
-		}
+        // Print the HTML output.
+        echo $args['before_widget'];
+        if ( ! empty( $title ) ) {
+            echo $args['before_title'] . $title . $args['after_title'];
+        }
 
-		// Print the geomap shortcode
-		// ( global = true - because it is not post-specific)
-		echo do_shortcode( '[wl_geomap global=true]' );
+        // Print the geomap shortcode
+        // ( global = true - because it is not post-specific)
+        echo do_shortcode( '[wl_geomap global=true]' );
 
-		echo $args['after_widget'];
-	}
+        echo $args['after_widget'];
+    }
 
-	/**
-	 * Ouputs the options form on admin
-	 *
-	 * @param array $instance The widget options
-	 */
-	public
-	function form(
-		$instance
-	) {
+    /**
+     * Ouputs the options form on admin
+     *
+     * @param array $instance The widget options
+     */
+    public
+    function form(
+        $instance
+    ) {
 
-		if ( isset( $instance['title'] ) ) {
-			$title = $instance['title'];
-		} else {
-			$title = __( 'New title', 'wordlift' );
-		}
-		?>
+        if ( isset( $instance['title'] ) ) {
+            $title = $instance['title'];
+        } else {
+            $title = __( 'New title', 'wordlift' );
+        }
+        ?>
         <p>
             <label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php esc_html_e( 'Title:' ); ?></label>
             <input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>"
@@ -66,26 +66,26 @@ 
         </p>
 		<?php
 
-	}
+    }
 
-	/**
-	 * Processing widget options on save
-	 *
-	 * @param array $new_instance The new options
-	 * @param array $old_instance The previous options
-	 */
-	public
-	function update(
-		$new_instance, $old_instance
-	) {
+    /**
+     * Processing widget options on save
+     *
+     * @param array $new_instance The new options
+     * @param array $old_instance The previous options
+     */
+    public
+    function update(
+        $new_instance, $old_instance
+    ) {
 
-		$instance          = array();
-		$instance['title'] = ( ! empty( $new_instance['title'] ) ) ? strip_tags( $new_instance['title'] ) : '';
+        $instance          = array();
+        $instance['title'] = ( ! empty( $new_instance['title'] ) ) ? strip_tags( $new_instance['title'] ) : '';
 
-		return $instance;
-	}
+        return $instance;
+    }
 }
 
 function wl_register_geo_widget() {
-	register_widget( 'WordLift_Geo_Widget' );
+    register_widget( 'WordLift_Geo_Widget' );
 }

Spacing +15 added lines, -15 removed lines

@@ -14,8 +14,8 @@ 
 		// Initialize the Widget.
 		parent::__construct(
 			'wl_geo_widget', // Base ID
-			__( 'Geo Widget', 'wordlift' ), // Name
-			array( 'description' => __( 'Geo Widget description', 'wordlift' ), ) // Args
+			__('Geo Widget', 'wordlift'), // Name
+			array('description' => __('Geo Widget description', 'wordlift'),) // Args
 		);
 	}
 
@@ -25,19 +25,19 @@ 
 	 * @param array $args
 	 * @param array $instance
 	 */
-	public function widget( $args, $instance ) {
+	public function widget($args, $instance) {
 		// Get the widget's title.
-		$title = apply_filters( 'widget_title', $instance['title'] );
+		$title = apply_filters('widget_title', $instance['title']);
 
 		// Print the HTML output.
 		echo $args['before_widget'];
-		if ( ! empty( $title ) ) {
-			echo $args['before_title'] . $title . $args['after_title'];
+		if ( ! empty($title)) {
+			echo $args['before_title'].$title.$args['after_title'];
 		}
 
 		// Print the geomap shortcode
 		// ( global = true - because it is not post-specific)
-		echo do_shortcode( '[wl_geomap global=true]' );
+		echo do_shortcode('[wl_geomap global=true]');
 
 		echo $args['after_widget'];
 	}
@@ -52,17 +52,17 @@ 
 		$instance
 	) {
 
-		if ( isset( $instance['title'] ) ) {
+		if (isset($instance['title'])) {
 			$title = $instance['title'];
 		} else {
-			$title = __( 'New title', 'wordlift' );
+			$title = __('New title', 'wordlift');
 		}
 		?>
         <p>
-            <label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php esc_html_e( 'Title:' ); ?></label>
-            <input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>"
-                   name="<?php echo $this->get_field_name( 'title' ); ?>" type="text"
-                   value="<?php echo esc_attr( $title ); ?>">
+            <label for="<?php echo $this->get_field_id('title'); ?>"><?php esc_html_e('Title:'); ?></label>
+            <input class="widefat" id="<?php echo $this->get_field_id('title'); ?>"
+                   name="<?php echo $this->get_field_name('title'); ?>" type="text"
+                   value="<?php echo esc_attr($title); ?>">
         </p>
 		<?php
 
@@ -80,12 +80,12 @@ 
 	) {
 
 		$instance          = array();
-		$instance['title'] = ( ! empty( $new_instance['title'] ) ) ? strip_tags( $new_instance['title'] ) : '';
+		$instance['title'] = ( ! empty($new_instance['title'])) ? strip_tags($new_instance['title']) : '';
 
 		return $instance;
 	}
 }
 
 function wl_register_geo_widget() {
-	register_widget( 'WordLift_Geo_Widget' );
+	register_widget('WordLift_Geo_Widget');
 }

src/widgets/wordlift_widget_timeline.php

Indentation +39 added lines, -39 removed lines

@@ -2,50 +2,50 @@
 
 class Wordlift_Timeline_Widget extends WP_Widget {
 
-	/**
-	 * Sets up the widgets name etc
-	 */
-	public function __construct() {
-		// widget actual processes
-		parent::__construct(
-			'wl_timeline_widget', // Base ID
-			__( 'WordLift Timeline Widget', 'wordlift' ), // Name
-			array( 'description' => __( 'Displays entities of type event using an interactive timeline.', 'wordlift' ), ) // Args
-		);
-	}
+    /**
+     * Sets up the widgets name etc
+     */
+    public function __construct() {
+        // widget actual processes
+        parent::__construct(
+            'wl_timeline_widget', // Base ID
+            __( 'WordLift Timeline Widget', 'wordlift' ), // Name
+            array( 'description' => __( 'Displays entities of type event using an interactive timeline.', 'wordlift' ), ) // Args
+        );
+    }
 
-	/**
-	 * Outputs the content of the widget
-	 *
-	 * @param array $args
-	 * @param array $instance
-	 */
-	public function widget( $args, $instance ) {
-		// outputs the content of the widget	
-		echo do_shortcode( '[wl_timeline global=true]' );
-	}
+    /**
+     * Outputs the content of the widget
+     *
+     * @param array $args
+     * @param array $instance
+     */
+    public function widget( $args, $instance ) {
+        // outputs the content of the widget	
+        echo do_shortcode( '[wl_timeline global=true]' );
+    }
 
-	/**
-	 * Outputs the options form on admin
-	 *
-	 * @param array $instance The widget options
-	 */
-	public function form( $instance ) {
-		// outputs the options form on admin
-	}
+    /**
+     * Outputs the options form on admin
+     *
+     * @param array $instance The widget options
+     */
+    public function form( $instance ) {
+        // outputs the options form on admin
+    }
 
-	/**
-	 * Processing widget options on save
-	 *
-	 * @param array $new_instance The new options
-	 * @param array $old_instance The previous options
-	 */
-	public function update( $new_instance, $old_instance ) {
-		// processes widget options to be saved
-	}
+    /**
+     * Processing widget options on save
+     *
+     * @param array $new_instance The new options
+     * @param array $old_instance The previous options
+     */
+    public function update( $new_instance, $old_instance ) {
+        // processes widget options to be saved
+    }
 }
 
 function wl_register_timeline_widget() {
 
-	register_widget( 'WordLift_Timeline_Widget' );
+    register_widget( 'WordLift_Timeline_Widget' );
 }

Spacing +7 added lines, -7 removed lines

@@ -9,8 +9,8 @@ 
 		// widget actual processes
 		parent::__construct(
 			'wl_timeline_widget', // Base ID
-			__( 'WordLift Timeline Widget', 'wordlift' ), // Name
-			array( 'description' => __( 'Displays entities of type event using an interactive timeline.', 'wordlift' ), ) // Args
+			__('WordLift Timeline Widget', 'wordlift'), // Name
+			array('description' => __('Displays entities of type event using an interactive timeline.', 'wordlift'),) // Args
 		);
 	}
 
@@ -20,9 +20,9 @@ 
 	 * @param array $args
 	 * @param array $instance
 	 */
-	public function widget( $args, $instance ) {
+	public function widget($args, $instance) {
 		// outputs the content of the widget	
-		echo do_shortcode( '[wl_timeline global=true]' );
+		echo do_shortcode('[wl_timeline global=true]');
 	}
 
 	/**
@@ -30,7 +30,7 @@ 
 	 *
 	 * @param array $instance The widget options
 	 */
-	public function form( $instance ) {
+	public function form($instance) {
 		// outputs the options form on admin
 	}
 
@@ -40,12 +40,12 @@ 
 	 * @param array $new_instance The new options
 	 * @param array $old_instance The previous options
 	 */
-	public function update( $new_instance, $old_instance ) {
+	public function update($new_instance, $old_instance) {
 		// processes widget options to be saved
 	}
 }
 
 function wl_register_timeline_widget() {
 
-	register_widget( 'WordLift_Timeline_Widget' );
+	register_widget('WordLift_Timeline_Widget');
 }

src/widgets/class-wordlift-chord-widget.php

Indentation +46 added lines, -46 removed lines

@@ -10,54 +10,54 @@ 
  */
 class Wordlift_Chord_Widget extends WP_Widget {
 
-	/**
-	 * Sets up the widgets name etc
-	 */
-	public function __construct() {
-		// widget actual processes.
-		parent::__construct(
-			'wl_chord_widget', // Base ID.
-			__( 'Chord Widget', 'wordlift' ), // Name.
-			array(
-				'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ),
-			) // Args.
-		);
-	}
+    /**
+     * Sets up the widgets name etc
+     */
+    public function __construct() {
+        // widget actual processes.
+        parent::__construct(
+            'wl_chord_widget', // Base ID.
+            __( 'Chord Widget', 'wordlift' ), // Name.
+            array(
+                'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ),
+            ) // Args.
+        );
+    }
 
-	/**
-	 * Outputs the content of the widget
-	 *
-	 * @param array $args widget args.
-	 * @param array $instance widget instance.
-	 */
-	// @codingStandardsIgnoreLine Generic.CodeAnalysis.UnusedFunctionParameter.Found
-	public function widget( $args, $instance ) {
-		// outputs the content of the widget.
-		echo do_shortcode( '[wl_chord global=true]' );
-	}
+    /**
+     * Outputs the content of the widget
+     *
+     * @param array $args widget args.
+     * @param array $instance widget instance.
+     */
+    // @codingStandardsIgnoreLine Generic.CodeAnalysis.UnusedFunctionParameter.Found
+    public function widget( $args, $instance ) {
+        // outputs the content of the widget.
+        echo do_shortcode( '[wl_chord global=true]' );
+    }
 
-	/**
-	 * Outputs the options form on admin
-	 *
-	 * @param array $instance The widget options.
-	 *
-	 * @return string|void
-	 */
-	public function form( $instance ) {
-		// outputs the options form on admin.
-	}
+    /**
+     * Outputs the options form on admin
+     *
+     * @param array $instance The widget options.
+     *
+     * @return string|void
+     */
+    public function form( $instance ) {
+        // outputs the options form on admin.
+    }
 
-	/**
-	 * Processing widget options on save
-	 *
-	 * @param array $new_instance The new options.
-	 * @param array $old_instance The previous options.
-	 *
-	 * @return array|void
-	 */
-	public function update( $new_instance, $old_instance ) {
-		// processes widget options to be saved.
-	}
+    /**
+     * Processing widget options on save
+     *
+     * @param array $new_instance The new options.
+     * @param array $old_instance The previous options.
+     *
+     * @return array|void
+     */
+    public function update( $new_instance, $old_instance ) {
+        // processes widget options to be saved.
+    }
 }
 
 /**
@@ -67,5 +67,5 @@ 
  */
 function wl_register_chord_widget() {
 
-	register_widget( 'WordLift_Chord_Widget' );
+    register_widget( 'WordLift_Chord_Widget' );
 }
\ No newline at end of file

Spacing +7 added lines, -7 removed lines

@@ -17,9 +17,9 @@ 
 		// widget actual processes.
 		parent::__construct(
 			'wl_chord_widget', // Base ID.
-			__( 'Chord Widget', 'wordlift' ), // Name.
+			__('Chord Widget', 'wordlift'), // Name.
 			array(
-				'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ),
+				'description' => __('The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift'),
 			) // Args.
 		);
 	}
@@ -31,9 +31,9 @@ 
 	 * @param array $instance widget instance.
 	 */
 	// @codingStandardsIgnoreLine Generic.CodeAnalysis.UnusedFunctionParameter.Found
-	public function widget( $args, $instance ) {
+	public function widget($args, $instance) {
 		// outputs the content of the widget.
-		echo do_shortcode( '[wl_chord global=true]' );
+		echo do_shortcode('[wl_chord global=true]');
 	}
 
 	/**
@@ -43,7 +43,7 @@ 
 	 *
 	 * @return string|void
 	 */
-	public function form( $instance ) {
+	public function form($instance) {
 		// outputs the options form on admin.
 	}
 
@@ -55,7 +55,7 @@ 
 	 *
 	 * @return array|void
 	 */
-	public function update( $new_instance, $old_instance ) {
+	public function update($new_instance, $old_instance) {
 		// processes widget options to be saved.
 	}
 }
@@ -67,5 +67,5 @@ 
  */
 function wl_register_chord_widget() {
 
-	register_widget( 'WordLift_Chord_Widget' );
+	register_widget('WordLift_Chord_Widget');
 }
\ No newline at end of file

src/wordlift/external-plugin-hooks/recipe-maker/class-recipe-maker-warning.php

Doc Comments +3 added lines

@@ -15,6 +15,9 @@
 	 */
 	private $recipe_maker_validation_service;
 
+	/**
+	 * @param Recipe_Maker_Validation_Service $recipe_maker_validation_service
+	 */
 	public function __construct( $recipe_maker_validation_service ) {
 		$this->recipe_maker_validation_service = $recipe_maker_validation_service;
 		/**

Indentation +87 added lines, -87 removed lines

@@ -10,99 +10,99 @@
  */
 class Recipe_Maker_Warning {
 
-	/**
-	 * @var Recipe_Maker_Validation_Service
-	 */
-	private $recipe_maker_validation_service;
-
-	public function __construct( $recipe_maker_validation_service ) {
-		$this->recipe_maker_validation_service = $recipe_maker_validation_service;
-		/**
-		 * Filter: wl_feature__enable__notices.
-		 *
-		 * @param bool whether the notices needs to be enabled or not.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			add_action( 'admin_notices', array( $this, 'display_image_size_warning' ) );
-		}
-	}
-
-	/**
-	 * Show the warning after applying the conditions.
-	 */
-	public function display_image_size_warning() {
-
-		// Check if we are on the post.
-		if ( ! get_post() instanceof \WP_Post ) {
-			return false;
-		}
-		if ( ! $this->recipe_maker_validation_service->is_wp_recipe_maker_available() ) {
-			return false;
-		}
-		$post_id = get_the_ID();
-
-		// Dont show notification if there is no recipes referred by the post.
-		if ( ! $this->recipe_maker_validation_service->is_atleast_once_recipe_present_in_the_post( $post_id ) ) {
-			return false;
-		}
-
-		$recipe_with_image_warnings = $this->get_warnings( $post_id );
-
-		if ( count( $recipe_with_image_warnings ) > 0 ) {
-			// Show notification.
-			?>
+    /**
+     * @var Recipe_Maker_Validation_Service
+     */
+    private $recipe_maker_validation_service;
+
+    public function __construct( $recipe_maker_validation_service ) {
+        $this->recipe_maker_validation_service = $recipe_maker_validation_service;
+        /**
+         * Filter: wl_feature__enable__notices.
+         *
+         * @param bool whether the notices needs to be enabled or not.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+            add_action( 'admin_notices', array( $this, 'display_image_size_warning' ) );
+        }
+    }
+
+    /**
+     * Show the warning after applying the conditions.
+     */
+    public function display_image_size_warning() {
+
+        // Check if we are on the post.
+        if ( ! get_post() instanceof \WP_Post ) {
+            return false;
+        }
+        if ( ! $this->recipe_maker_validation_service->is_wp_recipe_maker_available() ) {
+            return false;
+        }
+        $post_id = get_the_ID();
+
+        // Dont show notification if there is no recipes referred by the post.
+        if ( ! $this->recipe_maker_validation_service->is_atleast_once_recipe_present_in_the_post( $post_id ) ) {
+            return false;
+        }
+
+        $recipe_with_image_warnings = $this->get_warnings( $post_id );
+
+        if ( count( $recipe_with_image_warnings ) > 0 ) {
+            // Show notification.
+            ?>
             <div class="notice notice-warning is-dismissible">
                 <p><?php echo __( 'The following recipes didnt have minimum image size of 1200 x 1200 px', 'wordlift' ); ?></p>
                 <ol>
 					<?php
-					foreach ( $recipe_with_image_warnings as $post_id ) {
-						echo "<li>" . get_the_title( $post_id ) . "</li>";
-					}
-					?>
+                    foreach ( $recipe_with_image_warnings as $post_id ) {
+                        echo "<li>" . get_the_title( $post_id ) . "</li>";
+                    }
+                    ?>
                 </ol>
             </div>
 			<?php
-		}
-
-	}
-
-	/**
-	 * @param $post_id
-	 *
-	 * @return array
-	 */
-	private function get_warnings( $post_id ) {
-
-		$recipe_ids = \WPRM_Recipe_Manager::get_recipe_ids_from_post( $post_id );
-
-		// Dont show duplicate warnings.
-		$recipe_ids = array_unique( $recipe_ids );
-
-		$recipe_with_image_warnings = array();
-
-		foreach ( $recipe_ids as $recipe_id ) {
-			$recipe     = \WPRM_Recipe_Manager::get_recipe( $recipe_id );
-			$image_id   = $recipe->image_id();
-			$image_data = wp_get_attachment_image_src( $image_id, array( 1200, 1200 ) );
-			if ( ! is_array( $image_data ) ) {
-				continue;
-			}
-			$image_width  = array_key_exists( 1, $image_data ) ? $image_data [1] : false;
-			$image_height = array_key_exists( 2, $image_data ) ? $image_data [2] : false;
-			if ( ! ( $image_height && $image_width ) ) {
-				continue;
-			}
-
-			if ( $image_height < 1200 || $image_width < 1200 ) {
-				// Image size not present in 1200 * 1200, show a warning.
-				$recipe_with_image_warnings[] = $recipe_id;
-			}
-		}
-
-		return $recipe_with_image_warnings;
-	}
+        }
+
+    }
+
+    /**
+     * @param $post_id
+     *
+     * @return array
+     */
+    private function get_warnings( $post_id ) {
+
+        $recipe_ids = \WPRM_Recipe_Manager::get_recipe_ids_from_post( $post_id );
+
+        // Dont show duplicate warnings.
+        $recipe_ids = array_unique( $recipe_ids );
+
+        $recipe_with_image_warnings = array();
+
+        foreach ( $recipe_ids as $recipe_id ) {
+            $recipe     = \WPRM_Recipe_Manager::get_recipe( $recipe_id );
+            $image_id   = $recipe->image_id();
+            $image_data = wp_get_attachment_image_src( $image_id, array( 1200, 1200 ) );
+            if ( ! is_array( $image_data ) ) {
+                continue;
+            }
+            $image_width  = array_key_exists( 1, $image_data ) ? $image_data [1] : false;
+            $image_height = array_key_exists( 2, $image_data ) ? $image_data [2] : false;
+            if ( ! ( $image_height && $image_width ) ) {
+                continue;
+            }
+
+            if ( $image_height < 1200 || $image_width < 1200 ) {
+                // Image size not present in 1200 * 1200, show a warning.
+                $recipe_with_image_warnings[] = $recipe_id;
+            }
+        }
+
+        return $recipe_with_image_warnings;
+    }
 
 }

Spacing +22 added lines, -22 removed lines

@@ -15,7 +15,7 @@ 
 	 */
 	private $recipe_maker_validation_service;
 
-	public function __construct( $recipe_maker_validation_service ) {
+	public function __construct($recipe_maker_validation_service) {
 		$this->recipe_maker_validation_service = $recipe_maker_validation_service;
 		/**
 		 * Filter: wl_feature__enable__notices.
@@ -25,8 +25,8 @@ 
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			add_action( 'admin_notices', array( $this, 'display_image_size_warning' ) );
+		if (apply_filters('wl_feature__enable__notices', true)) {
+			add_action('admin_notices', array($this, 'display_image_size_warning'));
 		}
 	}
 
@@ -36,30 +36,30 @@ 
 	public function display_image_size_warning() {
 
 		// Check if we are on the post.
-		if ( ! get_post() instanceof \WP_Post ) {
+		if ( ! get_post() instanceof \WP_Post) {
 			return false;
 		}
-		if ( ! $this->recipe_maker_validation_service->is_wp_recipe_maker_available() ) {
+		if ( ! $this->recipe_maker_validation_service->is_wp_recipe_maker_available()) {
 			return false;
 		}
 		$post_id = get_the_ID();
 
 		// Dont show notification if there is no recipes referred by the post.
-		if ( ! $this->recipe_maker_validation_service->is_atleast_once_recipe_present_in_the_post( $post_id ) ) {
+		if ( ! $this->recipe_maker_validation_service->is_atleast_once_recipe_present_in_the_post($post_id)) {
 			return false;
 		}
 
-		$recipe_with_image_warnings = $this->get_warnings( $post_id );
+		$recipe_with_image_warnings = $this->get_warnings($post_id);
 
-		if ( count( $recipe_with_image_warnings ) > 0 ) {
+		if (count($recipe_with_image_warnings) > 0) {
 			// Show notification.
 			?>
             <div class="notice notice-warning is-dismissible">
-                <p><?php echo __( 'The following recipes didnt have minimum image size of 1200 x 1200 px', 'wordlift' ); ?></p>
+                <p><?php echo __('The following recipes didnt have minimum image size of 1200 x 1200 px', 'wordlift'); ?></p>
                 <ol>
 					<?php
-					foreach ( $recipe_with_image_warnings as $post_id ) {
-						echo "<li>" . get_the_title( $post_id ) . "</li>";
+					foreach ($recipe_with_image_warnings as $post_id) {
+						echo "<li>".get_the_title($post_id)."</li>";
 					}
 					?>
                 </ol>
@@ -74,29 +74,29 @@ 
 	 *
 	 * @return array
 	 */
-	private function get_warnings( $post_id ) {
+	private function get_warnings($post_id) {
 
-		$recipe_ids = \WPRM_Recipe_Manager::get_recipe_ids_from_post( $post_id );
+		$recipe_ids = \WPRM_Recipe_Manager::get_recipe_ids_from_post($post_id);
 
 		// Dont show duplicate warnings.
-		$recipe_ids = array_unique( $recipe_ids );
+		$recipe_ids = array_unique($recipe_ids);
 
 		$recipe_with_image_warnings = array();
 
-		foreach ( $recipe_ids as $recipe_id ) {
-			$recipe     = \WPRM_Recipe_Manager::get_recipe( $recipe_id );
+		foreach ($recipe_ids as $recipe_id) {
+			$recipe     = \WPRM_Recipe_Manager::get_recipe($recipe_id);
 			$image_id   = $recipe->image_id();
-			$image_data = wp_get_attachment_image_src( $image_id, array( 1200, 1200 ) );
-			if ( ! is_array( $image_data ) ) {
+			$image_data = wp_get_attachment_image_src($image_id, array(1200, 1200));
+			if ( ! is_array($image_data)) {
 				continue;
 			}
-			$image_width  = array_key_exists( 1, $image_data ) ? $image_data [1] : false;
-			$image_height = array_key_exists( 2, $image_data ) ? $image_data [2] : false;
-			if ( ! ( $image_height && $image_width ) ) {
+			$image_width  = array_key_exists(1, $image_data) ? $image_data [1] : false;
+			$image_height = array_key_exists(2, $image_data) ? $image_data [2] : false;
+			if ( ! ($image_height && $image_width)) {
 				continue;
 			}
 
-			if ( $image_height < 1200 || $image_width < 1200 ) {
+			if ($image_height < 1200 || $image_width < 1200) {
 				// Image size not present in 1200 * 1200, show a warning.
 				$recipe_with_image_warnings[] = $recipe_id;
 			}

src/includes/class-wordlift-key-validation-service.php

Indentation +149 added lines, -149 removed lines

@@ -17,157 +17,157 @@
  */
 class Wordlift_Key_Validation_Service {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * Create a {@link Wordlift_Key_Validation_Service} instance.
-	 *
-	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since 3.14.0
-	 *
-	 */
-	public function __construct( $configuration_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
-
-		$this->configuration_service = $configuration_service;
-		add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
-		/**
-		 * Filter: wl_feature__enable__notices.
-		 *
-		 * @param bool whether the notices needs to be enabled or not.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
-		}
-	}
-
-	/**
-	 * Validate the provided key.
-	 *
-	 * @param string $key WordLift's key to validate.
-	 *
-	 * @return WP_Error|array The response or WP_Error on failure.
-	 * @since 3.9.0
-	 *
-	 */
-	public function get_account_info( $key ) {
-
-		$this->log->debug( 'Validating key...' );
-
-		// Request the account info as a way to validate the key
-
-		$args = array_merge_recursive(
-			unserialize( WL_REDLINK_API_HTTP_OPTIONS ),
-			array(
-				'headers' => array(
-					'Content-Type'    => 'application/json; charset=utf-8',
-					'X-Authorization' => $key,
-				)
-			)
-		);
-
-		return wp_remote_get( $this->configuration_service->get_accounts_info_by_key( $key ), $args );
-	}
-
-	/**
-	 * This function is hooked to the `wl_validate_key` AJAX call.
-	 *
-	 * @since 3.9.0
-	 */
-	public function validate_key() {
-
-		// Ensure we don't have garbage before us.
-		ob_clean();
-
-		// Check if we have a key.
-		if ( ! isset( $_POST['key'] ) ) {
-			wp_send_json_error( 'The key parameter is required.' );
-		}
-
-		$response = $this->get_account_info( $_POST['key'] );
-
-		// If we got an error, return invalid.
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			wp_send_json_success( array( 'valid' => false, 'message' => '' ) );
-		}
-
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
-
-		// The URL stored in WLS. If this is the initial install the URL may be null.
-		$url = $res_body['url'];
-
-		// If the URL isn't set or matches, then it's valid.
-		if ( is_null( $url ) || $url === get_option( 'home' ) ) {
-			wp_send_json_success( array( 'valid' => true, 'message' => '' ) );
-		}
-
-		// If the URL doesn't match it means that this key has been configured elsewhere already.
-		if ( $url !== get_option( 'home' ) ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			wp_send_json_success( array(
-				'valid'   => false,
-				'message' => __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ),
-			) );
-		}
-
-		// Set a response with valid set to true or false according to the key validity with message.
-		wp_send_json_success( array(
-			'valid'   => false,
-			'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
-		) );
-	}
-
-	/**
-	 * This function is hooked `admin_init` to check _wl_blog_url.
-	 *
-	 */
-	public function wl_load_plugin() {
-
-		$wl_blog_url = get_option( '_wl_blog_url' );
-		$home_url    = defined( 'WP_HOME' ) ? WP_HOME : get_option( 'home' );
-
-		if ( ! $wl_blog_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-		} else if ( $wl_blog_url !== $home_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			set_transient( 'wl-key-error-msg', __( "Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift' ), 10 );
-		}
-
-	}
-
-	/**
-	 * This function is hooked to the `admin_notices` to show admin notification.
-	 *
-	 */
-	public function wl_key_update_notice() {
-		if ( get_transient( 'wl-key-error-msg' ) ) {
-			?>
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * Create a {@link Wordlift_Key_Validation_Service} instance.
+     *
+     * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since 3.14.0
+     *
+     */
+    public function __construct( $configuration_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+
+        $this->configuration_service = $configuration_service;
+        add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
+        /**
+         * Filter: wl_feature__enable__notices.
+         *
+         * @param bool whether the notices needs to be enabled or not.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+            add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
+        }
+    }
+
+    /**
+     * Validate the provided key.
+     *
+     * @param string $key WordLift's key to validate.
+     *
+     * @return WP_Error|array The response or WP_Error on failure.
+     * @since 3.9.0
+     *
+     */
+    public function get_account_info( $key ) {
+
+        $this->log->debug( 'Validating key...' );
+
+        // Request the account info as a way to validate the key
+
+        $args = array_merge_recursive(
+            unserialize( WL_REDLINK_API_HTTP_OPTIONS ),
+            array(
+                'headers' => array(
+                    'Content-Type'    => 'application/json; charset=utf-8',
+                    'X-Authorization' => $key,
+                )
+            )
+        );
+
+        return wp_remote_get( $this->configuration_service->get_accounts_info_by_key( $key ), $args );
+    }
+
+    /**
+     * This function is hooked to the `wl_validate_key` AJAX call.
+     *
+     * @since 3.9.0
+     */
+    public function validate_key() {
+
+        // Ensure we don't have garbage before us.
+        ob_clean();
+
+        // Check if we have a key.
+        if ( ! isset( $_POST['key'] ) ) {
+            wp_send_json_error( 'The key parameter is required.' );
+        }
+
+        $response = $this->get_account_info( $_POST['key'] );
+
+        // If we got an error, return invalid.
+        if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+            wp_send_json_success( array( 'valid' => false, 'message' => '' ) );
+        }
+
+        $res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+        // The URL stored in WLS. If this is the initial install the URL may be null.
+        $url = $res_body['url'];
+
+        // If the URL isn't set or matches, then it's valid.
+        if ( is_null( $url ) || $url === get_option( 'home' ) ) {
+            wp_send_json_success( array( 'valid' => true, 'message' => '' ) );
+        }
+
+        // If the URL doesn't match it means that this key has been configured elsewhere already.
+        if ( $url !== get_option( 'home' ) ) {
+            Wordlift_Configuration_Service::get_instance()->set_key( '' );
+            wp_send_json_success( array(
+                'valid'   => false,
+                'message' => __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ),
+            ) );
+        }
+
+        // Set a response with valid set to true or false according to the key validity with message.
+        wp_send_json_success( array(
+            'valid'   => false,
+            'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
+        ) );
+    }
+
+    /**
+     * This function is hooked `admin_init` to check _wl_blog_url.
+     *
+     */
+    public function wl_load_plugin() {
+
+        $wl_blog_url = get_option( '_wl_blog_url' );
+        $home_url    = defined( 'WP_HOME' ) ? WP_HOME : get_option( 'home' );
+
+        if ( ! $wl_blog_url ) {
+            update_option( '_wl_blog_url', $home_url, true );
+        } else if ( $wl_blog_url !== $home_url ) {
+            update_option( '_wl_blog_url', $home_url, true );
+            Wordlift_Configuration_Service::get_instance()->set_key( '' );
+            set_transient( 'wl-key-error-msg', __( "Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift' ), 10 );
+        }
+
+    }
+
+    /**
+     * This function is hooked to the `admin_notices` to show admin notification.
+     *
+     */
+    public function wl_key_update_notice() {
+        if ( get_transient( 'wl-key-error-msg' ) ) {
+            ?>
             <div class="updated notice is-dismissible error">
                 <p><?php _e( get_transient( 'wl-key-error-msg' ), 'wordlift' ); ?></p>
             </div>
 			<?php
-		}
-	}
+        }
+    }
 }

Spacing +35 added lines, -35 removed lines

@@ -43,12 +43,12 @@ 
 	 * @since 3.14.0
 	 *
 	 */
-	public function __construct( $configuration_service ) {
+	public function __construct($configuration_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Key_Validation_Service');
 
 		$this->configuration_service = $configuration_service;
-		add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
+		add_action('admin_init', array($this, 'wl_load_plugin'));
 		/**
 		 * Filter: wl_feature__enable__notices.
 		 *
@@ -57,8 +57,8 @@ 
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
+		if (apply_filters('wl_feature__enable__notices', true)) {
+			add_action('admin_notices', array($this, 'wl_key_update_notice'));
 		}
 	}
 
@@ -71,14 +71,14 @@ 
 	 * @since 3.9.0
 	 *
 	 */
-	public function get_account_info( $key ) {
+	public function get_account_info($key) {
 
-		$this->log->debug( 'Validating key...' );
+		$this->log->debug('Validating key...');
 
 		// Request the account info as a way to validate the key
 
 		$args = array_merge_recursive(
-			unserialize( WL_REDLINK_API_HTTP_OPTIONS ),
+			unserialize(WL_REDLINK_API_HTTP_OPTIONS),
 			array(
 				'headers' => array(
 					'Content-Type'    => 'application/json; charset=utf-8',
@@ -87,7 +87,7 @@ 
 			)
 		);
 
-		return wp_remote_get( $this->configuration_service->get_accounts_info_by_key( $key ), $args );
+		return wp_remote_get($this->configuration_service->get_accounts_info_by_key($key), $args);
 	}
 
 	/**
@@ -101,41 +101,41 @@ 
 		ob_clean();
 
 		// Check if we have a key.
-		if ( ! isset( $_POST['key'] ) ) {
-			wp_send_json_error( 'The key parameter is required.' );
+		if ( ! isset($_POST['key'])) {
+			wp_send_json_error('The key parameter is required.');
 		}
 
-		$response = $this->get_account_info( $_POST['key'] );
+		$response = $this->get_account_info($_POST['key']);
 
 		// If we got an error, return invalid.
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			wp_send_json_success( array( 'valid' => false, 'message' => '' ) );
+		if (is_wp_error($response) || 2 !== (int) $response['response']['code'] / 100) {
+			wp_send_json_success(array('valid' => false, 'message' => ''));
 		}
 
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+		$res_body = json_decode(wp_remote_retrieve_body($response), true);
 
 		// The URL stored in WLS. If this is the initial install the URL may be null.
 		$url = $res_body['url'];
 
 		// If the URL isn't set or matches, then it's valid.
-		if ( is_null( $url ) || $url === get_option( 'home' ) ) {
-			wp_send_json_success( array( 'valid' => true, 'message' => '' ) );
+		if (is_null($url) || $url === get_option('home')) {
+			wp_send_json_success(array('valid' => true, 'message' => ''));
 		}
 
 		// If the URL doesn't match it means that this key has been configured elsewhere already.
-		if ( $url !== get_option( 'home' ) ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			wp_send_json_success( array(
+		if ($url !== get_option('home')) {
+			Wordlift_Configuration_Service::get_instance()->set_key('');
+			wp_send_json_success(array(
 				'valid'   => false,
-				'message' => __( 'The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift' ),
-			) );
+				'message' => __('The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift'),
+			));
 		}
 
 		// Set a response with valid set to true or false according to the key validity with message.
-		wp_send_json_success( array(
+		wp_send_json_success(array(
 			'valid'   => false,
-			'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
-		) );
+			'message' => __('An error occurred, please contact us at hello@wordlift.io', 'wordlift'),
+		));
 	}
 
 	/**
@@ -144,15 +144,15 @@ 
 	 */
 	public function wl_load_plugin() {
 
-		$wl_blog_url = get_option( '_wl_blog_url' );
-		$home_url    = defined( 'WP_HOME' ) ? WP_HOME : get_option( 'home' );
+		$wl_blog_url = get_option('_wl_blog_url');
+		$home_url    = defined('WP_HOME') ? WP_HOME : get_option('home');
 
-		if ( ! $wl_blog_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-		} else if ( $wl_blog_url !== $home_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			set_transient( 'wl-key-error-msg', __( "Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift' ), 10 );
+		if ( ! $wl_blog_url) {
+			update_option('_wl_blog_url', $home_url, true);
+		} else if ($wl_blog_url !== $home_url) {
+			update_option('_wl_blog_url', $home_url, true);
+			Wordlift_Configuration_Service::get_instance()->set_key('');
+			set_transient('wl-key-error-msg', __("Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift'), 10);
 		}
 
 	}
@@ -162,10 +162,10 @@ 
 	 *
 	 */
 	public function wl_key_update_notice() {
-		if ( get_transient( 'wl-key-error-msg' ) ) {
+		if (get_transient('wl-key-error-msg')) {
 			?>
             <div class="updated notice is-dismissible error">
-                <p><?php _e( get_transient( 'wl-key-error-msg' ), 'wordlift' ); ?></p>
+                <p><?php _e(get_transient('wl-key-error-msg'), 'wordlift'); ?></p>
             </div>
 			<?php
 		}

src/admin/class-wordlift-entity-type-settings.php

Indentation +202 added lines, -202 removed lines

@@ -13,7 +13,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -30,217 +30,217 @@ 
  */
 class Wordlift_Admin_Entity_Type_Settings {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a {@link Wordlift_Admin_Entity_Type_Settings} instance.
-	 *
-	 * @since 3.14.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Admin_Entity_Type_Settings' );
-
-	}
-
-	/**
-	 * Handle menu registration.
-	 *
-	 * The registration is required, although we do not want to actually to add
-	 * an item to the menu, in order to "whitelist" the access to the settings page in
-	 * the admin.
-	 *
-	 * @since 3.11.0
-	 */
-	public function admin_menu() {
-
-		/*
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a {@link Wordlift_Admin_Entity_Type_Settings} instance.
+     *
+     * @since 3.14.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Admin_Entity_Type_Settings' );
+
+    }
+
+    /**
+     * Handle menu registration.
+     *
+     * The registration is required, although we do not want to actually to add
+     * an item to the menu, in order to "whitelist" the access to the settings page in
+     * the admin.
+     *
+     * @since 3.11.0
+     */
+    public function admin_menu() {
+
+        /*
 		 * Before anything else check if an settings form was submitted.
 		 * This has to be done before any output happens in order to be able to
 		 * display proper "die" error messages and redirect.
 		 */
-		if ( isset( $_GET['page'] ) && ( 'wl_entity_type_settings' === $_GET['page'] ) ) {
-
-			// Validate inputs. Do not return on invalid parameters or capabilities.
-			$this->validate_proper_term();
-
-			// If proper form submission, handle it and redirect back to the settings page.
-			if ( isset( $_POST['action'] ) && ( 'wl_edit_entity_type_term' === $_POST['action'] ) ) {
-				$this->handle_form_submission();
-			}
-			/**
-			 * Filter: wl_feature__enable__notices.
-			 *
-			 * @param bool whether the notices needs to be enabled or not.
-			 *
-			 * @return bool
-			 * @since 3.27.6
-			 */
-			if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-				// Register admin notices handler.
-				add_action( 'admin_notices', array( $this, 'admin_notice' ) );
-			}
-
-		}
-
-		/*
+        if ( isset( $_GET['page'] ) && ( 'wl_entity_type_settings' === $_GET['page'] ) ) {
+
+            // Validate inputs. Do not return on invalid parameters or capabilities.
+            $this->validate_proper_term();
+
+            // If proper form submission, handle it and redirect back to the settings page.
+            if ( isset( $_POST['action'] ) && ( 'wl_edit_entity_type_term' === $_POST['action'] ) ) {
+                $this->handle_form_submission();
+            }
+            /**
+             * Filter: wl_feature__enable__notices.
+             *
+             * @param bool whether the notices needs to be enabled or not.
+             *
+             * @return bool
+             * @since 3.27.6
+             */
+            if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+                // Register admin notices handler.
+                add_action( 'admin_notices', array( $this, 'admin_notice' ) );
+            }
+
+        }
+
+        /*
 		 * Use a null parent slug to prevent the menu from actually appearing
 		 * in the admin menu.
 		 */
-		// @todo: use the new {@link Wordlift_Admin_Page}.
-		add_submenu_page(
-			null,
-			__( 'Edit Entity term', 'wordlift' ),
-			__( 'Edit Entity term', 'wordlift' ),
-			'manage_options',
-			'wl_entity_type_settings',
-			array( $this, 'render' )
-		);
-	}
-
-	/**
-	 * Output admin notices if needed, based on the message url parameter.
-	 * A value of 1 indicates that a successful save was done.
-	 *
-	 * @since 3.11.0
-	 */
-	function admin_notice() {
-		if ( isset( $_GET['message'] ) && ( '1' === $_GET['message'] ) ) {
-			?>
+        // @todo: use the new {@link Wordlift_Admin_Page}.
+        add_submenu_page(
+            null,
+            __( 'Edit Entity term', 'wordlift' ),
+            __( 'Edit Entity term', 'wordlift' ),
+            'manage_options',
+            'wl_entity_type_settings',
+            array( $this, 'render' )
+        );
+    }
+
+    /**
+     * Output admin notices if needed, based on the message url parameter.
+     * A value of 1 indicates that a successful save was done.
+     *
+     * @since 3.11.0
+     */
+    function admin_notice() {
+        if ( isset( $_GET['message'] ) && ( '1' === $_GET['message'] ) ) {
+            ?>
             <div class="notice notice-success is-dismissible">
                 <p><?php esc_html_e( 'Settings saved', 'wordlift' ) ?></p>
             </div>
 			<?php
-		}
-	}
-
-	/**
-	 * Validate the existence of the entity type indicated by the tag_ID url
-	 * parameter before doing any processing. Done before any output to mimic
-	 * the way WordPress handles same situation with "normal" term editing screens.
-	 *
-	 * @since 3.11.0
-	 */
-	function validate_proper_term() {
-
-		// Validate capabilities.
-		if ( ! current_user_can( 'manage_options' ) ) {
-			wp_die(
-				'<h1>' . __( 'Cheatin&#8217; uh?' ) . '</h1>' .
-				'<p>' . __( 'Sorry, you are not allowed to edit this item.' ) . '</p>',
-				403
-			);
-		}
-
-		// Get the term id and the actual term.
-		$term_id = (int) $_REQUEST['tag_ID'];
-
-		if ( ! term_exists( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) ) {
-			wp_die( __( 'You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift' ) );
-		}
-
-	}
-
-	/**
-	 * Handle the form submission of the settings form. On successful
-	 * handling redirect tp the setting edit page.
-	 *
-	 * @since 3.11.0
-	 */
-	function handle_form_submission() {
-
-		$term_id = (int) $_POST['tag_ID'];
-
-		// Check the nonce.
-		check_admin_referer( 'update-entity_type_term_' . $term_id );
-
-		$term = get_term( $term_id, 'wl_entity_type' );
-
-		$this->set_setting(
-			$term_id,
-			trim( wp_unslash( $_POST['title'] ) ),
-			wp_unslash( $_POST['description'] )
-		);
-
-		// Redirect back to the term settings page and indicate a save was done.
-		$url = admin_url( "admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1" );
-
-		wp_redirect( $url );
-		exit;
-
-	}
-
-	/**
-	 * Render the settings page for the term.
-	 *
-	 * Access and parameter validity is assumed to be done earlier.
-	 *
-	 * @since 3.11.0
-	 */
-	function render() {
-
-		// Set variables used by the partial
-		$term_id  = absint( $_REQUEST['tag_ID'] );
-		$settings = $this->get_setting( $term_id );
-
-		include plugin_dir_path( dirname( __FILE__ ) ) . 'admin/partials/wordlift-admin-entity-type-settings.php';
-
-	}
-
-	/**
-	 * Store the entity type term settings in the DB
-	 *
-	 * @param integer $term_id The ID of the entity type term
-	 * @param string $title The override for the terms title.
-	 * @param string $description The override for the terms description.
-	 *
-	 * @since 3.11.0
-	 *
-	 */
-	function set_setting( $term_id, $title, $description ) {
-
-		$settings             = get_option( 'wl_entity_type_settings', array() );
-		$settings[ $term_id ] = array(
-			'title'       => $title,
-			'description' => $description,
-		);
-		update_option( 'wl_entity_type_settings', $settings );
-
-	}
-
-	/**
-	 * Retrieve the entity type term settings from the DB
-	 *
-	 * @param integer $term_id The ID of the entity type term
-	 *
-	 * @return    null|array {
-	 *                null is returned when there are no settings otherwise
-	 *                an array is returned with following fields
-	 *
-	 * @type    string    title    The overriding title for the term
-	 * @type    string    description    The overriding description for the term
-	 *            }
-	 * @since 3.11.0
-	 *
-	 */
-	function get_setting( $term_id ) {
-
-		$settings = get_option( 'wl_entity_type_settings', array() );
-
-		if ( isset( $settings[ $term_id ] ) ) {
-			return $settings[ $term_id ];
-		}
-
-		$this->log->warn( "No settings found for term id $term_id." );
-
-		return null;
-	}
+        }
+    }
+
+    /**
+     * Validate the existence of the entity type indicated by the tag_ID url
+     * parameter before doing any processing. Done before any output to mimic
+     * the way WordPress handles same situation with "normal" term editing screens.
+     *
+     * @since 3.11.0
+     */
+    function validate_proper_term() {
+
+        // Validate capabilities.
+        if ( ! current_user_can( 'manage_options' ) ) {
+            wp_die(
+                '<h1>' . __( 'Cheatin&#8217; uh?' ) . '</h1>' .
+                '<p>' . __( 'Sorry, you are not allowed to edit this item.' ) . '</p>',
+                403
+            );
+        }
+
+        // Get the term id and the actual term.
+        $term_id = (int) $_REQUEST['tag_ID'];
+
+        if ( ! term_exists( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) ) {
+            wp_die( __( 'You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift' ) );
+        }
+
+    }
+
+    /**
+     * Handle the form submission of the settings form. On successful
+     * handling redirect tp the setting edit page.
+     *
+     * @since 3.11.0
+     */
+    function handle_form_submission() {
+
+        $term_id = (int) $_POST['tag_ID'];
+
+        // Check the nonce.
+        check_admin_referer( 'update-entity_type_term_' . $term_id );
+
+        $term = get_term( $term_id, 'wl_entity_type' );
+
+        $this->set_setting(
+            $term_id,
+            trim( wp_unslash( $_POST['title'] ) ),
+            wp_unslash( $_POST['description'] )
+        );
+
+        // Redirect back to the term settings page and indicate a save was done.
+        $url = admin_url( "admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1" );
+
+        wp_redirect( $url );
+        exit;
+
+    }
+
+    /**
+     * Render the settings page for the term.
+     *
+     * Access and parameter validity is assumed to be done earlier.
+     *
+     * @since 3.11.0
+     */
+    function render() {
+
+        // Set variables used by the partial
+        $term_id  = absint( $_REQUEST['tag_ID'] );
+        $settings = $this->get_setting( $term_id );
+
+        include plugin_dir_path( dirname( __FILE__ ) ) . 'admin/partials/wordlift-admin-entity-type-settings.php';
+
+    }
+
+    /**
+     * Store the entity type term settings in the DB
+     *
+     * @param integer $term_id The ID of the entity type term
+     * @param string $title The override for the terms title.
+     * @param string $description The override for the terms description.
+     *
+     * @since 3.11.0
+     *
+     */
+    function set_setting( $term_id, $title, $description ) {
+
+        $settings             = get_option( 'wl_entity_type_settings', array() );
+        $settings[ $term_id ] = array(
+            'title'       => $title,
+            'description' => $description,
+        );
+        update_option( 'wl_entity_type_settings', $settings );
+
+    }
+
+    /**
+     * Retrieve the entity type term settings from the DB
+     *
+     * @param integer $term_id The ID of the entity type term
+     *
+     * @return    null|array {
+     *                null is returned when there are no settings otherwise
+     *                an array is returned with following fields
+     *
+     * @type    string    title    The overriding title for the term
+     * @type    string    description    The overriding description for the term
+     *            }
+     * @since 3.11.0
+     *
+     */
+    function get_setting( $term_id ) {
+
+        $settings = get_option( 'wl_entity_type_settings', array() );
+
+        if ( isset( $settings[ $term_id ] ) ) {
+            return $settings[ $term_id ];
+        }
+
+        $this->log->warn( "No settings found for term id $term_id." );
+
+        return null;
+    }
 
 }

Spacing +34 added lines, -34 removed lines

@@ -12,7 +12,7 @@ 
  * @since      3.11.0
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -46,7 +46,7 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Admin_Entity_Type_Settings' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Admin_Entity_Type_Settings');
 
 	}
 
@@ -66,13 +66,13 @@ 
 		 * This has to be done before any output happens in order to be able to
 		 * display proper "die" error messages and redirect.
 		 */
-		if ( isset( $_GET['page'] ) && ( 'wl_entity_type_settings' === $_GET['page'] ) ) {
+		if (isset($_GET['page']) && ('wl_entity_type_settings' === $_GET['page'])) {
 
 			// Validate inputs. Do not return on invalid parameters or capabilities.
 			$this->validate_proper_term();
 
 			// If proper form submission, handle it and redirect back to the settings page.
-			if ( isset( $_POST['action'] ) && ( 'wl_edit_entity_type_term' === $_POST['action'] ) ) {
+			if (isset($_POST['action']) && ('wl_edit_entity_type_term' === $_POST['action'])) {
 				$this->handle_form_submission();
 			}
 			/**
@@ -83,9 +83,9 @@ 
 			 * @return bool
 			 * @since 3.27.6
 			 */
-			if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+			if (apply_filters('wl_feature__enable__notices', true)) {
 				// Register admin notices handler.
-				add_action( 'admin_notices', array( $this, 'admin_notice' ) );
+				add_action('admin_notices', array($this, 'admin_notice'));
 			}
 
 		}
@@ -97,11 +97,11 @@ 
 		// @todo: use the new {@link Wordlift_Admin_Page}.
 		add_submenu_page(
 			null,
-			__( 'Edit Entity term', 'wordlift' ),
-			__( 'Edit Entity term', 'wordlift' ),
+			__('Edit Entity term', 'wordlift'),
+			__('Edit Entity term', 'wordlift'),
 			'manage_options',
 			'wl_entity_type_settings',
-			array( $this, 'render' )
+			array($this, 'render')
 		);
 	}
 
@@ -112,10 +112,10 @@ 
 	 * @since 3.11.0
 	 */
 	function admin_notice() {
-		if ( isset( $_GET['message'] ) && ( '1' === $_GET['message'] ) ) {
+		if (isset($_GET['message']) && ('1' === $_GET['message'])) {
 			?>
             <div class="notice notice-success is-dismissible">
-                <p><?php esc_html_e( 'Settings saved', 'wordlift' ) ?></p>
+                <p><?php esc_html_e('Settings saved', 'wordlift') ?></p>
             </div>
 			<?php
 		}
@@ -131,10 +131,10 @@ 
 	function validate_proper_term() {
 
 		// Validate capabilities.
-		if ( ! current_user_can( 'manage_options' ) ) {
+		if ( ! current_user_can('manage_options')) {
 			wp_die(
-				'<h1>' . __( 'Cheatin&#8217; uh?' ) . '</h1>' .
-				'<p>' . __( 'Sorry, you are not allowed to edit this item.' ) . '</p>',
+				'<h1>'.__('Cheatin&#8217; uh?').'</h1>'.
+				'<p>'.__('Sorry, you are not allowed to edit this item.').'</p>',
 				403
 			);
 		}
@@ -142,8 +142,8 @@ 
 		// Get the term id and the actual term.
 		$term_id = (int) $_REQUEST['tag_ID'];
 
-		if ( ! term_exists( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) ) {
-			wp_die( __( 'You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift' ) );
+		if ( ! term_exists($term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME)) {
+			wp_die(__('You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift'));
 		}
 
 	}
@@ -159,20 +159,20 @@ 
 		$term_id = (int) $_POST['tag_ID'];
 
 		// Check the nonce.
-		check_admin_referer( 'update-entity_type_term_' . $term_id );
+		check_admin_referer('update-entity_type_term_'.$term_id);
 
-		$term = get_term( $term_id, 'wl_entity_type' );
+		$term = get_term($term_id, 'wl_entity_type');
 
 		$this->set_setting(
 			$term_id,
-			trim( wp_unslash( $_POST['title'] ) ),
-			wp_unslash( $_POST['description'] )
+			trim(wp_unslash($_POST['title'])),
+			wp_unslash($_POST['description'])
 		);
 
 		// Redirect back to the term settings page and indicate a save was done.
-		$url = admin_url( "admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1" );
+		$url = admin_url("admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1");
 
-		wp_redirect( $url );
+		wp_redirect($url);
 		exit;
 
 	}
@@ -187,10 +187,10 @@ 
 	function render() {
 
 		// Set variables used by the partial
-		$term_id  = absint( $_REQUEST['tag_ID'] );
-		$settings = $this->get_setting( $term_id );
+		$term_id  = absint($_REQUEST['tag_ID']);
+		$settings = $this->get_setting($term_id);
 
-		include plugin_dir_path( dirname( __FILE__ ) ) . 'admin/partials/wordlift-admin-entity-type-settings.php';
+		include plugin_dir_path(dirname(__FILE__)).'admin/partials/wordlift-admin-entity-type-settings.php';
 
 	}
 
@@ -204,14 +204,14 @@ 
 	 * @since 3.11.0
 	 *
 	 */
-	function set_setting( $term_id, $title, $description ) {
+	function set_setting($term_id, $title, $description) {
 
-		$settings             = get_option( 'wl_entity_type_settings', array() );
-		$settings[ $term_id ] = array(
+		$settings             = get_option('wl_entity_type_settings', array());
+		$settings[$term_id] = array(
 			'title'       => $title,
 			'description' => $description,
 		);
-		update_option( 'wl_entity_type_settings', $settings );
+		update_option('wl_entity_type_settings', $settings);
 
 	}
 
@@ -230,15 +230,15 @@ 
 	 * @since 3.11.0
 	 *
 	 */
-	function get_setting( $term_id ) {
+	function get_setting($term_id) {
 
-		$settings = get_option( 'wl_entity_type_settings', array() );
+		$settings = get_option('wl_entity_type_settings', array());
 
-		if ( isset( $settings[ $term_id ] ) ) {
-			return $settings[ $term_id ];
+		if (isset($settings[$term_id])) {
+			return $settings[$term_id];
 		}
 
-		$this->log->warn( "No settings found for term id $term_id." );
+		$this->log->warn("No settings found for term id $term_id.");
 
 		return null;
 	}

src/admin/class-wordlift-notice-service.php

Indentation +189 added lines, -189 removed lines

@@ -7,194 +7,194 @@
  */
 class Wordlift_Notice_Service {
 
-	/**
-	 * The template used to display notices. The <em>notice dismissible</em> style classes make this notice dismissible
-	 * on the WordPress UI (via a small X button on the right side of the notice).
-	 *
-	 * @since 3.2.0
-	 */
-	const TEMPLATE = '<div class="wl-notice notice is-dismissible %s"><p>%s</p></div>';
-
-	/**
-	 * The standard WordPress <em>update</em> style class.
-	 *
-	 * @since 3.2.0
-	 */
-	const UPDATE = 'update';
-
-	/**
-	 * The standard WordPress <em>update-nag</em> style class.
-	 *
-	 * @since 3.2.0
-	 */
-	const UPDATE_NAG = 'update-nag';
-
-	/**
-	 * The standard WordPress <em>error</em> style class.
-	 *
-	 * @since 3.2.0
-	 */
-	const ERROR = 'error';
-
-	/**
-	 * A custom WordLift css style class used for WordLift suggestions.
-	 *
-	 * @since 3.3.0
-	 */
-	const SUGGESTION = 'wl-suggestion';
-
-	/**
-	 * The array of notices.
-	 *
-	 * @since 3.2.0
-	 * @access private
-	 * @var array $notices The array of notices.
-	 */
-	private $notices = array();
-
-	/**
-	 * A singleton instance of the Notice service.
-	 *
-	 * @since 3.2.0
-	 * @access private
-	 * @var \Wordlift_Notice_Service $instance A singleton instance of the Notice service.
-	 */
-	private static $instance;
-
-	/**
-	 * Create an instance of the Notice service.
-	 *
-	 * @since 3.2.0
-	 */
-	public function __construct() {
-		/**
-		 * Filter: wl_feature__enable__notices.
-		 *
-		 * @param bool whether the notices needs to be enabled or not.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			// Hook to be called when to display notices.
-			add_action( 'admin_notices', array( $this, 'admin_notices' ) );
-		}
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance of the Notice service.
-	 *
-	 * @return \Wordlift_Notice_Service The singleton instance of the Notice service.
-	 * @since 3.2.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Add a notice.
-	 *
-	 * @param string $class The css class.
-	 * @param string $message The message.
-	 *
-	 * @since 3.2.0
-	 *
-	 */
-	public function add( $class, $message ) {
-
-		$this->notices[] = sprintf( self::TEMPLATE, $class, $this->transform( $message ) );
-
-	}
-
-	/**
-	 * Add an update notice (message with a white background and a green left border).
-	 *
-	 * @param string $message The message to display.
-	 *
-	 * @since 3.2.0
-	 *
-	 */
-	public function add_update( $message ) {
-
-		$this->add( self::UPDATE, $message );
-
-	}
-
-	/**
-	 * Add an update nag notice (message with a white background and a yellow left border).
-	 *
-	 * @param string $message The message to display.
-	 *
-	 * @since 3.2.0
-	 *
-	 */
-	public function add_update_nag( $message ) {
-
-		$this->add( self::UPDATE_NAG, $message );
-
-	}
-
-	/**
-	 * Add an error notice (message with a white background and a red left border).
-	 *
-	 * @param string $message The message to display.
-	 *
-	 * @since 3.2.0
-	 *
-	 */
-	public function add_error( $message ) {
-
-		$this->add( self::ERROR, $message );
-
-	}
-
-	/**
-	 * Add a suggestion notice (message with a white background and a WordLift brand colored left border).
-	 *
-	 * @param string $message The message to display.
-	 *
-	 * @since 3.3.0
-	 *
-	 */
-	public function add_suggestion( $message ) {
-
-		$this->add( self::SUGGESTION, $message );
-
-	}
-
-	/**
-	 * Print out the notices when the admin_notices action is called.
-	 *
-	 * @since 3.2.0
-	 */
-	public function admin_notices() {
-
-		foreach ( $this->notices as $notice ) {
-			echo( $notice );
-		}
-
-	}
-
-	/**
-	 * Transform message depending on message type. Return a string
-	 *
-	 * @param string $message The message.
-	 *
-	 * @since 3.3.0
-	 *
-	 */
-	private function transform( $message ) {
-
-		switch ( gettype( $message ) ) {
-			case 'array':
-				return implode( $message, '<br />' );
-			default:
-				return $message;
-		}
-
-	}
+    /**
+     * The template used to display notices. The <em>notice dismissible</em> style classes make this notice dismissible
+     * on the WordPress UI (via a small X button on the right side of the notice).
+     *
+     * @since 3.2.0
+     */
+    const TEMPLATE = '<div class="wl-notice notice is-dismissible %s"><p>%s</p></div>';
+
+    /**
+     * The standard WordPress <em>update</em> style class.
+     *
+     * @since 3.2.0
+     */
+    const UPDATE = 'update';
+
+    /**
+     * The standard WordPress <em>update-nag</em> style class.
+     *
+     * @since 3.2.0
+     */
+    const UPDATE_NAG = 'update-nag';
+
+    /**
+     * The standard WordPress <em>error</em> style class.
+     *
+     * @since 3.2.0
+     */
+    const ERROR = 'error';
+
+    /**
+     * A custom WordLift css style class used for WordLift suggestions.
+     *
+     * @since 3.3.0
+     */
+    const SUGGESTION = 'wl-suggestion';
+
+    /**
+     * The array of notices.
+     *
+     * @since 3.2.0
+     * @access private
+     * @var array $notices The array of notices.
+     */
+    private $notices = array();
+
+    /**
+     * A singleton instance of the Notice service.
+     *
+     * @since 3.2.0
+     * @access private
+     * @var \Wordlift_Notice_Service $instance A singleton instance of the Notice service.
+     */
+    private static $instance;
+
+    /**
+     * Create an instance of the Notice service.
+     *
+     * @since 3.2.0
+     */
+    public function __construct() {
+        /**
+         * Filter: wl_feature__enable__notices.
+         *
+         * @param bool whether the notices needs to be enabled or not.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+            // Hook to be called when to display notices.
+            add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+        }
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance of the Notice service.
+     *
+     * @return \Wordlift_Notice_Service The singleton instance of the Notice service.
+     * @since 3.2.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Add a notice.
+     *
+     * @param string $class The css class.
+     * @param string $message The message.
+     *
+     * @since 3.2.0
+     *
+     */
+    public function add( $class, $message ) {
+
+        $this->notices[] = sprintf( self::TEMPLATE, $class, $this->transform( $message ) );
+
+    }
+
+    /**
+     * Add an update notice (message with a white background and a green left border).
+     *
+     * @param string $message The message to display.
+     *
+     * @since 3.2.0
+     *
+     */
+    public function add_update( $message ) {
+
+        $this->add( self::UPDATE, $message );
+
+    }
+
+    /**
+     * Add an update nag notice (message with a white background and a yellow left border).
+     *
+     * @param string $message The message to display.
+     *
+     * @since 3.2.0
+     *
+     */
+    public function add_update_nag( $message ) {
+
+        $this->add( self::UPDATE_NAG, $message );
+
+    }
+
+    /**
+     * Add an error notice (message with a white background and a red left border).
+     *
+     * @param string $message The message to display.
+     *
+     * @since 3.2.0
+     *
+     */
+    public function add_error( $message ) {
+
+        $this->add( self::ERROR, $message );
+
+    }
+
+    /**
+     * Add a suggestion notice (message with a white background and a WordLift brand colored left border).
+     *
+     * @param string $message The message to display.
+     *
+     * @since 3.3.0
+     *
+     */
+    public function add_suggestion( $message ) {
+
+        $this->add( self::SUGGESTION, $message );
+
+    }
+
+    /**
+     * Print out the notices when the admin_notices action is called.
+     *
+     * @since 3.2.0
+     */
+    public function admin_notices() {
+
+        foreach ( $this->notices as $notice ) {
+            echo( $notice );
+        }
+
+    }
+
+    /**
+     * Transform message depending on message type. Return a string
+     *
+     * @param string $message The message.
+     *
+     * @since 3.3.0
+     *
+     */
+    private function transform( $message ) {
+
+        switch ( gettype( $message ) ) {
+            case 'array':
+                return implode( $message, '<br />' );
+            default:
+                return $message;
+        }
+
+    }
 
 }

Spacing +17 added lines, -17 removed lines

@@ -75,9 +75,9 @@ 
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+		if (apply_filters('wl_feature__enable__notices', true)) {
 			// Hook to be called when to display notices.
-			add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+			add_action('admin_notices', array($this, 'admin_notices'));
 		}
 		self::$instance = $this;
 
@@ -103,9 +103,9 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function add( $class, $message ) {
+	public function add($class, $message) {
 
-		$this->notices[] = sprintf( self::TEMPLATE, $class, $this->transform( $message ) );
+		$this->notices[] = sprintf(self::TEMPLATE, $class, $this->transform($message));
 
 	}
 
@@ -117,9 +117,9 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function add_update( $message ) {
+	public function add_update($message) {
 
-		$this->add( self::UPDATE, $message );
+		$this->add(self::UPDATE, $message);
 
 	}
 
@@ -131,9 +131,9 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function add_update_nag( $message ) {
+	public function add_update_nag($message) {
 
-		$this->add( self::UPDATE_NAG, $message );
+		$this->add(self::UPDATE_NAG, $message);
 
 	}
 
@@ -145,9 +145,9 @@ 
 	 * @since 3.2.0
 	 *
 	 */
-	public function add_error( $message ) {
+	public function add_error($message) {
 
-		$this->add( self::ERROR, $message );
+		$this->add(self::ERROR, $message);
 
 	}
 
@@ -159,9 +159,9 @@ 
 	 * @since 3.3.0
 	 *
 	 */
-	public function add_suggestion( $message ) {
+	public function add_suggestion($message) {
 
-		$this->add( self::SUGGESTION, $message );
+		$this->add(self::SUGGESTION, $message);
 
 	}
 
@@ -172,8 +172,8 @@ 
 	 */
 	public function admin_notices() {
 
-		foreach ( $this->notices as $notice ) {
-			echo( $notice );
+		foreach ($this->notices as $notice) {
+			echo($notice);
 		}
 
 	}
@@ -186,11 +186,11 @@ 
 	 * @since 3.3.0
 	 *
 	 */
-	private function transform( $message ) {
+	private function transform($message) {
 
-		switch ( gettype( $message ) ) {
+		switch (gettype($message)) {
 			case 'array':
-				return implode( $message, '<br />' );
+				return implode($message, '<br />');
 			default:
 				return $message;
 		}

src/admin/class-wordlift-admin-setup.php

Indentation +282 added lines, -282 removed lines

@@ -13,7 +13,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -28,148 +28,148 @@ 
  */
 class Wordlift_Admin_Setup {
 
-	/**
-	 * A {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.9.0
-	 * @access private
-	 * @var Wordlift_Configuration_Service A {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * A {@link Wordlift_Key_Validation_Service} instance.
-	 *
-	 * @since  3.9.0
-	 * @access private
-	 * @var Wordlift_Key_Validation_Service A {@link Wordlift_Key_Validation_Service} instance.
-	 */
-	private $key_validation_service;
-
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.9.0
-	 * @access private
-	 * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 *
-	 * @since  3.20.0
-	 * @access private
-	 * @var \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 */
-	private $language_select_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 *
-	 * @since  3.20.0
-	 * @access private
-	 * @var \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 */
-	private $country_select_element;
-
-	/**
-	 * Initialize the class and set its properties.
-	 *
-	 * @param \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
-	 * @param \Wordlift_Key_Validation_Service $key_validation_service A {@link Wordlift_Key_Validation_Service} instance.
-	 * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
-	 * @param \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
-	 *
-	 * @since    3.9.0
-	 *
-	 */
-	public function __construct( $configuration_service, $key_validation_service, $entity_service, $language_select_element, $country_select_element ) {
-
-		// Set a reference to the configuration service.
-		$this->configuration_service = $configuration_service;
-
-		// Set a reference to the key validation service.
-		$this->key_validation_service = $key_validation_service;
-
-		// Set a reference to the entity service.
-		$this->entity_service = $entity_service;
-
-		// Set a reference to the UI elements language and country.
-		$this->language_select_element = $language_select_element;
-		$this->country_select_element  = $country_select_element;
-
-		// Hook to some WP's events:
-		// When WP is loaded check whether the user decided to skip the set-up, i.e. don't show us even if WL is not set up.
-		add_action( 'wp_loaded', array( $this, 'hide_notices' ) );
-
-		// Hook to `admin_menu` in order to add our own setup wizard page.
-		add_action( 'admin_menu', array( $this, 'admin_menu' ) );
-
-
-		/**
-		 * Filter: wl_feature__enable__setup_screen.
-		 *
-		 * @param bool whether the setup screen needs to be shown or not, default to true.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__setup_screen', true ) ) {
-			// Triggered when the user accesses the admin area, we decide whether to show our own wizard.
-			add_action( 'admin_init', array( $this, 'show_page' ) );
-		}
-		/**
-		 * Filter: wl_feature__enable__notices.
-		 * @param bool whether the notices needs to be enabled or not.
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			// Hook to `admin_notices` to display our notices.
-			add_action( 'admin_notices', array( $this, 'admin_notices' ) );
-		}
-	}
-
-	/**
-	 * Hook to `admin_init` and redirect to WordLift's setup page if the `_wl_activation_redirect` transient flag is set.
-	 *
-	 * @since 3.9.0
-	 */
-	public function admin_init() {
-
-		// If the `_wl_activation_redirect` is set, the redirect to the setup page.
-		if ( get_transient( '_wl_activation_redirect' ) ) {
-			delete_transient( '_wl_activation_redirect' );
-
-			// If the user asked to skip the wizard then comply.
-			if ( $this->configuration_service->is_skip_wizard() ) {
-				return;
-			}
-
-			// If we're already on the page or the user doesn't have permissions, return.
-			if ( ( ! empty( $_GET['page'] ) && 'wl-setup' === $_GET['page'] ) || is_network_admin() || isset( $_GET['activate-multi'] ) || ! current_user_can( 'manage_options' ) ) {
-				return;
-			}
-
-			// Finally redirect to the setup page.
-			wp_safe_redirect( admin_url( 'index.php?page=wl-setup' ) );
-
-			exit;
-		}
-
-	}
-
-	/**
-	 * Generate an admin notice suggesting to start the wizard if there is no configuration.
-	 *
-	 * @since    3.9.0
-	 */
-	public function admin_notices() {
-
-		// Use `wl_configuration_get_key` to check whether WL's key is set and that the user didn't disable the wizard.
-		if ( '' === $this->configuration_service->get_key() && ! $this->configuration_service->is_skip_wizard() ) { ?>
+    /**
+     * A {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.9.0
+     * @access private
+     * @var Wordlift_Configuration_Service A {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * A {@link Wordlift_Key_Validation_Service} instance.
+     *
+     * @since  3.9.0
+     * @access private
+     * @var Wordlift_Key_Validation_Service A {@link Wordlift_Key_Validation_Service} instance.
+     */
+    private $key_validation_service;
+
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.9.0
+     * @access private
+     * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     *
+     * @since  3.20.0
+     * @access private
+     * @var \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     */
+    private $language_select_element;
+
+    /**
+     * A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     *
+     * @since  3.20.0
+     * @access private
+     * @var \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     */
+    private $country_select_element;
+
+    /**
+     * Initialize the class and set its properties.
+     *
+     * @param \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
+     * @param \Wordlift_Key_Validation_Service $key_validation_service A {@link Wordlift_Key_Validation_Service} instance.
+     * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Admin_Language_Select_Element $language_select_element A {@link Wordlift_Admin_Language_Select_Element} element renderer.
+     * @param \Wordlift_Admin_Country_Select_Element $country_select_element A {@link Wordlift_Admin_Country_Select_Element} element renderer.
+     *
+     * @since    3.9.0
+     *
+     */
+    public function __construct( $configuration_service, $key_validation_service, $entity_service, $language_select_element, $country_select_element ) {
+
+        // Set a reference to the configuration service.
+        $this->configuration_service = $configuration_service;
+
+        // Set a reference to the key validation service.
+        $this->key_validation_service = $key_validation_service;
+
+        // Set a reference to the entity service.
+        $this->entity_service = $entity_service;
+
+        // Set a reference to the UI elements language and country.
+        $this->language_select_element = $language_select_element;
+        $this->country_select_element  = $country_select_element;
+
+        // Hook to some WP's events:
+        // When WP is loaded check whether the user decided to skip the set-up, i.e. don't show us even if WL is not set up.
+        add_action( 'wp_loaded', array( $this, 'hide_notices' ) );
+
+        // Hook to `admin_menu` in order to add our own setup wizard page.
+        add_action( 'admin_menu', array( $this, 'admin_menu' ) );
+
+
+        /**
+         * Filter: wl_feature__enable__setup_screen.
+         *
+         * @param bool whether the setup screen needs to be shown or not, default to true.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__setup_screen', true ) ) {
+            // Triggered when the user accesses the admin area, we decide whether to show our own wizard.
+            add_action( 'admin_init', array( $this, 'show_page' ) );
+        }
+        /**
+         * Filter: wl_feature__enable__notices.
+         * @param bool whether the notices needs to be enabled or not.
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+            // Hook to `admin_notices` to display our notices.
+            add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+        }
+    }
+
+    /**
+     * Hook to `admin_init` and redirect to WordLift's setup page if the `_wl_activation_redirect` transient flag is set.
+     *
+     * @since 3.9.0
+     */
+    public function admin_init() {
+
+        // If the `_wl_activation_redirect` is set, the redirect to the setup page.
+        if ( get_transient( '_wl_activation_redirect' ) ) {
+            delete_transient( '_wl_activation_redirect' );
+
+            // If the user asked to skip the wizard then comply.
+            if ( $this->configuration_service->is_skip_wizard() ) {
+                return;
+            }
+
+            // If we're already on the page or the user doesn't have permissions, return.
+            if ( ( ! empty( $_GET['page'] ) && 'wl-setup' === $_GET['page'] ) || is_network_admin() || isset( $_GET['activate-multi'] ) || ! current_user_can( 'manage_options' ) ) {
+                return;
+            }
+
+            // Finally redirect to the setup page.
+            wp_safe_redirect( admin_url( 'index.php?page=wl-setup' ) );
+
+            exit;
+        }
+
+    }
+
+    /**
+     * Generate an admin notice suggesting to start the wizard if there is no configuration.
+     *
+     * @since    3.9.0
+     */
+    public function admin_notices() {
+
+        // Use `wl_configuration_get_key` to check whether WL's key is set and that the user didn't disable the wizard.
+        if ( '' === $this->configuration_service->get_key() && ! $this->configuration_service->is_skip_wizard() ) { ?>
             <div id="wl-message" class="updated">
                 <p><?php esc_html_e( 'Welcome to WordLift &#8211; You&lsquo;re almost ready to start', 'wordlift' ); ?></p>
                 <p class="submit">
@@ -181,144 +181,144 @@ 
             </div>
 		<?php }
 
-	}
-
-	/**
-	 * Handle hiding the wizard notices by user request.
-	 *
-	 * @since    3.9.0
-	 */
-	public function hide_notices() {
-
-		// If it's not a `wl-hide-notice` or the nonce is not set, return.
-		if ( ! isset( $_GET['wl-hide-notice'], $_GET['_wl_notice_nonce'] ) ) {
-			return;
-		}
-
-		// If the nonce is invalid, return an error.
-		if ( ! wp_verify_nonce( $_GET['_wl_notice_nonce'], 'wordlift_hide_notices_nonce' ) ) {
-			wp_die( __( 'Action failed. Please refresh the page and retry.', 'wordlift' ) );
-		}
-
-		// If the user doesn't have the right privileges, return an error.
-		if ( ! current_user_can( 'manage_options' ) ) {
-			wp_die( __( 'Cheatin&#8217; huh?', 'wordlift' ) );
-		}
-
-		// Store a flag telling to skip the wizard.
-		$this->configuration_service->set_skip_wizard( true );
-
-	}
-
-	/**
-	 * Register the wizard page to be able to access it.
-	 *
-	 * @since    3.9.0
-	 */
-	public function admin_menu() {
-		/**
-		 * Filter: wl_feature__enable__screens.
-		 *
-		 * @param bool whether the screens needed to be registered, defaults to true.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__screens', true ) ) {
-			// @todo: find another way to do this, since this is adding an empty space in WP's dashboard menu.
-			add_dashboard_page( '', '', 'manage_options', 'wl-setup', '' );
-		}
-	}
-
-	/**
-	 * Displays the wizard page.
-	 *
-	 * @since    3.9.0
-	 */
-	public function show_page() {
-
-		// First check if we are in the wizard page at all, if not do nothing.
-		if ( empty( $_GET['page'] ) || 'wl-setup' !== $_GET['page'] ) {
-			return;
-		}
-
-		// If it's a POST and the `wl-save-configuration` action is set, save the configuration.
-		if ( isset( $_POST['action'] ) && 'wl-save-configuration' === $_POST['action'] ) {
-
-			// Check the nonce and the user capabilities.
-			check_admin_referer( 'wl-save-configuration' );
-
-			// Check if the user has the right privileges.
-			if ( ! current_user_can( 'manage_options' ) ) {
-				wp_die( __( 'Sorry, you do not have a permission to save the settings', 'wordlift' ) );
-			}
-
-			// Save the configuration.
-			$this->save_configuration( $_POST );
-
-			// Redirect to the admin's page.
-			wp_redirect( admin_url() );
-
-			exit;
-		}
-
-		$language_select = $this->language_select_element;
-		$country_select  = $this->country_select_element;
-
-		include plugin_dir_path( dirname( __FILE__ ) ) . 'admin/partials/wordlift-admin-setup.php';
-
-		exit;
-	}
-
-	/**
-	 * Save WordLift's configuration using the provided parameters.
-	 *
-	 * @param array $params An array of configuration parameters.
-	 *
-	 * @since 3.9.0
-	 *
-	 */
-	private function save_configuration( $params ) {
-
-		// We have the following parameters:
-		// `key`, holding WL's key,
-		// `vocabulary`, holding the vocabulary path,
-		// `language`, with the language code (e.g. `en`),
-		// `send_diagnostic`, the user preferences about sharing data with us.
-		// `user_type`, the user type either `personal` or `company`,
-		// `name`, with the `personal` or `company`'s name,
-		// `logo`, the attachment id for the `personal` or `company` entity.
-
-		// Store the key:
-		$this->configuration_service->set_key( $params['key'] );
-
-		// Store the vocabulary path:
-		$this->configuration_service->set_entity_base_path( $params['vocabulary'] );
-
-		// Store the site's language:
-		$this->configuration_service->set_language_code( $params['wl-site-language'] );
-
-		// Store the site's country:
-		$this->configuration_service->set_country_code( $params['wl-country-code'] );
-
-		// Store the preferences in variable, because if the checkbox is not checked
-		// the `share-diagnostic` will not exists in `$params` array.
-		$share_diagnostic_preferences = empty( $params['share-diagnostic'] ) ? 'no' : 'yes';
-
-		// Store the diagnostic preferences:
-		$this->configuration_service->set_diagnostic_preferences( $share_diagnostic_preferences );
-
-		// Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
-		$type_uri = sprintf( 'http://schema.org/%s', 'organization' === $params['user_type'] ? 'Organization' : 'Person' );
-
-		// Create an entity for the publisher.
-		$publisher_post_id = $this->entity_service->create( $params['name'], $type_uri, $params['logo'], 'publish' );
-
-		// Store the publisher entity post id in the configuration.
-		$this->configuration_service->set_publisher_id( $publisher_post_id );
-
-		flush_rewrite_rules(); // Needed because of possible change to the entity base path.
-
-	}
+    }
+
+    /**
+     * Handle hiding the wizard notices by user request.
+     *
+     * @since    3.9.0
+     */
+    public function hide_notices() {
+
+        // If it's not a `wl-hide-notice` or the nonce is not set, return.
+        if ( ! isset( $_GET['wl-hide-notice'], $_GET['_wl_notice_nonce'] ) ) {
+            return;
+        }
+
+        // If the nonce is invalid, return an error.
+        if ( ! wp_verify_nonce( $_GET['_wl_notice_nonce'], 'wordlift_hide_notices_nonce' ) ) {
+            wp_die( __( 'Action failed. Please refresh the page and retry.', 'wordlift' ) );
+        }
+
+        // If the user doesn't have the right privileges, return an error.
+        if ( ! current_user_can( 'manage_options' ) ) {
+            wp_die( __( 'Cheatin&#8217; huh?', 'wordlift' ) );
+        }
+
+        // Store a flag telling to skip the wizard.
+        $this->configuration_service->set_skip_wizard( true );
+
+    }
+
+    /**
+     * Register the wizard page to be able to access it.
+     *
+     * @since    3.9.0
+     */
+    public function admin_menu() {
+        /**
+         * Filter: wl_feature__enable__screens.
+         *
+         * @param bool whether the screens needed to be registered, defaults to true.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__screens', true ) ) {
+            // @todo: find another way to do this, since this is adding an empty space in WP's dashboard menu.
+            add_dashboard_page( '', '', 'manage_options', 'wl-setup', '' );
+        }
+    }
+
+    /**
+     * Displays the wizard page.
+     *
+     * @since    3.9.0
+     */
+    public function show_page() {
+
+        // First check if we are in the wizard page at all, if not do nothing.
+        if ( empty( $_GET['page'] ) || 'wl-setup' !== $_GET['page'] ) {
+            return;
+        }
+
+        // If it's a POST and the `wl-save-configuration` action is set, save the configuration.
+        if ( isset( $_POST['action'] ) && 'wl-save-configuration' === $_POST['action'] ) {
+
+            // Check the nonce and the user capabilities.
+            check_admin_referer( 'wl-save-configuration' );
+
+            // Check if the user has the right privileges.
+            if ( ! current_user_can( 'manage_options' ) ) {
+                wp_die( __( 'Sorry, you do not have a permission to save the settings', 'wordlift' ) );
+            }
+
+            // Save the configuration.
+            $this->save_configuration( $_POST );
+
+            // Redirect to the admin's page.
+            wp_redirect( admin_url() );
+
+            exit;
+        }
+
+        $language_select = $this->language_select_element;
+        $country_select  = $this->country_select_element;
+
+        include plugin_dir_path( dirname( __FILE__ ) ) . 'admin/partials/wordlift-admin-setup.php';
+
+        exit;
+    }
+
+    /**
+     * Save WordLift's configuration using the provided parameters.
+     *
+     * @param array $params An array of configuration parameters.
+     *
+     * @since 3.9.0
+     *
+     */
+    private function save_configuration( $params ) {
+
+        // We have the following parameters:
+        // `key`, holding WL's key,
+        // `vocabulary`, holding the vocabulary path,
+        // `language`, with the language code (e.g. `en`),
+        // `send_diagnostic`, the user preferences about sharing data with us.
+        // `user_type`, the user type either `personal` or `company`,
+        // `name`, with the `personal` or `company`'s name,
+        // `logo`, the attachment id for the `personal` or `company` entity.
+
+        // Store the key:
+        $this->configuration_service->set_key( $params['key'] );
+
+        // Store the vocabulary path:
+        $this->configuration_service->set_entity_base_path( $params['vocabulary'] );
+
+        // Store the site's language:
+        $this->configuration_service->set_language_code( $params['wl-site-language'] );
+
+        // Store the site's country:
+        $this->configuration_service->set_country_code( $params['wl-country-code'] );
+
+        // Store the preferences in variable, because if the checkbox is not checked
+        // the `share-diagnostic` will not exists in `$params` array.
+        $share_diagnostic_preferences = empty( $params['share-diagnostic'] ) ? 'no' : 'yes';
+
+        // Store the diagnostic preferences:
+        $this->configuration_service->set_diagnostic_preferences( $share_diagnostic_preferences );
+
+        // Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
+        $type_uri = sprintf( 'http://schema.org/%s', 'organization' === $params['user_type'] ? 'Organization' : 'Person' );
+
+        // Create an entity for the publisher.
+        $publisher_post_id = $this->entity_service->create( $params['name'], $type_uri, $params['logo'], 'publish' );
+
+        // Store the publisher entity post id in the configuration.
+        $this->configuration_service->set_publisher_id( $publisher_post_id );
+
+        flush_rewrite_rules(); // Needed because of possible change to the entity base path.
+
+    }
 
 }

Spacing +44 added lines, -44 removed lines

@@ -12,7 +12,7 @@ 
  * @since      3.9.0
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -85,7 +85,7 @@ 
 	 * @since    3.9.0
 	 *
 	 */
-	public function __construct( $configuration_service, $key_validation_service, $entity_service, $language_select_element, $country_select_element ) {
+	public function __construct($configuration_service, $key_validation_service, $entity_service, $language_select_element, $country_select_element) {
 
 		// Set a reference to the configuration service.
 		$this->configuration_service = $configuration_service;
@@ -102,10 +102,10 @@ 
 
 		// Hook to some WP's events:
 		// When WP is loaded check whether the user decided to skip the set-up, i.e. don't show us even if WL is not set up.
-		add_action( 'wp_loaded', array( $this, 'hide_notices' ) );
+		add_action('wp_loaded', array($this, 'hide_notices'));
 
 		// Hook to `admin_menu` in order to add our own setup wizard page.
-		add_action( 'admin_menu', array( $this, 'admin_menu' ) );
+		add_action('admin_menu', array($this, 'admin_menu'));
 
 
 		/**
@@ -116,9 +116,9 @@ 
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__setup_screen', true ) ) {
+		if (apply_filters('wl_feature__enable__setup_screen', true)) {
 			// Triggered when the user accesses the admin area, we decide whether to show our own wizard.
-			add_action( 'admin_init', array( $this, 'show_page' ) );
+			add_action('admin_init', array($this, 'show_page'));
 		}
 		/**
 		 * Filter: wl_feature__enable__notices.
@@ -126,9 +126,9 @@ 
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+		if (apply_filters('wl_feature__enable__notices', true)) {
 			// Hook to `admin_notices` to display our notices.
-			add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+			add_action('admin_notices', array($this, 'admin_notices'));
 		}
 	}
 
@@ -140,21 +140,21 @@ 
 	public function admin_init() {
 
 		// If the `_wl_activation_redirect` is set, the redirect to the setup page.
-		if ( get_transient( '_wl_activation_redirect' ) ) {
-			delete_transient( '_wl_activation_redirect' );
+		if (get_transient('_wl_activation_redirect')) {
+			delete_transient('_wl_activation_redirect');
 
 			// If the user asked to skip the wizard then comply.
-			if ( $this->configuration_service->is_skip_wizard() ) {
+			if ($this->configuration_service->is_skip_wizard()) {
 				return;
 			}
 
 			// If we're already on the page or the user doesn't have permissions, return.
-			if ( ( ! empty( $_GET['page'] ) && 'wl-setup' === $_GET['page'] ) || is_network_admin() || isset( $_GET['activate-multi'] ) || ! current_user_can( 'manage_options' ) ) {
+			if (( ! empty($_GET['page']) && 'wl-setup' === $_GET['page']) || is_network_admin() || isset($_GET['activate-multi']) || ! current_user_can('manage_options')) {
 				return;
 			}
 
 			// Finally redirect to the setup page.
-			wp_safe_redirect( admin_url( 'index.php?page=wl-setup' ) );
+			wp_safe_redirect(admin_url('index.php?page=wl-setup'));
 
 			exit;
 		}
@@ -169,14 +169,14 @@ 
 	public function admin_notices() {
 
 		// Use `wl_configuration_get_key` to check whether WL's key is set and that the user didn't disable the wizard.
-		if ( '' === $this->configuration_service->get_key() && ! $this->configuration_service->is_skip_wizard() ) { ?>
+		if ('' === $this->configuration_service->get_key() && ! $this->configuration_service->is_skip_wizard()) { ?>
             <div id="wl-message" class="updated">
-                <p><?php esc_html_e( 'Welcome to WordLift &#8211; You&lsquo;re almost ready to start', 'wordlift' ); ?></p>
+                <p><?php esc_html_e('Welcome to WordLift &#8211; You&lsquo;re almost ready to start', 'wordlift'); ?></p>
                 <p class="submit">
-                    <a href="<?php echo esc_url( admin_url( 'admin.php?page=wl-setup' ) ); ?>"
-                       class="button-primary"><?php esc_html_e( 'Run the Setup Wizard', 'wordlift' ); ?></a>
+                    <a href="<?php echo esc_url(admin_url('admin.php?page=wl-setup')); ?>"
+                       class="button-primary"><?php esc_html_e('Run the Setup Wizard', 'wordlift'); ?></a>
                     <a class="button-secondary skip"
-                       href="<?php echo esc_url( wp_nonce_url( add_query_arg( 'wl-hide-notice', 'install' ), 'wordlift_hide_notices_nonce', '_wl_notice_nonce' ) ); ?>"><?php esc_html_e( 'Skip Setup', 'wordlift' ); ?></a>
+                       href="<?php echo esc_url(wp_nonce_url(add_query_arg('wl-hide-notice', 'install'), 'wordlift_hide_notices_nonce', '_wl_notice_nonce')); ?>"><?php esc_html_e('Skip Setup', 'wordlift'); ?></a>
                 </p>
             </div>
 		<?php }
@@ -191,22 +191,22 @@ 
 	public function hide_notices() {
 
 		// If it's not a `wl-hide-notice` or the nonce is not set, return.
-		if ( ! isset( $_GET['wl-hide-notice'], $_GET['_wl_notice_nonce'] ) ) {
+		if ( ! isset($_GET['wl-hide-notice'], $_GET['_wl_notice_nonce'])) {
 			return;
 		}
 
 		// If the nonce is invalid, return an error.
-		if ( ! wp_verify_nonce( $_GET['_wl_notice_nonce'], 'wordlift_hide_notices_nonce' ) ) {
-			wp_die( __( 'Action failed. Please refresh the page and retry.', 'wordlift' ) );
+		if ( ! wp_verify_nonce($_GET['_wl_notice_nonce'], 'wordlift_hide_notices_nonce')) {
+			wp_die(__('Action failed. Please refresh the page and retry.', 'wordlift'));
 		}
 
 		// If the user doesn't have the right privileges, return an error.
-		if ( ! current_user_can( 'manage_options' ) ) {
-			wp_die( __( 'Cheatin&#8217; huh?', 'wordlift' ) );
+		if ( ! current_user_can('manage_options')) {
+			wp_die(__('Cheatin&#8217; huh?', 'wordlift'));
 		}
 
 		// Store a flag telling to skip the wizard.
-		$this->configuration_service->set_skip_wizard( true );
+		$this->configuration_service->set_skip_wizard(true);
 
 	}
 
@@ -224,9 +224,9 @@ 
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__screens', true ) ) {
+		if (apply_filters('wl_feature__enable__screens', true)) {
 			// @todo: find another way to do this, since this is adding an empty space in WP's dashboard menu.
-			add_dashboard_page( '', '', 'manage_options', 'wl-setup', '' );
+			add_dashboard_page('', '', 'manage_options', 'wl-setup', '');
 		}
 	}
 
@@ -238,26 +238,26 @@ 
 	public function show_page() {
 
 		// First check if we are in the wizard page at all, if not do nothing.
-		if ( empty( $_GET['page'] ) || 'wl-setup' !== $_GET['page'] ) {
+		if (empty($_GET['page']) || 'wl-setup' !== $_GET['page']) {
 			return;
 		}
 
 		// If it's a POST and the `wl-save-configuration` action is set, save the configuration.
-		if ( isset( $_POST['action'] ) && 'wl-save-configuration' === $_POST['action'] ) {
+		if (isset($_POST['action']) && 'wl-save-configuration' === $_POST['action']) {
 
 			// Check the nonce and the user capabilities.
-			check_admin_referer( 'wl-save-configuration' );
+			check_admin_referer('wl-save-configuration');
 
 			// Check if the user has the right privileges.
-			if ( ! current_user_can( 'manage_options' ) ) {
-				wp_die( __( 'Sorry, you do not have a permission to save the settings', 'wordlift' ) );
+			if ( ! current_user_can('manage_options')) {
+				wp_die(__('Sorry, you do not have a permission to save the settings', 'wordlift'));
 			}
 
 			// Save the configuration.
-			$this->save_configuration( $_POST );
+			$this->save_configuration($_POST);
 
 			// Redirect to the admin's page.
-			wp_redirect( admin_url() );
+			wp_redirect(admin_url());
 
 			exit;
 		}
@@ -265,7 +265,7 @@ 
 		$language_select = $this->language_select_element;
 		$country_select  = $this->country_select_element;
 
-		include plugin_dir_path( dirname( __FILE__ ) ) . 'admin/partials/wordlift-admin-setup.php';
+		include plugin_dir_path(dirname(__FILE__)).'admin/partials/wordlift-admin-setup.php';
 
 		exit;
 	}
@@ -278,7 +278,7 @@ 
 	 * @since 3.9.0
 	 *
 	 */
-	private function save_configuration( $params ) {
+	private function save_configuration($params) {
 
 		// We have the following parameters:
 		// `key`, holding WL's key,
@@ -290,32 +290,32 @@ 
 		// `logo`, the attachment id for the `personal` or `company` entity.
 
 		// Store the key:
-		$this->configuration_service->set_key( $params['key'] );
+		$this->configuration_service->set_key($params['key']);
 
 		// Store the vocabulary path:
-		$this->configuration_service->set_entity_base_path( $params['vocabulary'] );
+		$this->configuration_service->set_entity_base_path($params['vocabulary']);
 
 		// Store the site's language:
-		$this->configuration_service->set_language_code( $params['wl-site-language'] );
+		$this->configuration_service->set_language_code($params['wl-site-language']);
 
 		// Store the site's country:
-		$this->configuration_service->set_country_code( $params['wl-country-code'] );
+		$this->configuration_service->set_country_code($params['wl-country-code']);
 
 		// Store the preferences in variable, because if the checkbox is not checked
 		// the `share-diagnostic` will not exists in `$params` array.
-		$share_diagnostic_preferences = empty( $params['share-diagnostic'] ) ? 'no' : 'yes';
+		$share_diagnostic_preferences = empty($params['share-diagnostic']) ? 'no' : 'yes';
 
 		// Store the diagnostic preferences:
-		$this->configuration_service->set_diagnostic_preferences( $share_diagnostic_preferences );
+		$this->configuration_service->set_diagnostic_preferences($share_diagnostic_preferences);
 
 		// Set the type URI, either http://schema.org/Person or http://schema.org/Organization.
-		$type_uri = sprintf( 'http://schema.org/%s', 'organization' === $params['user_type'] ? 'Organization' : 'Person' );
+		$type_uri = sprintf('http://schema.org/%s', 'organization' === $params['user_type'] ? 'Organization' : 'Person');
 
 		// Create an entity for the publisher.
-		$publisher_post_id = $this->entity_service->create( $params['name'], $type_uri, $params['logo'], 'publish' );
+		$publisher_post_id = $this->entity_service->create($params['name'], $type_uri, $params['logo'], 'publish');
 
 		// Store the publisher entity post id in the configuration.
-		$this->configuration_service->set_publisher_id( $publisher_post_id );
+		$this->configuration_service->set_publisher_id($publisher_post_id);
 
 		flush_rewrite_rules(); // Needed because of possible change to the entity base path.