business-hours.php
4 years ago
class-wpcom-rest-api-v2-endpoint-admin-menu.php
2 years ago
class-wpcom-rest-api-v2-endpoint-ai.php
2 years ago
class-wpcom-rest-api-v2-endpoint-app-media.php
2 years ago
class-wpcom-rest-api-v2-endpoint-blog-stats.php
2 years ago
class-wpcom-rest-api-v2-endpoint-external-media.php
2 years ago
class-wpcom-rest-api-v2-endpoint-following.php
2 years ago
class-wpcom-rest-api-v2-endpoint-goodreads.php
2 years ago
class-wpcom-rest-api-v2-endpoint-google-docs.php
4 years ago
class-wpcom-rest-api-v2-endpoint-instagram-gallery.php
3 years ago
class-wpcom-rest-api-v2-endpoint-mailchimp.php
3 years ago
class-wpcom-rest-api-v2-endpoint-newsletter-categories-list.php
2 years ago
class-wpcom-rest-api-v2-endpoint-newsletter-categories-subscriptions-count.php
2 years ago
class-wpcom-rest-api-v2-endpoint-podcast-player.php
2 years ago
class-wpcom-rest-api-v2-endpoint-publicize-share-post.php
3 years ago
class-wpcom-rest-api-v2-endpoint-related-posts.php
2 years ago
class-wpcom-rest-api-v2-endpoint-resolve-redirect.php
2 years ago
class-wpcom-rest-api-v2-endpoint-search.php
4 years ago
class-wpcom-rest-api-v2-endpoint-send-email-preview.php
2 years ago
class-wpcom-rest-api-v2-endpoint-template-loader.php
3 years ago
class-wpcom-rest-api-v2-endpoint-top-posts.php
2 years ago
class-wpcom-rest-api-v2-endpoint-transient.php
5 years ago
class-wpcom-rest-api-v3-endpoint-blogging-prompts.php
2 years ago
gutenberg-available-extensions.php
2 years ago
hello.php
4 years ago
memberships.php
2 years ago
publicize-connection-test-results.php
3 years ago
publicize-connections.php
2 years ago
publicize-services.php
3 years ago
service-api-keys.php
2 years ago
sites-posts-featured-media-url.php
2 years ago
subscribers.php
3 years ago
trait-wpcom-rest-api-proxy-request-trait.php
2 years ago
subscribers.php
109 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 | if ( ! current_user_can_for_blog( get_current_blog_id(), 'edit_posts' ) ) { |
| 61 | return new WP_Error( 'authorization_required', 'Only users with the permission to edit posts can see the subscriber count.', array( 'status' => 401 ) ); |
| 62 | } |
| 63 | |
| 64 | return true; |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Retrieves subscriber count |
| 69 | * |
| 70 | * @param WP_REST_Request $request incoming API request info. |
| 71 | * @return array data object containing subscriber count |
| 72 | */ |
| 73 | public function get_subscriber_count( $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable |
| 74 | // Get the most up to date subscriber count when request is not a test. |
| 75 | if ( ! Constants::is_defined( 'TESTING_IN_JETPACK' ) ) { |
| 76 | delete_transient( 'wpcom_subscribers_total' ); |
| 77 | delete_transient( 'wpcom_subscribers_total_no_publicize' ); |
| 78 | } |
| 79 | $subscriber_count = Jetpack_Subscriptions_Widget::fetch_subscriber_count(); |
| 80 | |
| 81 | return array( |
| 82 | 'count' => $subscriber_count, |
| 83 | ); |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Retrieves splitted subscriber counts |
| 88 | * |
| 89 | * @return array data object containing subscriber counts ['email_subscribers' => 0, 'social_followers' => 0] |
| 90 | */ |
| 91 | public function get_subscriber_counts() { |
| 92 | if ( ! Constants::is_defined( 'TESTING_IN_JETPACK' ) ) { |
| 93 | delete_transient( 'wpcom_subscribers_totals' ); |
| 94 | } |
| 95 | |
| 96 | $subscriber_info = Automattic\Jetpack\Extensions\Subscriptions\fetch_subscriber_counts(); |
| 97 | $subscriber_counts = $subscriber_info['value']; |
| 98 | |
| 99 | return array( 'counts' => $subscriber_counts ); |
| 100 | } |
| 101 | } |
| 102 | |
| 103 | if ( |
| 104 | Jetpack::is_module_active( 'subscriptions' ) || |
| 105 | ( Constants::is_defined( 'TESTING_IN_JETPACK' ) && Constants::get_constant( 'TESTING_IN_JETPACK' ) ) |
| 106 | ) { |
| 107 | wpcom_rest_api_v2_load_plugin( 'WPCOM_REST_API_V2_Endpoint_Subscribers' ); |
| 108 | } |
| 109 |