Top Posts & Pages Endpoint: Remove Unnecessary Parameters (#34614)

* Tidy up Top Posts endpoint * Fix fatal in Block Editor * Add changelog * Address review
Automattic · Feb 4, 2024 · a9797ca · a9797ca
1 parent 271bd23
commit a9797ca
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 24 deletions.
diff --git a/projects/plugins/jetpack/_inc/lib/class-jetpack-top-posts-helper.php b/projects/plugins/jetpack/_inc/lib/class-jetpack-top-posts-helper.php
@@ -15,11 +15,11 @@ class Jetpack_Top_Posts_Helper {
 	 * Returns user's top posts.
 	 *
 	 * @param int    $period       Period of days to draw stats from.
-	 * @param int    $items_count  Number of items to display.
-	 * @param string $types        Content types to include.
+	 * @param int    $items_count  Optional. Number of items to display.
+	 * @param string $types        Optional. Content types to include.
 	 * @return array
 	 */
-	public static function get_top_posts( $period, $items_count, $types ) {
+	public static function get_top_posts( $period, $items_count = null, $types = null ) {
 		$all_time_days = floor( ( time() - strtotime( get_option( 'site_created_date' ) ) ) / ( 60 * 60 * 24 * 365 ) );
 
 		// While we only display ten posts, users can filter out content types.
@@ -28,7 +28,7 @@ public static function get_top_posts( $period, $items_count, $types ) {
 
 		// We should not override cache when displaying the block on the frontend.
 		// But we should allow instant preview of changes when editing the block.
-		$is_rendering_block = isset( $types );
+		$is_rendering_block = ! empty( $types );
 		$override_cache     = ! $is_rendering_block;
 
 		$query_args = array(

diff --git a/.../jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-top-posts.php b/.../jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-top-posts.php
@@ -47,7 +47,9 @@ public function register_routes() {
 				array(
 					'methods'             => WP_REST_Server::READABLE,
 					'callback'            => array( $this, 'get_top_posts' ),
-					'permission_callback' => '__return_true',
+					'permission_callback' => function () {
+						return current_user_can( 'edit_posts' );
+					},
 					'args'                => array(
 						'period' => array(
 							'description'       => __( 'Timeframe for stats.', 'jetpack' ),
@@ -57,22 +59,6 @@ public function register_routes() {
 								return is_numeric( $param ) || is_string( $param );
 							},
 						),
-						'number' => array(
-							'description'       => __( 'Number of posts to display.', 'jetpack' ),
-							'type'              => 'integer',
-							'required'          => false,
-							'validate_callback' => function ( $param ) {
-								return is_numeric( $param );
-							},
-						),
-						'types'  => array(
-							'description'       => __( 'Types of content to include.', 'jetpack' ),
-							'type'              => 'string',
-							'required'          => false,
-							'validate_callback' => function ( $param ) {
-								return is_string( $param );
-							},
-						),
 					),
 				),
 			)
@@ -107,9 +93,7 @@ public function get_post_types() {
 	 */
 	public function get_top_posts( $request ) {
 		$period = $request->get_param( 'period' );
-		$number = $request->get_param( 'number' );
-		$types  = $request->get_param( 'types' );
-		return Jetpack_Top_Posts_Helper::get_top_posts( $period, $number, $types );
+		return Jetpack_Top_Posts_Helper::get_top_posts( $period );
 	}
 }
 

diff --git a/projects/plugins/jetpack/changelog/update-tidy-top-posts-endpoint b/projects/plugins/jetpack/changelog/update-tidy-top-posts-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: enhancement
+
+Top Posts & Pages block: Remove unnecessary parameters from endpoint.