PHP Class Jetpack_RelatedPosts_Raw, jetpack

Inheritance: extends Jetpack_RelatedPosts

Show file Open project: automattic/jetpack

Protected Properties

Property	Type	Description
$_query_name

Public Methods

Method	Description
action_admin_init ( )	The raw related posts class can be used by other plugins or themes to get related content. This class wraps the existing RelatedPosts logic thus we never want to add anything to the DOM or do anything for event hooks. We will also not present any settings for this class and keep it enabled as calls to this class is done programmatically.
action_frontend_init ( )
get_options ( )
set_query_name ( string $name ) : Jetpack_RelatedPosts_Raw	Allows callers of this class to tag each query with a unique name for tracking purposes.

Protected Methods

Method	Description
_get_related_posts ( integer $post_id, integer $size, array $filters ) : array	Workhorse method to return array of related posts ids matched by ElasticSearch.

Method Details

_get_related_posts() protected method

Workhorse method to return array of related posts ids matched by ElasticSearch.

protected _get_related_posts ( integer $post_id, integer $size, array $filters ) : array
$post_id	integer
$size	integer
$filters	array
return	array

action_admin_init() public method

The raw related posts class can be used by other plugins or themes to get related content. This class wraps the existing RelatedPosts logic thus we never want to add anything to the DOM or do anything for event hooks. We will also not present any settings for this class and keep it enabled as calls to this class is done programmatically.

public action_admin_init ( )

action_frontend_init() public method

public action_frontend_init ( )

get_options() public method

public get_options ( )

set_query_name() public method

Allows callers of this class to tag each query with a unique name for tracking purposes.

public set_query_name ( string $name ) : Jetpack_RelatedPosts_Raw
$name	string
return	Jetpack_RelatedPosts_Raw

Property Details

$_query_name protected property

protected $_query_name