subscribers.php — Jetpack – WP Security, Backup, Speed, & Growth 14.2.2

jetpack / _inc / lib / core-api / wpcom-endpoints / subscribers.php

jetpack / _inc / lib / core-api / wpcom-endpoints Last commit date

subscribers.php

110 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Get subscriber count from Jetpack's Subscriptions module.
4	*
5	* @package automattic/jetpack
6	*/
7	use Automattic\Jetpack\Constants;
8
9	/**
10	* Subscribers: Get subscriber count
11	*
12	* @since 6.9
13	*/
14	class WPCOM_REST_API_V2_Endpoint_Subscribers extends WP_REST_Controller {
15	/**
16	* Constructor.
17	*/
18	public function __construct() {
19	$this->namespace = 'wpcom/v2';
20	$this->rest_base = 'subscribers';
21	// This endpoint does not need to connect directly to Jetpack sites.
22	$this->wpcom_is_wpcom_only_endpoint = true;
23	add_action( 'rest_api_init', array( $this, 'register_routes' ) );
24	}
25
26	/**
27	* Register API routes.
28	*/
29	public function register_routes() {
30	// GET /sites/<blog_id>/subscribers/count - Return number of subscribers for this site.
31	register_rest_route(
32	$this->namespace,
33	'/' . $this->rest_base . '/count',
34	array(
35	array(
36	'methods' => WP_REST_Server::READABLE,
37	'callback' => array( $this, 'get_subscriber_count' ),
38	'permission_callback' => array( $this, 'readable_permission_check' ),
39	),
40	)
41	);
42	// GET /sites/<blog_id>/subscriber/counts - Return splitted number of subscribers for this site
43	register_rest_route(
44	$this->namespace,
45	'/' . $this->rest_base . '/counts',
46	array(
47	array(
48	'methods' => WP_REST_Server::READABLE,
49	'callback' => array( $this, 'get_subscriber_counts' ),
50	'permission_callback' => array( $this, 'readable_permission_check' ),
51	),
52	)
53	);
54	}
55
56	/**
57	* Permission check. Only authors can access this endpoint.
58	*/
59	public function readable_permission_check() {
60	// @phan-suppress-next-line PhanDeprecatedFunction -- @todo Switch to current_user_can_for_site when we drop support for WP 6.6.
61	if ( ! current_user_can_for_blog( get_current_blog_id(), 'edit_posts' ) ) {
62	return new WP_Error( 'authorization_required', 'Only users with the permission to edit posts can see the subscriber count.', array( 'status' => 401 ) );
63	}
64
65	return true;
66	}
67
68	/**
69	* Retrieves subscriber count
70	*
71	* @param WP_REST_Request $request incoming API request info.
72	* @return array data object containing subscriber count
73	*/
74	public function get_subscriber_count( $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
75	// Get the most up to date subscriber count when request is not a test.
76	if ( ! Constants::is_defined( 'TESTING_IN_JETPACK' ) ) {
77	delete_transient( 'wpcom_subscribers_total' );
78	delete_transient( 'wpcom_subscribers_total_no_publicize' );
79	}
80	$subscriber_count = Jetpack_Subscriptions_Widget::fetch_subscriber_count();
81
82	return array(
83	'count' => $subscriber_count,
84	);
85	}
86
87	/**
88	* Retrieves splitted subscriber counts
89	*
90	* @return array data object containing subscriber counts ['email_subscribers' => 0, 'social_followers' => 0]
91	*/
92	public function get_subscriber_counts() {
93	if ( ! Constants::is_defined( 'TESTING_IN_JETPACK' ) ) {
94	delete_transient( 'wpcom_subscribers_totals' );
95	}
96
97	$subscriber_info = Automattic\Jetpack\Extensions\Subscriptions\fetch_subscriber_counts();
98	$subscriber_counts = $subscriber_info['value'];
99
100	return array( 'counts' => $subscriber_counts );
101	}
102	}
103
104	if (
105	Jetpack::is_module_active( 'subscriptions' ) \|\|
106	( Constants::is_defined( 'TESTING_IN_JETPACK' ) && Constants::get_constant( 'TESTING_IN_JETPACK' ) )
107	) {
108	wpcom_rest_api_v2_load_plugin( 'WPCOM_REST_API_V2_Endpoint_Subscribers' );
109	}
110