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.php

Indentation +193 added lines, -193 removed lines

@@ -47,7 +47,7 @@ 
 
 // If this file is called directly, abort.
 if ( ! defined( 'WPINC' ) ) {
-	die;
+    die;
 }
 
 // Include WordLift constants.
@@ -68,7 +68,7 @@ 
  */
 function wl_write_log( $log ) {
 
-	Wordlift_Log_Service::get_instance()->debug( $log );
+    Wordlift_Log_Service::get_instance()->debug( $log );
 
 }
 
@@ -85,7 +85,7 @@ 
  */
 function wl_write_log_hide_key( $text ) {
 
-	return str_ireplace( wl_configuration_get_key(), '<hidden>', $text );
+    return str_ireplace( wl_configuration_get_key(), '<hidden>', $text );
 }
 
 /**
@@ -93,21 +93,21 @@ 
  * see http://vip.wordpress.com/documentation/register-additional-html-attributes-for-tinymce-and-wp-kses/
  */
 function wordlift_allowed_post_tags() {
-	global $allowedposttags;
-
-	$tags           = array( 'span' );
-	$new_attributes = array(
-		'itemscope' => array(),
-		'itemtype'  => array(),
-		'itemprop'  => array(),
-		'itemid'    => array(),
-	);
-
-	foreach ( $tags as $tag ) {
-		if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
-			$allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes );
-		}
-	}
+    global $allowedposttags;
+
+    $tags           = array( 'span' );
+    $new_attributes = array(
+        'itemscope' => array(),
+        'itemtype'  => array(),
+        'itemprop'  => array(),
+        'itemid'    => array(),
+    );
+
+    foreach ( $tags as $tag ) {
+        if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
+            $allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes );
+        }
+    }
 }
 
 // add allowed post tags.
@@ -118,18 +118,18 @@ 
  */
 function wordlift_admin_enqueue_scripts() {
 
-	// Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
-	wp_enqueue_script( 'wpdialogs' );
-	wp_enqueue_style( 'wp-jquery-ui-dialog' );
+    // Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
+    wp_enqueue_script( 'wpdialogs' );
+    wp_enqueue_style( 'wp-jquery-ui-dialog' );
 
-	wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css' );
+    wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css' );
 
-	wp_enqueue_script( 'jquery-ui-autocomplete' );
+    wp_enqueue_script( 'jquery-ui-autocomplete' );
 
-	// Disable auto-save for custom entity posts only
-	if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
-		wp_dequeue_script( 'autosave' );
-	}
+    // Disable auto-save for custom entity posts only
+    if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
+        wp_dequeue_script( 'autosave' );
+    }
 
 }
 
