insideout10 / wordlift-plugin

src/public/class-wordlift-shortcode.php

Indentation +50 added lines, -50 removed lines

@@ -8,55 +8,55 @@
  */
 abstract class Wordlift_Shortcode {
 
-	/**
-	 * The shortcode, set by extending classes.
-	 */
-	const SHORTCODE = null;
-
-	/**
-	 * Create a shortcode instance by registering the shortcode with the render
-	 * function.
-	 *
-	 * @since 3.5.4
-	 */
-	public function __construct() {
-
-		add_shortcode( static::SHORTCODE, array( $this, 'render' ) );
-
-	}
-
-	/**
-	 * Render the shortcode.
-	 *
-	 * @param array $atts An array of shortcode attributes as set by the editor.
-	 *
-	 * @return string The output html code.
-	 * @since 3.5.4
-	 */
-	abstract public function render( $atts );
-
-	/**
-	 * Enqueue scripts. Called by the shortcode implementations in their render
-	 * method.
-	 *
-	 * @since 3.5.4
-	 */
-	protected function enqueue_scripts() {
-
-		wp_enqueue_script( 'angularjs', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular.min.js', array(), '1.3.11', false );
-		wp_enqueue_script( 'angularjs-touch', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular-touch.min.js', array( 'angularjs' ), '1.3.11', false );
-		wp_enqueue_script(
-			'wordlift-ui',
-			dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-ui' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js',
-			array(
-				'jquery',
-				'angularjs',
-				'angularjs-touch',
-			),
-			WORDLIFT_VERSION,
-			false
-		);
-
-	}
+    /**
+     * The shortcode, set by extending classes.
+     */
+    const SHORTCODE = null;
+
+    /**
+     * Create a shortcode instance by registering the shortcode with the render
+     * function.
+     *
+     * @since 3.5.4
+     */
+    public function __construct() {
+
+        add_shortcode( static::SHORTCODE, array( $this, 'render' ) );
+
+    }
+
+    /**
+     * Render the shortcode.
+     *
+     * @param array $atts An array of shortcode attributes as set by the editor.
+     *
+     * @return string The output html code.
+     * @since 3.5.4
+     */
+    abstract public function render( $atts );
+
+    /**
+     * Enqueue scripts. Called by the shortcode implementations in their render
+     * method.
+     *
+     * @since 3.5.4
+     */
+    protected function enqueue_scripts() {
+
+        wp_enqueue_script( 'angularjs', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular.min.js', array(), '1.3.11', false );
+        wp_enqueue_script( 'angularjs-touch', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular-touch.min.js', array( 'angularjs' ), '1.3.11', false );
+        wp_enqueue_script(
+            'wordlift-ui',
+            dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-ui' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js',
+            array(
+                'jquery',
+                'angularjs',
+                'angularjs-touch',
+            ),
+            WORDLIFT_VERSION,
+            false
+        );
+
+    }
 
 }

Spacing +5 added lines, -5 removed lines

@@ -21,7 +21,7 @@ 
 	 */
 	public function __construct() {
 
-		add_shortcode( static::SHORTCODE, array( $this, 'render' ) );
+		add_shortcode(static::SHORTCODE, array($this, 'render'));
 
 	}
 
@@ -33,7 +33,7 @@ 
 	 * @return string The output html code.
 	 * @since 3.5.4
 	 */
-	abstract public function render( $atts );
+	abstract public function render($atts);
 
 	/**
 	 * Enqueue scripts. Called by the shortcode implementations in their render
@@ -43,11 +43,11 @@ 
 	 */
 	protected function enqueue_scripts() {
 
-		wp_enqueue_script( 'angularjs', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular.min.js', array(), '1.3.11', false );
-		wp_enqueue_script( 'angularjs-touch', plugin_dir_url( __DIR__ ) . '/js/3rdparty/angular-touch.min.js', array( 'angularjs' ), '1.3.11', false );
+		wp_enqueue_script('angularjs', plugin_dir_url(__DIR__).'/js/3rdparty/angular.min.js', array(), '1.3.11', false);
+		wp_enqueue_script('angularjs-touch', plugin_dir_url(__DIR__).'/js/3rdparty/angular-touch.min.js', array('angularjs'), '1.3.11', false);
 		wp_enqueue_script(
 			'wordlift-ui',
-			dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-ui' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js',
+			dirname(plugin_dir_url(__FILE__)).'/js/wordlift-ui'.( ! defined('SCRIPT_DEBUG') || ! SCRIPT_DEBUG ? '.min' : '').'.js',
 			array(
 				'jquery',
 				'angularjs',

src/shortcodes/wordlift-shortcode-faceted-search.php

Indentation +219 added lines, -219 removed lines

@@ -20,45 +20,45 @@ 
  */
 function wl_shortcode_faceted_search( $request ) {
 
-	// Filter the allowed parameters for caching.
-	$cache_params = array_intersect_key(
-		$_GET, // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		array(
-			'post_id'    => 1,
-			'post_types' => 1,
-			'limit'      => 1,
-			'amp'        => 1,
-			'sort'       => 1,
-		)
-	);
+    // Filter the allowed parameters for caching.
+    $cache_params = array_intersect_key(
+        $_GET, // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        array(
+            'post_id'    => 1,
+            'post_types' => 1,
+            'limit'      => 1,
+            'amp'        => 1,
+            'sort'       => 1,
+        )
+    );
 
-	// Create the cache key.
-	$cache_key = array(
-		'request_params' => $cache_params,
-	);
+    // Create the cache key.
+    $cache_key = array(
+        'request_params' => $cache_params,
+    );
 
-	// Create the TTL cache and try to get the results.
-	$cache         = new Ttl_Cache( 'faceted-search', 8 * 60 * 60 ); // 8 hours.
-	$cache_results = $cache->get( $cache_key );
+    // Create the TTL cache and try to get the results.
+    $cache         = new Ttl_Cache( 'faceted-search', 8 * 60 * 60 ); // 8 hours.
+    $cache_results = $cache->get( $cache_key );
 
-	// So that the endpoint can be used remotely
-	header( 'Access-Control-Allow-Origin: *' );
+    // So that the endpoint can be used remotely
+    header( 'Access-Control-Allow-Origin: *' );
 
-	if ( isset( $cache_results ) ) {
-		header( 'X-WordLift-Cache: HIT' );
-		wl_core_send_json( $cache_results );
+    if ( isset( $cache_results ) ) {
+        header( 'X-WordLift-Cache: HIT' );
+        wl_core_send_json( $cache_results );
 
-		return;
-	}
+        return;
+    }
 
-	header( 'X-WordLift-Cache: MISS' );
+    header( 'X-WordLift-Cache: MISS' );
 
-	$results = wl_shortcode_faceted_search_origin( $request->get_query_params() );
+    $results = wl_shortcode_faceted_search_origin( $request->get_query_params() );
 
-	// Put the result before sending the json to the client, since sending the json will terminate us.
-	$cache->put( $cache_key, $results );
+    // Put the result before sending the json to the client, since sending the json will terminate us.
+    $cache->put( $cache_key, $results );
 
-	wl_core_send_json( $results );
+    wl_core_send_json( $results );
 
 }
 
@@ -70,141 +70,141 @@ 
  */
 // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 function wl_shortcode_faceted_search_origin( $request ) {
-	// Post ID must be defined.
-	if ( ! isset( $request['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
-		wp_die( 'No post_id given' );
-
-		return;
-	}
-
-	$current_post_id = (int) $request['post_id']; // WPCS: input var ok; CSRF ok.
-	$current_post    = get_post( $current_post_id );
-	$faceted_id      = isset( $request['uniqid'] ) ? sanitize_text_field( wp_unslash( (string) $request['uniqid'] ) ) : '';
-
-	$post_types          = isset( $request['post_types'] ) ? sanitize_text_field( wp_unslash( (string) $request['post_types'] ) ) : '';
-	$post_types          = explode( ',', $post_types );
-	$existing_post_types = get_post_types();
-	$post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
-
-	// Post ID has to match an existing item.
-	if ( null === $current_post ) {
-		wp_die( 'No valid post_id given' );
-
-		return;
-	}
-
-	// If the current post is an entity,
-	// the current post is used as main entity.
-	// Otherwise, current post related entities are used.
-	$entity_service = Wordlift_Entity_Service::get_instance();
-
-	$entity_ids = $entity_service->is_entity( $current_post->ID ) ?
-		array( $current_post->ID ) :
-		$entity_service->get_related_entities( $current_post->ID );
-
-	// If there are no entities we cannot render the widget.
-	if ( 0 === count( $entity_ids ) ) {
-		/**
-		 * If this function is not called from ajax
-		 * then this should not throw an error.
-		 * Note: Used in scripbox longtail project on json endpoint.
-		 */
-		if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
-			wp_die( 'No entities available' );
-		}
-	}
-
-	// phpcs:ignore Standard.Category.SniffName.ErrorCode
-	$limit = ( isset( $request['limit'] ) ) ? (int) $request['limit'] : 4;
-	$amp   = isset( $request['amp'] );
-
-	/**
-	 * see https://github.com/insideout10/wordlift-plugin/issues/1181
-	 * The ordering should be descending by date on default.
-	 */
-	$order_by = 'DESC';
-	if ( isset( $request['sort'] ) && is_string( $request['sort'] ) ) {
-		$order_by = sanitize_sql_orderby( wp_unslash( (string) $request['sort'] ) );
-	}
-
-	$referencing_posts = Wordlift_Relation_Service::get_instance()->get_article_subjects(
-		$entity_ids,
-		'*',
-		null,
-		'publish',
-		array( $current_post_id ),
-		$limit,
-		null,
-		$order_by,
-		$post_types
-	);
-
-	$referencing_post_ids = array_map(
-		function ( $p ) {
-			return $p->ID;
-		},
-		$referencing_posts
-	);
-
-	$post_results   = array();
-	$entity_results = array();
-
-	// Populate $post_results
-
-	if ( $referencing_posts ) {
-		foreach ( $referencing_posts as $post_obj ) {
-
-			/**
-			 * Use the thumbnail.
-			 *
-			 * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
-			 * @see https://github.com/insideout10/wordlift-plugin/issues/837
-			 *
-			 * @since 3.19.3 We're using the medium size image.
-			 */
-			$thumbnail            = get_the_post_thumbnail_url( $post_obj, 'medium' );
-			$post_obj->thumbnail  = ( $thumbnail ) ?
-				$thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-			$post_obj->permalink  = get_permalink( $post_obj->ID );
-			$post_obj->srcset     = Srcset_Util::get_srcset( $post_obj->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
-			$post_obj->post_title = wp_strip_all_tags( html_entity_decode( $post_obj->post_title, ENT_QUOTES, 'UTF-8' ) );
-			$result               = $post_obj;
-			$post_results[]       = $result;
-		}
-	}
-
-	// Add filler posts if needed
-
-	$filler_count = $limit - count( $post_results );
-	if ( 0 < apply_filters( 'wl_faceted_search__filler_count', $filler_count, $current_post_id, $referencing_post_ids ) ) {
-		$filler_posts_util       = new Filler_Posts_Util( $current_post_id );
-		$post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
-		$filler_posts            = $filler_posts_util->get_filler_posts( $filler_count, $post_ids_to_be_excluded );
-
-		$post_results = array_merge( $post_results, $filler_posts );
-	}
-	$referencing_post_ids = array_map(
-		function ( $post ) {
-			return $post->ID;
-		},
-		$post_results
-	);
-
-	// Populate $entity_results
-
-	global $wpdb;
-
-	// Retrieve Wordlift relation instances table name.
-	$table_name = wl_core_get_relation_instances_table_name();
-
-	/*
+    // Post ID must be defined.
+    if ( ! isset( $request['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
+        wp_die( 'No post_id given' );
+
+        return;
+    }
+
+    $current_post_id = (int) $request['post_id']; // WPCS: input var ok; CSRF ok.
+    $current_post    = get_post( $current_post_id );
+    $faceted_id      = isset( $request['uniqid'] ) ? sanitize_text_field( wp_unslash( (string) $request['uniqid'] ) ) : '';
+
+    $post_types          = isset( $request['post_types'] ) ? sanitize_text_field( wp_unslash( (string) $request['post_types'] ) ) : '';
+    $post_types          = explode( ',', $post_types );
+    $existing_post_types = get_post_types();
+    $post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
+
+    // Post ID has to match an existing item.
+    if ( null === $current_post ) {
+        wp_die( 'No valid post_id given' );
+
+        return;
+    }
+
+    // If the current post is an entity,
+    // the current post is used as main entity.
+    // Otherwise, current post related entities are used.
+    $entity_service = Wordlift_Entity_Service::get_instance();
+
+    $entity_ids = $entity_service->is_entity( $current_post->ID ) ?
+        array( $current_post->ID ) :
+        $entity_service->get_related_entities( $current_post->ID );
+
+    // If there are no entities we cannot render the widget.
+    if ( 0 === count( $entity_ids ) ) {
+        /**
+         * If this function is not called from ajax
+         * then this should not throw an error.
+         * Note: Used in scripbox longtail project on json endpoint.
+         */
+        if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
+            wp_die( 'No entities available' );
+        }
+    }
+
+    // phpcs:ignore Standard.Category.SniffName.ErrorCode
+    $limit = ( isset( $request['limit'] ) ) ? (int) $request['limit'] : 4;
+    $amp   = isset( $request['amp'] );
+
+    /**
+     * see https://github.com/insideout10/wordlift-plugin/issues/1181
+     * The ordering should be descending by date on default.
+     */
+    $order_by = 'DESC';
+    if ( isset( $request['sort'] ) && is_string( $request['sort'] ) ) {
+        $order_by = sanitize_sql_orderby( wp_unslash( (string) $request['sort'] ) );
+    }
+
+    $referencing_posts = Wordlift_Relation_Service::get_instance()->get_article_subjects(
+        $entity_ids,
+        '*',
+        null,
+        'publish',
+        array( $current_post_id ),
+        $limit,
+        null,
+        $order_by,
+        $post_types
+    );
+
+    $referencing_post_ids = array_map(
+        function ( $p ) {
+            return $p->ID;
+        },
+        $referencing_posts
+    );
+
+    $post_results   = array();
+    $entity_results = array();
+
+    // Populate $post_results
+
+    if ( $referencing_posts ) {
+        foreach ( $referencing_posts as $post_obj ) {
+
+            /**
+             * Use the thumbnail.
+             *
+             * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
+             * @see https://github.com/insideout10/wordlift-plugin/issues/837
+             *
+             * @since 3.19.3 We're using the medium size image.
+             */
+            $thumbnail            = get_the_post_thumbnail_url( $post_obj, 'medium' );
+            $post_obj->thumbnail  = ( $thumbnail ) ?
+                $thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
+            $post_obj->permalink  = get_permalink( $post_obj->ID );
+            $post_obj->srcset     = Srcset_Util::get_srcset( $post_obj->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
+            $post_obj->post_title = wp_strip_all_tags( html_entity_decode( $post_obj->post_title, ENT_QUOTES, 'UTF-8' ) );
+            $result               = $post_obj;
+            $post_results[]       = $result;
+        }
+    }
+
+    // Add filler posts if needed
+
+    $filler_count = $limit - count( $post_results );
+    if ( 0 < apply_filters( 'wl_faceted_search__filler_count', $filler_count, $current_post_id, $referencing_post_ids ) ) {
+        $filler_posts_util       = new Filler_Posts_Util( $current_post_id );
+        $post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
+        $filler_posts            = $filler_posts_util->get_filler_posts( $filler_count, $post_ids_to_be_excluded );
+
+        $post_results = array_merge( $post_results, $filler_posts );
+    }
+    $referencing_post_ids = array_map(
+        function ( $post ) {
+            return $post->ID;
+        },
+        $post_results
+    );
+
+    // Populate $entity_results
+
+    global $wpdb;
+
+    // Retrieve Wordlift relation instances table name.
+    $table_name = wl_core_get_relation_instances_table_name();
+
+    /*
 	 * Make sure we have some referenced post, otherwise the IN parts of
 	 * the SQL will produce an SQL error.
 	 */
-	if ( ! empty( $referencing_post_ids ) ) {
-		$subject_ids = implode( ',', $referencing_post_ids );
+    if ( ! empty( $referencing_post_ids ) ) {
+        $subject_ids = implode( ',', $referencing_post_ids );
 
-		$query = "
+        $query = "
 				SELECT
 					object_id AS ID,
 					count( object_id ) AS counter
@@ -216,71 +216,71 @@ 
 				LIMIT $limit;
 			";
 
-		wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
+        wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
 
-		$entities = $wpdb->get_results( $query, OBJECT ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+        $entities = $wpdb->get_results( $query, OBJECT ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 
-		wl_write_log( 'Entities found ' . count( $entities ) );
+        wl_write_log( 'Entities found ' . count( $entities ) );
 
-		foreach ( $entities as $obj ) {
+        foreach ( $entities as $obj ) {
 
-			$entity = get_post( $obj->ID );
+            $entity = get_post( $obj->ID );
 
-			// Ensure only valid and published entities are returned.
-			if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
+            // Ensure only valid and published entities are returned.
+            if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
 
-				$serialized_entity                    = wl_serialize_entity( $entity );
-				$serialized_entity['label']           = html_entity_decode( wl_shortcode_faceted_search_get_the_title( $obj->ID ), ENT_QUOTES, 'UTF-8' );
-				$serialized_entity['counter']         = $obj->counter;
-				$serialized_entity['createdAt']       = $entity->post_date;
-				$serialized_entity['referencedPosts'] = Wordlift_Relation_Service::get_instance()->get_article_subjects(
-					$obj->ID,
-					'ids',
-					null,
-					null,
-					array(),
-					null,
-					$referencing_post_ids
-				);
-				$entity_results[]                     = $serialized_entity;
-			}
-		}
-	}
+                $serialized_entity                    = wl_serialize_entity( $entity );
+                $serialized_entity['label']           = html_entity_decode( wl_shortcode_faceted_search_get_the_title( $obj->ID ), ENT_QUOTES, 'UTF-8' );
+                $serialized_entity['counter']         = $obj->counter;
+                $serialized_entity['createdAt']       = $entity->post_date;
+                $serialized_entity['referencedPosts'] = Wordlift_Relation_Service::get_instance()->get_article_subjects(
+                    $obj->ID,
+                    'ids',
+                    null,
+                    null,
+                    array(),
+                    null,
+                    $referencing_post_ids
+                );
+                $entity_results[]                     = $serialized_entity;
+            }
+        }
+    }
 
-	$post_results = apply_filters( 'wl_faceted_data_posts', $post_results, $faceted_id );
+    $post_results = apply_filters( 'wl_faceted_data_posts', $post_results, $faceted_id );
 
-	// Add srcset attribute.
-	$post_results = array_map(
-		function ( $post ) {
-			$post->srcset = Srcset_Util::get_srcset( $post->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
+    // Add srcset attribute.
+    $post_results = array_map(
+        function ( $post ) {
+            $post->srcset = Srcset_Util::get_srcset( $post->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
 
-			return $post;
-		},
-		$post_results
-	);
+            return $post;
+        },
+        $post_results
+    );
 
-	$entity_results = apply_filters( 'wl_faceted_data_entities', $entity_results, $faceted_id );
+    $entity_results = apply_filters( 'wl_faceted_data_entities', $entity_results, $faceted_id );
 
-	return array(
-		'posts'    => $amp ? array( array( 'values' => $post_results ) ) : $post_results,
-		'entities' => $entity_results,
-	);
+    return array(
+        'posts'    => $amp ? array( array( 'values' => $post_results ) ) : $post_results,
+        'entities' => $entity_results,
+    );
 
 }
 
 function wl_shortcode_faceted_search_get_the_title( $post_id ) {
 
-	$title = wp_strip_all_tags( get_the_title( $post_id ) );
+    $title = wp_strip_all_tags( get_the_title( $post_id ) );
 
-	if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
-		$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
+    if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
+        $alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
 
-		if ( count( $alternative_labels ) > 0 ) {
-			$title = $alternative_labels[0];
-		}
-	}
+        if ( count( $alternative_labels ) > 0 ) {
+            $title = $alternative_labels[0];
+        }
+    }
 
-	return remove_accents( $title );
+    return remove_accents( $title );
 
 }
 
@@ -288,16 +288,16 @@ 
  * Adding `rest_api_init` action for network faceted-search
  */
 add_action(
-	'rest_api_init',
-	function () {
-		register_rest_route(
-			WL_REST_ROUTE_DEFAULT_NAMESPACE,
-			'/faceted-search',
-			array(
-				'methods'             => 'GET',
-				'callback'            => 'wl_shortcode_faceted_search',
-				'permission_callback' => '__return_true',
-			)
-		);
-	}
+    'rest_api_init',
+    function () {
+        register_rest_route(
+            WL_REST_ROUTE_DEFAULT_NAMESPACE,
+            '/faceted-search',
+            array(
+                'methods'             => 'GET',
+                'callback'            => 'wl_shortcode_faceted_search',
+                'permission_callback' => '__return_true',
+            )
+        );
+    }
 );

Spacing +69 added lines, -70 removed lines

@@ -18,7 +18,7 @@ 
  * @since 3.21.4 fix the cache key by also using the request body.
  * @since 3.21.2 add a caching layer.
  */
-function wl_shortcode_faceted_search( $request ) {
+function wl_shortcode_faceted_search($request) {
 
 	// Filter the allowed parameters for caching.
 	$cache_params = array_intersect_key(
@@ -38,27 +38,27 @@ 
 	);
 
 	// Create the TTL cache and try to get the results.
-	$cache         = new Ttl_Cache( 'faceted-search', 8 * 60 * 60 ); // 8 hours.
-	$cache_results = $cache->get( $cache_key );
+	$cache         = new Ttl_Cache('faceted-search', 8 * 60 * 60); // 8 hours.
+	$cache_results = $cache->get($cache_key);
 
 	// So that the endpoint can be used remotely
-	header( 'Access-Control-Allow-Origin: *' );
+	header('Access-Control-Allow-Origin: *');
 
-	if ( isset( $cache_results ) ) {
-		header( 'X-WordLift-Cache: HIT' );
-		wl_core_send_json( $cache_results );
+	if (isset($cache_results)) {
+		header('X-WordLift-Cache: HIT');
+		wl_core_send_json($cache_results);
 
 		return;
 	}
 
-	header( 'X-WordLift-Cache: MISS' );
+	header('X-WordLift-Cache: MISS');
 
-	$results = wl_shortcode_faceted_search_origin( $request->get_query_params() );
+	$results = wl_shortcode_faceted_search_origin($request->get_query_params());
 
 	// Put the result before sending the json to the client, since sending the json will terminate us.
-	$cache->put( $cache_key, $results );
+	$cache->put($cache_key, $results);
 
-	wl_core_send_json( $results );
+	wl_core_send_json($results);
 
 }
 
@@ -69,26 +69,26 @@ 
  * @since        3.26.0
  */
 // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-function wl_shortcode_faceted_search_origin( $request ) {
+function wl_shortcode_faceted_search_origin($request) {
 	// Post ID must be defined.
-	if ( ! isset( $request['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
-		wp_die( 'No post_id given' );
+	if ( ! isset($request['post_id'])) { // WPCS: input var ok; CSRF ok.
+		wp_die('No post_id given');
 
 		return;
 	}
 
 	$current_post_id = (int) $request['post_id']; // WPCS: input var ok; CSRF ok.
-	$current_post    = get_post( $current_post_id );
-	$faceted_id      = isset( $request['uniqid'] ) ? sanitize_text_field( wp_unslash( (string) $request['uniqid'] ) ) : '';
+	$current_post    = get_post($current_post_id);
+	$faceted_id      = isset($request['uniqid']) ? sanitize_text_field(wp_unslash((string) $request['uniqid'])) : '';
 
-	$post_types          = isset( $request['post_types'] ) ? sanitize_text_field( wp_unslash( (string) $request['post_types'] ) ) : '';
-	$post_types          = explode( ',', $post_types );
+	$post_types          = isset($request['post_types']) ? sanitize_text_field(wp_unslash((string) $request['post_types'])) : '';
+	$post_types          = explode(',', $post_types);
 	$existing_post_types = get_post_types();
-	$post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
+	$post_types          = array_values(array_intersect($existing_post_types, $post_types));
 
 	// Post ID has to match an existing item.
-	if ( null === $current_post ) {
-		wp_die( 'No valid post_id given' );
+	if (null === $current_post) {
+		wp_die('No valid post_id given');
 
 		return;
 	}
@@ -98,33 +98,32 @@ 
 	// Otherwise, current post related entities are used.
 	$entity_service = Wordlift_Entity_Service::get_instance();
 
-	$entity_ids = $entity_service->is_entity( $current_post->ID ) ?
-		array( $current_post->ID ) :
-		$entity_service->get_related_entities( $current_post->ID );
+	$entity_ids = $entity_service->is_entity($current_post->ID) ?
+		array($current_post->ID) : $entity_service->get_related_entities($current_post->ID);
 
 	// If there are no entities we cannot render the widget.
-	if ( 0 === count( $entity_ids ) ) {
+	if (0 === count($entity_ids)) {
 		/**
 		 * If this function is not called from ajax
 		 * then this should not throw an error.
 		 * Note: Used in scripbox longtail project on json endpoint.
 		 */
-		if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
-			wp_die( 'No entities available' );
+		if (apply_filters('wp_doing_ajax', defined('DOING_AJAX') && DOING_AJAX)) {
+			wp_die('No entities available');
 		}
 	}
 
 	// phpcs:ignore Standard.Category.SniffName.ErrorCode
-	$limit = ( isset( $request['limit'] ) ) ? (int) $request['limit'] : 4;
-	$amp   = isset( $request['amp'] );
+	$limit = (isset($request['limit'])) ? (int) $request['limit'] : 4;
+	$amp   = isset($request['amp']);
 
 	/**
 	 * see https://github.com/insideout10/wordlift-plugin/issues/1181
 	 * The ordering should be descending by date on default.
 	 */
 	$order_by = 'DESC';
-	if ( isset( $request['sort'] ) && is_string( $request['sort'] ) ) {
-		$order_by = sanitize_sql_orderby( wp_unslash( (string) $request['sort'] ) );
+	if (isset($request['sort']) && is_string($request['sort'])) {
+		$order_by = sanitize_sql_orderby(wp_unslash((string) $request['sort']));
 	}
 
 	$referencing_posts = Wordlift_Relation_Service::get_instance()->get_article_subjects(
@@ -132,7 +131,7 @@ 
 		'*',
 		null,
 		'publish',
-		array( $current_post_id ),
+		array($current_post_id),
 		$limit,
 		null,
 		$order_by,
@@ -140,7 +139,7 @@ 
 	);
 
 	$referencing_post_ids = array_map(
-		function ( $p ) {
+		function($p) {
 			return $p->ID;
 		},
 		$referencing_posts
@@ -151,8 +150,8 @@ 
 
 	// Populate $post_results
 
-	if ( $referencing_posts ) {
-		foreach ( $referencing_posts as $post_obj ) {
+	if ($referencing_posts) {
+		foreach ($referencing_posts as $post_obj) {
 
 			/**
 			 * Use the thumbnail.
@@ -162,12 +161,12 @@ 
 			 *
 			 * @since 3.19.3 We're using the medium size image.
 			 */
-			$thumbnail            = get_the_post_thumbnail_url( $post_obj, 'medium' );
-			$post_obj->thumbnail  = ( $thumbnail ) ?
+			$thumbnail            = get_the_post_thumbnail_url($post_obj, 'medium');
+			$post_obj->thumbnail  = ($thumbnail) ?
 				$thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-			$post_obj->permalink  = get_permalink( $post_obj->ID );
-			$post_obj->srcset     = Srcset_Util::get_srcset( $post_obj->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
-			$post_obj->post_title = wp_strip_all_tags( html_entity_decode( $post_obj->post_title, ENT_QUOTES, 'UTF-8' ) );
+			$post_obj->permalink  = get_permalink($post_obj->ID);
+			$post_obj->srcset     = Srcset_Util::get_srcset($post_obj->ID, Srcset_Util::FACETED_SEARCH_WIDGET);
+			$post_obj->post_title = wp_strip_all_tags(html_entity_decode($post_obj->post_title, ENT_QUOTES, 'UTF-8'));
 			$result               = $post_obj;
 			$post_results[]       = $result;
 		}
@@ -175,16 +174,16 @@ 
 
 	// Add filler posts if needed
 
-	$filler_count = $limit - count( $post_results );
-	if ( 0 < apply_filters( 'wl_faceted_search__filler_count', $filler_count, $current_post_id, $referencing_post_ids ) ) {
-		$filler_posts_util       = new Filler_Posts_Util( $current_post_id );
-		$post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
-		$filler_posts            = $filler_posts_util->get_filler_posts( $filler_count, $post_ids_to_be_excluded );
+	$filler_count = $limit - count($post_results);
+	if (0 < apply_filters('wl_faceted_search__filler_count', $filler_count, $current_post_id, $referencing_post_ids)) {
+		$filler_posts_util       = new Filler_Posts_Util($current_post_id);
+		$post_ids_to_be_excluded = array_merge(array($current_post_id), $referencing_post_ids);
+		$filler_posts            = $filler_posts_util->get_filler_posts($filler_count, $post_ids_to_be_excluded);
 
-		$post_results = array_merge( $post_results, $filler_posts );
+		$post_results = array_merge($post_results, $filler_posts);
 	}
 	$referencing_post_ids = array_map(
-		function ( $post ) {
+		function($post) {
 			return $post->ID;
 		},
 		$post_results
@@ -201,8 +200,8 @@ 
 	 * Make sure we have some referenced post, otherwise the IN parts of
 	 * the SQL will produce an SQL error.
 	 */
-	if ( ! empty( $referencing_post_ids ) ) {
-		$subject_ids = implode( ',', $referencing_post_ids );
+	if ( ! empty($referencing_post_ids)) {
+		$subject_ids = implode(',', $referencing_post_ids);
 
 		$query = "
 				SELECT
@@ -216,21 +215,21 @@ 
 				LIMIT $limit;
 			";
 
-		wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
+		wl_write_log("Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]");
 
-		$entities = $wpdb->get_results( $query, OBJECT ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+		$entities = $wpdb->get_results($query, OBJECT); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 
-		wl_write_log( 'Entities found ' . count( $entities ) );
+		wl_write_log('Entities found '.count($entities));
 
-		foreach ( $entities as $obj ) {
+		foreach ($entities as $obj) {
 
-			$entity = get_post( $obj->ID );
+			$entity = get_post($obj->ID);
 
 			// Ensure only valid and published entities are returned.
-			if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
+			if ((null !== $entity) && ('publish' === $entity->post_status)) {
 
-				$serialized_entity                    = wl_serialize_entity( $entity );
-				$serialized_entity['label']           = html_entity_decode( wl_shortcode_faceted_search_get_the_title( $obj->ID ), ENT_QUOTES, 'UTF-8' );
+				$serialized_entity                    = wl_serialize_entity($entity);
+				$serialized_entity['label']           = html_entity_decode(wl_shortcode_faceted_search_get_the_title($obj->ID), ENT_QUOTES, 'UTF-8');
 				$serialized_entity['counter']         = $obj->counter;
 				$serialized_entity['createdAt']       = $entity->post_date;
 				$serialized_entity['referencedPosts'] = Wordlift_Relation_Service::get_instance()->get_article_subjects(
@@ -242,45 +241,45 @@ 
 					null,
 					$referencing_post_ids
 				);
-				$entity_results[]                     = $serialized_entity;
+				$entity_results[] = $serialized_entity;
 			}
 		}
 	}
 
-	$post_results = apply_filters( 'wl_faceted_data_posts', $post_results, $faceted_id );
+	$post_results = apply_filters('wl_faceted_data_posts', $post_results, $faceted_id);
 
 	// Add srcset attribute.
 	$post_results = array_map(
-		function ( $post ) {
-			$post->srcset = Srcset_Util::get_srcset( $post->ID, Srcset_Util::FACETED_SEARCH_WIDGET );
+		function($post) {
+			$post->srcset = Srcset_Util::get_srcset($post->ID, Srcset_Util::FACETED_SEARCH_WIDGET);
 
 			return $post;
 		},
 		$post_results
 	);
 
-	$entity_results = apply_filters( 'wl_faceted_data_entities', $entity_results, $faceted_id );
+	$entity_results = apply_filters('wl_faceted_data_entities', $entity_results, $faceted_id);
 
 	return array(
-		'posts'    => $amp ? array( array( 'values' => $post_results ) ) : $post_results,
+		'posts'    => $amp ? array(array('values' => $post_results)) : $post_results,
 		'entities' => $entity_results,
 	);
 
 }
 
-function wl_shortcode_faceted_search_get_the_title( $post_id ) {
+function wl_shortcode_faceted_search_get_the_title($post_id) {
 
-	$title = wp_strip_all_tags( get_the_title( $post_id ) );
+	$title = wp_strip_all_tags(get_the_title($post_id));
 
-	if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
-		$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
+	if (get_post_type($post_id) !== Wordlift_Entity_Service::TYPE_NAME) {
+		$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels($post_id);
 
-		if ( count( $alternative_labels ) > 0 ) {
+		if (count($alternative_labels) > 0) {
 			$title = $alternative_labels[0];
 		}
 	}
 
-	return remove_accents( $title );
+	return remove_accents($title);
 
 }
 
@@ -289,7 +288,7 @@ 
  */
 add_action(
 	'rest_api_init',
-	function () {
+	function() {
 		register_rest_route(
 			WL_REST_ROUTE_DEFAULT_NAMESPACE,
 			'/faceted-search',

src/shortcodes/wordlift-shortcode-navigator.php

Indentation +204 added lines, -204 removed lines

@@ -19,176 +19,176 @@ 
  */
 function wl_shortcode_navigator_data() {
 
-	// Create the cache key.
-	$cache_params = array_intersect_key(
-		$_REQUEST, // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		array(
-			'limit'      => 1,
-			'offset'     => 1,
-			'sort'       => 1,
-			'post_types' => 1,
-			'post_id'    => 1,
-		)
-	);
+    // Create the cache key.
+    $cache_params = array_intersect_key(
+        $_REQUEST, // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        array(
+            'limit'      => 1,
+            'offset'     => 1,
+            'sort'       => 1,
+            'post_types' => 1,
+            'post_id'    => 1,
+        )
+    );
 
-	$cache_key = array( 'request_params' => $cache_params );
+    $cache_key = array( 'request_params' => $cache_params );
 
-	// Create the TTL cache and try to get the results.
-	$cache         = new Ttl_Cache( 'navigator', 8 * 60 * 60 ); // 8 hours.
-	$cache_results = $cache->get( $cache_key );
+    // Create the TTL cache and try to get the results.
+    $cache         = new Ttl_Cache( 'navigator', 8 * 60 * 60 ); // 8 hours.
+    $cache_results = $cache->get( $cache_key );
 
-	// So that the endpoint can be used remotely
-	header( 'Access-Control-Allow-Origin: *' );
+    // So that the endpoint can be used remotely
+    header( 'Access-Control-Allow-Origin: *' );
 
-	if ( isset( $cache_results ) ) {
-		header( 'X-WordLift-Cache: HIT' );
+    if ( isset( $cache_results ) ) {
+        header( 'X-WordLift-Cache: HIT' );
 
-		return $cache_results;
-	}
+        return $cache_results;
+    }
 
-	header( 'X-WordLift-Cache: MISS' );
+    header( 'X-WordLift-Cache: MISS' );
 
-	$results = _wl_navigator_get_data();
+    $results = _wl_navigator_get_data();
 
-	// Put the result before sending the json to the client, since sending the json will terminate us.
-	$cache->put( $cache_key, $results );
+    // Put the result before sending the json to the client, since sending the json will terminate us.
+    $cache->put( $cache_key, $results );
 
-	return $results;
+    return $results;
 }
 
 function _wl_navigator_get_data() {
 
-	check_ajax_referer( 'wl_navigator' );
-
-	// Post ID must be defined
-	if ( ! isset( $_GET['post_id'] ) ) {
-		wp_send_json_error( 'No post_id given' );
-
-		return array();
-	}
-
-	// Post ID must be defined
-	if ( ! isset( $_GET['uniqid'] ) ) {
-		wp_send_json_error( 'No uniqid given' );
-
-		return array();
-	}
-
-	// Limit the results (defaults to 4)
-	$navigator_length    = isset( $_GET['limit'] ) ? intval( $_GET['limit'] ) : 4;
-	$navigator_offset    = isset( $_GET['offset'] ) ? intval( $_GET['offset'] ) : 0;
-	$order_by            = isset( $_GET['sort'] ) ? sanitize_sql_orderby( wp_unslash( $_GET['sort'] ) ) : 'ID DESC';
-	$post_types          = isset( $_GET['post_types'] ) ? sanitize_text_field( wp_unslash( $_GET['post_types'] ) ) : '';
-	$post_types          = explode( ',', $post_types );
-	$existing_post_types = get_post_types();
-	$post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
-	$current_post_id     = (int) $_GET['post_id'];
-	$current_post        = get_post( $current_post_id );
-
-	$navigator_id = sanitize_text_field( wp_unslash( $_GET['uniqid'] ) );
-
-	// Post ID has to match an existing item
-	if ( null === $current_post ) {
-		wp_send_json_error( 'No valid post_id given' );
-
-		return array();
-	}
-
-	// Determine navigator type and call respective _get_results
-	if ( get_post_type( $current_post_id ) === Wordlift_Entity_Service::TYPE_NAME ) {
-
-		$referencing_posts = Navigator_Data::entity_navigator_get_results(
-			$current_post_id,
-			array(
-				'ID',
-				'post_title',
-			),
-			$order_by,
-			$navigator_length,
-			$navigator_offset,
-			$post_types
-		);
-	} else {
-		$referencing_posts = Navigator_Data::post_navigator_get_results(
-			$current_post_id,
-			array(
-				'ID',
-				'post_title',
-			),
-			$order_by,
-			$navigator_length,
-			$navigator_offset,
-			$post_types
-		);
-
-	}
-
-	// loop over them and take the first one which is not already in the $related_posts
-	$results = array();
-	foreach ( $referencing_posts as $referencing_post ) {
-		$serialized_entity = wl_serialize_entity( $referencing_post->entity_id );
-
-		/**
-		 * Use the thumbnail.
-		 *
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/837
-		 *
-		 * @since 3.19.3 We're using the medium size image.
-		 */
-		$thumbnail = get_the_post_thumbnail_url( $referencing_post, 'medium' );
-
-		$result = array(
-			'post'   => array(
-				'id'        => $referencing_post->ID,
-				'permalink' => get_permalink( $referencing_post->ID ),
-				'title'     => html_entity_decode( $referencing_post->post_title, ENT_QUOTES, 'UTF-8' ),
-				'thumbnail' => $thumbnail,
-				'srcset'    => Srcset_Util::get_srcset( $referencing_post->ID, Srcset_Util::NAVIGATOR_WIDGET ),
-			),
-			'entity' => array(
-				'id'        => $referencing_post->entity_id,
-				'label'     => $serialized_entity['label'],
-				'mainType'  => $serialized_entity['mainType'],
-				'permalink' => get_permalink( $referencing_post->entity_id ),
-			),
-		);
-
-		$results[] = $result;
-	}
-
-	if ( count( $results ) < $navigator_length ) {
-		$results = apply_filters( 'wl_navigator_data_placeholder', $results, $navigator_id, $navigator_offset, $navigator_length );
-	}
-
-	// Add filler posts if needed
-	$filler_count = $navigator_length - count( $results );
-	if ( $filler_count > 0 ) {
-		$referencing_post_ids = array_map(
-			function ( $p ) {
-				return $p->ID;
-			},
-			$referencing_posts
-		);
-		/**
-		 * @since 3.27.8
-		 * Filler posts are fetched using this util.
-		 */
-		$filler_posts_util       = new Filler_Posts_Util( $current_post_id, $post_types );
-		$post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
-		$filler_posts            = $filler_posts_util->get_filler_response( $filler_count, $post_ids_to_be_excluded );
-		$results                 = array_merge( $results, $filler_posts );
-	}
-
-	// Apply filters after fillers are added
-	foreach ( $results as $result_index => $result ) {
-		$results[ $result_index ]['post']   = apply_filters( 'wl_navigator_data_post', $result['post'], intval( $result['post']['id'] ), $navigator_id );
-		$results[ $result_index ]['entity'] = apply_filters( 'wl_navigator_data_entity', $result['entity'], intval( $result['entity']['id'] ), $navigator_id );
-	}
-
-	$results = apply_filters( 'wl_navigator_results', $results, $navigator_id, $current_post_id );
-
-	return $results;
+    check_ajax_referer( 'wl_navigator' );
+
+    // Post ID must be defined
+    if ( ! isset( $_GET['post_id'] ) ) {
+        wp_send_json_error( 'No post_id given' );
+
+        return array();
+    }
+
+    // Post ID must be defined
+    if ( ! isset( $_GET['uniqid'] ) ) {
+        wp_send_json_error( 'No uniqid given' );
+
+        return array();
+    }
+
+    // Limit the results (defaults to 4)
+    $navigator_length    = isset( $_GET['limit'] ) ? intval( $_GET['limit'] ) : 4;
+    $navigator_offset    = isset( $_GET['offset'] ) ? intval( $_GET['offset'] ) : 0;
+    $order_by            = isset( $_GET['sort'] ) ? sanitize_sql_orderby( wp_unslash( $_GET['sort'] ) ) : 'ID DESC';
+    $post_types          = isset( $_GET['post_types'] ) ? sanitize_text_field( wp_unslash( $_GET['post_types'] ) ) : '';
+    $post_types          = explode( ',', $post_types );
+    $existing_post_types = get_post_types();
+    $post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
+    $current_post_id     = (int) $_GET['post_id'];
+    $current_post        = get_post( $current_post_id );
+
+    $navigator_id = sanitize_text_field( wp_unslash( $_GET['uniqid'] ) );
+
+    // Post ID has to match an existing item
+    if ( null === $current_post ) {
+        wp_send_json_error( 'No valid post_id given' );
+
+        return array();
+    }
+
+    // Determine navigator type and call respective _get_results
+    if ( get_post_type( $current_post_id ) === Wordlift_Entity_Service::TYPE_NAME ) {
+
+        $referencing_posts = Navigator_Data::entity_navigator_get_results(
+            $current_post_id,
+            array(
+                'ID',
+                'post_title',
+            ),
+            $order_by,
+            $navigator_length,
+            $navigator_offset,
+            $post_types
+        );
+    } else {
+        $referencing_posts = Navigator_Data::post_navigator_get_results(
+            $current_post_id,
+            array(
+                'ID',
+                'post_title',
+            ),
+            $order_by,
+            $navigator_length,
+            $navigator_offset,
+            $post_types
+        );
+
+    }
+
+    // loop over them and take the first one which is not already in the $related_posts
+    $results = array();
+    foreach ( $referencing_posts as $referencing_post ) {
+        $serialized_entity = wl_serialize_entity( $referencing_post->entity_id );
+
+        /**
+         * Use the thumbnail.
+         *
+         * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
+         * @see https://github.com/insideout10/wordlift-plugin/issues/837
+         *
+         * @since 3.19.3 We're using the medium size image.
+         */
+        $thumbnail = get_the_post_thumbnail_url( $referencing_post, 'medium' );
+
+        $result = array(
+            'post'   => array(
+                'id'        => $referencing_post->ID,
+                'permalink' => get_permalink( $referencing_post->ID ),
+                'title'     => html_entity_decode( $referencing_post->post_title, ENT_QUOTES, 'UTF-8' ),
+                'thumbnail' => $thumbnail,
+                'srcset'    => Srcset_Util::get_srcset( $referencing_post->ID, Srcset_Util::NAVIGATOR_WIDGET ),
+            ),
+            'entity' => array(
+                'id'        => $referencing_post->entity_id,
+                'label'     => $serialized_entity['label'],
+                'mainType'  => $serialized_entity['mainType'],
+                'permalink' => get_permalink( $referencing_post->entity_id ),
+            ),
+        );
+
+        $results[] = $result;
+    }
+
+    if ( count( $results ) < $navigator_length ) {
+        $results = apply_filters( 'wl_navigator_data_placeholder', $results, $navigator_id, $navigator_offset, $navigator_length );
+    }
+
+    // Add filler posts if needed
+    $filler_count = $navigator_length - count( $results );
+    if ( $filler_count > 0 ) {
+        $referencing_post_ids = array_map(
+            function ( $p ) {
+                return $p->ID;
+            },
+            $referencing_posts
+        );
+        /**
+         * @since 3.27.8
+         * Filler posts are fetched using this util.
+         */
+        $filler_posts_util       = new Filler_Posts_Util( $current_post_id, $post_types );
+        $post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
+        $filler_posts            = $filler_posts_util->get_filler_response( $filler_count, $post_ids_to_be_excluded );
+        $results                 = array_merge( $results, $filler_posts );
+    }
+
+    // Apply filters after fillers are added
+    foreach ( $results as $result_index => $result ) {
+        $results[ $result_index ]['post']   = apply_filters( 'wl_navigator_data_post', $result['post'], intval( $result['post']['id'] ), $navigator_id );
+        $results[ $result_index ]['entity'] = apply_filters( 'wl_navigator_data_entity', $result['entity'], intval( $result['entity']['id'] ), $navigator_id );
+    }
+
+    $results = apply_filters( 'wl_navigator_results', $results, $navigator_id, $current_post_id );
+
+    return $results;
 }
 
 /**
@@ -198,9 +198,9 @@ 
  */
 function wl_shortcode_navigator_ajax() {
 
-	// Temporary blocking the Navigator.
-	$results = wl_shortcode_navigator_data();
-	wl_core_send_json( $results );
+    // Temporary blocking the Navigator.
+    $results = wl_shortcode_navigator_data();
+    wl_core_send_json( $results );
 
 }
 
@@ -212,16 +212,16 @@ 
  */
 function wl_shortcode_navigator_wp_json() {
 
-	$results = wl_shortcode_navigator_data();
-	if ( ob_get_contents() ) {
-		ob_clean();
-	}
+    $results = wl_shortcode_navigator_data();
+    if ( ob_get_contents() ) {
+        ob_clean();
+    }
 
-	return array(
-		'items' => array(
-			array( 'values' => $results ),
-		),
-	);
+    return array(
+        'items' => array(
+            array( 'values' => $results ),
+        ),
+    );
 
 }
 
@@ -229,18 +229,18 @@ 
  * Adding `rest_api_init` action for amp backend of navigator
  */
 add_action(
-	'rest_api_init',
-	function () {
-		register_rest_route(
-			WL_REST_ROUTE_DEFAULT_NAMESPACE,
-			'/navigator',
-			array(
-				'methods'             => 'GET',
-				'permission_callback' => '__return_true',
-				'callback'            => 'wl_shortcode_navigator_wp_json',
-			)
-		);
-	}
+    'rest_api_init',
+    function () {
+        register_rest_route(
+            WL_REST_ROUTE_DEFAULT_NAMESPACE,
+            '/navigator',
+            array(
+                'methods'             => 'GET',
+                'permission_callback' => '__return_true',
+                'callback'            => 'wl_shortcode_navigator_wp_json',
+            )
+        );
+    }
 );
 
 /**
@@ -249,31 +249,31 @@ 
  * @since 2.2.0
  */
 add_action(
-	'plugins_loaded',
-	function () {
-		$action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
-			return;
-		}
-
-		remove_action( 'plugins_loaded', 'rocket_init' );
-		remove_action( 'plugins_loaded', 'wpseo_premium_init', 14 );
-		remove_action( 'plugins_loaded', 'wpseo_init', 14 );
-	},
-	0
+    'plugins_loaded',
+    function () {
+        $action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
+            return;
+        }
+
+        remove_action( 'plugins_loaded', 'rocket_init' );
+        remove_action( 'plugins_loaded', 'wpseo_premium_init', 14 );
+        remove_action( 'plugins_loaded', 'wpseo_init', 14 );
+    },
+    0
 );
 
 add_action(
-	'init',
-	function () {
-		$action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
-			return;
-		}
-
-		remove_action( 'init', 'wp_widgets_init', 1 );
-		remove_action( 'init', 'gglcptch_init' );
-	},
-	0
+    'init',
+    function () {
+        $action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
+            return;
+        }
+
+        remove_action( 'init', 'wp_widgets_init', 1 );
+        remove_action( 'init', 'gglcptch_init' );
+    },
+    0
 );
 

Spacing +61 added lines, -61 removed lines

@@ -31,71 +31,71 @@ 
 		)
 	);
 
-	$cache_key = array( 'request_params' => $cache_params );
+	$cache_key = array('request_params' => $cache_params);
 
 	// Create the TTL cache and try to get the results.
-	$cache         = new Ttl_Cache( 'navigator', 8 * 60 * 60 ); // 8 hours.
-	$cache_results = $cache->get( $cache_key );
+	$cache         = new Ttl_Cache('navigator', 8 * 60 * 60); // 8 hours.
+	$cache_results = $cache->get($cache_key);
 
 	// So that the endpoint can be used remotely
-	header( 'Access-Control-Allow-Origin: *' );
+	header('Access-Control-Allow-Origin: *');
 
-	if ( isset( $cache_results ) ) {
-		header( 'X-WordLift-Cache: HIT' );
+	if (isset($cache_results)) {
+		header('X-WordLift-Cache: HIT');
 
 		return $cache_results;
 	}
 
-	header( 'X-WordLift-Cache: MISS' );
+	header('X-WordLift-Cache: MISS');
 
 	$results = _wl_navigator_get_data();
 
 	// Put the result before sending the json to the client, since sending the json will terminate us.
-	$cache->put( $cache_key, $results );
+	$cache->put($cache_key, $results);
 
 	return $results;
 }
 
 function _wl_navigator_get_data() {
 
-	check_ajax_referer( 'wl_navigator' );
+	check_ajax_referer('wl_navigator');
 
 	// Post ID must be defined
-	if ( ! isset( $_GET['post_id'] ) ) {
-		wp_send_json_error( 'No post_id given' );
+	if ( ! isset($_GET['post_id'])) {
+		wp_send_json_error('No post_id given');
 
 		return array();
 	}
 
 	// Post ID must be defined
-	if ( ! isset( $_GET['uniqid'] ) ) {
-		wp_send_json_error( 'No uniqid given' );
+	if ( ! isset($_GET['uniqid'])) {
+		wp_send_json_error('No uniqid given');
 
 		return array();
 	}
 
 	// Limit the results (defaults to 4)
-	$navigator_length    = isset( $_GET['limit'] ) ? intval( $_GET['limit'] ) : 4;
-	$navigator_offset    = isset( $_GET['offset'] ) ? intval( $_GET['offset'] ) : 0;
-	$order_by            = isset( $_GET['sort'] ) ? sanitize_sql_orderby( wp_unslash( $_GET['sort'] ) ) : 'ID DESC';
-	$post_types          = isset( $_GET['post_types'] ) ? sanitize_text_field( wp_unslash( $_GET['post_types'] ) ) : '';
-	$post_types          = explode( ',', $post_types );
+	$navigator_length    = isset($_GET['limit']) ? intval($_GET['limit']) : 4;
+	$navigator_offset    = isset($_GET['offset']) ? intval($_GET['offset']) : 0;
+	$order_by            = isset($_GET['sort']) ? sanitize_sql_orderby(wp_unslash($_GET['sort'])) : 'ID DESC';
+	$post_types          = isset($_GET['post_types']) ? sanitize_text_field(wp_unslash($_GET['post_types'])) : '';
+	$post_types          = explode(',', $post_types);
 	$existing_post_types = get_post_types();
-	$post_types          = array_values( array_intersect( $existing_post_types, $post_types ) );
+	$post_types          = array_values(array_intersect($existing_post_types, $post_types));
 	$current_post_id     = (int) $_GET['post_id'];
-	$current_post        = get_post( $current_post_id );
+	$current_post        = get_post($current_post_id);
 
-	$navigator_id = sanitize_text_field( wp_unslash( $_GET['uniqid'] ) );
+	$navigator_id = sanitize_text_field(wp_unslash($_GET['uniqid']));
 
 	// Post ID has to match an existing item
-	if ( null === $current_post ) {
-		wp_send_json_error( 'No valid post_id given' );
+	if (null === $current_post) {
+		wp_send_json_error('No valid post_id given');
 
 		return array();
 	}
 
 	// Determine navigator type and call respective _get_results
-	if ( get_post_type( $current_post_id ) === Wordlift_Entity_Service::TYPE_NAME ) {
+	if (get_post_type($current_post_id) === Wordlift_Entity_Service::TYPE_NAME) {
 
 		$referencing_posts = Navigator_Data::entity_navigator_get_results(
 			$current_post_id,
@@ -125,8 +125,8 @@ 
 
 	// loop over them and take the first one which is not already in the $related_posts
 	$results = array();
-	foreach ( $referencing_posts as $referencing_post ) {
-		$serialized_entity = wl_serialize_entity( $referencing_post->entity_id );
+	foreach ($referencing_posts as $referencing_post) {
+		$serialized_entity = wl_serialize_entity($referencing_post->entity_id);
 
 		/**
 		 * Use the thumbnail.
@@ -136,36 +136,36 @@ 
 		 *
 		 * @since 3.19.3 We're using the medium size image.
 		 */
-		$thumbnail = get_the_post_thumbnail_url( $referencing_post, 'medium' );
+		$thumbnail = get_the_post_thumbnail_url($referencing_post, 'medium');
 
 		$result = array(
 			'post'   => array(
 				'id'        => $referencing_post->ID,
-				'permalink' => get_permalink( $referencing_post->ID ),
-				'title'     => html_entity_decode( $referencing_post->post_title, ENT_QUOTES, 'UTF-8' ),
+				'permalink' => get_permalink($referencing_post->ID),
+				'title'     => html_entity_decode($referencing_post->post_title, ENT_QUOTES, 'UTF-8'),
 				'thumbnail' => $thumbnail,
-				'srcset'    => Srcset_Util::get_srcset( $referencing_post->ID, Srcset_Util::NAVIGATOR_WIDGET ),
+				'srcset'    => Srcset_Util::get_srcset($referencing_post->ID, Srcset_Util::NAVIGATOR_WIDGET),
 			),
 			'entity' => array(
 				'id'        => $referencing_post->entity_id,
 				'label'     => $serialized_entity['label'],
 				'mainType'  => $serialized_entity['mainType'],
-				'permalink' => get_permalink( $referencing_post->entity_id ),
+				'permalink' => get_permalink($referencing_post->entity_id),
 			),
 		);
 
 		$results[] = $result;
 	}
 
-	if ( count( $results ) < $navigator_length ) {
-		$results = apply_filters( 'wl_navigator_data_placeholder', $results, $navigator_id, $navigator_offset, $navigator_length );
+	if (count($results) < $navigator_length) {
+		$results = apply_filters('wl_navigator_data_placeholder', $results, $navigator_id, $navigator_offset, $navigator_length);
 	}
 
 	// Add filler posts if needed
-	$filler_count = $navigator_length - count( $results );
-	if ( $filler_count > 0 ) {
+	$filler_count = $navigator_length - count($results);
+	if ($filler_count > 0) {
 		$referencing_post_ids = array_map(
-			function ( $p ) {
+			function($p) {
 				return $p->ID;
 			},
 			$referencing_posts
@@ -174,19 +174,19 @@ 
 		 * @since 3.27.8
 		 * Filler posts are fetched using this util.
 		 */
-		$filler_posts_util       = new Filler_Posts_Util( $current_post_id, $post_types );
-		$post_ids_to_be_excluded = array_merge( array( $current_post_id ), $referencing_post_ids );
-		$filler_posts            = $filler_posts_util->get_filler_response( $filler_count, $post_ids_to_be_excluded );
-		$results                 = array_merge( $results, $filler_posts );
+		$filler_posts_util       = new Filler_Posts_Util($current_post_id, $post_types);
+		$post_ids_to_be_excluded = array_merge(array($current_post_id), $referencing_post_ids);
+		$filler_posts            = $filler_posts_util->get_filler_response($filler_count, $post_ids_to_be_excluded);
+		$results                 = array_merge($results, $filler_posts);
 	}
 
 	// Apply filters after fillers are added
-	foreach ( $results as $result_index => $result ) {
-		$results[ $result_index ]['post']   = apply_filters( 'wl_navigator_data_post', $result['post'], intval( $result['post']['id'] ), $navigator_id );
-		$results[ $result_index ]['entity'] = apply_filters( 'wl_navigator_data_entity', $result['entity'], intval( $result['entity']['id'] ), $navigator_id );
+	foreach ($results as $result_index => $result) {
+		$results[$result_index]['post']   = apply_filters('wl_navigator_data_post', $result['post'], intval($result['post']['id']), $navigator_id);
+		$results[$result_index]['entity'] = apply_filters('wl_navigator_data_entity', $result['entity'], intval($result['entity']['id']), $navigator_id);
 	}
 
-	$results = apply_filters( 'wl_navigator_results', $results, $navigator_id, $current_post_id );
+	$results = apply_filters('wl_navigator_results', $results, $navigator_id, $current_post_id);
 
 	return $results;
 }
@@ -200,12 +200,12 @@ 
 
 	// Temporary blocking the Navigator.
 	$results = wl_shortcode_navigator_data();
-	wl_core_send_json( $results );
+	wl_core_send_json($results);
 
 }
 
-add_action( 'wp_ajax_wl_navigator', 'wl_shortcode_navigator_ajax' );
-add_action( 'wp_ajax_nopriv_wl_navigator', 'wl_shortcode_navigator_ajax' );
+add_action('wp_ajax_wl_navigator', 'wl_shortcode_navigator_ajax');
+add_action('wp_ajax_nopriv_wl_navigator', 'wl_shortcode_navigator_ajax');
 
 /**
  * wp-json call for the navigator widget
@@ -213,13 +213,13 @@ 
 function wl_shortcode_navigator_wp_json() {
 
 	$results = wl_shortcode_navigator_data();
-	if ( ob_get_contents() ) {
+	if (ob_get_contents()) {
 		ob_clean();
 	}
 
 	return array(
 		'items' => array(
-			array( 'values' => $results ),
+			array('values' => $results),
 		),
 	);
 
@@ -230,7 +230,7 @@ 
  */
 add_action(
 	'rest_api_init',
-	function () {
+	function() {
 		register_rest_route(
 			WL_REST_ROUTE_DEFAULT_NAMESPACE,
 			'/navigator',
@@ -250,29 +250,29 @@ 
  */
 add_action(
 	'plugins_loaded',
-	function () {
-		$action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
+	function() {
+		$action = array_key_exists('action', $_REQUEST) ? sanitize_text_field(wp_unslash((string) $_REQUEST['action'])) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( ! defined('DOING_AJAX') || ! DOING_AJAX || 'wl_navigator' !== $action) {
 			return;
 		}
 
-		remove_action( 'plugins_loaded', 'rocket_init' );
-		remove_action( 'plugins_loaded', 'wpseo_premium_init', 14 );
-		remove_action( 'plugins_loaded', 'wpseo_init', 14 );
+		remove_action('plugins_loaded', 'rocket_init');
+		remove_action('plugins_loaded', 'wpseo_premium_init', 14);
+		remove_action('plugins_loaded', 'wpseo_init', 14);
 	},
 	0
 );
 
 add_action(
 	'init',
-	function () {
-		$action = array_key_exists( 'action', $_REQUEST ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || 'wl_navigator' !== $action ) {
+	function() {
+		$action = array_key_exists('action', $_REQUEST) ? sanitize_text_field(wp_unslash((string) $_REQUEST['action'])) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( ! defined('DOING_AJAX') || ! DOING_AJAX || 'wl_navigator' !== $action) {
 			return;
 		}
 
-		remove_action( 'init', 'wp_widgets_init', 1 );
-		remove_action( 'init', 'gglcptch_init' );
+		remove_action('init', 'wp_widgets_init', 1);
+		remove_action('init', 'gglcptch_init');
 	},
 	0
 );