<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/**
* Top Posts widget.
*
* Currently, this widget depends on the Stats Module. To not load this file
* when the Stats Module is not active would potentially bypass Jetpack's
* fatal error detection on module activation, so we always load this file.
* Instead, we don't register the widget if the Stats Module isn't active.
*
* @package automattic/jetpack
*/
// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files.
use Automattic\Jetpack\Redirect;
use Automattic\Jetpack\Stats\WPCOM_Stats;
use Automattic\Jetpack\Status;
use Automattic\Jetpack\Status\Host;
// Register the widget for use in Appearance -> Widgets
add_action( 'widgets_init', 'jetpack_top_posts_widget_init' );
/**
* Register the widget, if the Stats module is active.
*/
function jetpack_top_posts_widget_init() {
// Currently, this widget depends on the Stats Module.
if (
! ( defined( 'IS_WPCOM' ) && IS_WPCOM )
&& (
! Jetpack::is_module_active( 'stats' )
|| ( new Status() )->is_offline_mode()
)
) {
return;
}
register_widget( 'Jetpack_Top_Posts_Widget' );
}
/**
* Widget class.
*/
class Jetpack_Top_Posts_Widget extends WP_Widget {
/**
* Widget unique identifier.
*
* @var string
*/
public $alt_option_name = 'widget_stats_topposts';
/**
* Widget default title.
*
* @var string
*/
public $default_title = '';
/**
* Constructor.
*/
public function __construct() {
parent::__construct(
'top-posts',
/** This filter is documented in modules/widgets/facebook-likebox.php */
apply_filters( 'jetpack_widget_name', __( 'Top Posts & Pages', 'jetpack' ) ),
array(
'description' => __( 'Shows your most viewed posts and pages.', 'jetpack' ),
'customize_selective_refresh' => true,
'show_instance_in_rest' => true,
)
);
$this->default_title = __( 'Top Posts & Pages', 'jetpack' );
/**
* Add explanation about how the statistics are calculated.
*
* @module widgets
*
* @since 3.9.3
*/
add_action( 'jetpack_widget_top_posts_after_fields', array( $this, 'stats_explanation' ) );
add_filter( 'widget_types_to_hide_from_legacy_widget_block', array( $this, 'hide_widget_in_block_editor' ) );
}
/**
* Remove the "Top Posts and Pages" widget from the Legacy Widget block
*
* @param array $widget_types List of widgets that are currently removed from the Legacy Widget block.
* @return array $widget_types New list of widgets that will be removed.
*/
public function hide_widget_in_block_editor( $widget_types ) {
// @TODO: Hide for Simple sites when the block API starts working.
if ( ! ( new Host() )->is_wpcom_simple() ) {
$widget_types[] = 'top-posts';
}
return $widget_types;
}
/**
* Enqueue stylesheet.
*/
public function enqueue_style() {
wp_register_style( 'jetpack-top-posts-widget', plugins_url( 'top-posts/style.css', __FILE__ ), array(), '20141013' );
wp_enqueue_style( 'jetpack-top-posts-widget' );
}
/**
* Displays the form for this widget on the Widgets page of the WP Admin area.
*
* @param array $instance Instance configuration.
*
* @return void
*/
public function form( $instance ) {
$instance = wp_parse_args( (array) $instance, static::defaults() );
if ( false === $instance['title'] ) {
$instance['title'] = $this->default_title;
}
$title = stripslashes( $instance['title'] );
$count = isset( $instance['count'] ) ? (int) $instance['count'] : 10;
if ( $count < 1 || 10 < $count ) {
$count = 10;
}
$allowed_post_types = array_values( get_post_types( array( 'public' => true ) ) );
$types = isset( $instance['types'] ) ? (array) $instance['types'] : array( 'post', 'page' );
// 'likes' are not available in Jetpack
$ordering = isset( $instance['ordering'] ) && 'likes' === $instance['ordering'] ? 'likes' : 'views';
if ( isset( $instance['display'] ) && in_array( $instance['display'], array( 'grid', 'list', 'text' ), true ) ) {
$display = $instance['display'];
} else {
$display = 'text';
}
?>
<p>
<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'jetpack' ); ?></label>
<input class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" />
</p>
<p>
<label for="<?php echo esc_attr( $this->get_field_id( 'count' ) ); ?>"><?php esc_html_e( 'Maximum number of posts to show (no more than 10):', 'jetpack' ); ?></label>
<input id="<?php echo esc_attr( $this->get_field_id( 'count' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'count' ) ); ?>" type="number" value="<?php echo (int) $count; ?>" min="1" max="10" />
</p>
<?php if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) : ?>
<p>
<label><?php esc_html_e( 'Order Top Posts & Pages By:', 'jetpack' ); ?></label>
<ul>
<li><label><input id="<?php echo esc_attr( $this->get_field_id( 'ordering' ) ); ?>-likes" name="<?php echo esc_attr( $this->get_field_name( 'ordering' ) ); ?>" type="radio" value="likes" <?php checked( 'likes', $ordering ); ?> /> <?php esc_html_e( 'Likes', 'jetpack' ); ?></label></li>
<li><label><input id="<?php echo esc_attr( $this->get_field_id( 'ordering' ) ); ?>-views" name="<?php echo esc_attr( $this->get_field_name( 'ordering' ) ); ?>" type="radio" value="views" <?php checked( 'views', $ordering ); ?> /> <?php esc_html_e( 'Views', 'jetpack' ); ?></label></li>
</ul>
</p>
<?php endif; ?>
<p>
<label for="<?php echo esc_attr( $this->get_field_id( 'types' ) ); ?>"><?php esc_html_e( 'Types of pages to display:', 'jetpack' ); ?></label>
<ul>
<?php
foreach ( $allowed_post_types as $type ) {
// Get the Post Type name to display next to the checkbox.
$post_type_object = get_post_type_object( $type );
$label = $post_type_object->labels->name;
$checked = '';
if ( in_array( $type, $types, true ) ) {
$checked = 'checked="checked" ';
}
?>
<li><label>
<input
value="<?php echo esc_attr( $type ); ?>"
name="<?php echo esc_attr( $this->get_field_name( 'types' ) ); ?>[]"
id="<?php echo esc_attr( $this->get_field_id( 'types' ) . '-' . $type ); ?>"
type="checkbox"
<?php echo $checked; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
>
<?php echo esc_html( $label ); ?>
</label></li>
<?php } // End foreach ?>
</ul>
</p>
<p>
<label><?php esc_html_e( 'Display as:', 'jetpack' ); ?></label>
<ul>
<li><label><input id="<?php echo esc_attr( $this->get_field_id( 'display' ) ); ?>-text" name="<?php echo esc_attr( $this->get_field_name( 'display' ) ); ?>" type="radio" value="text" <?php checked( 'text', $display ); ?> /> <?php esc_html_e( 'Text List', 'jetpack' ); ?></label></li>
<li><label><input id="<?php echo esc_attr( $this->get_field_id( 'display' ) ); ?>-list" name="<?php echo esc_attr( $this->get_field_name( 'display' ) ); ?>" type="radio" value="list" <?php checked( 'list', $display ); ?> /> <?php esc_html_e( 'Image List', 'jetpack' ); ?></label></li>
<li><label><input id="<?php echo esc_attr( $this->get_field_id( 'display' ) ); ?>-grid" name="<?php echo esc_attr( $this->get_field_name( 'display' ) ); ?>" type="radio" value="grid" <?php checked( 'grid', $display ); ?> /> <?php esc_html_e( 'Image Grid', 'jetpack' ); ?></label></li>
</ul>
</p>
<?php
/**
* Fires after the fields are displayed in the Top Posts Widget settings in wp-admin.
*
* Allow adding extra content after the fields are displayed.
*
* @module widgets
*
* @since 3.9.3
*
* @param array $args {
* @param array $instance The widget instance.
* @param object $this The class object.
* }
*/
do_action( 'jetpack_widget_top_posts_after_fields', array( $instance, $this ) );
}
/**
* Explains how the statics are calculated.
*/
public function stats_explanation() {
echo '<p>';
esc_html_e( 'Top Posts & Pages by views are calculated from 24-48 hours of stats. They take a while to change.', 'jetpack' );
echo '</p>';
}
/**
* Deals with the settings when they are saved by the admin.
*
* @param array $new_instance New configuration values.
* @param array $old_instance Old configuration values.
*
* @return array
*/
public function update( $new_instance, $old_instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
$instance = array();
$instance['title'] = wp_kses( $new_instance['title'], array() );
if ( $instance['title'] === $this->default_title ) {
$instance['title'] = false; // Store as false in case of language change.
}
$instance['count'] = (int) $new_instance['count'];
if ( $instance['count'] < 1 || 10 < $instance['count'] ) {
$instance['count'] = 10;
}
// 'likes' are not available in Jetpack
$instance['ordering'] = isset( $new_instance['ordering'] ) && 'likes' === $new_instance['ordering']
? 'likes'
: 'views';
$allowed_post_types = array_values( get_post_types( array( 'public' => true ) ) );
$instance['types'] = $new_instance['types'];
foreach ( $new_instance['types'] as $key => $type ) {
if ( ! in_array( $type, $allowed_post_types, true ) ) {
unset( $new_instance['types'][ $key ] );
}
}
if ( isset( $new_instance['display'] ) && in_array( $new_instance['display'], array( 'grid', 'list', 'text' ), true ) ) {
$instance['display'] = $new_instance['display'];
} else {
$instance['display'] = 'text';
}
/**
* Filters Top Posts Widget settings before they're saved.
*
* @module widgets
*
* @since 3.9.3
*
* @param array $instance The santized widget instance. Only contains data processed by the current widget.
* @param array $new_instance The new widget instance before sanitization.
*/
$instance = apply_filters( 'jetpack_top_posts_saving', $instance, $new_instance );
return $instance;
}
/**
* Outputs the HTML for this widget.
*
* @param array $args An array of standard parameters for widgets in this theme.
* @param array $instance An array of settings for this widget instance.
*
* @return void Echoes it's output
*/
public function widget( $args, $instance ) {
/** This action is documented in modules/widgets/gravatar-profile.php */
do_action( 'jetpack_stats_extra', 'widget_view', 'top_posts' );
$instance = wp_parse_args( (array) $instance, static::defaults() );
$title = isset( $instance['title'] ) ? $instance['title'] : false;
if ( false === $title ) {
$title = $this->default_title;
}
/** This filter is documented in core/src/wp-includes/default-widgets.php */
$title = apply_filters( 'widget_title', $title );
// Enqueue front end assets.
$this->enqueue_style();
$count = isset( $instance['count'] ) ? (int) $instance['count'] : false;
if ( $count < 1 || 10 < $count ) {
$count = 10;
}
/**
* Control the number of displayed posts.
*
* @module widgets
*
* @since 3.3.0
*
* @param string $count Number of Posts displayed in the Top Posts widget. Default is 10.
*/
$count = apply_filters( 'jetpack_top_posts_widget_count', $count );
$types = isset( $instance['types'] ) ? (array) $instance['types'] : array( 'post', 'page' );
// 'likes' are not available in Jetpack
$ordering = isset( $instance['ordering'] ) && 'likes' === $instance['ordering']
? 'likes'
: 'views';
if (
isset( $instance['display'] )
&& in_array( $instance['display'], array( 'grid', 'list', 'text' ), true )
) {
$display = $instance['display'];
} else {
$display = 'text';
}
$get_image_options = array();
if ( 'text' !== $display ) {
$get_image_options = array(
'fallback_to_avatars' => true,
/** This filter is documented in modules/stats.php */
'gravatar_default' => apply_filters( 'jetpack_static_url', set_url_scheme( 'https://en.wordpress.com/i/logo/white-gray-80.png' ) ),
'avatar_size' => 40,
'width' => null,
'height' => null,
);
if ( 'grid' === $display ) {
$get_image_options['avatar_size'] = 200;
}
/**
* Top Posts Widget Image options.
*
* @module widgets
*
* @since 1.8.0
*
* @param array $get_image_options {
* Array of Image options.
* @type bool true Should we default to Gravatars when no image is found? Default is true.
* @type string $gravatar_default Default Image URL if no Gravatar is found.
* @type int $avatar_size Default Image size.
* @type mixed $width Image width, not set by default and $avatar_size is used instead.
* @type mixed $height Image height, not set by default and $avatar_size is used instead.
* }
*/
$get_image_options = apply_filters( 'jetpack_top_posts_widget_image_options', $get_image_options );
}
if ( function_exists( 'wpl_get_blogs_most_liked_posts' ) && 'likes' === $ordering ) {
$posts = $this->get_by_likes( $count, $types );
} else {
$posts = $this->get_by_views( $count, $args, $types );
}
echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
if ( ! empty( $title ) ) {
echo $args['before_title'] . $title . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/*
* If we have no posts, add some fallback posts
* and display a fallback message for admins.
*/
if ( ! $posts ) {
if ( current_user_can( 'edit_theme_options' ) ) {
echo self::fallback_message(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
$posts = $this->get_fallback_posts( $count, $types );
}
/*
* Display our posts.
*/
/**
* Filter the layout of the Top Posts Widget
*
* @module widgets
*
* @since 6.4.0
*
* @param string $layout layout of the Top Posts Widget (empty string).
* @param array $posts IDs of the posts to be displayed.
* @param array $display Display option from widget form.
*/
$layout = apply_filters( 'jetpack_top_posts_widget_layout', '', $posts, $display );
if ( ! empty( $layout ) ) {
echo $layout; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
switch ( $display ) {
case 'list':
case 'grid':
// Keep the avatar_size as default dimensions for backward compatibility.
$width = (int) $get_image_options['avatar_size'];
$height = (int) $get_image_options['avatar_size'];
// Check if the user has changed the width.
if ( ! empty( $get_image_options['width'] ) ) {
$width = (int) $get_image_options['width'];
}
// Check if the user has changed the height.
if ( ! empty( $get_image_options['height'] ) ) {
$height = (int) $get_image_options['height'];
}
foreach ( $posts as &$post ) {
$image = Jetpack_PostImages::get_image(
$post['post_id'],
array(
'fallback_to_avatars' => (bool) $get_image_options['fallback_to_avatars'],
'width' => (int) $width,
'height' => (int) $height,
'avatar_size' => (int) $get_image_options['avatar_size'],
)
);
if ( $image ) {
$post['image'] = Jetpack_PostImages::fit_image_url(
$image['src'],
$width,
$height
);
$post['image_srcset'] = Jetpack_PostImages::generate_cropped_srcset(
$image,
$width,
$height
);
if ( empty( $post['image_srcset'] ) ) {
$post['image_srcset'] = "{$post['image']} 1x";
}
}
}
unset( $post );
if ( 'grid' === $display ) {
echo "<div class='widgets-grid-layout no-grav'>\n";
foreach ( $posts as $post ) {
echo '<div class="widget-grid-view-image">';
/**
* Fires before each Top Post result, inside <li>.
*
* @module widgets
*
* @since 3.2.0
*
* @param string $post['post_id'] Post ID.
*/
do_action( 'jetpack_widget_top_posts_before_post', $post['post_id'] );
/**
* Filter the permalink of items in the Top Posts widget.
*
* @module widgets
*
* @since 4.4.0
*
* @param string $post['permalink'] Post permalink.
* @param array $post Post array.
*/
$filtered_permalink = apply_filters( 'jetpack_top_posts_widget_permalink', $post['permalink'], $post );
if ( $post['image'] ) {
printf(
'<a href="%1$s" title="%2$s" class="bump-view" data-bump-view="tp"%3$s><img loading="lazy" width="%4$d" height="%5$d" src="%6$s" srcset="%7$s" alt="%2$s" data-pin-nopin="true"/></a>',
esc_url( $filtered_permalink ),
esc_attr( wp_kses( $post['title'], array() ) ),
( get_queried_object_id() === $post['post_id'] ? ' aria-current="page"' : '' ),
absint( $width ),
absint( $height ),
esc_url( $post['image'] ),
esc_attr( $post['image_srcset'] )
);
}
/**
* Fires after each Top Post result, inside <li>.
*
* @module widgets
*
* @since 3.2.0
*
* @param string $post['post_id'] Post ID.
*/
do_action( 'jetpack_widget_top_posts_after_post', $post['post_id'] );
echo '</div>';
}
echo "</div>\n";
} else {
echo "<ul class='widgets-list-layout no-grav'>\n";
foreach ( $posts as $post ) {
echo '<li>';
/** This action is documented in modules/widgets/top-posts.php */
do_action( 'jetpack_widget_top_posts_before_post', $post['post_id'] );
/** This filter is documented in modules/widgets/top-posts.php */
$filtered_permalink = apply_filters( 'jetpack_top_posts_widget_permalink', $post['permalink'], $post );
if ( $post['image'] ) {
printf(
'<a href="%1$s" title="%2$s" class="bump-view" data-bump-view="tp"%3$s><img loading="lazy" width="%4$d" height="%5$d" src="%6$s" srcset="%7$s" alt="%2$s" data-pin-nopin="true" class="widgets-list-layout-blavatar" /></a>',
esc_url( $filtered_permalink ),
esc_attr( wp_kses( $post['title'], array() ) ),
( get_queried_object_id() === $post['post_id'] ? ' aria-current="page"' : '' ),
absint( $width ),
absint( $height ),
esc_url( $post['image'] ),
esc_attr( $post['image_srcset'] )
);
}
printf(
'<div class="widgets-list-layout-links">
<a href="%1$s" title="%2$s" class="bump-view" data-bump-view="tp"%3$s>%4$s</a>
</div>
',
esc_url( $filtered_permalink ),
esc_attr( wp_kses( $post['title'], array() ) ),
( get_queried_object_id() === $post['post_id'] ? ' aria-current="page"' : '' ),
esc_html( wp_kses( $post['title'], array() ) )
);
/** This action is documented in modules/widgets/top-posts.php */
do_action( 'jetpack_widget_top_posts_after_post', $post['post_id'] );
echo '</li>';
}
echo "</ul>\n";
}
break;
default:
echo '<ul>';
foreach ( $posts as $post ) {
echo '<li>';
/** This action is documented in modules/widgets/top-posts.php */
do_action( 'jetpack_widget_top_posts_before_post', $post['post_id'] );
/** This filter is documented in modules/widgets/top-posts.php */
$filtered_permalink = apply_filters( 'jetpack_top_posts_widget_permalink', $post['permalink'], $post );
printf(
'<a href="%1$s" class="bump-view" data-bump-view="tp"%2$s>%3$s</a>',
esc_url( $filtered_permalink ),
( get_queried_object_id() === $post['post_id'] ? ' aria-current="page"' : '' ),
esc_html( wp_kses( $post['title'], array() ) )
);
/** This action is documented in modules/widgets/top-posts.php */
do_action( 'jetpack_widget_top_posts_after_post', $post['post_id'] );
echo '</li>';
}
echo '</ul>';
break;
}
echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Display a message with recommendations when there are no recorded top posts.
*
* @return string $fallback_message
*/
private static function fallback_message() {
$link = esc_url( Redirect::get_url( 'jetpack-support-getting-more-views-and-traffic' ) );
if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
$link = 'https://en.support.wordpress.com/getting-more-site-traffic/';
}
$fallback_message = '<p>';
$fallback_message .= sprintf(
wp_kses(
/* Translators: Placeholder: link to the Jetpack support article. */
__( 'There are no popular posts to display. Instead, your visitors will see a list of your recent posts below. <a href="%s" target="_blank">Want more traffic?</a>', 'jetpack' ),
array(
'a' => array(
'href' => array(),
'target' => array(),
),
)
),
esc_url( $link )
);
$fallback_message .= '<p>';
return $fallback_message;
}
/**
* Widget default option values.
*/
public static function defaults() {
return array(
'title' => esc_html__( 'Top Posts & Pages', 'jetpack' ),
'count' => absint( 10 ),
'types' => array( 'post', 'page' ),
'ordering' => 'views',
'display' => 'text',
);
}
/**
* Get most liked posts
*
* ONLY TO BE USED IN WPCOM
*
* @since 8.4.0 Added $types param
*
* @param int $count The maximum number of posts to be returned.
* @param array $types The post types that should be returned. Optional. Defaults to 'post' and 'page'.
*
* @return array array of posts.
*/
public function get_by_likes( $count, $types = array( 'post', 'page' ) ) {
$post_likes = wpl_get_blogs_most_liked_posts();
if ( ! $post_likes ) {
return array();
}
return $this->get_posts( array_keys( $post_likes ), $count, $types );
}
/**
* Get the top posts based on views
*
* @since 8.4.0 Added $types param
*
* @param int $count The maximum number of posts to be returned.
* @param array $args The widget arguments.
* @param array $types The post types that should be returned.
*
* @return array array of posts. Defaults to 'post' and 'page'.
*/
public function get_by_views( $count, $args, $types = array( 'post', 'page' ) ) {
if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
$post_views = wp_cache_get( "get_top_posts_$count", 'stats' );
if ( false === $post_views ) {
$stats_get_daily_history = stats_get_daily_history(
false,
get_current_blog_id(),
'postviews',
'post_id',
false,
2,
'',
$count * 2 + 10,
true
);
$post_views = array_shift( $stats_get_daily_history );
unset( $post_views[0] );
wp_cache_add( "get_top_posts_$count", $post_views, 'stats', 1200 );
}
return $this->get_posts( array_keys( $post_views ), $count, $types );
}
/**
* Filter the number of days used to calculate Top Posts for the Top Posts widget.
* We do not recommend accessing more than 10 days of results at one.
* When more than 10 days of results are accessed at once, results should be cached via the WordPress transients API.
* Querying for -1 days will give results for an infinite number of days.
*
* @module widgets
*
* @since 3.9.3
*
* @param int 2 Number of days. Default is 2.
* @param array $args The widget arguments.
*/
$days = (int) apply_filters( 'jetpack_top_posts_days', 2, $args );
/** Handling situations where the number of days makes no sense - allows for unlimited days where $days = -1 */
if ( 0 === $days || false === $days ) {
$days = 2;
}
$query_args = array(
'max' => 11,
'summarize' => 1,
'num' => (int) $days,
);
$wpcom_stats = new WPCOM_Stats();
$post_view_posts = $wpcom_stats->convert_stats_array_to_object(
$wpcom_stats->get_top_posts( $query_args )
);
if ( ! isset( $post_view_posts->summary ) || empty( $post_view_posts->summary->postviews ) ) {
return array();
}
$post_view_ids = array_filter( wp_list_pluck( $post_view_posts->summary->postviews, 'id' ) );
if ( ! $post_view_ids ) {
return array();
}
return $this->get_posts( $post_view_ids, $count, $types );
}
/**
* Get some posts if no posts are found in the stats API
*
* @since 8.4.0 Added $count and $types
*
* @param int $count The maximum number of posts to be returned.
* @param array $types The post types that should be returned.
* @return array
*/
public function get_fallback_posts( $count = 10, $types = array( 'post', 'page' ) ) {
$post_query = new WP_Query();
if ( ! is_array( $types ) || empty( $types ) ) {
$types = array( 'post', 'page' );
}
$posts = $post_query->query(
array(
'posts_per_page' => $count,
'post_status' => 'publish',
'post_type' => $types,
'no_found_rows' => true,
'fields' => 'ids',
)
);
if ( ! $posts ) {
return array();
}
return $this->get_posts( $posts, $count, $types );
}
/**
* Get posts from an array of IDs
*
* @since 8.4.0 Added $types parameters
*
* @param array $post_ids The post IDs.
* @param int $count The maximum number of posts to return.
* @param array $types The post types that should be returned. Optional. Defaults to 'post', 'page'.
* @return array
*/
public function get_posts( $post_ids, $count, $types = array( 'post', 'page' ) ) {
$counter = 0;
if ( ! is_array( $types ) || empty( $types ) ) {
$types = array( 'post', 'page' );
}
$posts = array();
foreach ( (array) $post_ids as $post_id ) {
$post = get_post( $post_id );
if ( ! $post ) {
continue;
}
/**
* Attachment pages use the 'inherit' post status by default.
* To be able to remove attachment pages from private and password protect posts,
* we need to replace their post status by the parent post' status.
*/
if ( 'inherit' === $post->post_status && 'attachment' === $post->post_type ) {
$post->post_status = get_post_status( $post_id );
}
// hide private and password protected posts.
if ( 'publish' !== $post->post_status || ! empty( $post->post_password ) ) {
continue;
}
// Filter by chosen Post Types.
if ( ! in_array( $post->post_type, $types, true ) ) {
continue;
}
// Both get HTML stripped etc on display.
if ( empty( $post->post_title ) ) {
$title_source = $post->post_content;
$title = wp_html_excerpt( $title_source, 50 );
$title .= '…';
} else {
$title = $post->post_title;
}
$permalink = get_permalink( $post->ID );
$post_type = $post->post_type;
$posts[] = compact( 'title', 'permalink', 'post_id', 'post_type' );
++$counter;
if ( $counter == $count ) { // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual
break; // only need to load and show x number of likes.
}
}
/**
* Filter the Top Posts and Pages.
*
* @module widgets
*
* @since 3.0.0
*
* @param array $posts Array of the most popular posts.
* @param array $post_ids Array of Post IDs.
* @param string $count Number of Top Posts we want to display.
*/
return apply_filters( 'jetpack_widget_get_top_posts', $posts, $post_ids, $count );
}
}
/**
* Create a shortcode to display the widget anywhere.
*
* @since 3.9.2
*
* @param array $instance Saved values from database.
*/
function jetpack_do_top_posts_widget( $instance ) {
// Post Types can't be entered as an array in the shortcode parameters.
if ( isset( $instance['types'] ) && is_string( $instance['types'] ) ) {
$instance['types'] = explode( ',', $instance['types'] );
}
$instance = shortcode_atts(
Jetpack_Top_Posts_Widget::defaults(),
$instance,
'jetpack_top_posts_widget'
);
// Add a class to allow styling.
$args = array(
'before_widget' => sprintf( '<div class="%s">', 'jetpack_top_posts_widget' ),
);
ob_start();
the_widget( 'Jetpack_Top_Posts_Widget', $instance, $args );
$output = ob_get_clean();
return $output;
}
add_shortcode( 'jetpack_top_posts_widget', 'jetpack_do_top_posts_widget' );