@@ -145,18 +145,18 @@ 
  */
 function wordlift_allowed_html( $allowedtags, $context ) {
 
-	if ( 'post' !== $context ) {
-		return $allowedtags;
-	}
-
-	return array_merge_recursive( $allowedtags, array(
-		'span' => array(
-			'itemscope' => true,
-			'itemtype'  => true,
-			'itemid'    => true,
-			'itemprop'  => true,
-		),
-	) );
+    if ( 'post' !== $context ) {
+        return $allowedtags;
+    }
+
+    return array_merge_recursive( $allowedtags, array(
+        'span' => array(
+            'itemscope' => true,
+            'itemtype'  => true,
+            'itemid'    => true,
+            'itemprop'  => true,
+        ),
+    ) );
 }
 
 add_filter( 'wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2 );
@@ -170,16 +170,16 @@ 
  */
 function wl_get_coordinates( $post_id ) {
 
-	$latitude  = wl_schema_get_value( $post_id, 'latitude' );
-	$longitude = wl_schema_get_value( $post_id, 'longitude' );
+    $latitude  = wl_schema_get_value( $post_id, 'latitude' );
+    $longitude = wl_schema_get_value( $post_id, 'longitude' );
 
-	// DO NOT set latitude/longitude to 0/0 as default values. It's a specific
-	// place on the globe:"The zero/zero point of this system is located in the
-	// Gulf of Guinea about 625 km (390 mi) south of Tema, Ghana."
-	return array(
-		'latitude'  => isset( $latitude[0] ) && is_numeric( $latitude[0] ) ? $latitude[0] : '',
-		'longitude' => isset( $longitude[0] ) && is_numeric( $longitude[0] ) ? $longitude[0] : '',
-	);
+    // DO NOT set latitude/longitude to 0/0 as default values. It's a specific
+    // place on the globe:"The zero/zero point of this system is located in the
+    // Gulf of Guinea about 625 km (390 mi) south of Tema, Ghana."
+    return array(
+        'latitude'  => isset( $latitude[0] ) && is_numeric( $latitude[0] ) ? $latitude[0] : '',
+        'longitude' => isset( $longitude[0] ) && is_numeric( $longitude[0] ) ? $longitude[0] : '',
+    );
 }
 
 /**
@@ -193,9 +193,9 @@ 
  */
 function wl_get_image_urls( $post_id ) {
 
-	return Wordlift_Storage_Factory::get_instance()
-	                               ->post_images()
-	                               ->get( $post_id );
+    return Wordlift_Storage_Factory::get_instance()
+                                    ->post_images()
+                                    ->get( $post_id );
 
 }
 
@@ -209,24 +209,24 @@ 
  */
 function wl_get_attachment_for_source_url( $parent_post_id, $source_url ) {
 
-	// wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
+    // wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
 
-	$posts = get_posts( array(
-		'post_type'      => 'attachment',
-		'posts_per_page' => 1,
-		'post_status'    => 'any',
-		'post_parent'    => $parent_post_id,
-		'meta_key'       => 'wl_source_url',
-		'meta_value'     => $source_url,
-	) );
+    $posts = get_posts( array(
+        'post_type'      => 'attachment',
+        'posts_per_page' => 1,
+        'post_status'    => 'any',
+        'post_parent'    => $parent_post_id,
+        'meta_key'       => 'wl_source_url',
+        'meta_value'     => $source_url,
+    ) );
 
-	// Return the found post.
-	if ( 1 === count( $posts ) ) {
-		return $posts[0];
-	}
+    // Return the found post.
+    if ( 1 === count( $posts ) ) {
+        return $posts[0];
+    }
 
-	// Return null.
-	return null;
+    // Return null.
+    return null;
 }
 
 /**
@@ -237,8 +237,8 @@ 
  */
 function wl_set_source_url( $post_id, $source_url ) {
 
-	delete_post_meta( $post_id, 'wl_source_url' );
-	add_post_meta( $post_id, 'wl_source_url', $source_url );
+    delete_post_meta( $post_id, 'wl_source_url' );
+    add_post_meta( $post_id, 'wl_source_url', $source_url );
 }
 
 /**
@@ -255,7 +255,7 @@ 
  */
 function wl_sanitize_uri_path( $path, $char = '_' ) {
 
-	return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
+    return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
 }
 
 /**
@@ -267,47 +267,47 @@ 
  */
 function wl_replace_item_id_with_uri( $content ) {
 
-	$log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
-	$log->trace( 'Replacing item IDs with URIs...' );
+    $log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
+    $log->trace( 'Replacing item IDs with URIs...' );
 
-	// Strip slashes, see https://core.trac.wordpress.org/ticket/21767
-	$content = stripslashes( $content );
+    // Strip slashes, see https://core.trac.wordpress.org/ticket/21767
+    $content = stripslashes( $content );
 
-	// If any match are found.
-	$matches = array();
-	if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
+    // If any match are found.
+    $matches = array();
+    if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
 
-		foreach ( $matches as $match ) {
+        foreach ( $matches as $match ) {
 
-			// Get the item ID.
-			$item_id = $match[1];
+            // Get the item ID.
+            $item_id = $match[1];
 
-			// Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
-			$post = Wordlift_Entity_Service::get_instance()
-			                               ->get_entity_post_by_uri( $item_id );
+            // Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
+            $post = Wordlift_Entity_Service::get_instance()
+                                            ->get_entity_post_by_uri( $item_id );
 
-			// If no entity is found, continue to the next one.
-			if ( null === $post ) {
-				continue;
-			}
+            // If no entity is found, continue to the next one.
+            if ( null === $post ) {
+                continue;
+            }
 
-			// Get the URI for that post.
-			$uri = wl_get_entity_uri( $post->ID );
+            // Get the URI for that post.
+            $uri = wl_get_entity_uri( $post->ID );
 
-			// wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
+            // wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
 
-			// If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
-			if ( $item_id !== $uri ) {
-				$uri_e   = esc_html( $uri );
-				$content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
-			}
-		}
-	}
+            // If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
+            if ( $item_id !== $uri ) {
+                $uri_e   = esc_html( $uri );
+                $content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
+            }
+        }
+    }
 
-	// Reapply slashes.
-	$content = addslashes( $content );
+    // Reapply slashes.
+    $content = addslashes( $content );
 
-	return $content;
+    return $content;
 }
 
 add_filter( 'content_save_pre', 'wl_replace_item_id_with_uri', 1, 1 );
@@ -370,24 +370,24 @@ 
  */
 function activate_wordlift() {
 
-	$log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
+    $log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
 
-	$log->info( 'Activating WordLift...' );
+    $log->info( 'Activating WordLift...' );
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
-	Wordlift_Activator::activate();
+    require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
+    Wordlift_Activator::activate();
 
-	/**
-	 * Tell the {@link Wordlift_Http_Api} class that we're activating, to let it run activation tasks.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
-	 * @since 3.19.2
-	 */
-	Wordlift_Http_Api::activate();
+    /**
+     * Tell the {@link Wordlift_Http_Api} class that we're activating, to let it run activation tasks.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
+     * @since 3.19.2
+     */
+    Wordlift_Http_Api::activate();
 
-	// Ensure the post type is registered before flushing the rewrite rules.
-	Wordlift_Entity_Post_Type_Service::get_instance()->register();
-	flush_rewrite_rules();
+    // Ensure the post type is registered before flushing the rewrite rules.
+    Wordlift_Entity_Post_Type_Service::get_instance()->register();
+    flush_rewrite_rules();
 }
 
 /**
@@ -396,11 +396,11 @@ 
  */
 function deactivate_wordlift() {
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
-	Wordlift_Deactivator::deactivate();
-	Wordlift_Http_Api::deactivate();
-	Ttl_Cache_Cleaner::deactivate();
-	flush_rewrite_rules();
+    require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
+    Wordlift_Deactivator::deactivate();
+    Wordlift_Http_Api::deactivate();
+    Ttl_Cache_Cleaner::deactivate();
+    flush_rewrite_rules();
 
 }
 
