Skip to content

Feat/4211: Related Posts: Add setting to weight results by date #4294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Sidsector9 wants to merge 2 commits into
base: develop
Choose a base branch
from
+385 −0
Draft

Feat/4211: Related Posts: Add setting to weight results by date #4294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c833bea
Merge branch 'develop' of github.com:10up/ElasticPress into develop
Sidsector9 Feb 20, 2026
86cdf0b
add Weight related posts by date setting
Sidsector9 Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 176 additions & 0 deletions includes/classes/Feature/RelatedPosts/RelatedPosts.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ public function __construct() {

$this->requires_install_reindex = false;

$this->default_settings = [
'decaying_enabled' => '0',
];

parent::__construct();
}

Expand Down Expand Up @@ -134,6 +138,7 @@ public function get_related_query( $post_id, $post_return = 5 ) {
'posts_per_page' => $post_return,
'ep_integrate' => true,
'ignore_sticky_posts' => true,
'orderby' => 'relevance',
);

/**
Expand Down Expand Up @@ -167,6 +172,176 @@ public function find_related( $post_id, $post_return = 5 ) {
return $query->posts;
}

/**
* Set the `settings_schema` attribute.
*
* @since 5.4.0
*/
protected function set_settings_schema() {
$this->settings_schema = [
[
'default' => '0',
'help' => __( 'When enabled, newer content will be favored over older content in related posts results.', 'elasticpress' ),
'key' => 'decaying_enabled',
'label' => __( 'Weight related posts by date', 'elasticpress' ),
'type' => 'checkbox',
],
];
}

/**
* Returns whether date decay is enabled for related posts.
*
* @since 5.4.0
* @param array $args WP_Query args.
* @return bool
*/
public function is_decaying_enabled( $args = [] ) {
$settings = $this->get_settings();

$is_decaying_enabled = ! empty( $settings['decaying_enabled'] ) && '0' !== $settings['decaying_enabled'];

/**
* Filter to enable or disable decay by date for related posts.
*
* @hook ep_related_posts_is_decaying_enabled
* @since 5.4.0
* @param {bool} $is_decaying_enabled Whether decay by date is enabled or not.
* @param {array} $settings Related Posts feature settings.
* @param {array} $args WP_Query args.
* @return {bool} New value.
*/
return apply_filters( 'ep_related_posts_is_decaying_enabled', $is_decaying_enabled, $settings, $args );
}

/**
* Weight more recent content in related posts results.
*
* @param array $formatted_args Formatted ES args.
* @param array $args WP_Query args.
* @since 5.4.0
* @return array
*/
public function weight_recent( $formatted_args, $args ) {
if ( empty( $args['more_like'] ) ) {
return $formatted_args;
}

if ( ! $this->is_decaying_enabled( $args ) ) {
return $formatted_args;
}

/**
* Filter related posts date weighting decay function.
*
* @hook epwr_related_posts_decay_function
* @since 5.4.0
* @param {string} $decay_function Current decay function.
* @param {array} $formatted_args Formatted Elasticsearch arguments.
* @param {array} $args WP_Query arguments.
* @return {string} New decay function.
*/
$decay_function = apply_filters( 'epwr_related_posts_decay_function', 'exp', $formatted_args, $args );

/**
* Filter related posts date weighting field.
*
* @hook epwr_related_posts_decay_field
* @since 5.4.0
* @param {string} $field Current decay field.
* @param {array} $formatted_args Formatted Elasticsearch arguments.
* @param {array} $args WP_Query arguments.
* @return {string} New decay field.
*/
$field = apply_filters( 'epwr_related_posts_decay_field', 'post_date_gmt', $formatted_args, $args );

$date_score = array(
'function_score' => array(
'query' => $formatted_args['query'],
'functions' => array(
array(
$decay_function => array(
$field => array(
/**
* Filter related posts date weighting scale.
*
* @hook epwr_related_posts_scale
* @since 5.4.0
* @param {string} $scale Current scale.
* @param {array} $formatted_args Formatted Elasticsearch arguments.
* @param {array} $args WP_Query arguments.
* @return {string} New scale.
*/
'scale' => apply_filters( 'epwr_related_posts_scale', '360d', $formatted_args, $args ),
/**
* Filter related posts date weighting decay.
*
* @hook epwr_related_posts_decay
* @since 5.4.0
* @param {float} $decay Current decay.
* @param {array} $formatted_args Formatted Elasticsearch arguments.
* @param {array} $args WP_Query arguments.
* @return {float} New decay.
*/
'decay' => apply_filters( 'epwr_related_posts_decay', 0.5, $formatted_args, $args ),
/**
* Filter related posts date weighting offset.
*
* @hook epwr_related_posts_offset
* @since 5.4.0
* @param {string} $offset Current offset.
* @param {array} $formatted_args Formatted Elasticsearch arguments.
* @param {array} $args WP_Query arguments.
* @return {string} New offset.
*/
'offset' => apply_filters( 'epwr_related_posts_offset', '30d', $formatted_args, $args ),
),
),
),
array(
/**
* Filter related posts date weight.
*
* @hook epwr_related_posts_weight
* @since 5.4.0
* @param {float} $weight Current weight.
* @param {array} $formatted_args Formatted Elasticsearch arguments.
* @param {array} $args WP_Query arguments.
* @return {float} New weight.
*/
'weight' => apply_filters( 'epwr_related_posts_weight', 0.001, $formatted_args, $args ),
),
),
/**
* Filter related posts date weighting score mode.
*
* @hook epwr_related_posts_score_mode
* @since 5.4.0
* @param {string} $score_mode Current score mode.
* @param {array} $formatted_args Formatted Elasticsearch arguments.
* @param {array} $args WP_Query arguments.
* @return {string} New score mode.
*/
'score_mode' => apply_filters( 'epwr_related_posts_score_mode', 'sum', $formatted_args, $args ),
/**
* Filter related posts date weighting boost mode.
*
* @hook epwr_related_posts_boost_mode
* @since 5.4.0
* @param {string} $boost_mode Current boost mode.
* @param {array} $formatted_args Formatted Elasticsearch arguments.
* @param {array} $args WP_Query arguments.
* @return {string} New boost mode.
*/
'boost_mode' => apply_filters( 'epwr_related_posts_boost_mode', 'multiply', $formatted_args, $args ),
),
);

$formatted_args['query'] = $date_score;

return $formatted_args;
}

/**
* Setup all feature filters
*
Expand All @@ -176,6 +351,7 @@ public function setup() {
add_action( 'widgets_init', [ $this, 'register_widget' ] );
add_filter( 'widget_types_to_hide_from_legacy_widget_block', [ $this, 'hide_legacy_widget' ] );
add_filter( 'ep_formatted_args', [ $this, 'formatted_args' ], 10, 2 );
add_filter( 'ep_formatted_args', [ $this, 'weight_recent' ], 11, 2 );
add_action( 'init', [ $this, 'register_block' ] );
add_action( 'rest_api_init', [ $this, 'setup_endpoint' ] );
}
Expand Down
Loading
Loading