admin-pages
1 week ago
core-api
2 days ago
debugger
1 month ago
markdown
7 months ago
class-jetpack-ai-helper.php
4 months ago
class-jetpack-application-password-extras.php
3 months ago
class-jetpack-blog-stats-helper.php
7 months ago
class-jetpack-currencies.php
1 year ago
class-jetpack-instagram-gallery-helper.php
1 month ago
class-jetpack-mapbox-helper.php
3 years ago
class-jetpack-newsletter-category-helper.php
7 months ago
class-jetpack-podcast-feed-locator.php
1 month ago
class-jetpack-podcast-helper.php
5 months ago
class-jetpack-recommendations.php
1 month ago
class-jetpack-spinner.php
2 months ago
class-jetpack-top-posts-helper.php
1 week ago
class.color.php
1 year ago
class.core-rest-api-endpoints.php
1 week ago
class.jetpack-automatic-install-skin.php
2 years ago
class.jetpack-iframe-embed.php
3 years ago
class.jetpack-password-checker.php
7 months ago
class.jetpack-search-performance-logger.php
4 years ago
class.media-extractor.php
1 month ago
class.media-summary.php
1 week ago
class.media.php
7 months ago
components.php
7 months ago
debugger.php
1 month ago
icalendar-reader.php
1 month ago
markdown.php
7 months ago
plans.php
4 years ago
plugins.php
4 years ago
tonesque.php
7 months ago
widgets.php
3 months ago
class-jetpack-top-posts-helper.php
161 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Top Posts & Pages block helper. |
| 4 | * |
| 5 | * @package automattic/jetpack |
| 6 | */ |
| 7 | |
| 8 | use Automattic\Jetpack\Stats\WPCOM_Stats; |
| 9 | |
| 10 | /** |
| 11 | * Class Jetpack_Top_Posts_Helper |
| 12 | */ |
| 13 | class Jetpack_Top_Posts_Helper { |
| 14 | /** |
| 15 | * Returns user's top posts. |
| 16 | * |
| 17 | * @param int $period Period of days to draw stats from. |
| 18 | * @param int $items_count Optional. Number of items to display. |
| 19 | * @param string $types Optional. Content types to include. |
| 20 | * @return array |
| 21 | */ |
| 22 | public static function get_top_posts( $period, $items_count = null, $types = null ) { |
| 23 | $all_time_days = floor( ( time() - strtotime( get_option( 'site_created_date' ) ) ) / ( 60 * 60 * 24 * 365 ) ); |
| 24 | |
| 25 | // While we only display ten posts, users can filter out content types. |
| 26 | // As such, we should obtain a few spare posts from the Stats endpoint. |
| 27 | $posts_to_obtain_count = 30; |
| 28 | |
| 29 | // We should not override cache when displaying the block on the frontend. |
| 30 | // But we should allow instant preview of changes when editing the block. |
| 31 | $is_rendering_block = ! empty( $types ); |
| 32 | $override_cache = ! $is_rendering_block; |
| 33 | |
| 34 | $query_args = array( |
| 35 | 'max' => $posts_to_obtain_count, |
| 36 | 'summarize' => true, |
| 37 | 'num' => $period !== 'all-time' ? $period : $all_time_days, |
| 38 | 'period' => 'day', |
| 39 | ); |
| 40 | |
| 41 | // Atomic or self-hosted sites via WPCOM public v1.1 endpoint. |
| 42 | if ( ! defined( 'IS_WPCOM' ) || ! IS_WPCOM ) { |
| 43 | $data = ( new WPCOM_Stats() )->get_top_posts( $query_args, $override_cache ); |
| 44 | } else { |
| 45 | // Directly access posts on WPCOM, as Simple sites run on the same environment. |
| 46 | require_lib( 'jetpack-stats' ); |
| 47 | if ( class_exists( '\Jetpack\Stats\Top_Posts' ) ) { |
| 48 | // @phan-suppress-next-line PhanUndeclaredClassMethod |
| 49 | $data = ( new \Jetpack\Stats\Top_Posts() )->get_top_posts( get_current_blog_id(), $query_args ); |
| 50 | } else { |
| 51 | $data = array( 'summary' => array( 'postviews' => array() ) ); |
| 52 | } |
| 53 | } |
| 54 | |
| 55 | if ( is_wp_error( $data ) ) { |
| 56 | $data = array( 'summary' => array( 'postviews' => array() ) ); |
| 57 | } |
| 58 | |
| 59 | // Remove posts that have subsequently been deleted. |
| 60 | $data['summary']['postviews'] = array_filter( |
| 61 | $data['summary']['postviews'], |
| 62 | function ( $item ) { |
| 63 | return get_post_status( $item['id'] ) === 'publish'; |
| 64 | } |
| 65 | ); |
| 66 | |
| 67 | $posts_retrieved = is_countable( $data['summary']['postviews'] ) ? count( $data['summary']['postviews'] ) : 0; |
| 68 | |
| 69 | // Fallback to random posts if user does not have enough top content. |
| 70 | if ( $posts_retrieved < $posts_to_obtain_count ) { |
| 71 | $args = array( |
| 72 | 'numberposts' => $posts_to_obtain_count - $posts_retrieved, |
| 73 | 'exclude' => array_column( $data['summary']['postviews'], 'id' ), |
| 74 | 'orderby' => 'rand', |
| 75 | 'post_status' => 'publish', |
| 76 | ); |
| 77 | |
| 78 | $random_posts = get_posts( $args ); |
| 79 | |
| 80 | foreach ( $random_posts as $post ) { |
| 81 | $random_posts_data = array( |
| 82 | 'id' => $post->ID, |
| 83 | 'href' => get_permalink( $post->ID ), |
| 84 | 'date' => $post->post_date, |
| 85 | 'title' => $post->post_title, |
| 86 | 'type' => 'post', |
| 87 | 'public' => true, |
| 88 | ); |
| 89 | |
| 90 | $data['summary']['postviews'][] = $random_posts_data; |
| 91 | } |
| 92 | |
| 93 | $data['summary']['postviews'] = array_slice( $data['summary']['postviews'], 0, 10 ); |
| 94 | } |
| 95 | |
| 96 | $top_posts = array(); |
| 97 | |
| 98 | foreach ( $data['summary']['postviews'] as $post ) { |
| 99 | $post_id = $post['id']; |
| 100 | $thumbnail = get_the_post_thumbnail_url( $post_id ); |
| 101 | |
| 102 | if ( ! $thumbnail ) { |
| 103 | $post_images = get_attached_media( 'image', $post_id ); |
| 104 | $post_image = reset( $post_images ); |
| 105 | if ( $post_image ) { |
| 106 | $thumbnail = wp_get_attachment_url( $post_image->ID ); |
| 107 | } |
| 108 | } |
| 109 | |
| 110 | if ( $post['public'] ) { |
| 111 | $top_post = array( |
| 112 | 'id' => $post_id, |
| 113 | 'author' => get_the_author_meta( 'display_name', get_post_field( 'post_author', $post_id ) ), |
| 114 | 'context' => get_the_category( $post_id ) ? get_the_category( $post_id ) : get_the_tags( $post_id ), |
| 115 | // Use the local permalink to avoid stale values from the Stats API. |
| 116 | 'href' => get_permalink( $post_id ), |
| 117 | 'date' => get_the_date( '', $post_id ), |
| 118 | 'title' => $post['title'], |
| 119 | 'type' => $post['type'], |
| 120 | 'public' => $post['public'], |
| 121 | 'views' => $post['views'] ?? 0, |
| 122 | 'thumbnail' => $thumbnail, |
| 123 | ); |
| 124 | |
| 125 | /** |
| 126 | * Allows modifying the title of each individual post returned by the Top Posts helper. |
| 127 | * |
| 128 | * Applies to both the Top Posts block's front-end output and the REST |
| 129 | * response used by the block editor preview. |
| 130 | * |
| 131 | * @module stats |
| 132 | * |
| 133 | * @since 15.8 |
| 134 | * |
| 135 | * @param string $post_title Post title. |
| 136 | * @param array $top_post Information about the post. |
| 137 | */ |
| 138 | $top_post['title'] = apply_filters( 'jetpack_top_posts_item_title', $top_post['title'], $top_post ); |
| 139 | |
| 140 | $top_posts[] = $top_post; |
| 141 | } |
| 142 | } |
| 143 | |
| 144 | // This applies for rendering the block front-end, but not for editing it. |
| 145 | if ( $is_rendering_block ) { |
| 146 | $acceptable_types = explode( ',', $types ); |
| 147 | |
| 148 | $top_posts = array_filter( |
| 149 | $top_posts, |
| 150 | function ( $item ) use ( $acceptable_types ) { |
| 151 | return in_array( $item['type'], $acceptable_types, true ); |
| 152 | } |
| 153 | ); |
| 154 | |
| 155 | $top_posts = array_slice( $top_posts, 0, $items_count ); |
| 156 | } |
| 157 | |
| 158 | return $top_posts; |
| 159 | } |
| 160 | } |
| 161 |