@@ -423,70 +423,70 @@ 
  * @since    1.0.0
  */
 function run_wordlift() {
-	/**
-	 * Filter: wl_feature__enable__widgets.
-	 *
-	 * @param bool whether the widgets needed to be registered, defaults to true.
-	 *
-	 * @return bool
-	 * @since 3.27.6
-	 */
-	if ( apply_filters( 'wl_feature__enable__widgets', true ) ) {
-		add_action( 'widgets_init', 'wl_register_chord_widget' );
-		add_filter( 'widget_text', 'do_shortcode' );
-		add_action( 'widgets_init', 'wl_register_geo_widget' );
-		add_action( 'widgets_init', 'wl_register_timeline_widget' );
-		add_filter( 'widget_text', 'do_shortcode' );
-	}
-	/*
+    /**
+     * Filter: wl_feature__enable__widgets.
+     *
+     * @param bool whether the widgets needed to be registered, defaults to true.
+     *
+     * @return bool
+     * @since 3.27.6
+     */
+    if ( apply_filters( 'wl_feature__enable__widgets', true ) ) {
+        add_action( 'widgets_init', 'wl_register_chord_widget' );
+        add_filter( 'widget_text', 'do_shortcode' );
+        add_action( 'widgets_init', 'wl_register_geo_widget' );
+        add_action( 'widgets_init', 'wl_register_timeline_widget' );
+        add_filter( 'widget_text', 'do_shortcode' );
+    }
+    /*
 	 * We introduce the WordLift autoloader, since we start using classes in namespaces, i.e. Wordlift\Http.
 	 *
 	 * @since 3.21.2
 	 */
-	wordlift_plugin_autoload_register();
+    wordlift_plugin_autoload_register();
 
-	$plugin = new Wordlift();
-	$plugin->run();
+    $plugin = new Wordlift();
+    $plugin->run();
 
-	// Initialize the TTL Cache Cleaner.
-	new Ttl_Cache_Cleaner();
+    // Initialize the TTL Cache Cleaner.
+    new Ttl_Cache_Cleaner();
 
-	// Load the new Post Adapter.
-	new Post_Adapter();
+    // Load the new Post Adapter.
+    new Post_Adapter();
 
-	// Licenses Images.
-	$user_agent                   = User_Agent::get_user_agent();
-	$wordlift_key                 = Wordlift_Configuration_Service::get_instance()->get_key();
-	$api_service                  = new Default_Api_Service( 'https://api.wordlift.io', 60, $user_agent, $wordlift_key );
-	$image_license_factory        = new Image_License_Factory();
-	$image_license_service        = new Image_License_Service( $api_service, $image_license_factory );
-	$image_license_cache          = new Ttl_Cache( 'image-license', 86400 * 30 ); // 30 days.
-	$cached_image_license_service = new Cached_Image_License_Service( $image_license_service, $image_license_cache );
+    // Licenses Images.
+    $user_agent                   = User_Agent::get_user_agent();
+    $wordlift_key                 = Wordlift_Configuration_Service::get_instance()->get_key();
+    $api_service                  = new Default_Api_Service( 'https://api.wordlift.io', 60, $user_agent, $wordlift_key );
+    $image_license_factory        = new Image_License_Factory();
+    $image_license_service        = new Image_License_Service( $api_service, $image_license_factory );
+    $image_license_cache          = new Ttl_Cache( 'image-license', 86400 * 30 ); // 30 days.
+    $cached_image_license_service = new Cached_Image_License_Service( $image_license_service, $image_license_cache );
 
-	$image_license_scheduler       = new Image_License_Scheduler( $image_license_service, $image_license_cache );
-	$image_license_cleanup_service = new Image_License_Cleanup_Service();
+    $image_license_scheduler       = new Image_License_Scheduler( $image_license_service, $image_license_cache );
+    $image_license_cleanup_service = new Image_License_Cleanup_Service();
 
-	// Get the cached data. If we have cached data, we load the notifier.
-	$image_license_data = $image_license_cache->get( Cached_Image_License_Service::GET_NON_PUBLIC_DOMAIN_IMAGES );
-	if ( null !== $image_license_data ) {
-		$image_license_page = new Image_License_Page( $image_license_data, Wordlift::get_instance()->get_version() );
-		new Image_License_Notifier( $image_license_data, $image_license_page );
-	}
+    // Get the cached data. If we have cached data, we load the notifier.
+    $image_license_data = $image_license_cache->get( Cached_Image_License_Service::GET_NON_PUBLIC_DOMAIN_IMAGES );
+    if ( null !== $image_license_data ) {
+        $image_license_page = new Image_License_Page( $image_license_data, Wordlift::get_instance()->get_version() );
+        new Image_License_Notifier( $image_license_data, $image_license_page );
+    }
 
-	$remove_all_images_task         = new Remove_All_Images_Task( $cached_image_license_service );
-	$remove_all_images_task_adapter = new Task_Ajax_Adapter( $remove_all_images_task );
+    $remove_all_images_task         = new Remove_All_Images_Task( $cached_image_license_service );
+    $remove_all_images_task_adapter = new Task_Ajax_Adapter( $remove_all_images_task );
 
-	$reload_data_task         = new Reload_Data_Task();
-	$reload_data_task_adapter = new Task_Ajax_Adapter( $reload_data_task );
+    $reload_data_task         = new Reload_Data_Task();
+    $reload_data_task_adapter = new Task_Ajax_Adapter( $reload_data_task );
 
-	$add_license_caption_or_remove_task         = new Add_License_Caption_Or_Remove_Task( $cached_image_license_service );
-	$add_license_caption_or_remove_task_adapter = new Task_Ajax_Adapter( $add_license_caption_or_remove_task );
+    $add_license_caption_or_remove_task         = new Add_License_Caption_Or_Remove_Task( $cached_image_license_service );
+    $add_license_caption_or_remove_task_adapter = new Task_Ajax_Adapter( $add_license_caption_or_remove_task );
 
-	$remove_all_images_task_page             = new Remove_All_Images_Page( new Task_Ajax_Adapters_Registry( $remove_all_images_task_adapter ), $plugin->get_version() );
-	$reload_data_task_page                   = new Reload_Data_Page( new Task_Ajax_Adapters_Registry( $reload_data_task_adapter ), $plugin->get_version() );
-	$add_license_caption_or_remove_task_page = new Add_License_Caption_Or_Remove_Page( new Task_Ajax_Adapters_Registry( $add_license_caption_or_remove_task_adapter ), $plugin->get_version() );
+    $remove_all_images_task_page             = new Remove_All_Images_Page( new Task_Ajax_Adapters_Registry( $remove_all_images_task_adapter ), $plugin->get_version() );
+    $reload_data_task_page                   = new Reload_Data_Page( new Task_Ajax_Adapters_Registry( $reload_data_task_adapter ), $plugin->get_version() );
+    $add_license_caption_or_remove_task_page = new Add_License_Caption_Or_Remove_Page( new Task_Ajax_Adapters_Registry( $add_license_caption_or_remove_task_adapter ), $plugin->get_version() );
 
-	new Wordlift_Products_Navigator_Shortcode_REST();
+    new Wordlift_Products_Navigator_Shortcode_REST();
 
 }
 
