insideout10 / wordlift-plugin

src/js/dist/faq.asset.php

Indentation +2 added lines, -2 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'react', 'react-dom', 'wp-polyfill' ),
-	'version'      => '0df9b7715acd39056c8ca1e24dedb4b1',
+    'dependencies' => array( 'react', 'react-dom', 'wp-polyfill' ),
+    'version'      => '0df9b7715acd39056c8ca1e24dedb4b1',
 );

Spacing +1 added lines, -1 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'react', 'react-dom', 'wp-polyfill' ),
+	'dependencies' => array('react', 'react-dom', 'wp-polyfill'),
 	'version'      => '0df9b7715acd39056c8ca1e24dedb4b1',
 );

src/js/dist/bundle.asset.php

Indentation +2 added lines, -2 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'wp-polyfill' ),
-	'version'      => 'dc74b50aef496ca5fcca1eda880e38a1',
+    'dependencies' => array( 'wp-polyfill' ),
+    'version'      => 'dc74b50aef496ca5fcca1eda880e38a1',
 );

Spacing +1 added lines, -1 removed lines

@@ -1,4 +1,4 @@
 <?php return array(
-	'dependencies' => array( 'wp-polyfill' ),
+	'dependencies' => array('wp-polyfill'),
 	'version'      => 'dc74b50aef496ca5fcca1eda880e38a1',
 );

src/admin/class-wordlift-entity-types-taxonomy-walker.php

Indentation +109 added lines, -109 removed lines

@@ -10,7 +10,7 @@ 
  * @subpackage Wordlift/includes
  */
 if ( ! class_exists( 'Walker_Category_Checklist' ) ) {
-	require_once ABSPATH . 'wp-admin/includes/template.php';
+    require_once ABSPATH . 'wp-admin/includes/template.php';
 }
 
 /**
@@ -24,113 +24,113 @@ 
 // phpcs:ignore Generic.Classes.DuplicateClassName.Found
 class Wordlift_Entity_Types_Taxonomy_Walker extends Walker_Category_Checklist {
 
-	/**
-	 * Entity taxonomy metabox must show exclusive options, no checkboxes.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param       $args     {
-	 *                        An array of arguments.
-	 *
-	 * @type string $taxonomy The taxonomy name.
-	 *              }
-	 *
-	 * @return array An array of arguments, with this walker in case the taxonomy is the Entity Type taxonomy.
-	 */
-	public function terms_checklist_args( $args ) {
-
-		if ( ! isset( $args['taxonomy'] ) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			return $args;
-		}
-
-		// We override the way WP prints the taxonomy metabox HTML.
-		$args['walker']        = $this;
-		$args['checked_ontop'] = false;
-
-		return $args;
-
-	}
-
-	/**
-	 * Change checkboxes to radios.
-	 *
-	 * $max_depth = -1 means flatly display every element.
-	 * $max_depth = 0 means display all levels.
-	 * $max_depth > 0 specifies the number of display levels.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param array $elements  An array of elements.
-	 * @param int   $max_depth The maximum hierarchical depth.
-	 *
-	 * @param array $args      Additional arguments.
-	 *
-	 * @return string The hierarchical item output.
-	 */
-	public function walk( $elements, $max_depth, $args = array() ) {
-
-		// `max_depth` force to -1 to display a flat taxonomy.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/305
-		$output = parent::walk( $elements, - 1, $args );
-
-		$output = str_replace(
-			array( 'type="checkbox"', "type='checkbox'" ),
-			array( 'type="radio"', "type='radio'" ),
-			$output
-		);
-
-		return $output;
-	}
-
-	/**
-	 * Start the element output, output nothing in case of article term.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param string $output   Passed by reference. Used to append additional content.
-	 * @param object $category The current term object.
-	 * @param int    $depth    Depth of the term in reference to parents. Default 0.
-	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
-	 * @param int    $id       ID of the current term.
-	 */
-	public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
-		global $post;
-
-		if ( ! isset( $post ) ) {
-			return;
-		}
-
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
-			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::start_el( $output, $category, $depth, $args, $id );
-		}
-	}
-
-	/**
-	 * End the element output, output nothing in case of article term.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param string $output   Passed by reference. Used to append additional content.
-	 * @param object $category The current term object.
-	 * @param int    $depth    Depth of the term in reference to parents. Default 0.
-	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
-	 */
-	public function end_el( &$output, $category, $depth = 0, $args = array() ) {
-		global $post;
-
-		if ( ! isset( $post ) ) {
-			return;
-		}
-
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
-			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::end_el( $output, $category, $depth, $args );
-		}
-
-	}
+    /**
+     * Entity taxonomy metabox must show exclusive options, no checkboxes.
+     *
+     * @since 3.1.0
+     *
+     * @param       $args     {
+     *                        An array of arguments.
+     *
+     * @type string $taxonomy The taxonomy name.
+     *              }
+     *
+     * @return array An array of arguments, with this walker in case the taxonomy is the Entity Type taxonomy.
+     */
+    public function terms_checklist_args( $args ) {
+
+        if ( ! isset( $args['taxonomy'] ) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+            return $args;
+        }
+
+        // We override the way WP prints the taxonomy metabox HTML.
+        $args['walker']        = $this;
+        $args['checked_ontop'] = false;
+
+        return $args;
+
+    }
+
+    /**
+     * Change checkboxes to radios.
+     *
+     * $max_depth = -1 means flatly display every element.
+     * $max_depth = 0 means display all levels.
+     * $max_depth > 0 specifies the number of display levels.
+     *
+     * @since 3.1.0
+     *
+     * @param array $elements  An array of elements.
+     * @param int   $max_depth The maximum hierarchical depth.
+     *
+     * @param array $args      Additional arguments.
+     *
+     * @return string The hierarchical item output.
+     */
+    public function walk( $elements, $max_depth, $args = array() ) {
+
+        // `max_depth` force to -1 to display a flat taxonomy.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/305
+        $output = parent::walk( $elements, - 1, $args );
+
+        $output = str_replace(
+            array( 'type="checkbox"', "type='checkbox'" ),
+            array( 'type="radio"', "type='radio'" ),
+            $output
+        );
+
+        return $output;
+    }
+
+    /**
+     * Start the element output, output nothing in case of article term.
+     *
+     * @since 3.15.0
+     *
+     * @param string $output   Passed by reference. Used to append additional content.
+     * @param object $category The current term object.
+     * @param int    $depth    Depth of the term in reference to parents. Default 0.
+     * @param array  $args     An array of arguments. @see wp_terms_checklist()
+     * @param int    $id       ID of the current term.
+     */
+    public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
+        global $post;
+
+        if ( ! isset( $post ) ) {
+            return;
+        }
+
+        if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+             || 'article' !== $category->slug
+             || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+            parent::start_el( $output, $category, $depth, $args, $id );
+        }
+    }
+
+    /**
+     * End the element output, output nothing in case of article term.
+     *
+     * @since 3.15.0
+     *
+     * @param string $output   Passed by reference. Used to append additional content.
+     * @param object $category The current term object.
+     * @param int    $depth    Depth of the term in reference to parents. Default 0.
+     * @param array  $args     An array of arguments. @see wp_terms_checklist()
+     */
+    public function end_el( &$output, $category, $depth = 0, $args = array() ) {
+        global $post;
+
+        if ( ! isset( $post ) ) {
+            return;
+        }
+
+        if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+             || 'article' !== $category->slug
+             || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+            parent::end_el( $output, $category, $depth, $args );
+        }
+
+    }
 
 }

Spacing +18 added lines, -18 removed lines

@@ -9,8 +9,8 @@ 
  * @package    Wordlift
  * @subpackage Wordlift/includes
  */