@@ -500,45 +500,45 @@ 
  */
 function wordlift_plugin_autoload_register() {
 
-	spl_autoload_register( function ( $class_name ) {
+    spl_autoload_register( function ( $class_name ) {
 
-		// Bail out if these are not our classes.
-		if ( 0 !== strpos( $class_name, 'Wordlift\\' ) ) {
-			return false;
-		}
+        // Bail out if these are not our classes.
+        if ( 0 !== strpos( $class_name, 'Wordlift\\' ) ) {
+            return false;
+        }
 
-		$class_name_lc = strtolower( str_replace( '_', '-', $class_name ) );
+        $class_name_lc = strtolower( str_replace( '_', '-', $class_name ) );
 
-		preg_match( '|^(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches );
+        preg_match( '|^(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches );
 
-		$path = str_replace( '\\', DIRECTORY_SEPARATOR, $matches[1] );
-		$file = 'class-' . $matches[2] . '.php';
+        $path = str_replace( '\\', DIRECTORY_SEPARATOR, $matches[1] );
+        $file = 'class-' . $matches[2] . '.php';
 
-		$full_path = plugin_dir_path( __FILE__ ) . $path . DIRECTORY_SEPARATOR . $file;
+        $full_path = plugin_dir_path( __FILE__ ) . $path . DIRECTORY_SEPARATOR . $file;
 
-		if ( ! file_exists( $full_path ) ) {
-			echo( "Class $class_name not found at $full_path." );
+        if ( ! file_exists( $full_path ) ) {
+            echo( "Class $class_name not found at $full_path." );
 
-			return false;
-		}
+            return false;
+        }
 
-		require_once $full_path;
+        require_once $full_path;
 
-		return true;
-	} );
+        return true;
+    } );
 
 }
 
 function wl_block_categories( $categories, $post ) {
-	return array_merge(
-		$categories,
-		array(
-			array(
-				'slug'  => 'wordlift',
-				'title' => __( 'WordLift', 'wordlift' ),
-			),
-		)
-	);
+    return array_merge(
+        $categories,
+        array(
+            array(
+                'slug'  => 'wordlift',
+                'title' => __( 'WordLift', 'wordlift' ),
+            ),
+        )
+    );
 }
 
 add_filter( 'block_categories', 'wl_block_categories', 10, 2 );

Spacing +122 added lines, -122 removed lines

@@ -46,15 +46,15 @@ 
 use Wordlift\Tasks\Task_Ajax_Adapters_Registry;
 
 // If this file is called directly, abort.
-if ( ! defined( 'WPINC' ) ) {
+if ( ! defined('WPINC')) {
 	die;
 }
 
 // Include WordLift constants.
-require_once( 'wordlift_constants.php' );
+require_once('wordlift_constants.php');
 
 // Load modules.
-require_once( 'modules/core/wordlift_core.php' );
+require_once('modules/core/wordlift_core.php');
 
 /**
  * Log to the debug.log file.
@@ -66,9 +66,9 @@ 
  * @deprecated use Wordlift_Log_Service::get_instance()->info( $log );
  *
  */
-function wl_write_log( $log ) {
+function wl_write_log($log) {
 
-	Wordlift_Log_Service::get_instance()->debug( $log );
+	Wordlift_Log_Service::get_instance()->debug($log);
 
 }
 
@@ -83,9 +83,9 @@ 
  * @since 3.0.0
  *
  */
-function wl_write_log_hide_key( $text ) {
+function wl_write_log_hide_key($text) {
 
-	return str_ireplace( wl_configuration_get_key(), '<hidden>', $text );
+	return str_ireplace(wl_configuration_get_key(), '<hidden>', $text);
 }
 
 /**
@@ -95,7 +95,7 @@ 
 function wordlift_allowed_post_tags() {
 	global $allowedposttags;
 
-	$tags           = array( 'span' );
+	$tags           = array('span');
 	$new_attributes = array(
 		'itemscope' => array(),
 		'itemtype'  => array(),
@@ -103,15 +103,15 @@ 
 		'itemid'    => array(),
 	);
 
-	foreach ( $tags as $tag ) {
-		if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
-			$allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes );
+	foreach ($tags as $tag) {
+		if (isset($allowedposttags[$tag]) && is_array($allowedposttags[$tag])) {
+			$allowedposttags[$tag] = array_merge($allowedposttags[$tag], $new_attributes);
 		}
 	}
 }
 
 // add allowed post tags.
-add_action( 'init', 'wordlift_allowed_post_tags' );
+add_action('init', 'wordlift_allowed_post_tags');
 
 /**
  * Register additional scripts for the admin UI.
@@ -119,21 +119,21 @@ 
 function wordlift_admin_enqueue_scripts() {
 
 	// Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
-	wp_enqueue_script( 'wpdialogs' );
-	wp_enqueue_style( 'wp-jquery-ui-dialog' );
+	wp_enqueue_script('wpdialogs');
+	wp_enqueue_style('wp-jquery-ui-dialog');
 
-	wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css' );
+	wp_enqueue_style('wordlift-reloaded', plugin_dir_url(__FILE__).'css/wordlift-reloaded.min.css');
 
-	wp_enqueue_script( 'jquery-ui-autocomplete' );
+	wp_enqueue_script('jquery-ui-autocomplete');
 
 	// Disable auto-save for custom entity posts only
-	if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
-		wp_dequeue_script( 'autosave' );
+	if (Wordlift_Entity_Service::TYPE_NAME === get_post_type()) {
+		wp_dequeue_script('autosave');
 	}
 
 }
 
-add_action( 'admin_enqueue_scripts', 'wordlift_admin_enqueue_scripts' );
+add_action('admin_enqueue_scripts', 'wordlift_admin_enqueue_scripts');
 
 /**
  * Hooked to *wp_kses_allowed_html* filter, adds microdata attributes.
@@ -143,23 +143,23 @@ 
  *
  * @return array An array which contains allowed microdata attributes.
  */
-function wordlift_allowed_html( $allowedtags, $context ) {
+function wordlift_allowed_html($allowedtags, $context) {
 
-	if ( 'post' !== $context ) {
+	if ('post' !== $context) {
 		return $allowedtags;
 	}
 
-	return array_merge_recursive( $allowedtags, array(
+	return array_merge_recursive($allowedtags, array(
 		'span' => array(
 			'itemscope' => true,
 			'itemtype'  => true,
 			'itemid'    => true,
 			'itemprop'  => true,
 		),
-	) );
+	));
 }
 
-add_filter( 'wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2 );
+add_filter('wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2);
 
 /**
  * Get the coordinates for the specified post ID.
@@ -168,17 +168,17 @@ 
  *
  * @return array|null An array of coordinates or null.
  */
-function wl_get_coordinates( $post_id ) {
+function wl_get_coordinates($post_id) {
 
-	$latitude  = wl_schema_get_value( $post_id, 'latitude' );
-	$longitude = wl_schema_get_value( $post_id, 'longitude' );
+	$latitude  = wl_schema_get_value($post_id, 'latitude');
+	$longitude = wl_schema_get_value($post_id, 'longitude');
 
 	// DO NOT set latitude/longitude to 0/0 as default values. It's a specific
 	// place on the globe:"The zero/zero point of this system is located in the
 	// Gulf of Guinea about 625 km (390 mi) south of Tema, Ghana."
 	return array(
-		'latitude'  => isset( $latitude[0] ) && is_numeric( $latitude[0] ) ? $latitude[0] : '',
-		'longitude' => isset( $longitude[0] ) && is_numeric( $longitude[0] ) ? $longitude[0] : '',
+		'latitude'  => isset($latitude[0]) && is_numeric($latitude[0]) ? $latitude[0] : '',
+		'longitude' => isset($longitude[0]) && is_numeric($longitude[0]) ? $longitude[0] : '',
 	);
 }
 
@@ -191,11 +191,11 @@ 
  * @deprecated use Wordlift_Storage_Factory::get_instance()->post_images()->get( $post_id )
  *
  */
-function wl_get_image_urls( $post_id ) {
+function wl_get_image_urls($post_id) {
 
 	return Wordlift_Storage_Factory::get_instance()
 	                               ->post_images()
-	                               ->get( $post_id );
+	                               ->get($post_id);
 
 }
 
@@ -207,21 +207,21 @@ 
  *
  * @return WP_Post|null A post instance or null if not found.
  */
-function wl_get_attachment_for_source_url( $parent_post_id, $source_url ) {
+function wl_get_attachment_for_source_url($parent_post_id, $source_url) {
 
 	// wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
 
-	$posts = get_posts( array(
+	$posts = get_posts(array(
 		'post_type'      => 'attachment',
 		'posts_per_page' => 1,
 		'post_status'    => 'any',
 		'post_parent'    => $parent_post_id,
 		'meta_key'       => 'wl_source_url',
 		'meta_value'     => $source_url,
-	) );
+	));
 
 	// Return the found post.
-	if ( 1 === count( $posts ) ) {
+	if (1 === count($posts)) {
 		return $posts[0];
 	}
 
@@ -235,10 +235,10 @@ 
  * @param int $post_id The post ID.
  * @param string $source_url The source URL.
  */
-function wl_set_source_url( $post_id, $source_url ) {
+function wl_set_source_url($post_id, $source_url) {
 
-	delete_post_meta( $post_id, 'wl_source_url' );
-	add_post_meta( $post_id, 'wl_source_url', $source_url );
+	delete_post_meta($post_id, 'wl_source_url');
+	add_post_meta($post_id, 'wl_source_url', $source_url);
 }
 
 /**
@@ -253,9 +253,9 @@ 
  * @see        https://codex.wordpress.org/Function_Reference/sanitize_title
  *
  */
-function wl_sanitize_uri_path( $path, $char = '_' ) {
+function wl_sanitize_uri_path($path, $char = '_') {
 
-	return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
+	return Wordlift_Uri_Service::get_instance()->sanitize_path($path, $char);
 }
 
 /**
@@ -265,104 +265,104 @@ 
  *
  * @return string The updated post content.
  */
-function wl_replace_item_id_with_uri( $content ) {
+function wl_replace_item_id_with_uri($content) {
 
-	$log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
-	$log->trace( 'Replacing item IDs with URIs...' );
+	$log = Wordlift_Log_Service::get_logger('wl_replace_item_id_with_uri');
+	$log->trace('Replacing item IDs with URIs...');
 
 	// Strip slashes, see https://core.trac.wordpress.org/ticket/21767
-	$content = stripslashes( $content );
+	$content = stripslashes($content);
 
 	// If any match are found.
 	$matches = array();
-	if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
+	if (0 < preg_match_all('/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER)) {
 
-		foreach ( $matches as $match ) {
+		foreach ($matches as $match) {
 
 			// Get the item ID.
 			$item_id = $match[1];
 
 			// Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
 			$post = Wordlift_Entity_Service::get_instance()
-			                               ->get_entity_post_by_uri( $item_id );
+			                               ->get_entity_post_by_uri($item_id);
 
 			// If no entity is found, continue to the next one.
-			if ( null === $post ) {
+			if (null === $post) {
 				continue;
 			}
 
 			// Get the URI for that post.
-			$uri = wl_get_entity_uri( $post->ID );
+			$uri = wl_get_entity_uri($post->ID);
 
 			// wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
 
 			// If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
-			if ( $item_id !== $uri ) {
-				$uri_e   = esc_html( $uri );
-				$content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
+			if ($item_id !== $uri) {
+				$uri_e   = esc_html($uri);
+				$content = str_replace(" itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content);
 			}
 		}
 	}
 
 	// Reapply slashes.
-	$content = addslashes( $content );
+	$content = addslashes($content);
 
 	return $content;
 }
 
-add_filter( 'content_save_pre', 'wl_replace_item_id_with_uri', 1, 1 );
+add_filter('content_save_pre', 'wl_replace_item_id_with_uri', 1, 1);
 
-require_once( 'wordlift_entity_functions.php' );
+require_once('wordlift_entity_functions.php');
 
 // add editor related methods.
-require_once( 'wordlift_editor.php' );
+require_once('wordlift_editor.php');
 
 // add the WordLift entity custom type.
-require_once( 'wordlift_entity_type.php' );
+require_once('wordlift_entity_type.php');
 
 // add callbacks on post save to notify data changes from wp to redlink triple store
-require_once( 'wordlift_to_redlink_data_push_callbacks.php' );
+require_once('wordlift_to_redlink_data_push_callbacks.php');
 
-require_once( 'modules/configuration/wordlift_configuration_settings.php' );
+require_once('modules/configuration/wordlift_configuration_settings.php');
 
 // Load modules
-require_once( 'modules/analyzer/wordlift_analyzer.php' );
-require_once( 'modules/linked_data/wordlift_linked_data.php' );
-require_once( 'modules/prefixes/wordlift_prefixes.php' );
+require_once('modules/analyzer/wordlift_analyzer.php');
+require_once('modules/linked_data/wordlift_linked_data.php');
+require_once('modules/prefixes/wordlift_prefixes.php');
 
 // Shortcodes
 
-require_once( 'modules/geo_widget/wordlift_geo_widget.php' );
-require_once( 'shortcodes/class-wordlift-shortcode-rest.php' );
-require_once( 'shortcodes/wordlift_shortcode_chord.php' );
-require_once( 'shortcodes/wordlift_shortcode_geomap.php' );
-require_once( 'shortcodes/wordlift_shortcode_field.php' );
-require_once( 'shortcodes/wordlift_shortcode_faceted_search.php' );
-require_once( 'shortcodes/wordlift_shortcode_navigator.php' );
-require_once( 'shortcodes/class-wordlift-products-navigator-shortcode-rest.php' );
+require_once('modules/geo_widget/wordlift_geo_widget.php');
+require_once('shortcodes/class-wordlift-shortcode-rest.php');
+require_once('shortcodes/wordlift_shortcode_chord.php');
+require_once('shortcodes/wordlift_shortcode_geomap.php');
+require_once('shortcodes/wordlift_shortcode_field.php');
+require_once('shortcodes/wordlift_shortcode_faceted_search.php');
+require_once('shortcodes/wordlift_shortcode_navigator.php');
+require_once('shortcodes/class-wordlift-products-navigator-shortcode-rest.php');
 
-require_once( 'widgets/wordlift_widget_geo.php' );
-require_once( 'widgets/class-wordlift-chord-widget.php' );
-require_once( 'widgets/wordlift_widget_timeline.php' );
+require_once('widgets/wordlift_widget_geo.php');
+require_once('widgets/class-wordlift-chord-widget.php');
+require_once('widgets/wordlift_widget_timeline.php');
 
-require_once( 'wordlift_redlink.php' );
+require_once('wordlift_redlink.php');
 
 // Add admin functions.
 // TODO: find a way to make 'admin' UI tests work.
 //if ( is_admin() ) {
 
-require_once( 'admin/wordlift_admin.php' );
-require_once( 'admin/wordlift_admin_edit_post.php' );
-require_once( 'admin/wordlift_admin_save_post.php' );
+require_once('admin/wordlift_admin.php');
+require_once('admin/wordlift_admin_edit_post.php');
+require_once('admin/wordlift_admin_save_post.php');
 
 // add the entities meta box.
-require_once( 'admin/wordlift_admin_meta_box_entities.php' );
+require_once('admin/wordlift_admin_meta_box_entities.php');
 
 // add the entity creation AJAX.
-require_once( 'admin/wordlift_admin_ajax_related_posts.php' );
+require_once('admin/wordlift_admin_ajax_related_posts.php');
 
 // Load the wl_chord TinyMCE button and configuration dialog.
-require_once( 'admin/wordlift_admin_shortcodes.php' );
+require_once('admin/wordlift_admin_shortcodes.php');
 
 /**
  * The code that runs during plugin activation.
@@ -370,11 +370,11 @@ 
  */
 function activate_wordlift() {
 
-	$log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
+	$log = Wordlift_Log_Service::get_logger('activate_wordlift');
 
-	$log->info( 'Activating WordLift...' );
+	$log->info('Activating WordLift...');
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
+	require_once plugin_dir_path(__FILE__).'includes/class-wordlift-activator.php';
 	Wordlift_Activator::activate();
 
 	/**
@@ -396,7 +396,7 @@ 
  */
 function deactivate_wordlift() {
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
+	require_once plugin_dir_path(__FILE__).'includes/class-wordlift-deactivator.php';
 	Wordlift_Deactivator::deactivate();
 	Wordlift_Http_Api::deactivate();
 	Ttl_Cache_Cleaner::deactivate();
@@ -404,14 +404,14 @@ 
 
 }
 
-register_activation_hook( __FILE__, 'activate_wordlift' );
-register_deactivation_hook( __FILE__, 'deactivate_wordlift' );
+register_activation_hook(__FILE__, 'activate_wordlift');
+register_deactivation_hook(__FILE__, 'deactivate_wordlift');
 
 /**
  * The core plugin class that is used to define internationalization,
  * admin-specific hooks, and public-facing site hooks.
  */
-require plugin_dir_path( __FILE__ ) . 'includes/class-wordlift.php';
+require plugin_dir_path(__FILE__).'includes/class-wordlift.php';
 
 /**
  * Begins execution of the plugin.
@@ -431,12 +431,12 @@ 
 	 * @return bool
 	 * @since 3.27.6
 	 */
-	if ( apply_filters( 'wl_feature__enable__widgets', true ) ) {
-		add_action( 'widgets_init', 'wl_register_chord_widget' );
-		add_filter( 'widget_text', 'do_shortcode' );
-		add_action( 'widgets_init', 'wl_register_geo_widget' );
-		add_action( 'widgets_init', 'wl_register_timeline_widget' );
-		add_filter( 'widget_text', 'do_shortcode' );
+	if (apply_filters('wl_feature__enable__widgets', true)) {
+		add_action('widgets_init', 'wl_register_chord_widget');
+		add_filter('widget_text', 'do_shortcode');
+		add_action('widgets_init', 'wl_register_geo_widget');
+		add_action('widgets_init', 'wl_register_timeline_widget');
+		add_filter('widget_text', 'do_shortcode');
 	}
 	/*
 	 * We introduce the WordLift autoloader, since we start using classes in namespaces, i.e. Wordlift\Http.
@@ -457,34 +457,34 @@ 
 	// Licenses Images.
 	$user_agent                   = User_Agent::get_user_agent();
 	$wordlift_key                 = Wordlift_Configuration_Service::get_instance()->get_key();
-	$api_service                  = new Default_Api_Service( 'https://api.wordlift.io', 60, $user_agent, $wordlift_key );
+	$api_service                  = new Default_Api_Service('https://api.wordlift.io', 60, $user_agent, $wordlift_key);
 	$image_license_factory        = new Image_License_Factory();
-	$image_license_service        = new Image_License_Service( $api_service, $image_license_factory );
-	$image_license_cache          = new Ttl_Cache( 'image-license', 86400 * 30 ); // 30 days.
-	$cached_image_license_service = new Cached_Image_License_Service( $image_license_service, $image_license_cache );
+	$image_license_service        = new Image_License_Service($api_service, $image_license_factory);
+	$image_license_cache          = new Ttl_Cache('image-license', 86400 * 30); // 30 days.
+	$cached_image_license_service = new Cached_Image_License_Service($image_license_service, $image_license_cache);
 
-	$image_license_scheduler       = new Image_License_Scheduler( $image_license_service, $image_license_cache );
+	$image_license_scheduler       = new Image_License_Scheduler($image_license_service, $image_license_cache);
 	$image_license_cleanup_service = new Image_License_Cleanup_Service();
 
 	// Get the cached data. If we have cached data, we load the notifier.
-	$image_license_data = $image_license_cache->get( Cached_Image_License_Service::GET_NON_PUBLIC_DOMAIN_IMAGES );
-	if ( null !== $image_license_data ) {
-		$image_license_page = new Image_License_Page( $image_license_data, Wordlift::get_instance()->get_version() );
-		new Image_License_Notifier( $image_license_data, $image_license_page );
+	$image_license_data = $image_license_cache->get(Cached_Image_License_Service::GET_NON_PUBLIC_DOMAIN_IMAGES);
+	if (null !== $image_license_data) {
+		$image_license_page = new Image_License_Page($image_license_data, Wordlift::get_instance()->get_version());
+		new Image_License_Notifier($image_license_data, $image_license_page);
 	}
 
-	$remove_all_images_task         = new Remove_All_Images_Task( $cached_image_license_service );
-	$remove_all_images_task_adapter = new Task_Ajax_Adapter( $remove_all_images_task );
+	$remove_all_images_task         = new Remove_All_Images_Task($cached_image_license_service);
+	$remove_all_images_task_adapter = new Task_Ajax_Adapter($remove_all_images_task);
 
 	$reload_data_task         = new Reload_Data_Task();
-	$reload_data_task_adapter = new Task_Ajax_Adapter( $reload_data_task );
+	$reload_data_task_adapter = new Task_Ajax_Adapter($reload_data_task);
 
-	$add_license_caption_or_remove_task         = new Add_License_Caption_Or_Remove_Task( $cached_image_license_service );
-	$add_license_caption_or_remove_task_adapter = new Task_Ajax_Adapter( $add_license_caption_or_remove_task );
+	$add_license_caption_or_remove_task         = new Add_License_Caption_Or_Remove_Task($cached_image_license_service);
+	$add_license_caption_or_remove_task_adapter = new Task_Ajax_Adapter($add_license_caption_or_remove_task);
 
-	$remove_all_images_task_page             = new Remove_All_Images_Page( new Task_Ajax_Adapters_Registry( $remove_all_images_task_adapter ), $plugin->get_version() );
-	$reload_data_task_page                   = new Reload_Data_Page( new Task_Ajax_Adapters_Registry( $reload_data_task_adapter ), $plugin->get_version() );
-	$add_license_caption_or_remove_task_page = new Add_License_Caption_Or_Remove_Page( new Task_Ajax_Adapters_Registry( $add_license_caption_or_remove_task_adapter ), $plugin->get_version() );
+	$remove_all_images_task_page             = new Remove_All_Images_Page(new Task_Ajax_Adapters_Registry($remove_all_images_task_adapter), $plugin->get_version());
+	$reload_data_task_page                   = new Reload_Data_Page(new Task_Ajax_Adapters_Registry($reload_data_task_adapter), $plugin->get_version());
+	$add_license_caption_or_remove_task_page = new Add_License_Caption_Or_Remove_Page(new Task_Ajax_Adapters_Registry($add_license_caption_or_remove_task_adapter), $plugin->get_version());
 
 	new Wordlift_Products_Navigator_Shortcode_REST();
 
@@ -500,24 +500,24 @@ 
  */
 function wordlift_plugin_autoload_register() {
 
-	spl_autoload_register( function ( $class_name ) {
+	spl_autoload_register(function($class_name) {
 
 		// Bail out if these are not our classes.
-		if ( 0 !== strpos( $class_name, 'Wordlift\\' ) ) {
+		if (0 !== strpos($class_name, 'Wordlift\\')) {
 			return false;
 		}
 
-		$class_name_lc = strtolower( str_replace( '_', '-', $class_name ) );
+		$class_name_lc = strtolower(str_replace('_', '-', $class_name));
 
-		preg_match( '|^(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches );
+		preg_match('|^(?:(.*)\\\\)?(.+?)$|', $class_name_lc, $matches);
 
-		$path = str_replace( '\\', DIRECTORY_SEPARATOR, $matches[1] );
-		$file = 'class-' . $matches[2] . '.php';
+		$path = str_replace('\\', DIRECTORY_SEPARATOR, $matches[1]);
+		$file = 'class-'.$matches[2].'.php';
 
-		$full_path = plugin_dir_path( __FILE__ ) . $path . DIRECTORY_SEPARATOR . $file;
+		$full_path = plugin_dir_path(__FILE__).$path.DIRECTORY_SEPARATOR.$file;
 
-		if ( ! file_exists( $full_path ) ) {
-			echo( "Class $class_name not found at $full_path." );
+		if ( ! file_exists($full_path)) {
+			echo("Class $class_name not found at $full_path.");
 
 			return false;
 		}
@@ -529,16 +529,16 @@ 
 
 }
 
-function wl_block_categories( $categories, $post ) {
+function wl_block_categories($categories, $post) {
 	return array_merge(
 		$categories,
 		array(
 			array(
 				'slug'  => 'wordlift',
-				'title' => __( 'WordLift', 'wordlift' ),
+				'title' => __('WordLift', 'wordlift'),
 			),
 		)
 	);
 }
 
-add_filter( 'block_categories', 'wl_block_categories', 10, 2 );
+add_filter('block_categories', 'wl_block_categories', 10, 2);

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;
 		}