-if ( ! class_exists( 'Walker_Category_Checklist' ) ) {
-	require_once ABSPATH . 'wp-admin/includes/template.php';
+if ( ! class_exists('Walker_Category_Checklist')) {
+	require_once ABSPATH.'wp-admin/includes/template.php';
 }
 
 /**
@@ -37,9 +37,9 @@ 
 	 *
 	 * @return array An array of arguments, with this walker in case the taxonomy is the Entity Type taxonomy.
 	 */
-	public function terms_checklist_args( $args ) {
+	public function terms_checklist_args($args) {
 
-		if ( ! isset( $args['taxonomy'] ) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
+		if ( ! isset($args['taxonomy']) || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy']) {
 			return $args;
 		}
 
@@ -67,16 +67,16 @@ 
 	 *
 	 * @return string The hierarchical item output.
 	 */
-	public function walk( $elements, $max_depth, $args = array() ) {
+	public function walk($elements, $max_depth, $args = array()) {
 
 		// `max_depth` force to -1 to display a flat taxonomy.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/305
-		$output = parent::walk( $elements, - 1, $args );
+		$output = parent::walk($elements, - 1, $args);
 
 		$output = str_replace(
-			array( 'type="checkbox"', "type='checkbox'" ),
-			array( 'type="radio"', "type='radio'" ),
+			array('type="checkbox"', "type='checkbox'"),
+			array('type="radio"', "type='radio'"),
 			$output
 		);
 
@@ -94,17 +94,17 @@ 
 	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
 	 * @param int    $id       ID of the current term.
 	 */
-	public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
+	public function start_el(&$output, $category, $depth = 0, $args = array(), $id = 0) {
 		global $post;
 
-		if ( ! isset( $post ) ) {
+		if ( ! isset($post)) {
 			return;
 		}
 
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+		if (Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
 			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::start_el( $output, $category, $depth, $args, $id );
+			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy']) {
+			parent::start_el($output, $category, $depth, $args, $id);
 		}
 	}
 
@@ -118,17 +118,17 @@ 
 	 * @param int    $depth    Depth of the term in reference to parents. Default 0.
 	 * @param array  $args     An array of arguments. @see wp_terms_checklist()
 	 */
-	public function end_el( &$output, $category, $depth = 0, $args = array() ) {
+	public function end_el(&$output, $category, $depth = 0, $args = array()) {
 		global $post;
 
-		if ( ! isset( $post ) ) {
+		if ( ! isset($post)) {
 			return;
 		}
 
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
+		if (Wordlift_Entity_Service::TYPE_NAME !== $post->post_type
 			 || 'article' !== $category->slug
-			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy'] ) {
-			parent::end_el( $output, $category, $depth, $args );
+			 || Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME !== $args['taxonomy']) {
+			parent::end_el($output, $category, $depth, $args);
 		}
 
 	}

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

Indentation +290 added lines, -290 removed lines

@@ -20,131 +20,131 @@ 
  */
 class Wordlift_Admin_Post_Edit_Page {
 
-	/**
-	 * Constants to be used instead of text inside FAQ
-	 * helper methods.
-	 */
-	const GUTENBERG       = 'gutenberg';
-	const TINY_MCE        = 'tiny_mce';
-	const FAQ_LIST_BOX_ID = 'wl-faq-meta-list-box';
-
-	/** Constant to be used for translation domain */
-	const WORDLIFT_TEXT_DOMAIN = 'wordlift';
-
-	/**
-	 * The {@link Wordlift} plugin instance.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @var \Wordlift $plugin The {@link Wordlift} plugin instance.
-	 */
-	private $plugin;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.15.4
-	 *
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create the {@link Wordlift_Admin_Post_Edit_Page} instance.
-	 *
-	 * @param \Wordlift $plugin The {@link Wordlift} plugin instance.
-	 *
-	 * @since 3.11.0
-	 */
-	public function __construct( $plugin ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_scripts_gutenberg' ) );
-
-		// Bail out if we're in the UX Builder editor.
-		if ( $this->is_ux_builder_editor() ) {
-			$this->log->info( 'WordLift will not show, since we are in UX Builder editor.' );
-
-			return;
-		}
-
-		// Define the callbacks.
-		$callback = array( $this, 'enqueue_scripts' );
-		// Set a hook to enqueue scripts only when the edit page is displayed.
-		add_action( 'admin_print_scripts-post.php', $callback );
-		add_action( 'admin_print_scripts-post-new.php', $callback );
-
-		$this->plugin = $plugin;
-	}
-
-	/**
-	 * Check whether the current post opens with G'berg or not.
-	 *
-	 * @return bool True if G'berg is used otherwise false.
-	 * @since 3.22.3
-	 */
-	public function is_gutenberg_page() {
-		if ( function_exists( 'is_gutenberg_page' ) && is_gutenberg_page() ) {
-			// The Gutenberg plugin is on.
-			return true;
-		}
-
-		$current_screen = get_current_screen();
-		if ( method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() ) {
-			// Gutenberg page on 5+.
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Check if we're in UX builder.
-	 *
-	 * @see   https://github.com/insideout10/wordlift-plugin/issues/691
-	 *
-	 * @since 3.15.4
-	 *
-	 * @return bool True if we're in UX builder, otherwise false.
-	 */
-	private function is_ux_builder_editor() {
-
-		return function_exists( 'ux_builder_is_editor' )
-			   && ux_builder_is_editor();
-	}
-
-	/**
-	 * Enqueue scripts and styles for the edit page.
-	 *
-	 * @since 3.11.0
-	 */
-	public function enqueue_scripts() {
-
-		// Dequeue potentially conflicting ontrapages angular scripts which any *are not* used on the edit screen.
-		//
-		// @see https://github.com/insideout10/wordlift-plugin/issues/832
-		wp_dequeue_script( 'ontrapagesAngular' );
-		wp_dequeue_script( 'ontrapagesApp' );
-		wp_dequeue_script( 'ontrapagesController' );
-
-		// Bail out if this is G'berg.
-		if ( $this->is_gutenberg_page() ) {
-			return;
-		}
-
-		// If Gutenberg is enabled for the post, do not load the legacy edit.js.
-		if ( function_exists( 'use_block_editor_for_post' ) && use_block_editor_for_post( get_post() ) ) {
-			return;
-		}
-
-		// Bail out if classification sidebar is not enabled via hook
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
-			return;
-		}
-
-		/*
+    /**
+     * Constants to be used instead of text inside FAQ
+     * helper methods.
+     */
+    const GUTENBERG       = 'gutenberg';
+    const TINY_MCE        = 'tiny_mce';
+    const FAQ_LIST_BOX_ID = 'wl-faq-meta-list-box';
+
+    /** Constant to be used for translation domain */
+    const WORDLIFT_TEXT_DOMAIN = 'wordlift';
+
+    /**
+     * The {@link Wordlift} plugin instance.
+     *
+     * @since 3.11.0
+     *
+     * @var \Wordlift $plugin The {@link Wordlift} plugin instance.
+     */
+    private $plugin;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.15.4
+     *
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create the {@link Wordlift_Admin_Post_Edit_Page} instance.
+     *
+     * @param \Wordlift $plugin The {@link Wordlift} plugin instance.
+     *
+     * @since 3.11.0
+     */
+    public function __construct( $plugin ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_scripts_gutenberg' ) );
+
+        // Bail out if we're in the UX Builder editor.
+        if ( $this->is_ux_builder_editor() ) {
+            $this->log->info( 'WordLift will not show, since we are in UX Builder editor.' );
+
+            return;
+        }
+
+        // Define the callbacks.
+        $callback = array( $this, 'enqueue_scripts' );
+        // Set a hook to enqueue scripts only when the edit page is displayed.
+        add_action( 'admin_print_scripts-post.php', $callback );
+        add_action( 'admin_print_scripts-post-new.php', $callback );
+
+        $this->plugin = $plugin;
+    }
+
+    /**
+     * Check whether the current post opens with G'berg or not.
+     *
+     * @return bool True if G'berg is used otherwise false.
+     * @since 3.22.3
+     */
+    public function is_gutenberg_page() {
+        if ( function_exists( 'is_gutenberg_page' ) && is_gutenberg_page() ) {
+            // The Gutenberg plugin is on.
+            return true;
+        }
+
+        $current_screen = get_current_screen();
+        if ( method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() ) {
+            // Gutenberg page on 5+.
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Check if we're in UX builder.
+     *
+     * @see   https://github.com/insideout10/wordlift-plugin/issues/691
+     *
+     * @since 3.15.4
+     *
+     * @return bool True if we're in UX builder, otherwise false.
+     */
+    private function is_ux_builder_editor() {
+
+        return function_exists( 'ux_builder_is_editor' )
+               && ux_builder_is_editor();
+    }
+
+    /**
+     * Enqueue scripts and styles for the edit page.
+     *
+     * @since 3.11.0
+     */
+    public function enqueue_scripts() {
+
+        // Dequeue potentially conflicting ontrapages angular scripts which any *are not* used on the edit screen.
+        //
+        // @see https://github.com/insideout10/wordlift-plugin/issues/832
+        wp_dequeue_script( 'ontrapagesAngular' );
+        wp_dequeue_script( 'ontrapagesApp' );
+        wp_dequeue_script( 'ontrapagesController' );
+
+        // Bail out if this is G'berg.
+        if ( $this->is_gutenberg_page() ) {
+            return;
+        }
+
+        // If Gutenberg is enabled for the post, do not load the legacy edit.js.
+        if ( function_exists( 'use_block_editor_for_post' ) && use_block_editor_for_post( get_post() ) ) {
+            return;
+        }
+
+        // Bail out if classification sidebar is not enabled via hook
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
+            return;
+        }
+
+        /*
 		 * Enqueue the edit screen JavaScript. The `wordlift-admin.bundle.js` file
 		 * is scheduled to replace the older `wordlift-admin.min.js` once client-side
 		 * code is properly refactored.
@@ -153,178 +153,178 @@ 
 		 *
 		 * @since 3.20.0 edit.js has been migrated to the new webpack configuration.
 		 */
-		$script_name = plugin_dir_url( __DIR__ ) . 'js/dist/edit';
-
-		/**
-		 * Scripts_Helper introduced.
-		 *
-		 * @since 3.25.0 Scripts are loaded using script helper to ensure WP 4.4 compatibiility.
-		 * @since 3.25.1 The handle is used to hook the wp_localize_script for the _wlEntityTypes global object.
-		 */
-		Scripts_Helper::enqueue_based_on_wordpress_version(
-			'wl-classic-editor',
-			$script_name,
-			array(
-				$this->plugin->get_plugin_name(),
-				'jquery',
-				// Require wp.ajax.
-				'wp-util',
-				// @@todo: provide the following dependencies when we're in WP < 5.0 (i.e. when these dependencies aren't already defined).
-				'react',
-				'react-dom',
-				'wp-element',
-				'wp-polyfill',
-				/*
+        $script_name = plugin_dir_url( __DIR__ ) . 'js/dist/edit';
+
+        /**
+         * Scripts_Helper introduced.
+         *
+         * @since 3.25.0 Scripts are loaded using script helper to ensure WP 4.4 compatibiility.
+         * @since 3.25.1 The handle is used to hook the wp_localize_script for the _wlEntityTypes global object.
+         */
+        Scripts_Helper::enqueue_based_on_wordpress_version(
+            'wl-classic-editor',
+            $script_name,
+            array(
+                $this->plugin->get_plugin_name(),
+                'jquery',
+                // Require wp.ajax.
+                'wp-util',
+                // @@todo: provide the following dependencies when we're in WP < 5.0 (i.e. when these dependencies aren't already defined).
+                'react',
+                'react-dom',
+                'wp-element',
+                'wp-polyfill',
+                /*
 				* Angular isn't loaded anymore remotely, but it is loaded within wordlift-reloaded.js.
 				*
 				* See https://github.com/insideout10/wordlift-plugin/issues/865.
 				*
 				* @since 3.19.6
 				*/
-				// Require Angular.
-				// 'wl-angular',
-				// 'wl-angular-geolocation',
-				// 'wl-angular-touch',
-				// 'wl-angular-animate',
-				/**
-				 * We need the `wp.hooks` global to allow the edit.js script to send actions.
-				 *
-				 * @since 3.23.0
-				 */
-				'wp-hooks',
-			)
-		);
-
-		wp_enqueue_style( 'wl-classic-editor', "$script_name.css", array(), $this->plugin->get_version() );
-		// Disable Faq Editor.
-		// $this->load_faq_scripts_and_styles();
-		// $this->load_faq_settings( self::TINY_MCE );
-	}
-
-	/**
-	 * Enqueue the scripts and styles needed for FAQ
-	 */
-	private function load_faq_scripts_and_styles() {
-		wp_enqueue_style(
-			'wl-faq-metabox-style',
-			plugin_dir_url( __DIR__ ) . 'js/dist/faq.css',
-			array(),
-			WORDLIFT_VERSION
-		);
-		Scripts_Helper::enqueue_based_on_wordpress_version(
-			'wl-faq-metabox-script',
-			plugin_dir_url( __DIR__ ) . 'js/dist/faq',
-			array( 'wp-polyfill' ),
-			true
-		);
-	}
-
-	/**
-	 * Get FAQ settings array
-	 *
-	 * @return array
-	 */
-	public function get_faq_settings() {
-		return array(
-			'restUrl'                 => get_rest_url( null, WL_REST_ROUTE_DEFAULT_NAMESPACE . '/faq' ),
-			'listBoxId'               => self::FAQ_LIST_BOX_ID,
-			'nonce'                   => wp_create_nonce( 'wp_rest' ),
-			'postId'                  => get_the_ID(),
-			// Translation for warning, error message.
-			/* translators: %s: The invalid tag. */
-			'invalidTagMessage'       => sprintf( __( 'Invalid tags %s is present in answer', 'wordlift' ), '{INVALID_TAGS}' ),
-			/* translators: %s: The word count limit warning. */
-			'invalidWordCountMessage' => sprintf( __( 'Answer word count must not exceed %s words', 'wordlift' ), '{ANSWER_WORD_COUNT_WARNING_LIMIT}' ),
-			'questionText'            => __( 'Question', 'wordlift' ),
-			'answerText'              => __( 'Answer', 'wordlift' ),
-			'addQuestionOrAnswerText' => __( 'Add Question / Answer', 'wordlift' ),
-			'addQuestionText'         => __( 'Add Question', 'wordlift' ),
-			'addAnswerText'           => __( 'Add Answer', 'wordlift' ),
-			'noFaqItemsText'          => __( 'Highlight a question in content, then click Add Question.', 'wordlift' ),
-			'updatingText'            => __( 'Updating...', 'wordlift' ),
-		);
-	}
-
-	/**
-	 * Load FAQ settings to the add/edit post page
-	 *
-	 * @param $editor string specifying which text editor needed to be used.
-	 */
-	private function load_faq_settings( $editor ) {
-		// This script also provides translations to gutenberg.
-		wp_localize_script( 'wl-faq-metabox-script', '_wlFaqSettings', $this->get_faq_settings() );
-
-		// Enqueue the FAQ style
-		if ( self::GUTENBERG === $editor ) {
-			Scripts_Helper::enqueue_based_on_wordpress_version(
-				'wl-faq-gutenberg-plugin',
-				plugin_dir_url( __DIR__ ) . 'js/dist/block-editor-faq-plugin',
-				array( 'wp-polyfill' ),
-				true
-			);
-		}
-	}
-
-	/**
-	 * Enqueue scripts and styles for the gutenberg edit page.
-	 *
-	 * @since 3.21.0
-	 */
-	public function enqueue_scripts_gutenberg() {
-		// Load FAQ settings. - Disabled for now
-		// $this->load_faq_scripts_and_styles();
-		// $this->load_faq_settings( self::GUTENBERG );
-
-		wp_register_script(
-			'wl-block-editor',
-			plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.js',
-			array(
-				'react',
-				'wordlift',
-				'wp-hooks',
-				'wp-data',
-				'wp-rich-text',
-				'wp-blocks',
-				'wp-plugins',
-				'wp-edit-post',
-			),
-			$this->plugin->get_version(),
-			false
-		);
-		wp_localize_script(
-			'wl-block-editor',
-			'_wlBlockEditorSettings',
-			array(
-				'root'  => esc_url_raw( rest_url() ),
-				'nonce' => wp_create_nonce( 'wp_rest' ),
-			)
-		);
-
-		/*
+                // Require Angular.
+                // 'wl-angular',
+                // 'wl-angular-geolocation',
+                // 'wl-angular-touch',
+                // 'wl-angular-animate',
+                /**
+                 * We need the `wp.hooks` global to allow the edit.js script to send actions.
+                 *
+                 * @since 3.23.0
+                 */
+                'wp-hooks',
+            )
+        );
+
+        wp_enqueue_style( 'wl-classic-editor', "$script_name.css", array(), $this->plugin->get_version() );
+        // Disable Faq Editor.
+        // $this->load_faq_scripts_and_styles();
+        // $this->load_faq_settings( self::TINY_MCE );
+    }
+
+    /**
+     * Enqueue the scripts and styles needed for FAQ
+     */
+    private function load_faq_scripts_and_styles() {
+        wp_enqueue_style(
+            'wl-faq-metabox-style',
+            plugin_dir_url( __DIR__ ) . 'js/dist/faq.css',
+            array(),
+            WORDLIFT_VERSION
+        );
+        Scripts_Helper::enqueue_based_on_wordpress_version(
+            'wl-faq-metabox-script',
+            plugin_dir_url( __DIR__ ) . 'js/dist/faq',
+            array( 'wp-polyfill' ),
+            true
+        );
+    }
+
+    /**
+     * Get FAQ settings array
+     *
+     * @return array
+     */
+    public function get_faq_settings() {
+        return array(
+            'restUrl'                 => get_rest_url( null, WL_REST_ROUTE_DEFAULT_NAMESPACE . '/faq' ),
+            'listBoxId'               => self::FAQ_LIST_BOX_ID,
+            'nonce'                   => wp_create_nonce( 'wp_rest' ),
+            'postId'                  => get_the_ID(),
+            // Translation for warning, error message.
+            /* translators: %s: The invalid tag. */
+            'invalidTagMessage'       => sprintf( __( 'Invalid tags %s is present in answer', 'wordlift' ), '{INVALID_TAGS}' ),
+            /* translators: %s: The word count limit warning. */
+            'invalidWordCountMessage' => sprintf( __( 'Answer word count must not exceed %s words', 'wordlift' ), '{ANSWER_WORD_COUNT_WARNING_LIMIT}' ),
+            'questionText'            => __( 'Question', 'wordlift' ),
+            'answerText'              => __( 'Answer', 'wordlift' ),
+            'addQuestionOrAnswerText' => __( 'Add Question / Answer', 'wordlift' ),
+            'addQuestionText'         => __( 'Add Question', 'wordlift' ),
+            'addAnswerText'           => __( 'Add Answer', 'wordlift' ),
+            'noFaqItemsText'          => __( 'Highlight a question in content, then click Add Question.', 'wordlift' ),
+            'updatingText'            => __( 'Updating...', 'wordlift' ),
+        );
+    }
+
+    /**
+     * Load FAQ settings to the add/edit post page
+     *
+     * @param $editor string specifying which text editor needed to be used.
+     */
+    private function load_faq_settings( $editor ) {
+        // This script also provides translations to gutenberg.
+        wp_localize_script( 'wl-faq-metabox-script', '_wlFaqSettings', $this->get_faq_settings() );
+
+        // Enqueue the FAQ style
+        if ( self::GUTENBERG === $editor ) {
+            Scripts_Helper::enqueue_based_on_wordpress_version(
+                'wl-faq-gutenberg-plugin',
+                plugin_dir_url( __DIR__ ) . 'js/dist/block-editor-faq-plugin',
+                array( 'wp-polyfill' ),
+                true
+            );
+        }
+    }
+
+    /**
+     * Enqueue scripts and styles for the gutenberg edit page.
+     *
+     * @since 3.21.0
+     */
+    public function enqueue_scripts_gutenberg() {
+        // Load FAQ settings. - Disabled for now
+        // $this->load_faq_scripts_and_styles();
+        // $this->load_faq_settings( self::GUTENBERG );
+
+        wp_register_script(
+            'wl-block-editor',
+            plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.js',
+            array(
+                'react',
+                'wordlift',
+                'wp-hooks',
+                'wp-data',
+                'wp-rich-text',
+                'wp-blocks',
+                'wp-plugins',
+                'wp-edit-post',
+            ),
+            $this->plugin->get_version(),
+            false
+        );
+        wp_localize_script(
+            'wl-block-editor',
+            '_wlBlockEditorSettings',
+            array(
+                'root'  => esc_url_raw( rest_url() ),
+                'nonce' => wp_create_nonce( 'wp_rest' ),
+            )
+        );
+
+        /*
 		 * @since 3.25.1 The hook is used by the wp_localize_script to register the _wlEntityTypes global object.
 		 */
-		wp_enqueue_style(
-			'wl-block-editor',
-			plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.css',
-			array(),
-			$this->plugin->get_version()
-		);
-
-		wp_enqueue_script(
-			'wl-autocomplete-select',
-			plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.js',
-			array(),
-			$this->plugin->get_version(),
-			true
-		);
-
-		wp_enqueue_style(
-			'wl-autocomplete-select',
-			plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.css',
-			array(),
-			$this->plugin->get_version()
-		);
-
-	}
+        wp_enqueue_style(
+            'wl-block-editor',
+            plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.css',
+            array(),
+            $this->plugin->get_version()
+        );
+
+        wp_enqueue_script(
+            'wl-autocomplete-select',
+            plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.js',
+            array(),
+            $this->plugin->get_version(),
+            true
+        );
+
+        wp_enqueue_style(
+            'wl-autocomplete-select',
+            plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.css',
+            array(),
+            $this->plugin->get_version()
+        );
+
+    }
 
 }

Spacing +44 added lines, -44 removed lines

@@ -56,24 +56,24 @@ 
 	 *
 	 * @since 3.11.0
 	 */
-	public function __construct( $plugin ) {
+	public function __construct($plugin) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
-		add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_scripts_gutenberg' ) );
+		add_action('enqueue_block_editor_assets', array($this, 'enqueue_scripts_gutenberg'));
 
 		// Bail out if we're in the UX Builder editor.
-		if ( $this->is_ux_builder_editor() ) {
-			$this->log->info( 'WordLift will not show, since we are in UX Builder editor.' );
+		if ($this->is_ux_builder_editor()) {
+			$this->log->info('WordLift will not show, since we are in UX Builder editor.');
 
 			return;
 		}
 
 		// Define the callbacks.
-		$callback = array( $this, 'enqueue_scripts' );
+		$callback = array($this, 'enqueue_scripts');
 		// Set a hook to enqueue scripts only when the edit page is displayed.
-		add_action( 'admin_print_scripts-post.php', $callback );
-		add_action( 'admin_print_scripts-post-new.php', $callback );
+		add_action('admin_print_scripts-post.php', $callback);
+		add_action('admin_print_scripts-post-new.php', $callback);
 
 		$this->plugin = $plugin;
 	}
@@ -85,13 +85,13 @@ 
 	 * @since 3.22.3
 	 */
 	public function is_gutenberg_page() {
-		if ( function_exists( 'is_gutenberg_page' ) && is_gutenberg_page() ) {
+		if (function_exists('is_gutenberg_page') && is_gutenberg_page()) {
 			// The Gutenberg plugin is on.
 			return true;
 		}
 
 		$current_screen = get_current_screen();
-		if ( method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() ) {
+		if (method_exists($current_screen, 'is_block_editor') && $current_screen->is_block_editor()) {
 			// Gutenberg page on 5+.
 			return true;
 		}
@@ -110,7 +110,7 @@ 
 	 */
 	private function is_ux_builder_editor() {
 
-		return function_exists( 'ux_builder_is_editor' )
+		return function_exists('ux_builder_is_editor')
 			   && ux_builder_is_editor();
 	}
 
@@ -124,23 +124,23 @@ 
 		// Dequeue potentially conflicting ontrapages angular scripts which any *are not* used on the edit screen.
 		//
 		// @see https://github.com/insideout10/wordlift-plugin/issues/832
-		wp_dequeue_script( 'ontrapagesAngular' );
-		wp_dequeue_script( 'ontrapagesApp' );
-		wp_dequeue_script( 'ontrapagesController' );
+		wp_dequeue_script('ontrapagesAngular');
+		wp_dequeue_script('ontrapagesApp');
+		wp_dequeue_script('ontrapagesController');
 
 		// Bail out if this is G'berg.
-		if ( $this->is_gutenberg_page() ) {
+		if ($this->is_gutenberg_page()) {
 			return;
 		}
 
 		// If Gutenberg is enabled for the post, do not load the legacy edit.js.
-		if ( function_exists( 'use_block_editor_for_post' ) && use_block_editor_for_post( get_post() ) ) {
+		if (function_exists('use_block_editor_for_post') && use_block_editor_for_post(get_post())) {
 			return;
 		}
 
 		// Bail out if classification sidebar is not enabled via hook
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
+		if ( ! apply_filters('wl_feature__enable__classification-sidebar', true)) {
 			return;
 		}
 
@@ -153,7 +153,7 @@ 
 		 *
 		 * @since 3.20.0 edit.js has been migrated to the new webpack configuration.
 		 */
-		$script_name = plugin_dir_url( __DIR__ ) . 'js/dist/edit';
+		$script_name = plugin_dir_url(__DIR__).'js/dist/edit';
 
 		/**
 		 * Scripts_Helper introduced.
@@ -195,7 +195,7 @@ 
 			)
 		);
 
-		wp_enqueue_style( 'wl-classic-editor', "$script_name.css", array(), $this->plugin->get_version() );
+		wp_enqueue_style('wl-classic-editor', "$script_name.css", array(), $this->plugin->get_version());
 		// Disable Faq Editor.
 		// $this->load_faq_scripts_and_styles();
 		// $this->load_faq_settings( self::TINY_MCE );
@@ -207,14 +207,14 @@ 
 	private function load_faq_scripts_and_styles() {
 		wp_enqueue_style(
 			'wl-faq-metabox-style',
-			plugin_dir_url( __DIR__ ) . 'js/dist/faq.css',
+			plugin_dir_url(__DIR__).'js/dist/faq.css',
 			array(),
 			WORDLIFT_VERSION
 		);
 		Scripts_Helper::enqueue_based_on_wordpress_version(
 			'wl-faq-metabox-script',
-			plugin_dir_url( __DIR__ ) . 'js/dist/faq',
-			array( 'wp-polyfill' ),
+			plugin_dir_url(__DIR__).'js/dist/faq',
+			array('wp-polyfill'),
 			true
 		);
 	}
@@ -226,22 +226,22 @@ 
 	 */
 	public function get_faq_settings() {
 		return array(
-			'restUrl'                 => get_rest_url( null, WL_REST_ROUTE_DEFAULT_NAMESPACE . '/faq' ),
+			'restUrl'                 => get_rest_url(null, WL_REST_ROUTE_DEFAULT_NAMESPACE.'/faq'),
 			'listBoxId'               => self::FAQ_LIST_BOX_ID,
-			'nonce'                   => wp_create_nonce( 'wp_rest' ),
+			'nonce'                   => wp_create_nonce('wp_rest'),
 			'postId'                  => get_the_ID(),
 			// Translation for warning, error message.
 			/* translators: %s: The invalid tag. */
-			'invalidTagMessage'       => sprintf( __( 'Invalid tags %s is present in answer', 'wordlift' ), '{INVALID_TAGS}' ),
+			'invalidTagMessage'       => sprintf(__('Invalid tags %s is present in answer', 'wordlift'), '{INVALID_TAGS}'),
 			/* translators: %s: The word count limit warning. */
-			'invalidWordCountMessage' => sprintf( __( 'Answer word count must not exceed %s words', 'wordlift' ), '{ANSWER_WORD_COUNT_WARNING_LIMIT}' ),
-			'questionText'            => __( 'Question', 'wordlift' ),
-			'answerText'              => __( 'Answer', 'wordlift' ),
-			'addQuestionOrAnswerText' => __( 'Add Question / Answer', 'wordlift' ),
-			'addQuestionText'         => __( 'Add Question', 'wordlift' ),
-			'addAnswerText'           => __( 'Add Answer', 'wordlift' ),
-			'noFaqItemsText'          => __( 'Highlight a question in content, then click Add Question.', 'wordlift' ),
-			'updatingText'            => __( 'Updating...', 'wordlift' ),
+			'invalidWordCountMessage' => sprintf(__('Answer word count must not exceed %s words', 'wordlift'), '{ANSWER_WORD_COUNT_WARNING_LIMIT}'),
+			'questionText'            => __('Question', 'wordlift'),
+			'answerText'              => __('Answer', 'wordlift'),
+			'addQuestionOrAnswerText' => __('Add Question / Answer', 'wordlift'),
+			'addQuestionText'         => __('Add Question', 'wordlift'),
+			'addAnswerText'           => __('Add Answer', 'wordlift'),
+			'noFaqItemsText'          => __('Highlight a question in content, then click Add Question.', 'wordlift'),
+			'updatingText'            => __('Updating...', 'wordlift'),
 		);
 	}
 
@@ -250,16 +250,16 @@ 
 	 *
 	 * @param $editor string specifying which text editor needed to be used.
 	 */
-	private function load_faq_settings( $editor ) {
+	private function load_faq_settings($editor) {
 		// This script also provides translations to gutenberg.
-		wp_localize_script( 'wl-faq-metabox-script', '_wlFaqSettings', $this->get_faq_settings() );
+		wp_localize_script('wl-faq-metabox-script', '_wlFaqSettings', $this->get_faq_settings());
 
 		// Enqueue the FAQ style
-		if ( self::GUTENBERG === $editor ) {
+		if (self::GUTENBERG === $editor) {
 			Scripts_Helper::enqueue_based_on_wordpress_version(
 				'wl-faq-gutenberg-plugin',
-				plugin_dir_url( __DIR__ ) . 'js/dist/block-editor-faq-plugin',
-				array( 'wp-polyfill' ),
+				plugin_dir_url(__DIR__).'js/dist/block-editor-faq-plugin',
+				array('wp-polyfill'),
 				true
 			);
 		}
@@ -277,7 +277,7 @@ 
 
 		wp_register_script(
 			'wl-block-editor',
-			plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.js',
+			plugin_dir_url(__DIR__).'js/dist/block-editor.js',
 			array(
 				'react',
 				'wordlift',
@@ -295,8 +295,8 @@ 
 			'wl-block-editor',
 			'_wlBlockEditorSettings',
 			array(
-				'root'  => esc_url_raw( rest_url() ),
-				'nonce' => wp_create_nonce( 'wp_rest' ),
+				'root'  => esc_url_raw(rest_url()),
+				'nonce' => wp_create_nonce('wp_rest'),
 			)
 		);
 
@@ -305,14 +305,14 @@ 
 		 */
 		wp_enqueue_style(
 			'wl-block-editor',
-			plugin_dir_url( __DIR__ ) . 'js/dist/block-editor.css',
+			plugin_dir_url(__DIR__).'js/dist/block-editor.css',
 			array(),
 			$this->plugin->get_version()
 		);
 
 		wp_enqueue_script(
 			'wl-autocomplete-select',
-			plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.js',
+			plugin_dir_url(__DIR__).'js/dist/autocomplete-select.js',
 			array(),
 			$this->plugin->get_version(),
 			true
@@ -320,7 +320,7 @@ 
 
 		wp_enqueue_style(
 			'wl-autocomplete-select',
-			plugin_dir_url( __DIR__ ) . 'js/dist/autocomplete-select.css',
+			plugin_dir_url(__DIR__).'js/dist/autocomplete-select.css',
 			array(),
 			$this->plugin->get_version()
 		);

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

Indentation +303 added lines, -303 removed lines

@@ -18,308 +18,308 @@
  */
 class Wordlift_Admin_Settings_Analytics_Page extends Wordlift_Admin_Page {
 
-	/**
-	 * A singleton instance of the Notice service.
-	 *
-	 * @since  3.21.0
-	 * @access private
-	 * @var \Wordlift_Admin_Settings_Analytics_Page $instance A singleton instance of a {@link Wordlift_Admin_Settings_Analytics_Page} class.
-	 */
-	private static $instance;
-
-	/**
-	 * A {@link Wordlift_Admin_Input_Element} element renderer.
-	 *
-	 * @since  3.21.0
-	 * @access private
-	 * @var \Wordlift_Admin_Input_Element $input_element An {@link Wordlift_Admin_Input_Element} element renderer.
-	 */
-	private $input_element;
-
-	/**
-	 * A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
-	 *
-	 * @since  3.21.0
-	 * @access protected
-	 * @var \Wordlift_Admin_Radio_Input_Element $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
-	 */
-	private $radio_input_element;
-
-	/**
-	 * Create a {@link Wordlift_Admin_Settings_Page} instance.
-	 *
-	 * @param \Wordlift_Admin_Input_Element       $input_element An input element class to output input boxes in a settings form.
-	 * @param \Wordlift_Admin_Radio_Input_Element $radio_input_element A radio element input class for use in a settings form.
-	 *
-	 * @since 3.21.0
-	 */
-	public function __construct( $input_element, $radio_input_element ) {
-
-		// Set a reference to the UI elements.
-		$this->input_element       = $input_element;
-		$this->radio_input_element = $radio_input_element;
-
-		// Adds this page to the main admin settings tabbed menu.
-		add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
-
-		self::$instance = $this;
-	}
-
-	/**
-	 * Get the singleton instance of the Notice service.
-	 *
-	 * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
-	 * @since 3.21.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	protected function get_parent_slug() {
-
-		return 'wl_admin_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	protected function get_capability() {
-
-		return 'manage_options';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_page_title() {
-
-		return __( 'WorldLift Analytics Settings', 'wordlift' );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_menu_title() {
-
-		return __( 'Analytics Settings', 'wordlift' );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_menu_slug() {
-
-		return 'wl_configuration_admin_analytics_menu';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function get_partial_name() {
-
-		return 'wordlift-admin-settings-analytics-page.php';
-	}
-
-	/**
-	 * Returns the string to use for the tab slug on main admin settings page.
-	 *
-	 * @method get_admin_page_tab_slug
-	 * @return string
-	 * @since  3.21.0
-	 */
-	public function get_admin_page_tab_slug() {
-		return 'analytics';
-	}
-
-	/**
-	 * Adds pages to the tabs menu on the main admin settings page.
-	 *
-	 * @method add_admin_page_tab
-	 * @param array $tabs an array of tab titles and slugs to use when building a tabbed menu on option pages.
-	 *
-	 * @since  3.21.0
-	 */
-	public function add_admin_page_tab( $tabs ) {
-		if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
-			$tabs[] = array(
-				'title' => $this->get_menu_title(),
-				'slug'  => $this->get_admin_page_tab_slug(),
-			);
-		}
-
-		return $tabs;
-	}
-
-	/**
-	 * Configure all the configuration parameters.
-	 *
-	 * Called by the *admin_init* hook.
-	 *
-	 * @since 3.21.0
-	 */
-	public function admin_init() {
-
-		// Register WordLift's analytics settings with our in class sanitizer.
-		register_setting(
-			'wl_analytics_settings',
-			'wl_analytics_settings',
-			array( $this, 'sanitize_callback' )
-		);
-
-		// Add the analytics settings setction.
-		add_settings_section(
-			'wl_analytics_settings_section',
-			'',
-			'',
-			'wl_analytics_settings'
-		);
-
-		// Add a toggle to determine if analytics functions are enabled or not.
-		// NOTE: this uses yes/no rather than true/false.
-		add_settings_field(
-			'wl-analytics-enabled',
-			__( 'Enable Analytics', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-enable',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
-				'value'       => Wordlift_Configuration_Service::get_instance()->is_analytics_enable() ? 'yes' : 'no',
-				'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
-			)
-		);
-
-		/**
-		 * A basic number field that will accept anything from 1 to 20.
-		 *
-		 * Represents the custom dim number for the uri.
-		 */
-		add_settings_field(
-			'wl-analytics-entity-uri-dimension',
-			__( 'Entity URI dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-entity-uri-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
-				'type'        => 'number',
-				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension(),
-				'description' => __( 'Entity URI dimesion', 'wordlift' ),
-			)
-		);
-
-		/**
-		 * A basic number field that will accept anything from 1 to 20.
-		 *
-		 * Represents the custom dim number for the type.
-		 */
-		add_settings_field(
-			'wl-analytics-entity-type-dimension',
-			__( 'Entity Type dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
-			'wl_analytics_settings',
-			'wl_analytics_settings_section',
-			array(
-				'id'          => 'wl-analytics-entity-type-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
-				'type'        => 'number',
-				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension(),
-				'description' => __( 'Entity Type dimension', 'wordlift' ),
-			)
-		);
-
-	}
-
-	/**
-	 * Validates an entity uri based on an integer passed.
-	 *
-	 * TODO: Needs a feedback method to pass back error messages.
-	 *
-	 * @method validate_entity_uri
-	 * @param string $uri a sting representing an entity ID that can be converted to a uri.
-	 *
-	 * @return int
-	 * @since 3.21.0
-	 */
-	public function validate_entity_uri( $uri ) {
-		// Basic validation is to ensure number is between 1 and 20.
-		// NOTE: certain analytics accounts have a much higher value - as many
-		// as 200 are allowed.
-		if ( (int) $uri < 1 || (int) $uri > 20 ) {
-			// if we are out of range then pass the default value.
-			$uri = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension();
-		}
-
-		return absint( $uri );
-	}
-
-	/**
-	 * Validates an entity type.
-	 *
-	 * TODO: Needs a feedback method to pass back error messages.
-	 *
-	 * @method validate_entity_type
-	 * @param string $type This is an entity type ID in string form - really a number.
-	 *
-	 * @return int
-	 * @since  3.21.0
-	 */
-	public function validate_entity_type( $type ) {
-		// Basic validation is to ensure number is between 1 and 20.
-		// NOTE: certain analytics accounts have a much higher value - as many
-		// as 200 are allowed.
-		if ( (int) $type < 1 || (int) $type > 20 ) {
-			// if we are out of range then pass the default value.
-			$type = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension();
-		}
-
-		return absint( $type );
-	}
-
-	/**
-	 * Sanitize the configuration settings to be stored.
-	 *
-	 * If a new entity is being created for the publisher, create it and set The
-	 * publisher setting.
-	 *
-	 * @param array $input The configuration settings array.
-	 *
-	 * @return array The sanitized input array.
-	 * @since 3.21.0
-	 */
-	public function sanitize_callback( $input ) {
-		if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
-			// Any failing nonce checks already die().
-			return;
-		}
-
-		/**
-		 * Validate and sanitize the $inputs and store them in $output saved.
-		 */
-		$output = array();
-		if ( isset( $input['analytics_enable'] ) ) {
-			$output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
-		}
-		if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
-			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
-		}
-		if ( isset( $input['analytics_entity_type_dimension'] ) ) {
-			// This dimension cannot be the same as the one set above. If it is
-			// then zero it out and it will fail validation.
-			if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
-				$input['analytics_entity_type_dimension'] = 0;
-			}
-			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
-		}
-
-		// return items added to the output for saving.
-		return $output;
-	}
+    /**
+     * A singleton instance of the Notice service.
+     *
+     * @since  3.21.0
+     * @access private
+     * @var \Wordlift_Admin_Settings_Analytics_Page $instance A singleton instance of a {@link Wordlift_Admin_Settings_Analytics_Page} class.
+     */
+    private static $instance;
+
+    /**
+     * A {@link Wordlift_Admin_Input_Element} element renderer.
+     *
+     * @since  3.21.0
+     * @access private
+     * @var \Wordlift_Admin_Input_Element $input_element An {@link Wordlift_Admin_Input_Element} element renderer.
+     */
+    private $input_element;
+
+    /**
+     * A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
+     *
+     * @since  3.21.0
+     * @access protected
+     * @var \Wordlift_Admin_Radio_Input_Element $radio_input_element A {@link Wordlift_Admin_Radio_Input_Element} element renderer.
+     */
+    private $radio_input_element;
+
+    /**
+     * Create a {@link Wordlift_Admin_Settings_Page} instance.
+     *
+     * @param \Wordlift_Admin_Input_Element       $input_element An input element class to output input boxes in a settings form.
+     * @param \Wordlift_Admin_Radio_Input_Element $radio_input_element A radio element input class for use in a settings form.
+     *
+     * @since 3.21.0
+     */
+    public function __construct( $input_element, $radio_input_element ) {
+
+        // Set a reference to the UI elements.
+        $this->input_element       = $input_element;
+        $this->radio_input_element = $radio_input_element;
+
+        // Adds this page to the main admin settings tabbed menu.
+        add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
+
+        self::$instance = $this;
+    }
+
+    /**
+     * Get the singleton instance of the Notice service.
+     *
+     * @return \Wordlift_Admin_Settings_Page The singleton instance of the settings page service.
+     * @since 3.21.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function get_parent_slug() {
+
+        return 'wl_admin_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function get_capability() {
+
+        return 'manage_options';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_page_title() {
+
+        return __( 'WorldLift Analytics Settings', 'wordlift' );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_menu_title() {
+
+        return __( 'Analytics Settings', 'wordlift' );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_menu_slug() {
+
+        return 'wl_configuration_admin_analytics_menu';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get_partial_name() {
+
+        return 'wordlift-admin-settings-analytics-page.php';
+    }
+
+    /**
+     * Returns the string to use for the tab slug on main admin settings page.
+     *
+     * @method get_admin_page_tab_slug
+     * @return string
+     * @since  3.21.0
+     */
+    public function get_admin_page_tab_slug() {
+        return 'analytics';
+    }
+
+    /**
+     * Adds pages to the tabs menu on the main admin settings page.
+     *
+     * @method add_admin_page_tab
+     * @param array $tabs an array of tab titles and slugs to use when building a tabbed menu on option pages.
+     *
+     * @since  3.21.0
+     */
+    public function add_admin_page_tab( $tabs ) {
+        if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
+            $tabs[] = array(
+                'title' => $this->get_menu_title(),
+                'slug'  => $this->get_admin_page_tab_slug(),
+            );
+        }
+
+        return $tabs;
+    }
+
+    /**
+     * Configure all the configuration parameters.
+     *
+     * Called by the *admin_init* hook.
+     *
+     * @since 3.21.0
+     */
+    public function admin_init() {
+
+        // Register WordLift's analytics settings with our in class sanitizer.
+        register_setting(
+            'wl_analytics_settings',
+            'wl_analytics_settings',
+            array( $this, 'sanitize_callback' )
+        );
+
+        // Add the analytics settings setction.
+        add_settings_section(
+            'wl_analytics_settings_section',
+            '',
+            '',
+            'wl_analytics_settings'
+        );
+
+        // Add a toggle to determine if analytics functions are enabled or not.
+        // NOTE: this uses yes/no rather than true/false.
+        add_settings_field(
+            'wl-analytics-enabled',
+            __( 'Enable Analytics', 'wordlift' ),
+            array( $this->radio_input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-enable',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
+                'value'       => Wordlift_Configuration_Service::get_instance()->is_analytics_enable() ? 'yes' : 'no',
+                'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
+            )
+        );
+
+        /**
+         * A basic number field that will accept anything from 1 to 20.
+         *
+         * Represents the custom dim number for the uri.
+         */
+        add_settings_field(
+            'wl-analytics-entity-uri-dimension',
+            __( 'Entity URI dimension', 'wordlift' ),
+            array( $this->input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-entity-uri-dimension',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
+                'type'        => 'number',
+                'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension(),
+                'description' => __( 'Entity URI dimesion', 'wordlift' ),
+            )
+        );
+
+        /**
+         * A basic number field that will accept anything from 1 to 20.
+         *
+         * Represents the custom dim number for the type.
+         */
+        add_settings_field(
+            'wl-analytics-entity-type-dimension',
+            __( 'Entity Type dimension', 'wordlift' ),
+            array( $this->input_element, 'render' ),
+            'wl_analytics_settings',
+            'wl_analytics_settings_section',
+            array(
+                'id'          => 'wl-analytics-entity-type-dimension',
+                'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
+                'type'        => 'number',
+                'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension(),
+                'description' => __( 'Entity Type dimension', 'wordlift' ),
+            )
+        );
+
+    }
+
+    /**
+     * Validates an entity uri based on an integer passed.
+     *
+     * TODO: Needs a feedback method to pass back error messages.
+     *
+     * @method validate_entity_uri
+     * @param string $uri a sting representing an entity ID that can be converted to a uri.
+     *
+     * @return int
+     * @since 3.21.0
+     */
+    public function validate_entity_uri( $uri ) {
+        // Basic validation is to ensure number is between 1 and 20.
+        // NOTE: certain analytics accounts have a much higher value - as many
+        // as 200 are allowed.
+        if ( (int) $uri < 1 || (int) $uri > 20 ) {
+            // if we are out of range then pass the default value.
+            $uri = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension();
+        }
+
+        return absint( $uri );
+    }
+
+    /**
+     * Validates an entity type.
+     *
+     * TODO: Needs a feedback method to pass back error messages.
+     *
+     * @method validate_entity_type
+     * @param string $type This is an entity type ID in string form - really a number.
+     *
+     * @return int
+     * @since  3.21.0
+     */
+    public function validate_entity_type( $type ) {
+        // Basic validation is to ensure number is between 1 and 20.
+        // NOTE: certain analytics accounts have a much higher value - as many
+        // as 200 are allowed.
+        if ( (int) $type < 1 || (int) $type > 20 ) {
+            // if we are out of range then pass the default value.
+            $type = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension();
+        }
+
+        return absint( $type );
+    }
+
+    /**
+     * Sanitize the configuration settings to be stored.
+     *
+     * If a new entity is being created for the publisher, create it and set The
+     * publisher setting.
+     *
+     * @param array $input The configuration settings array.
+     *
+     * @return array The sanitized input array.
+     * @since 3.21.0
+     */
+    public function sanitize_callback( $input ) {
+        if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
+            // Any failing nonce checks already die().
+            return;
+        }
+
+        /**
+         * Validate and sanitize the $inputs and store them in $output saved.
+         */
+        $output = array();
+        if ( isset( $input['analytics_enable'] ) ) {
+            $output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
+        }
+        if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
+            $output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
+        }
+        if ( isset( $input['analytics_entity_type_dimension'] ) ) {
+            // This dimension cannot be the same as the one set above. If it is
+            // then zero it out and it will fail validation.
+            if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
+                $input['analytics_entity_type_dimension'] = 0;
+            }
+            $output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
+        }
+
+        // return items added to the output for saving.
+        return $output;
+    }
 
 }

Spacing +34 added lines, -34 removed lines

@@ -53,14 +53,14 @@ 
 	 *
 	 * @since 3.21.0
 	 */
-	public function __construct( $input_element, $radio_input_element ) {
+	public function __construct($input_element, $radio_input_element) {
 
 		// Set a reference to the UI elements.
 		$this->input_element       = $input_element;
 		$this->radio_input_element = $radio_input_element;
 
 		// Adds this page to the main admin settings tabbed menu.
-		add_filter( 'wl_admin_page_tabs', array( $this, 'add_admin_page_tab' ) );
+		add_filter('wl_admin_page_tabs', array($this, 'add_admin_page_tab'));
 
 		self::$instance = $this;
 	}
@@ -97,7 +97,7 @@ 
 	 */
 	public function get_page_title() {
 
-		return __( 'WorldLift Analytics Settings', 'wordlift' );
+		return __('WorldLift Analytics Settings', 'wordlift');
 	}
 
 	/**
@@ -105,7 +105,7 @@ 
 	 */
 	public function get_menu_title() {
 
-		return __( 'Analytics Settings', 'wordlift' );
+		return __('Analytics Settings', 'wordlift');
 	}
 
 	/**
@@ -143,8 +143,8 @@ 
 	 *
 	 * @since  3.21.0
 	 */
-	public function add_admin_page_tab( $tabs ) {
-		if ( apply_filters( 'wl_feature__enable__analytics', true ) ) {
+	public function add_admin_page_tab($tabs) {
+		if (apply_filters('wl_feature__enable__analytics', true)) {
 			$tabs[] = array(
 				'title' => $this->get_menu_title(),
 				'slug'  => $this->get_admin_page_tab_slug(),
@@ -167,7 +167,7 @@ 
 		register_setting(
 			'wl_analytics_settings',
 			'wl_analytics_settings',
-			array( $this, 'sanitize_callback' )
+			array($this, 'sanitize_callback')
 		);
 
 		// Add the analytics settings setction.
@@ -182,15 +182,15 @@ 
 		// NOTE: this uses yes/no rather than true/false.
 		add_settings_field(
 			'wl-analytics-enabled',
-			__( 'Enable Analytics', 'wordlift' ),
-			array( $this->radio_input_element, 'render' ),
+			__('Enable Analytics', 'wordlift'),
+			array($this->radio_input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-enable',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENABLE . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENABLE.']',
 				'value'       => Wordlift_Configuration_Service::get_instance()->is_analytics_enable() ? 'yes' : 'no',
-				'description' => __( 'Toggle on/off the default values.', 'wordlift' ),
+				'description' => __('Toggle on/off the default values.', 'wordlift'),
 			)
 		);
 
@@ -201,16 +201,16 @@ 
 		 */
 		add_settings_field(
 			'wl-analytics-entity-uri-dimension',
-			__( 'Entity URI dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
+			__('Entity URI dimension', 'wordlift'),
+			array($this->input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-entity-uri-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENTITY_URI_DIMENSION.']',
 				'type'        => 'number',
 				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension(),
-				'description' => __( 'Entity URI dimesion', 'wordlift' ),
+				'description' => __('Entity URI dimesion', 'wordlift'),
 			)
 		);
 
@@ -221,16 +221,16 @@ 
 		 */
 		add_settings_field(
 			'wl-analytics-entity-type-dimension',
-			__( 'Entity Type dimension', 'wordlift' ),
-			array( $this->input_element, 'render' ),
+			__('Entity Type dimension', 'wordlift'),
+			array($this->input_element, 'render'),
 			'wl_analytics_settings',
 			'wl_analytics_settings_section',
 			array(
 				'id'          => 'wl-analytics-entity-type-dimension',
-				'name'        => 'wl_analytics_settings[' . Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION . ']',
+				'name'        => 'wl_analytics_settings['.Wordlift_Configuration_Service::ANALYTICS_ENTITY_TYPE_DIMENSION.']',
 				'type'        => 'number',
 				'value'       => Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension(),
-				'description' => __( 'Entity Type dimension', 'wordlift' ),
+				'description' => __('Entity Type dimension', 'wordlift'),
 			)
 		);
 
@@ -247,16 +247,16 @@ 
 	 * @return int
 	 * @since 3.21.0
 	 */
-	public function validate_entity_uri( $uri ) {
+	public function validate_entity_uri($uri) {
 		// Basic validation is to ensure number is between 1 and 20.
 		// NOTE: certain analytics accounts have a much higher value - as many
 		// as 200 are allowed.
-		if ( (int) $uri < 1 || (int) $uri > 20 ) {
+		if ((int) $uri < 1 || (int) $uri > 20) {
 			// if we are out of range then pass the default value.
 			$uri = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_uri_dimension();
 		}
 
-		return absint( $uri );
+		return absint($uri);
 	}
 
 	/**
@@ -270,16 +270,16 @@ 
 	 * @return int
 	 * @since  3.21.0
 	 */
-	public function validate_entity_type( $type ) {
+	public function validate_entity_type($type) {
 		// Basic validation is to ensure number is between 1 and 20.
 		// NOTE: certain analytics accounts have a much higher value - as many
 		// as 200 are allowed.
-		if ( (int) $type < 1 || (int) $type > 20 ) {
+		if ((int) $type < 1 || (int) $type > 20) {
 			// if we are out of range then pass the default value.
 			$type = Wordlift_Configuration_Service::get_instance()->get_analytics_entity_type_dimension();
 		}
 
-		return absint( $type );
+		return absint($type);
 	}
 
 	/**
@@ -293,8 +293,8 @@ 
 	 * @return array The sanitized input array.
 	 * @since 3.21.0
 	 */
-	public function sanitize_callback( $input ) {
-		if ( ! check_admin_referer( 'wl_analytics_settings-options' ) ) {
+	public function sanitize_callback($input) {
+		if ( ! check_admin_referer('wl_analytics_settings-options')) {
 			// Any failing nonce checks already die().
 			return;
 		}
@@ -303,19 +303,19 @@ 
 		 * Validate and sanitize the $inputs and store them in $output saved.
 		 */
 		$output = array();
-		if ( isset( $input['analytics_enable'] ) ) {
-			$output['analytics_enable'] = ( 'yes' === $input['analytics_enable'] ) ? 'yes' : 'no';
+		if (isset($input['analytics_enable'])) {
+			$output['analytics_enable'] = ('yes' === $input['analytics_enable']) ? 'yes' : 'no';
 		}
-		if ( isset( $input['analytics_entity_uri_dimension'] ) ) {
-			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri( $input['analytics_entity_uri_dimension'] );
+		if (isset($input['analytics_entity_uri_dimension'])) {
+			$output['analytics_entity_uri_dimension'] = (int) $this->validate_entity_uri($input['analytics_entity_uri_dimension']);
 		}
-		if ( isset( $input['analytics_entity_type_dimension'] ) ) {
+		if (isset($input['analytics_entity_type_dimension'])) {
 			// This dimension cannot be the same as the one set above. If it is
 			// then zero it out and it will fail validation.
-			if ( isset( $output['analytics_entity_uri_dimension'] ) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension'] ) {
+			if (isset($output['analytics_entity_uri_dimension']) && $output['analytics_entity_uri_dimension'] === (int) $input['analytics_entity_type_dimension']) {
 				$input['analytics_entity_type_dimension'] = 0;
 			}
-			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type( $input['analytics_entity_type_dimension'] );
+			$output['analytics_entity_type_dimension'] = (int) $this->validate_entity_type($input['analytics_entity_type_dimension']);
 		}
 
 		// return items added to the output for saving.

src/admin/wordlift-admin-meta-box-entities.php

Indentation +168 added lines, -168 removed lines

@@ -14,13 +14,13 @@ 
  */
 function wl_register_metaboxes() {
 
-	new Wl_Metabox();     // Everything is done inside here with the correct timing.
+    new Wl_Metabox();     // Everything is done inside here with the correct timing.
 
 }
 
 if ( is_admin() ) {
-	add_action( 'load-post.php', 'wl_register_metaboxes' );
-	add_action( 'load-post-new.php', 'wl_register_metaboxes' );
+    add_action( 'load-post.php', 'wl_register_metaboxes' );
+    add_action( 'load-post-new.php', 'wl_register_metaboxes' );
 }
 
 /**
@@ -31,41 +31,41 @@ 
  */
 function wl_admin_add_entities_meta_box( $post_type, $post ) {
 
-	/*
+    /*
 	 * Call the `wl_can_see_classification_box` filter to determine whether we can display the classification box.
 	 *
 	 * @since 3.20.3
 	 *
 	 * @see https://github.com/insideout10/wordlift-plugin/issues/914
 	 */
-	if ( ! apply_filters( 'wl_can_see_classification_box', true ) ) {
-		return;
-	}
-
-	// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-	if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
-		return;
-	}
-
-	// Bail out if the post type doesn't support a TinyMCE editor.
-	if ( ! wl_post_type_supports_editor( $post_type ) ) {
-		return;
-	}
-
-	// If the editor is not gutenberg and not any other custom editor then we use the sidebar.
-	if ( ! Wordlift_Admin::is_gutenberg() && ! No_Editor_Analysis_Feature::can_no_editor_analysis_be_used(
-		$post->ID
-	) ) {
-		// Add main meta box for related entities and 4W only if not Gutenberg
-		add_meta_box(
-			'wordlift_entities_box',
-			__( 'WordLift', 'wordlift' ),
-			'wl_entities_box_content',
-			$post_type,
-			'side',
-			'high'
-		);
-	}
+    if ( ! apply_filters( 'wl_can_see_classification_box', true ) ) {
+        return;
+    }
+
+    // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+    if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
+        return;
+    }
+
+    // Bail out if the post type doesn't support a TinyMCE editor.
+    if ( ! wl_post_type_supports_editor( $post_type ) ) {
+        return;
+    }
+
+    // If the editor is not gutenberg and not any other custom editor then we use the sidebar.
+    if ( ! Wordlift_Admin::is_gutenberg() && ! No_Editor_Analysis_Feature::can_no_editor_analysis_be_used(
+        $post->ID
+    ) ) {
+        // Add main meta box for related entities and 4W only if not Gutenberg
+        add_meta_box(
+            'wordlift_entities_box',
+            __( 'WordLift', 'wordlift' ),
+            'wl_entities_box_content',
+            $post_type,
+            'side',
+            'high'
+        );
+    }
 
 }
 
@@ -82,18 +82,18 @@ 
  */
 function wl_post_type_supports_editor( $post_type ) {
 
-	$default = post_type_supports( $post_type, 'editor' );
-
-	/**
-	 * Allow 3rd parties to force the classification to load.
-	 *
-	 * @param bool $default The preset value as gathered by the `post_type_supports` call.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/847.
-	 *
-	 * @since 3.19.4
-	 */
-	return apply_filters( 'wl_post_type_supports_editor', $default, $post_type );
+    $default = post_type_supports( $post_type, 'editor' );
+
+    /**
+     * Allow 3rd parties to force the classification to load.
+     *
+     * @param bool $default The preset value as gathered by the `post_type_supports` call.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/847.
+     *
+     * @since 3.19.4
+     */
+    return apply_filters( 'wl_post_type_supports_editor', $default, $post_type );
 }
 
 /**
@@ -103,141 +103,141 @@ 
  */
 function wl_entities_box_content( $post, $wrapper = true ) {
 
-	// Angularjs edit-post widget wrapper.
-	if ( $wrapper ) {
-		echo '<div id="wordlift-edit-post-outer-wrapper"></div>';
-	}
+    // Angularjs edit-post widget wrapper.
+    if ( $wrapper ) {
+        echo '<div id="wordlift-edit-post-outer-wrapper"></div>';
+    }
 }
 
 function wl_entities_box_content_scripts() {
-	$post = get_post();
+    $post = get_post();
 
-	// Angularjs edit-post widget classification boxes configuration.
-	// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
-	$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
+    // Angularjs edit-post widget classification boxes configuration.
+    // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
+    $classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
 
-	// Array to store all related entities ids.
-	$all_referenced_entities_ids = array();
+    // Array to store all related entities ids.
+    $all_referenced_entities_ids = array();
 
-	// Add selected entities to classification_boxes.
-	foreach ( $classification_boxes as $i => $box ) {
+    // Add selected entities to classification_boxes.
+    foreach ( $classification_boxes as $i => $box ) {
 
-		// Get the entity referenced from the post content.
-		/*
+        // Get the entity referenced from the post content.
+        /*
 		 * Allow 3rd parties to provide another post content.
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		$entity_uris  = Wordlift_Content_Filter_Service::get_instance()->get_entity_uris( $post_content );
-
-		// Enhance current box selected entities.
-		$classification_boxes[ $i ]['selectedEntities'] = $entity_uris;
-
-		// Maps the URIs to entity posts.
-		$entity_service = Wordlift_Entity_Service::get_instance();
-
-		// Replace all entity URI's with post ID's if found or null if there is no related post.
-		$entity_ids = array_map(
-			function ( $item ) use ( $entity_service ) {
-				// Return entity post by the entity URI or null.
-				$post = $entity_service->get_entity_post_by_uri( $item );
-
-				// Check that the post object is not null.
-				if ( ! empty( $post ) ) {
-					  return $post->ID;
-				}
-			},
-			$entity_uris
-		);
-		// Store the entity ids for all the 4W.
-		$all_referenced_entities_ids = array_merge( $all_referenced_entities_ids, $entity_ids );
-
-	}
-
-	// Json encoding for classification boxes structure.
-	$classification_boxes = wp_json_encode( $classification_boxes );
-
-	// Ensure there are no repetitions of the referenced entities.
-	$all_referenced_entities_ids = array_unique( $all_referenced_entities_ids );
-
-	// Remove all null, false and empty strings.
-	// NULL is being returned in some cases, when there is not related post, so we need to remove it.
-	$all_referenced_entities_ids = array_filter( $all_referenced_entities_ids );
-
-	// Build the entity storage object.
-	$referenced_entities_obj = array();
-	foreach ( $all_referenced_entities_ids as $referenced_entity ) {
-		$entity = wl_serialize_entity( $referenced_entity );
-		// Set a default confidence of `PHP_INT_MAX` for already annotated entities.
-		$referenced_entities_obj[ $entity['id'] ] = $entity
-													+ array( 'confidence' => PHP_INT_MAX );
-	}
-
-	$referenced_entities_obj = empty( $referenced_entities_obj ) ?
-		'{}' : wp_json_encode( $referenced_entities_obj );
-
-	$published_place_id  = get_post_meta(
-		$post->ID,
-		Wordlift_Schema_Service::FIELD_LOCATION_CREATED,
-		true
-	);
-	$published_place_obj = ( $published_place_id ) ?
-		wp_json_encode( wl_serialize_entity( $published_place_id ) ) :
-		null;
-
-	$topic_id  = get_post_meta(
-		$post->ID,
-		Wordlift_Schema_Service::FIELD_TOPIC,
-		true
-	);
-	$topic_obj = ( $topic_id ) ?
-		wp_json_encode( wl_serialize_entity( $topic_id ) ) :
-		null;
-
-	$configuration_service = Wordlift_Configuration_Service::get_instance();
-
-	$default_thumbnail_path = WL_DEFAULT_THUMBNAIL_PATH;
-	$default_path           = WL_DEFAULT_PATH;
-	$dataset_uri            = $configuration_service->get_dataset_uri();
-	$current_post_uri       = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
-	$is_entity              = Wordlift_Entity_Service::get_instance()->is_entity( $post->ID );
-
-	// Retrieve the current post author.
-	$post_author = get_userdata( $post->post_author )->display_name;
-	// Retrive the published date.
-	$published_date = get_the_time( 'Y-m-d', $post->ID );
-	// Current language.
-	$current_language            = $configuration_service->get_language_code();
-	$wordlift_timeline_shortcode = new Wordlift_Timeline_Shortcode();
-	$timelinejs_default_options  = wp_json_encode( $wordlift_timeline_shortcode->get_timelinejs_default_options(), JSON_PRETTY_PRINT );
-	$addslashes_post_author      = addslashes( $post_author );
-
-	$metabox_settings = array(
-		'classificationBoxes'      => json_decode( $classification_boxes ),
-		'entities'                 => json_decode( $referenced_entities_obj ),
-		'currentPostId'            => intval( $post->ID ),
-		'currentPostUri'           => $current_post_uri,
-		'currentPostType'          => $post->post_type,
-		'isEntity'                 => ! empty( $is_entity ),
-		'defaultThumbnailPath'     => $default_thumbnail_path,
-		'defaultWordLiftPath'      => $default_path,
-		'datasetUri'               => $dataset_uri,
-		'currentUser'              => $addslashes_post_author,
-		'publishedDate'            => $published_date,
-		'publishedPlace'           => $published_place_obj,
-		'topic'                    => json_decode( $topic_obj ),
-		'currentLanguage'          => $current_language,
-		'timelinejsDefaultOptions' => json_decode( $timelinejs_default_options ),
-		'ajax_url'                 => admin_url( 'admin-ajax.php' ),
-	);
-
-	// Allow Classic and Block Editor scripts to register first.
-	// Hook to the Block Editor script.
-	wp_localize_script( 'wl-block-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
-
-	// Hook to the Classic Editor script, see Wordlift_Admin_Post_Edit_Page.
-	wp_localize_script( 'wl-classic-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
+        $post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
+        $entity_uris  = Wordlift_Content_Filter_Service::get_instance()->get_entity_uris( $post_content );
+
+        // Enhance current box selected entities.
+        $classification_boxes[ $i ]['selectedEntities'] = $entity_uris;
+
+        // Maps the URIs to entity posts.
+        $entity_service = Wordlift_Entity_Service::get_instance();
+
+        // Replace all entity URI's with post ID's if found or null if there is no related post.
+        $entity_ids = array_map(
+            function ( $item ) use ( $entity_service ) {
+                // Return entity post by the entity URI or null.
+                $post = $entity_service->get_entity_post_by_uri( $item );
+
+                // Check that the post object is not null.
+                if ( ! empty( $post ) ) {
+                        return $post->ID;
+                }
+            },
+            $entity_uris
+        );
+        // Store the entity ids for all the 4W.
+        $all_referenced_entities_ids = array_merge( $all_referenced_entities_ids, $entity_ids );
+
+    }
+
+    // Json encoding for classification boxes structure.
+    $classification_boxes = wp_json_encode( $classification_boxes );
+
+    // Ensure there are no repetitions of the referenced entities.
+    $all_referenced_entities_ids = array_unique( $all_referenced_entities_ids );
+
+    // Remove all null, false and empty strings.
+    // NULL is being returned in some cases, when there is not related post, so we need to remove it.
+    $all_referenced_entities_ids = array_filter( $all_referenced_entities_ids );
+
+    // Build the entity storage object.
+    $referenced_entities_obj = array();
+    foreach ( $all_referenced_entities_ids as $referenced_entity ) {
+        $entity = wl_serialize_entity( $referenced_entity );
+        // Set a default confidence of `PHP_INT_MAX` for already annotated entities.
+        $referenced_entities_obj[ $entity['id'] ] = $entity
+                                                    + array( 'confidence' => PHP_INT_MAX );
+    }
+
+    $referenced_entities_obj = empty( $referenced_entities_obj ) ?
+        '{}' : wp_json_encode( $referenced_entities_obj );
+
+    $published_place_id  = get_post_meta(
+        $post->ID,
+        Wordlift_Schema_Service::FIELD_LOCATION_CREATED,
+        true
+    );
+    $published_place_obj = ( $published_place_id ) ?
+        wp_json_encode( wl_serialize_entity( $published_place_id ) ) :
+        null;
+
+    $topic_id  = get_post_meta(
+        $post->ID,
+        Wordlift_Schema_Service::FIELD_TOPIC,
+        true
+    );
+    $topic_obj = ( $topic_id ) ?
+        wp_json_encode( wl_serialize_entity( $topic_id ) ) :
+        null;
+
+    $configuration_service = Wordlift_Configuration_Service::get_instance();
+
+    $default_thumbnail_path = WL_DEFAULT_THUMBNAIL_PATH;
+    $default_path           = WL_DEFAULT_PATH;
+    $dataset_uri            = $configuration_service->get_dataset_uri();
+    $current_post_uri       = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
+    $is_entity              = Wordlift_Entity_Service::get_instance()->is_entity( $post->ID );
+
+    // Retrieve the current post author.
+    $post_author = get_userdata( $post->post_author )->display_name;
+    // Retrive the published date.
+    $published_date = get_the_time( 'Y-m-d', $post->ID );
+    // Current language.
+    $current_language            = $configuration_service->get_language_code();
+    $wordlift_timeline_shortcode = new Wordlift_Timeline_Shortcode();
+    $timelinejs_default_options  = wp_json_encode( $wordlift_timeline_shortcode->get_timelinejs_default_options(), JSON_PRETTY_PRINT );
+    $addslashes_post_author      = addslashes( $post_author );
+
+    $metabox_settings = array(
+        'classificationBoxes'      => json_decode( $classification_boxes ),
+        'entities'                 => json_decode( $referenced_entities_obj ),
+        'currentPostId'            => intval( $post->ID ),
+        'currentPostUri'           => $current_post_uri,
+        'currentPostType'          => $post->post_type,
+        'isEntity'                 => ! empty( $is_entity ),
+        'defaultThumbnailPath'     => $default_thumbnail_path,
+        'defaultWordLiftPath'      => $default_path,
+        'datasetUri'               => $dataset_uri,
+        'currentUser'              => $addslashes_post_author,
+        'publishedDate'            => $published_date,
+        'publishedPlace'           => $published_place_obj,
+        'topic'                    => json_decode( $topic_obj ),
+        'currentLanguage'          => $current_language,
+        'timelinejsDefaultOptions' => json_decode( $timelinejs_default_options ),
+        'ajax_url'                 => admin_url( 'admin-ajax.php' ),
+    );
+
+    // Allow Classic and Block Editor scripts to register first.
+    // Hook to the Block Editor script.
+    wp_localize_script( 'wl-block-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
+
+    // Hook to the Classic Editor script, see Wordlift_Admin_Post_Edit_Page.
+    wp_localize_script( 'wl-classic-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
 
 }
 

Spacing +57 added lines, -59 removed lines

@@ -14,13 +14,13 @@ 
  */
 function wl_register_metaboxes() {
 
-	new Wl_Metabox();     // Everything is done inside here with the correct timing.
+	new Wl_Metabox(); // Everything is done inside here with the correct timing.
 
 }
 
-if ( is_admin() ) {
-	add_action( 'load-post.php', 'wl_register_metaboxes' );
-	add_action( 'load-post-new.php', 'wl_register_metaboxes' );
+if (is_admin()) {
+	add_action('load-post.php', 'wl_register_metaboxes');
+	add_action('load-post-new.php', 'wl_register_metaboxes');
 }
 
 /**
@@ -29,7 +29,7 @@ 
  * @param string  $post_type The type of the current open post.
  * @param WP_Post $post WordPress post.
  */
-function wl_admin_add_entities_meta_box( $post_type, $post ) {
+function wl_admin_add_entities_meta_box($post_type, $post) {
 
 	/*
 	 * Call the `wl_can_see_classification_box` filter to determine whether we can display the classification box.
@@ -38,28 +38,28 @@ 
 	 *
 	 * @see https://github.com/insideout10/wordlift-plugin/issues/914
 	 */
-	if ( ! apply_filters( 'wl_can_see_classification_box', true ) ) {
+	if ( ! apply_filters('wl_can_see_classification_box', true)) {
 		return;
 	}
 
 	// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-	if ( ! apply_filters( 'wl_feature__enable__classification-sidebar', true ) ) {
+	if ( ! apply_filters('wl_feature__enable__classification-sidebar', true)) {
 		return;
 	}
 
 	// Bail out if the post type doesn't support a TinyMCE editor.
-	if ( ! wl_post_type_supports_editor( $post_type ) ) {
+	if ( ! wl_post_type_supports_editor($post_type)) {
 		return;
 	}
 
 	// If the editor is not gutenberg and not any other custom editor then we use the sidebar.
 	if ( ! Wordlift_Admin::is_gutenberg() && ! No_Editor_Analysis_Feature::can_no_editor_analysis_be_used(
 		$post->ID
-	) ) {
+	)) {
 		// Add main meta box for related entities and 4W only if not Gutenberg
 		add_meta_box(
 			'wordlift_entities_box',
-			__( 'WordLift', 'wordlift' ),
+			__('WordLift', 'wordlift'),
 			'wl_entities_box_content',
 			$post_type,
 			'side',
@@ -69,7 +69,7 @@ 
 
 }
 
-add_action( 'add_meta_boxes', 'wl_admin_add_entities_meta_box', 10, 2 );
+add_action('add_meta_boxes', 'wl_admin_add_entities_meta_box', 10, 2);
 
 /**
  * Whether the post type supports the editor UI.
@@ -80,9 +80,9 @@ 
  *
  * @return bool True if the editor UI is supported otherwise false.
  */
-function wl_post_type_supports_editor( $post_type ) {
+function wl_post_type_supports_editor($post_type) {
 
-	$default = post_type_supports( $post_type, 'editor' );
+	$default = post_type_supports($post_type, 'editor');
 
 	/**
 	 * Allow 3rd parties to force the classification to load.
@@ -93,7 +93,7 @@ 
 	 *
 	 * @since 3.19.4
 	 */
-	return apply_filters( 'wl_post_type_supports_editor', $default, $post_type );
+	return apply_filters('wl_post_type_supports_editor', $default, $post_type);
 }
 
 /**
@@ -101,10 +101,10 @@ 
  *
  * @param WP_Post $post The current post.
  */
-function wl_entities_box_content( $post, $wrapper = true ) {
+function wl_entities_box_content($post, $wrapper = true) {
 
 	// Angularjs edit-post widget wrapper.
-	if ( $wrapper ) {
+	if ($wrapper) {
 		echo '<div id="wordlift-edit-post-outer-wrapper"></div>';
 	}
 }
@@ -114,13 +114,13 @@ 
 
 	// Angularjs edit-post widget classification boxes configuration.
 	// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
-	$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
+	$classification_boxes = unserialize(WL_CORE_POST_CLASSIFICATION_BOXES);
 
 	// Array to store all related entities ids.
 	$all_referenced_entities_ids = array();
 
 	// Add selected entities to classification_boxes.
-	foreach ( $classification_boxes as $i => $box ) {
+	foreach ($classification_boxes as $i => $box) {
 
 		// Get the entity referenced from the post content.
 		/*
@@ -128,118 +128,116 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		$entity_uris  = Wordlift_Content_Filter_Service::get_instance()->get_entity_uris( $post_content );
+		$post_content = apply_filters('wl_post_content', $post->post_content, $post);
+		$entity_uris  = Wordlift_Content_Filter_Service::get_instance()->get_entity_uris($post_content);
 
 		// Enhance current box selected entities.
-		$classification_boxes[ $i ]['selectedEntities'] = $entity_uris;
+		$classification_boxes[$i]['selectedEntities'] = $entity_uris;
 
 		// Maps the URIs to entity posts.
 		$entity_service = Wordlift_Entity_Service::get_instance();
 
 		// Replace all entity URI's with post ID's if found or null if there is no related post.
 		$entity_ids = array_map(
-			function ( $item ) use ( $entity_service ) {
+			function($item) use ($entity_service) {
 				// Return entity post by the entity URI or null.
-				$post = $entity_service->get_entity_post_by_uri( $item );
+				$post = $entity_service->get_entity_post_by_uri($item);
 
 				// Check that the post object is not null.
-				if ( ! empty( $post ) ) {
+				if ( ! empty($post)) {
 					  return $post->ID;
 				}
 			},
 			$entity_uris
 		);
 		// Store the entity ids for all the 4W.
-		$all_referenced_entities_ids = array_merge( $all_referenced_entities_ids, $entity_ids );
+		$all_referenced_entities_ids = array_merge($all_referenced_entities_ids, $entity_ids);
 
 	}
 
 	// Json encoding for classification boxes structure.
-	$classification_boxes = wp_json_encode( $classification_boxes );
+	$classification_boxes = wp_json_encode($classification_boxes);
 
 	// Ensure there are no repetitions of the referenced entities.
-	$all_referenced_entities_ids = array_unique( $all_referenced_entities_ids );
+	$all_referenced_entities_ids = array_unique($all_referenced_entities_ids);
 
 	// Remove all null, false and empty strings.
 	// NULL is being returned in some cases, when there is not related post, so we need to remove it.
-	$all_referenced_entities_ids = array_filter( $all_referenced_entities_ids );
+	$all_referenced_entities_ids = array_filter($all_referenced_entities_ids);
 
 	// Build the entity storage object.
 	$referenced_entities_obj = array();
-	foreach ( $all_referenced_entities_ids as $referenced_entity ) {
-		$entity = wl_serialize_entity( $referenced_entity );
+	foreach ($all_referenced_entities_ids as $referenced_entity) {
+		$entity = wl_serialize_entity($referenced_entity);
 		// Set a default confidence of `PHP_INT_MAX` for already annotated entities.
-		$referenced_entities_obj[ $entity['id'] ] = $entity
-													+ array( 'confidence' => PHP_INT_MAX );
+		$referenced_entities_obj[$entity['id']] = $entity
+													+ array('confidence' => PHP_INT_MAX);
 	}
 
-	$referenced_entities_obj = empty( $referenced_entities_obj ) ?
-		'{}' : wp_json_encode( $referenced_entities_obj );
+	$referenced_entities_obj = empty($referenced_entities_obj) ?
+		'{}' : wp_json_encode($referenced_entities_obj);
 
-	$published_place_id  = get_post_meta(
+	$published_place_id = get_post_meta(
 		$post->ID,
 		Wordlift_Schema_Service::FIELD_LOCATION_CREATED,
 		true
 	);
-	$published_place_obj = ( $published_place_id ) ?
-		wp_json_encode( wl_serialize_entity( $published_place_id ) ) :
-		null;
+	$published_place_obj = ($published_place_id) ?
+		wp_json_encode(wl_serialize_entity($published_place_id)) : null;
 
-	$topic_id  = get_post_meta(
+	$topic_id = get_post_meta(
 		$post->ID,
 		Wordlift_Schema_Service::FIELD_TOPIC,
 		true
 	);
-	$topic_obj = ( $topic_id ) ?
-		wp_json_encode( wl_serialize_entity( $topic_id ) ) :
-		null;
+	$topic_obj = ($topic_id) ?
+		wp_json_encode(wl_serialize_entity($topic_id)) : null;
 
 	$configuration_service = Wordlift_Configuration_Service::get_instance();
 
 	$default_thumbnail_path = WL_DEFAULT_THUMBNAIL_PATH;
 	$default_path           = WL_DEFAULT_PATH;
 	$dataset_uri            = $configuration_service->get_dataset_uri();
-	$current_post_uri       = Wordlift_Entity_Service::get_instance()->get_uri( $post->ID );
-	$is_entity              = Wordlift_Entity_Service::get_instance()->is_entity( $post->ID );
+	$current_post_uri       = Wordlift_Entity_Service::get_instance()->get_uri($post->ID);
+	$is_entity              = Wordlift_Entity_Service::get_instance()->is_entity($post->ID);
 
 	// Retrieve the current post author.
-	$post_author = get_userdata( $post->post_author )->display_name;
+	$post_author = get_userdata($post->post_author)->display_name;
 	// Retrive the published date.
-	$published_date = get_the_time( 'Y-m-d', $post->ID );
+	$published_date = get_the_time('Y-m-d', $post->ID);
 	// Current language.
 	$current_language            = $configuration_service->get_language_code();
 	$wordlift_timeline_shortcode = new Wordlift_Timeline_Shortcode();
-	$timelinejs_default_options  = wp_json_encode( $wordlift_timeline_shortcode->get_timelinejs_default_options(), JSON_PRETTY_PRINT );
-	$addslashes_post_author      = addslashes( $post_author );
+	$timelinejs_default_options  = wp_json_encode($wordlift_timeline_shortcode->get_timelinejs_default_options(), JSON_PRETTY_PRINT);
+	$addslashes_post_author      = addslashes($post_author);
 
 	$metabox_settings = array(
-		'classificationBoxes'      => json_decode( $classification_boxes ),
-		'entities'                 => json_decode( $referenced_entities_obj ),
-		'currentPostId'            => intval( $post->ID ),
+		'classificationBoxes'      => json_decode($classification_boxes),
+		'entities'                 => json_decode($referenced_entities_obj),
+		'currentPostId'            => intval($post->ID),
 		'currentPostUri'           => $current_post_uri,
 		'currentPostType'          => $post->post_type,
-		'isEntity'                 => ! empty( $is_entity ),
+		'isEntity'                 => ! empty($is_entity),
 		'defaultThumbnailPath'     => $default_thumbnail_path,
 		'defaultWordLiftPath'      => $default_path,
 		'datasetUri'               => $dataset_uri,
 		'currentUser'              => $addslashes_post_author,
 		'publishedDate'            => $published_date,
 		'publishedPlace'           => $published_place_obj,
-		'topic'                    => json_decode( $topic_obj ),
+		'topic'                    => json_decode($topic_obj),
 		'currentLanguage'          => $current_language,
-		'timelinejsDefaultOptions' => json_decode( $timelinejs_default_options ),
-		'ajax_url'                 => admin_url( 'admin-ajax.php' ),
+		'timelinejsDefaultOptions' => json_decode($timelinejs_default_options),
+		'ajax_url'                 => admin_url('admin-ajax.php'),
 	);
 
 	// Allow Classic and Block Editor scripts to register first.
 	// Hook to the Block Editor script.
-	wp_localize_script( 'wl-block-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
+	wp_localize_script('wl-block-editor', '_wlMetaBoxSettings', array('settings' => $metabox_settings));
 
 	// Hook to the Classic Editor script, see Wordlift_Admin_Post_Edit_Page.
-	wp_localize_script( 'wl-classic-editor', '_wlMetaBoxSettings', array( 'settings' => $metabox_settings ) );
+	wp_localize_script('wl-classic-editor', '_wlMetaBoxSettings', array('settings' => $metabox_settings));
 
 }
 
-add_action( 'admin_print_scripts-post.php', 'wl_entities_box_content_scripts', 11 );
-add_action( 'admin_print_scripts-post-new.php', 'wl_entities_box_content_scripts', 11 );
+add_action('admin_print_scripts-post.php', 'wl_entities_box_content_scripts', 11);
+add_action('admin_print_scripts-post-new.php', 'wl_entities_box_content_scripts', 11);

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

Indentation +238 added lines, -238 removed lines

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

Spacing +41 added lines, -41 removed lines

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

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 wp_kses(
-				$notice,
-				array(
-					'div' => array( 'class' => array() ),
-					'p'   => array(),
-				)
-			);
-		}
-
-	}
-
-	/**
-	 * 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( '<br />', $message );
-			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 wp_kses(
+                $notice,
+                array(
+                    'div' => array( 'class' => array() ),
+                    'p'   => array(),
+                )
+            );
+        }
+
+    }
+
+    /**
+     * 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( '<br />', $message );
+            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;
 
@@ -102,9 +102,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));
 
 	}
 
@@ -115,9 +115,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);
 
 	}
 
@@ -128,9 +128,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);
 
 	}
 
@@ -141,9 +141,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);
 
 	}
 
@@ -154,9 +154,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);
 
 	}
 
@@ -167,11 +167,11 @@ 
 	 */
 	public function admin_notices() {
 
-		foreach ( $this->notices as $notice ) {
+		foreach ($this->notices as $notice) {
 			echo wp_kses(
 				$notice,
 				array(
-					'div' => array( 'class' => array() ),
+					'div' => array('class' => array()),
 					'p'   => array(),
 				)
 			);
@@ -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( '<br />', $message );
+				return implode('<br />', $message);
 			default:
 				return $message;
 		}

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

Indentation +128 added lines, -128 removed lines

@@ -18,133 +18,133 @@
  */
 abstract class Wordlift_Admin_Page {
 
-	/**
-	 * Define the {@link Wordlift_Admin_Page} constructor.
-	 *
-	 * @since 3.20.0
-	 */
-	public function __construct() {
-		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 public function get_page_title();
-
-	/**
-	 * Get the menu title. Will be translated.
-	 *
-	 * @return string The menu title.
-	 * @since 3.11.0
-	 */
-	abstract public function get_menu_title();
-
-	/**
-	 * Get the menu slug.
-	 *
-	 * @return string The menu slug.
-	 * @since 3.11.0
-	 */
-	abstract public function get_menu_slug();
-
-	/**
-	 * Get the page url.
-	 *
-	 * @return string The escaped url of the admin page
-	 * @since 3.14.0
-	 */
-	public 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 public 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() {
+        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 public function get_page_title();
+
+    /**
+     * Get the menu title. Will be translated.
+     *
+     * @return string The menu title.
+     * @since 3.11.0
+     */
+    abstract public function get_menu_title();
+
+    /**
+     * Get the menu slug.
+     *
+     * @return string The menu slug.
+     * @since 3.11.0
+     */
+    abstract public function get_menu_slug();
+
+    /**
+     * Get the page url.
+     *
+     * @return string The escaped url of the admin page
+     * @since 3.14.0
+     */
+    public 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 public 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 +7 added lines, -7 removed lines

@@ -24,7 +24,7 @@ 
 	 * @since 3.20.0
 	 */
 	public function __construct() {
-		add_action( 'admin_menu', array( $this, 'admin_menu' ), 10, 0 );
+		add_action('admin_menu', array($this, 'admin_menu'), 10, 0);
 	}
 
 	/**
@@ -82,9 +82,9 @@ 
 	public 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);
 	}
 
 	/**
@@ -110,14 +110,14 @@ 
 			$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,
+			'admin_print_scripts-'.$page,
 			array(
 				$this,
 				'enqueue_scripts',
@@ -143,7 +143,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();
 
 	}