PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 16.3-a.7
Jetpack – WP Security, Backup, Speed, & Growth v16.3-a.7
16.3-a.5 16.3-a.7 16.3-a.3 16.3-a.1 16.2 16.2-beta 12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 All 506 releases
← All changes | _inc/lib/class.core-rest-api-endpoints.php +617 -875 12.8.3 → 16.3-a.7 View file →
@@ -8,9 +8,10 @@
8 8 use Automattic\Jetpack\Connection\Client;
9 9 use Automattic\Jetpack\Connection\Manager as Connection_Manager;
10 10 use Automattic\Jetpack\Connection\Rest_Authentication;
11 11 use Automattic\Jetpack\Connection\REST_Connector;
12 -use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
12 +use Automattic\Jetpack\Connection\REST_Jetpack_AI_JWT;
13 +use Automattic\Jetpack\Connection\SSO;
13 14 use Automattic\Jetpack\Jetpack_CRM_Data;
14 15 use Automattic\Jetpack\Plugins_Installer;
15 16 use Automattic\Jetpack\Stats\Options as Stats_Options;
16 17 use Automattic\Jetpack\Status\Host;
@@ -19,9 +20,9 @@
19 20 use Automattic\Jetpack\Waf\Waf_Compatibility;
20 21
21 22 // Disable direct access.
22 23 if ( ! defined( 'ABSPATH' ) ) {
23 - exit;
24 + exit( 0 );
24 25 }
25 26
26 27 // Load WP_Error for error messages.
27 28 require_once ABSPATH . '/wp-includes/class-wp-error.php';
@@ -31,8 +32,10 @@
31 32 // Load API endpoints that are synced with WP.com
32 33 // Each of these is a class that will register its own routes on 'rest_api_init'.
33 34 require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/load-wpcom-endpoints.php';
34 35
36 +require_once JETPACK__PLUGIN_DIR . 'modules/subscriptions/class-settings.php';
37 +
35 38 /**
36 39 * Class Jetpack_Core_Json_Api_Endpoints
37 40 *
38 41 * @since 4.3.0
@@ -69,23 +72,10 @@
69 72 $module_toggle_endpoint = new Jetpack_Core_API_Module_Toggle_Endpoint( new Jetpack_IXR_Client() );
70 73 $site_endpoint = new Jetpack_Core_API_Site_Endpoint();
71 74 $widget_endpoint = new Jetpack_Core_API_Widget_Endpoint();
72 75
73 - /**
74 - * TODO: Move me somewhere that makes more sense.
75 - * Also give me permissions that aren't awful.
76 - */
77 - register_rest_route(
78 - 'jetpack/v4',
79 - 'jetpack-ai-jwt',
80 - array(
81 - 'methods' => WP_REST_Server::EDITABLE,
82 - 'callback' => __CLASS__ . '::get_openai_jwt',
83 - 'permission_callback' => function () {
84 - return ( new Connection_Manager( 'jetpack' ) )->is_user_connected() && current_user_can( 'edit_posts' );
85 - },
86 - )
87 - );
76 + // My Jetpack and Agents Manager register the same controller; its guard keeps the route registered once.
77 + ( new REST_Jetpack_AI_JWT() )->register_rest_route();
88 78
89 79 register_rest_route(
90 80 'jetpack/v4',
91 81 'plans',
@@ -115,32 +105,10 @@
115 105 'permission_callback' => __CLASS__ . '::disconnect_site_permission_callback',
116 106 )
117 107 );
118 108
119 - // Test current connection status of Jetpack.
120 109 register_rest_route(
121 110 'jetpack/v4',
122 - '/connection/test',
123 - array(
124 - 'methods' => WP_REST_Server::READABLE,
125 - 'callback' => __CLASS__ . '::jetpack_connection_test',
126 - 'permission_callback' => __CLASS__ . '::manage_modules_permission_check',
127 - )
128 - );
129 -
130 - // Endpoint specific for privileged servers to request detailed debug information.
131 - register_rest_route(
132 - 'jetpack/v4',
133 - '/connection/test-wpcom/',
134 - array(
135 - 'methods' => WP_REST_Server::READABLE,
136 - 'callback' => __CLASS__ . '::jetpack_connection_test_for_external',
137 - 'permission_callback' => __CLASS__ . '::view_jetpack_connection_test_check',
138 - )
139 - );
140 -
141 - register_rest_route(
142 - 'jetpack/v4',
143 111 '/rewind',
144 112 array(
145 113 'methods' => WP_REST_Server::READABLE,
146 114 'callback' => __CLASS__ . '::get_rewind_data',
@@ -193,33 +161,11 @@
193 161 ),
194 162 )
195 163 );
196 164
197 - // Disconnect/unlink user from WordPress.com servers.
165 + // Get current site features.
198 166 register_rest_route(
199 167 'jetpack/v4',
200 - '/connection/user',
201 - array(
202 - 'methods' => WP_REST_Server::EDITABLE,
203 - 'callback' => __CLASS__ . '::unlink_user',
204 - 'permission_callback' => __CLASS__ . '::unlink_user_permission_callback',
205 - )
206 - );
207 -
208 - // Get current site data.
209 - register_rest_route(
210 - 'jetpack/v4',
211 - '/site',
212 - array(
213 - 'methods' => WP_REST_Server::READABLE,
214 - 'callback' => __CLASS__ . '::get_site_data',
215 - 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
216 - )
217 - );
218 -
219 - // Get current site data.
220 - register_rest_route(
221 - 'jetpack/v4',
222 168 '/site/features',
223 169 array(
224 170 'methods' => WP_REST_Server::READABLE,
225 171 'callback' => array( $site_endpoint, 'get_features' ),
@@ -603,103 +549,8 @@
603 549 ),
604 550 )
605 551 );
606 552
607 - register_rest_route(
608 - 'jetpack/v4',
609 - '/recommendations/data',
610 - array(
611 - array(
612 - 'methods' => WP_REST_Server::READABLE,
613 - 'callback' => __CLASS__ . '::get_recommendations_data',
614 - 'permission_callback' => __CLASS__ . '::update_settings_permission_check',
615 - ),
616 - array(
617 - 'methods' => WP_REST_Server::EDITABLE,
618 - 'callback' => __CLASS__ . '::update_recommendations_data',
619 - 'permission_callback' => __CLASS__ . '::update_settings_permission_check',
620 - 'args' => array(
621 - 'data' => array(
622 - 'required' => true,
623 - 'type' => 'object',
624 - 'validate_callback' => __CLASS__ . '::validate_recommendations_data',
625 - ),
626 - ),
627 - ),
628 - )
629 - );
630 -
631 - register_rest_route(
632 - 'jetpack/v4',
633 - '/recommendations/step',
634 - array(
635 - array(
636 - 'methods' => WP_REST_Server::READABLE,
637 - 'callback' => __CLASS__ . '::get_recommendations_step',
638 - 'permission_callback' => __CLASS__ . '::update_settings_permission_check',
639 - ),
640 - array(
641 - 'methods' => WP_REST_Server::EDITABLE,
642 - 'callback' => __CLASS__ . '::update_recommendations_step',
643 - 'permission_callback' => __CLASS__ . '::update_settings_permission_check',
644 - 'args' => array(
645 - 'step' => array(
646 - 'required' => true,
647 - 'type' => 'string',
648 - 'validate_callback' => __CLASS__ . '::validate_string',
649 - ),
650 - ),
651 - ),
652 - )
653 - );
654 -
655 - register_rest_route(
656 - 'jetpack/v4',
657 - '/recommendations/product-suggestions',
658 - array(
659 - array(
660 - 'methods' => WP_REST_Server::READABLE,
661 - 'callback' => __CLASS__ . '::get_recommendations_product_suggestions',
662 - 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
663 - ),
664 - )
665 - );
666 -
667 - register_rest_route(
668 - 'jetpack/v4',
669 - '/recommendations/upsell',
670 - array(
671 - array(
672 - 'methods' => WP_REST_Server::READABLE,
673 - 'callback' => __CLASS__ . '::get_recommendations_upsell',
674 - 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
675 - ),
676 - )
677 - );
678 -
679 - register_rest_route(
680 - 'jetpack/v4',
681 - '/recommendations/conditional',
682 - array(
683 - array(
684 - 'methods' => WP_REST_Server::READABLE,
685 - 'callback' => __CLASS__ . '::get_conditional_recommendations',
686 - 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
687 - ),
688 - )
689 - );
690 -
691 - // Get site discount.
692 - register_rest_route(
693 - 'jetpack/v4',
694 - '/site/discount',
695 - array(
696 - 'methods' => WP_REST_Server::READABLE,
697 - 'callback' => __CLASS__ . '::get_site_discount',
698 - 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
699 - )
700 - );
701 -
702 553 /*
703 554 * Manage the Jetpack CRM plugin's integration with Jetpack contact forms.
704 555 */
705 556 register_rest_route(
@@ -754,256 +605,110 @@
754 605 'permission_callback' => __CLASS__ . '::manage_modules_permission_check',
755 606 )
756 607 );
757 608
758 - // Get Jetpack introduction offers
609 + // Save subscriber token and redirect
759 610 register_rest_route(
760 611 'jetpack/v4',
761 - '/intro-offers',
612 + '/subscribers/auth',
762 613 array(
763 614 'methods' => WP_REST_Server::READABLE,
764 - 'callback' => __CLASS__ . '::get_intro_offers',
765 - 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
615 + 'callback' => __CLASS__ . '::set_subscriber_cookie_and_redirect',
616 + 'permission_callback' => '__return_true',
617 + 'args' => array(
618 + 'redirect_url' => array(
619 + 'required' => true,
620 + 'description' => __( 'The URL to redirect to.', 'jetpack' ),
621 + 'validate_callback' => 'wp_http_validate_url',
622 + 'sanitize_callback' => 'sanitize_url',
623 + 'type' => 'string',
624 + 'format' => 'uri',
625 + ),
626 + ),
766 627 )
767 628 );
768 629
769 - // Save subscriber token and redirect
630 + /**
631 + * Get the list of available Jetpack features.
632 + *
633 + * @since 13.9
634 + */
770 635 register_rest_route(
771 636 'jetpack/v4',
772 - '/subscribers/auth',
637 + '/features/available',
773 638 array(
774 639 'methods' => WP_REST_Server::READABLE,
775 - 'callback' => __CLASS__ . '::set_subscriber_cookie_and_redirect',
776 - 'permission_callback' => '__return_true',
640 + 'callback' => array( static::class, 'get_features_available' ),
641 + 'permission_callback' => array( static::class, 'get_features_permission_check' ),
777 642 )
778 643 );
644 +
645 + /**
646 + * Get the list of enabled Jetpack features.
647 + *
648 + * @since 13.9
649 + */
650 + register_rest_route(
651 + 'jetpack/v4',
652 + '/features/enabled',
653 + array(
654 + 'methods' => WP_REST_Server::READABLE,
655 + 'callback' => array( static::class, 'get_features_enabled' ),
656 + 'permission_callback' => array( static::class, 'get_features_permission_check' ),
657 + )
658 + );
779 659 }
780 660
781 661 /**
782 662 * Ask WPCOM for a JWT token to use for OpenAI conversations.
783 - * TODO: Clean me up. This is ugly hack code.
663 + *
664 + * @deprecated since 16.2
665 + * @see Automattic\Jetpack\Connection\REST_Jetpack_AI_JWT::get_jwt()
666 + *
667 + * @return array|WP_Error The token and blog ID, or the error from WPCOM.
784 668 */
785 669 public static function get_openai_jwt() {
786 - $blog_id = \Jetpack_Options::get_option( 'id' );
670 + _deprecated_function( __METHOD__, 'jetpack-16.2', '\Automattic\Jetpack\Connection\REST_Jetpack_AI_JWT::get_jwt' );
787 671
788 - $response = \Automattic\Jetpack\Connection\Client::wpcom_json_api_request_as_user(
789 - "/sites/$blog_id/jetpack-openai-query/jwt",
790 - '2',
791 - array(
792 - 'method' => 'POST',
793 - 'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ),
794 - ),
795 - wp_json_encode( array() ),
796 - 'wpcom'
797 - );
672 + $response = ( new REST_Jetpack_AI_JWT() )->get_jwt();
798 673
799 674 if ( is_wp_error( $response ) ) {
800 675 return $response;
801 676 }
802 677
803 - $json = json_decode( wp_remote_retrieve_body( $response ) );
804 -
805 - if ( ! isset( $json->token ) ) {
806 - return new WP_Error( 'no-token', 'No token returned from WPCOM' );
807 - }
808 -
809 - return array(
810 - 'token' => $json->token,
811 - 'blog_id' => $blog_id,
812 - );
678 + // Pre-deprecation callers expect the raw array, not a WP_REST_Response.
679 + return $response->get_data();
813 680 }
814 681
815 682 /**
816 683 * Set subscriber cookie and redirect
817 684 *
685 + * @param \WP_Rest_Request $request The URL to redirect to.
686 + *
818 687 * @return WP_Error|WP_REST_Response
819 688 */
820 - public static function set_subscriber_cookie_and_redirect() {
689 + public static function set_subscriber_cookie_and_redirect( $request ) {
821 690 require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/premium-content/_inc/subscription-service/include.php';
822 691 $subscription_service = \Automattic\Jetpack\Extensions\Premium_Content\subscription_service();
823 - $token = $subscription_service->get_and_set_token_from_request();
824 - $payload = $subscription_service->decode_token( $token );
825 - $is_valid_token = ! empty( $payload );
826 - if ( $is_valid_token && isset( $payload['redirect_url'] ) ) {
827 - return new WP_REST_Response( null, 302, array( 'location' => $payload['redirect_url'] ) );
692 + // Note: get_and_set_token_from_request() sets the subscriber cookie as a side effect.
693 + // The cookie is set regardless of the redirect target below; only the redirect is gated.
694 + $token = $subscription_service->get_and_set_token_from_request();
695 + $payload = $subscription_service->decode_token( $token );
696 + $is_valid_token = ! empty( $payload );
697 + if ( ! $is_valid_token ) {
698 + return new WP_Error( 'invalid-token', 'Invalid Token', array( 'status' => 403 ) );
828 699 }
829 - return new WP_Error( 'invalid-token', 'Invalid Token' );
830 - }
831 700
832 - /**
833 - * Get the data for the recommendations
834 - *
835 - * @return array Recommendations data
836 - */
837 - public static function get_recommendations_data() {
838 - return Jetpack_Recommendations::get_recommendations_data();
839 - }
840 -
841 - /**
842 - * Update the data for the recommendations
843 - *
844 - * @param WP_REST_Request $request The request.
845 - *
846 - * @return bool true
847 - */
848 - public static function update_recommendations_data( $request ) {
849 - $data = $request['data'];
850 - Jetpack_Recommendations::update_recommendations_data( $data );
851 -
852 - return true;
853 - }
854 -
855 - /**
856 - * Get the data for the recommendations
857 - *
858 - * @return array Recommendations data
859 - */
860 - public static function get_recommendations_step() {
861 - return Jetpack_Recommendations::get_recommendations_step();
862 - }
863 -
864 - /**
865 - * Update the step for the recommendations
866 - *
867 - * @param WP_REST_Request $request The request.
868 - *
869 - * @return bool true
870 - */
871 - public static function update_recommendations_step( $request ) {
872 - $step = $request['step'];
873 - Jetpack_Recommendations::update_recommendations_step( $step );
874 -
875 - return true;
876 - }
877 -
878 - /**
879 - * Get product suggestions for the recommendations
880 - *
881 - * @return string|WP_Error The response from the wpcom product suggestions endpoint as a JSON object.
882 - */
883 - public static function get_recommendations_product_suggestions() {
884 - $blog_id = Jetpack_Options::get_option( 'id' );
885 - if ( ! $blog_id ) {
886 - return new WP_Error( 'site_not_registered', esc_html__( 'Site not registered.', 'jetpack' ) );
701 + // Only redirect to the current site, not to an arbitrary host.
702 + $redirect_url = wp_validate_redirect( $request['redirect_url'], '' );
703 + if ( ! $redirect_url ) {
704 + return new WP_Error( 'invalid-redirect', 'Invalid Redirect URL', array( 'status' => 400 ) );
887 705 }
888 706
889 - $user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected( get_current_user_id() );
890 - if ( ! $user_connected ) {
891 - return wp_json_encode( array() );
892 - }
893 -
894 - $request_path = sprintf( '/sites/%s/jetpack-recommendations/product-suggestions?locale=' . get_user_locale(), $blog_id );
895 - $wpcom_request = Client::wpcom_json_api_request_as_user(
896 - $request_path,
897 - '2',
898 - array(
899 - 'method' => 'GET',
900 - 'headers' => array(
901 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
902 - ),
903 - )
904 - );
905 -
906 - $response_code = wp_remote_retrieve_response_code( $wpcom_request );
907 - if ( 200 === $response_code ) {
908 - return json_decode( wp_remote_retrieve_body( $wpcom_request ) );
909 - } else {
910 - return new WP_Error(
911 - 'failed_to_fetch_data',
912 - esc_html__( 'Unable to fetch the requested data.', 'jetpack' ),
913 - array( 'status' => $response_code )
914 - );
915 - }
707 + return new WP_REST_Response( null, 302, array( 'location' => $redirect_url ) );
916 708 }
917 709
918 710 /**
919 - * Get the upsell for the recommendations
920 - *
921 - * @return string The response from the wpcom upsell endpoint as a JSON object
922 - */
923 - public static function get_recommendations_upsell() {
924 - $blog_id = Jetpack_Options::get_option( 'id' );
925 - if ( ! $blog_id ) {
926 - return new WP_Error( 'site_not_registered', esc_html__( 'Site not registered.', 'jetpack' ) );
927 - }
928 -
929 - $user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected( get_current_user_id() );
930 - if ( ! $user_connected ) {
931 - $response = array(
932 - 'hide_upsell' => true,
933 - );
934 -
935 - return $response;
936 - }
937 -
938 - $request_path = sprintf( '/sites/%s/jetpack-recommendations/upsell?locale=' . get_user_locale(), $blog_id );
939 - $wpcom_request = Client::wpcom_json_api_request_as_user(
940 - $request_path,
941 - '2',
942 - array(
943 - 'method' => 'GET',
944 - 'headers' => array(
945 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
946 - ),
947 - )
948 - );
949 -
950 - $response_code = wp_remote_retrieve_response_code( $wpcom_request );
951 - if ( 200 === $response_code ) {
952 - return json_decode( wp_remote_retrieve_body( $wpcom_request ) );
953 - } else {
954 - return new WP_Error(
955 - 'failed_to_fetch_data',
956 - esc_html__( 'Unable to fetch the requested data.', 'jetpack' ),
957 - array( 'status' => $response_code )
958 - );
959 - }
960 - }
961 -
962 - /**
963 - * Get conditional recommendations data.
964 - *
965 - * @return array Conditional recommendations data.
966 - */
967 - public static function get_conditional_recommendations() {
968 - return Jetpack_Recommendations::get_conditional_recommendations();
969 - }
970 -
971 - /**
972 - * Validate the recommendations data
973 - *
974 - * @param array $value Value to check received by request.
975 - * @param WP_REST_Request $request The request sent to the WP REST API.
976 - * @param string $param Name of the parameter passed to endpoint holding $value.
977 - *
978 - * @return bool|WP_Error
979 - */
980 - public static function validate_recommendations_data( $value, $request, $param ) {
981 - if ( ! is_array( $value ) ) {
982 - /* translators: Name of a parameter that must be an object */
983 - return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an object.', 'jetpack' ), $param ) );
984 - }
985 -
986 - foreach ( $value as $answer ) {
987 - if ( is_array( $answer ) ) {
988 - $validate = self::validate_array_of_strings( $answer, $request, $param );
989 - } elseif ( is_string( $answer ) ) {
990 - $validate = self::validate_string( $answer, $request, $param );
991 - } elseif ( $answer === null ) {
992 - $validate = true;
993 - } else {
994 - $validate = self::validate_boolean( $answer, $request, $param );
995 - }
996 -
997 - if ( is_wp_error( $validate ) ) {
998 - return $validate;
999 - }
1000 - }
1001 -
1002 - return true;
1003 - }
1004 -
1005 - /**
1006 711 * Return a purchase token used for site-connected (non user-authenticated) checkout.
1007 712 *
1008 713 * @return string|WP_Error The current purchase token or WP_Error with error details.
1009 714 */
@@ -1130,9 +835,9 @@
1130 835 * @since 6.6.0
1131 836 *
1132 837 * @param WP_REST_Request $request The request sent to the WP REST API.
1133 838 *
1134 - * @return array|wp-error
839 + * @return array|WP_Error
1135 840 */
1136 841 public static function is_site_verified_and_token( $request ) {
1137 842 /**
1138 843 * Return an error if the site uses a Maintenance / Coming Soon plugin
@@ -1158,8 +863,9 @@
1158 863 || Jetpack::is_plugin_active( 'mojo-under-construction/mojo-contruction.php' ) && 1 == $under_construction_activation_status // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual
1159 864 || ( Jetpack::is_plugin_active( 'under-construction-page/under-construction.php' ) && isset( $ucp_options['status'] ) && 1 == $ucp_options['status'] ) // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual
1160 865 || ( Jetpack::is_plugin_active( 'ultimate-under-construction/ultimate-under-construction.php' ) && isset( $uuc_settings['enable'] ) && 1 == $uuc_settings['enable'] ) // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual
1161 866 || ( Jetpack::is_plugin_active( 'coming-soon/coming-soon.php' ) && isset( $csp4['status'] ) && ( 1 == $csp4['status'] || 2 == $csp4['status'] ) ) // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual
867 + ||
1162 868 /**
1163 869 * Allow plugins to mark a site as "under construction".
1164 870 *
1165 871 * @since 6.7.0
@@ -1165,9 +871,9 @@
1165 871 * @since 6.7.0
1166 872 *
1167 873 * @param false bool Is the site under construction? Default to false.
1168 874 */
1169 - || true === apply_filters( 'jetpack_is_under_construction_plugin', false )
875 + true === apply_filters( 'jetpack_is_under_construction_plugin', false )
1170 876 ) {
1171 877 return new WP_Error( 'forbidden', __( 'Site is under construction and cannot be verified', 'jetpack' ) );
1172 878 }
1173 879
@@ -1239,9 +945,9 @@
1239 945 * @since 4.3.0
1240 946 *
1241 947 * @param WP_REST_Request $request The request sent to the WP REST API.
1242 948 *
1243 - * @return array|wp-error
949 + * @return array|WP_Error
1244 950 */
1245 951 public static function dismiss_notice( $request ) {
1246 952 $notice = $request['notice'];
1247 953
@@ -1306,24 +1012,20 @@
1306 1012
1307 1013 /**
1308 1014 * Verify that a user can use the /connection/user endpoint. Has to be a registered user and be currently linked.
1309 1015 *
1016 + * @uses Automattic\Jetpack\Connection\Manager::is_user_connected();)
1017 + *
1018 + * @deprecated since Jetpack 14.4.0
1019 + * @see Automattic\Jetpack\Connection\REST_Connector::unlink_user_permission_callback()
1020 + *
1310 1021 * @since 4.3.0
1311 1022 *
1312 - * @uses Automattic\Jetpack\Connection\Manager::is_user_connected();)
1313 - *
1314 1023 * @return bool|WP_Error True if user is able to unlink.
1315 1024 */
1316 1025 public static function unlink_user_permission_callback() {
1317 - if ( current_user_can( 'jetpack_connect_user' ) && ( new Connection_Manager( 'jetpack' ) )->is_user_connected( get_current_user_id() ) ) {
1318 - return true;
1319 - }
1320 -
1321 - return new WP_Error(
1322 - 'invalid_user_permission_unlink_user',
1323 - REST_Connector::get_user_permissions_error_msg(),
1324 - array( 'status' => rest_authorization_required_code() )
1325 - );
1026 + _deprecated_function( __METHOD__, 'jetpack-14.4.0', 'Automattic\Jetpack\Connection\REST_Connector::unlink_user_permission_callback()' );
1027 + return REST_Connector::unlink_user_permission_callback();
1326 1028 }
1327 1029
1328 1030 /**
1329 1031 * Verify that user can manage Jetpack modules.
@@ -1458,139 +1160,8 @@
1458 1160 );
1459 1161 }
1460 1162
1461 1163 /**
1462 - * Test connection status for this Jetpack site.
1463 - *
1464 - * @since 6.8.0
1465 - *
1466 - * @return array|WP_Error WP_Error returned if connection test does not succeed.
1467 - */
1468 - public static function jetpack_connection_test() {
1469 - require_once JETPACK__PLUGIN_DIR . '_inc/lib/debugger.php';
1470 - $cxntests = new Jetpack_Cxn_Tests();
1471 -
1472 - if ( $cxntests->pass() ) {
1473 - return rest_ensure_response(
1474 - array(
1475 - 'code' => 'success',
1476 - 'message' => __( 'All connection tests passed.', 'jetpack' ),
1477 - )
1478 - );
1479 - } else {
1480 - return $cxntests->output_fails_as_wp_error();
1481 - }
1482 - }
1483 -
1484 - /**
1485 - * Test connection permission check method.
1486 - *
1487 - * @since 7.1.0
1488 - *
1489 - * @return bool
1490 - */
1491 - public static function view_jetpack_connection_test_check() {
1492 - // phpcs:disable WordPress.Security.NonceVerification.Recommended -- This is verifying the trusted caller via a shared private key and timestamp.
1493 - if ( ! isset( $_GET['signature'] ) || ! isset( $_GET['timestamp'] ) || ! isset( $_GET['url'] ) ) {
1494 - return false;
1495 - }
1496 - $signature = base64_decode( wp_unslash( $_GET['signature'] ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
1497 -
1498 - $signature_data = wp_json_encode(
1499 - array(
1500 - 'rest_route' => isset( $_GET['rest_route'] ) ? filter_var( wp_unslash( $_GET['rest_route'] ) ) : null,
1501 - 'timestamp' => (int) $_GET['timestamp'],
1502 - 'url' => esc_url_raw( wp_unslash( $_GET['url'] ) ),
1503 - )
1504 - );
1505 -
1506 - if (
1507 - ! function_exists( 'openssl_verify' )
1508 - || 1 !== openssl_verify(
1509 - $signature_data,
1510 - $signature,
1511 - JETPACK__DEBUGGER_PUBLIC_KEY
1512 - )
1513 - ) {
1514 - return false;
1515 - }
1516 -
1517 - // signature timestamp must be within 5min of current time.
1518 - if ( abs( time() - (int) $_GET['timestamp'] ) > 300 ) {
1519 - return false;
1520 - }
1521 -
1522 - // phpcs:enable WordPress.Security.NonceVerification.Recommended
1523 -
1524 - return true;
1525 - }
1526 -
1527 - /**
1528 - * Test connection status for this Jetpack site, encrypt the results for decryption by a third-party.
1529 - *
1530 - * @since 7.1.0
1531 - *
1532 - * @return array|mixed|object|WP_Error
1533 - */
1534 - public static function jetpack_connection_test_for_external() {
1535 - // Since we are running this test for inclusion in the WP.com testing suite, let's not try to run them as part of these results.
1536 - add_filter( 'jetpack_debugger_run_self_test', '__return_false' );
1537 - require_once JETPACK__PLUGIN_DIR . '_inc/lib/debugger.php';
1538 - $cxntests = new Jetpack_Cxn_Tests();
1539 -
1540 - if ( $cxntests->pass() ) {
1541 - $result = array(
1542 - 'code' => 'success',
1543 - 'message' => __( 'All connection tests passed.', 'jetpack' ),
1544 - );
1545 - } else {
1546 - $error = $cxntests->output_fails_as_wp_error(); // Using this so the output is similar both ways.
1547 - $errors = array();
1548 -
1549 - // Borrowed from WP_REST_Server::error_to_response().
1550 - foreach ( (array) $error->errors as $code => $messages ) {
1551 - foreach ( (array) $messages as $message ) {
1552 - $errors[] = array(
1553 - 'code' => $code,
1554 - 'message' => $message,
1555 - 'data' => $error->get_error_data( $code ),
1556 - );
1557 - }
1558 - }
1559 -
1560 - $result = ( ! empty( $errors ) ) ? $errors[0] : null;
1561 - if ( count( $errors ) > 1 ) {
1562 - // Remove the primary error.
1563 - array_shift( $errors );
1564 - $result['additional_errors'] = $errors;
1565 - }
1566 - }
1567 -
1568 - $result = wp_json_encode( $result );
1569 -
1570 - $encrypted = $cxntests->encrypt_string_for_wpcom( $result );
1571 -
1572 - if ( ! $encrypted || ! is_array( $encrypted ) ) {
1573 - return rest_ensure_response(
1574 - array(
1575 - 'code' => 'action_required',
1576 - 'message' => 'Please request results from the in-plugin debugger',
1577 - )
1578 - );
1579 - }
1580 -
1581 - return rest_ensure_response(
1582 - array(
1583 - 'code' => 'response',
1584 - 'debug' => array(
1585 - 'data' => $encrypted['data'],
1586 - 'key' => $encrypted['key'],
1587 - ),
1588 - )
1589 - );
1590 - }
1591 -
1592 - /**
1593 1164 * Fetch information about the Rewind status of the site.
1594 1165 */
1595 1166 public static function rewind_data() {
1596 1167 $site_id = Jetpack_Options::get_option( 'id' );
@@ -1633,9 +1204,9 @@
1633 1204 return rest_ensure_response(
1634 1205 array(
1635 1206 'code' => 'success',
1636 1207 'message' => esc_html__( 'Backup & Scan data correctly received.', 'jetpack' ),
1637 - 'data' => wp_json_encode( $rewind_data ),
1208 + 'data' => wp_json_encode( $rewind_data, JSON_UNESCAPED_SLASHES ),
1638 1209 )
1639 1210 );
1640 1211 }
1641 1212
@@ -1716,9 +1287,9 @@
1716 1287 return rest_ensure_response(
1717 1288 array(
1718 1289 'code' => 'success',
1719 1290 'message' => esc_html__( 'Scan state correctly received.', 'jetpack' ),
1720 - 'data' => wp_json_encode( $scan_state ),
1291 + 'data' => wp_json_encode( $scan_state, JSON_UNESCAPED_SLASHES ),
1721 1292 )
1722 1293 );
1723 1294 }
1724 1295
@@ -1765,41 +1336,8 @@
1765 1336 return new WP_Error( 'disconnect_failed', esc_html__( 'Was not able to disconnect the site. Please try again.', 'jetpack' ), array( 'status' => 400 ) );
1766 1337 }
1767 1338
1768 1339 /**
1769 - * Registers the Jetpack site
1770 - *
1771 - * @deprecated since Jetpack 9.7.0
1772 - * @see Automattic\Jetpack\Connection\REST_Connector::connection_register()
1773 - *
1774 - * @param WP_REST_Request $request The request sent to the WP REST API.
1775 - *
1776 - * @return bool|WP_Error True if Jetpack successfully registered
1777 - */
1778 - public static function register_site( $request ) {
1779 - _deprecated_function( __METHOD__, 'jetpack-9.7.0', '\Automattic\Jetpack\Connection\REST_Connector::connection_register' );
1780 -
1781 - if ( ! wp_verify_nonce( $request->get_param( 'registration_nonce' ), 'jetpack-registration-nonce' ) ) {
1782 - return new WP_Error( 'invalid_nonce', __( 'Unable to verify your request.', 'jetpack' ), array( 'status' => 403 ) );
1783 - }
1784 -
1785 - if ( isset( $request['from'] ) ) {
1786 - Jetpack::connection()->add_register_request_param( 'from', (string) $request['from'] );
1787 - }
1788 - $response = Jetpack::connection()->try_registration();
1789 -
1790 - if ( is_wp_error( $response ) ) {
1791 - return $response;
1792 - }
1793 -
1794 - return rest_ensure_response(
1795 - array(
1796 - 'authorizeUrl' => Jetpack::build_authorize_url( false ),
1797 - )
1798 - );
1799 - }
1800 -
1801 - /**
1802 1340 * Gets a new connect raw URL with fresh nonce.
1803 1341 *
1804 1342 * @uses Jetpack::disconnect();
1805 1343 * @since 4.3.0
@@ -1808,10 +1346,10 @@
1808 1346 *
1809 1347 * @return string|WP_Error A raw URL if the connection URL could be built; error message otherwise.
1810 1348 */
1811 1349 public static function build_connect_url( $request = array() ) {
1812 - $from = isset( $request['from'] ) ? $request['from'] : false;
1813 - $redirect = isset( $request['redirect'] ) ? $request['redirect'] : false;
1350 + $from = $request['from'] ?? false;
1351 + $redirect = $request['redirect'] ?? false;
1814 1352
1815 1353 $url = Jetpack::init()->build_connect_url( true, $redirect, $from );
1816 1354 if ( $url ) {
1817 1355 return rest_ensure_response( $url );
@@ -1834,9 +1372,9 @@
1834 1372 */
1835 1373 public static function get_user_connection_data() {
1836 1374 _deprecated_function( __METHOD__, 'jetpack-10.0.0', '\Automattic\Jetpack\Connection\REST_Connector::get_user_connection_data' );
1837 1375
1838 - require_once JETPACK__PLUGIN_DIR . '_inc/lib/admin-pages/class.jetpack-react-page.php';
1376 + require_once JETPACK__PLUGIN_DIR . '_inc/lib/admin-pages/class-jetpack-redux-state-helper.php';
1839 1377
1840 1378 $connection_owner = ( new Connection_Manager() )->get_connection_owner();
1841 1379 $owner_display_name = false === $connection_owner ? null : $connection_owner->data->display_name;
1842 1380
@@ -1849,30 +1387,21 @@
1849 1387
1850 1388 /**
1851 1389 * Unlinks current user from the WordPress.com Servers.
1852 1390 *
1853 - * @since 4.3.0
1391 + * @param WP_REST_Request $request The request sent to the WP REST API.
1854 1392 * @uses Automattic\Jetpack\Connection\Manager->disconnect_user
1855 1393 *
1856 - * @param WP_REST_Request $request The request sent to the WP REST API.
1394 + * @deprecated since Jetpack 14.4.0
1395 + * @see Automattic\Jetpack\Connection\REST_Connector::unlink_user()
1857 1396 *
1397 + * @since 4.3.0
1398 + *
1858 1399 * @return bool|WP_Error True if user successfully unlinked.
1859 1400 */
1860 1401 public static function unlink_user( $request ) {
1861 -
1862 - if ( ! isset( $request['linked'] ) || false !== $request['linked'] ) {
1863 - return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
1864 - }
1865 -
1866 - if ( ( new Connection_Manager( 'jetpack' ) )->disconnect_user() ) {
1867 - return rest_ensure_response(
1868 - array(
1869 - 'code' => 'success',
1870 - )
1871 - );
1872 - }
1873 -
1874 - return new WP_Error( 'unlink_user_failed', esc_html__( 'Was not able to unlink the user. Please try again.', 'jetpack' ), array( 'status' => 400 ) );
1402 + _deprecated_function( __METHOD__, 'jetpack-14.4.0', 'Automattic\Jetpack\Connection\REST_Connector::unlink_user()' );
1403 + return REST_Connector::unlink_user( $request );
1875 1404 }
1876 1405
1877 1406 /**
1878 1407 * Gets current user's tracking settings.
@@ -1931,9 +1460,9 @@
1931 1460 'Content-Type' => 'application/json',
1932 1461 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
1933 1462 ),
1934 1463 ),
1935 - wp_json_encode( $request->get_params() )
1464 + wp_json_encode( $request->get_params(), JSON_UNESCAPED_SLASHES )
1936 1465 );
1937 1466 if ( ! is_wp_error( $response ) ) {
1938 1467 $response = json_decode( wp_remote_retrieve_body( $response ), true );
1939 1468 }
@@ -1945,93 +1474,30 @@
1945 1474 /**
1946 1475 * Fetch site data from .com including the site's current plan and the site's products.
1947 1476 *
1948 1477 * @since 5.5.0
1478 + * @deprecated 16.2 Use Automattic\Jetpack\Connection\Manager::get_connected_site_data().
1949 1479 *
1950 1480 * @return stdClass|WP_Error
1951 1481 */
1952 1482 public static function site_data() {
1953 - $site_id = Jetpack_Options::get_option( 'id' );
1483 + _deprecated_function( __METHOD__, 'jetpack-16.2', 'Automattic\Jetpack\Connection\Manager::get_connected_site_data' );
1954 1484
1955 - if ( ! $site_id ) {
1956 - return new WP_Error( 'site_id_missing', '', array( 'api_error_code' => __( 'site_id_missing', 'jetpack' ) ) );
1957 - }
1485 + return ( new Connection_Manager() )->get_connected_site_data();
1486 + }
1958 1487
1959 - $args = array( 'headers' => array() );
1960 -
1961 - // Allow use a store sandbox. Internal ref: PCYsg-IA-p2.
1962 - if ( isset( $_COOKIE ) && isset( $_COOKIE['store_sandbox'] ) ) {
1963 - $secret = filter_var( wp_unslash( $_COOKIE['store_sandbox'] ) );
1964 - $args['headers']['Cookie'] = "store_sandbox=$secret;";
1965 - }
1966 -
1967 - $response = Client::wpcom_json_api_request_as_blog( sprintf( '/sites/%d', $site_id ) . '?force=wpcom', '1.1', $args );
1968 - $body = wp_remote_retrieve_body( $response );
1969 - $data = $body ? json_decode( $body ) : null;
1970 -
1971 - if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
1972 - $error_info = array(
1973 - 'api_error_code' => null,
1974 - 'api_http_code' => wp_remote_retrieve_response_code( $response ),
1975 - );
1976 -
1977 - if ( is_wp_error( $response ) ) {
1978 - $error_info['api_error_code'] = $response->get_error_code() ? wp_strip_all_tags( $response->get_error_code() ) : null;
1979 - } elseif ( $data && ! empty( $data->error ) ) {
1980 - $error_info['api_error_code'] = $data->error;
1981 - }
1982 -
1983 - return new WP_Error( 'site_data_fetch_failed', '', $error_info );
1984 - }
1985 -
1986 - Jetpack_Plan::update_from_sites_response( $response );
1987 -
1988 - return $data;
1989 - }
1990 1488 /**
1991 1489 * Get site data, including for example, the site's current plan.
1992 1490 *
1491 + * @since 4.3.0
1492 + * @deprecated 16.2 Use Automattic\Jetpack\Connection\REST_Connector::site_data_response().
1493 + *
1993 1494 * @return WP_Error|WP_HTTP_Response|WP_REST_Response
1994 - * @since 4.3.0
1995 1495 */
1996 1496 public static function get_site_data() {
1997 - $site_data = self::site_data();
1497 + _deprecated_function( __METHOD__, 'jetpack-16.2', 'Automattic\Jetpack\Connection\REST_Connector::site_data_response' );
1998 1498
1999 - if ( ! is_wp_error( $site_data ) ) {
2000 -
2001 - /**
2002 - * Fires when the site data was successfully returned from the /sites/%d wpcom endpoint.
2003 - *
2004 - * @since 8.7.0
2005 - */
2006 - do_action( 'jetpack_get_site_data_success' );
2007 - return rest_ensure_response(
2008 - array(
2009 - 'code' => 'success',
2010 - 'message' => esc_html__( 'Site data correctly received.', 'jetpack' ),
2011 - 'data' => wp_json_encode( $site_data ),
2012 - )
2013 - );
2014 - }
2015 -
2016 - $error_data = $site_data->get_error_data();
2017 -
2018 - if ( empty( $error_data['api_error_code'] ) ) {
2019 - $error_message = esc_html__( 'Failed fetching site data from WordPress.com. If the problem persists, try reconnecting Jetpack.', 'jetpack' );
2020 - } else {
2021 - /* translators: %s is an error code (e.g. `token_mismatch`) */
2022 - $error_message = sprintf( esc_html__( 'Failed fetching site data from WordPress.com (%s). If the problem persists, try reconnecting Jetpack.', 'jetpack' ), $error_data['api_error_code'] );
2023 - }
2024 -
2025 - return new WP_Error(
2026 - $site_data->get_error_code(),
2027 - $error_message,
2028 - array(
2029 - 'status' => 400,
2030 - 'api_error_code' => empty( $error_data['api_error_code'] ) ? null : $error_data['api_error_code'],
2031 - 'api_http_code' => empty( $error_data['api_http_code'] ) ? null : $error_data['api_http_code'],
2032 - )
2033 - );
1499 + return REST_Connector::site_data_response();
2034 1500 }
2035 1501
2036 1502 /**
2037 1503 * Fetch AL data for this site and return it.
@@ -2091,64 +1557,8 @@
2091 1557 );
2092 1558 }
2093 1559
2094 1560 /**
2095 - * Fetch the discount for this site and return it.
2096 - *
2097 - * @since 10.8
2098 - *
2099 - * @return array|WP_Error
2100 - */
2101 - public static function get_site_discount() {
2102 - $site_id = Jetpack_Options::get_option( 'id' );
2103 -
2104 - if ( ! $site_id ) {
2105 - return new WP_Error(
2106 - 'site_id_missing',
2107 - esc_html__( 'Site ID is missing.', 'jetpack' ),
2108 - array( 'status' => 400 )
2109 - );
2110 - }
2111 -
2112 - $response = Client::wpcom_json_api_request_as_user(
2113 - "/sites/$site_id/discount",
2114 - '2',
2115 - array(
2116 - 'method' => 'GET',
2117 - 'headers' => array(
2118 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
2119 - ),
2120 - )
2121 - );
2122 -
2123 - $response_code = wp_remote_retrieve_response_code( $response );
2124 - $data = json_decode( wp_remote_retrieve_body( $response ) );
2125 -
2126 - if ( 200 !== $response_code ) {
2127 - return new WP_Error(
2128 - 'discount_fetch_failed',
2129 - is_object( $data ) && property_exists( $data, 'error' ) ? $data->error : esc_html__( 'Could not retrieve site discount.', 'jetpack' ),
2130 - array( 'status' => $response_code )
2131 - );
2132 - }
2133 -
2134 - if ( ! isset( $data ) ) {
2135 - return new WP_Error(
2136 - 'discount_parse_error',
2137 - esc_html__( 'Could not parse discount', 'jetpack' ),
2138 - array( 'status' => 204 ) // no content.
2139 - );
2140 - }
2141 -
2142 - return rest_ensure_response(
2143 - array(
2144 - 'code' => 'success',
2145 - 'data' => $data,
2146 - )
2147 - );
2148 - }
2149 -
2150 - /**
2151 1561 * Reset Jetpack options
2152 1562 *
2153 1563 * @since 4.3.0
2154 1564 *
@@ -2246,9 +1656,9 @@
2246 1656 public static function get_updateable_data_list( $selector = '' ) {
2247 1657
2248 1658 $options = array(
2249 1659 // Blocks.
2250 - 'jetpack_blocks_disabled' => array(
1660 + 'jetpack_blocks_disabled' => array(
2251 1661 'description' => esc_html__( 'Jetpack Blocks disabled.', 'jetpack' ),
2252 1662 'type' => 'boolean',
2253 1663 'default' => false,
2254 1664 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2255,9 +1665,9 @@
2255 1665 'jp_group' => 'settings',
2256 1666 ),
2257 1667
2258 1668 // Carousel
2259 - 'carousel_background_color' => array(
1669 + 'carousel_background_color' => array(
2260 1670 'description' => esc_html__( 'Color scheme.', 'jetpack' ),
2261 1671 'type' => 'string',
2262 1672 'default' => 'black',
2263 1673 'enum' => array(
@@ -2270,9 +1680,9 @@
2270 1680 ),
2271 1681 'validate_callback' => __CLASS__ . '::validate_list_item',
2272 1682 'jp_group' => 'carousel',
2273 1683 ),
2274 - 'carousel_display_exif' => array(
1684 + 'carousel_display_exif' => array(
2275 1685 'description' => wp_kses(
2276 1686 sprintf( __( 'Show photo metadata (<a href="https://en.wikipedia.org/wiki/Exchangeable_image_file_format" target="_blank">Exif</a>) in carousel, when available.', 'jetpack' ) ),
2277 1687 array(
2278 1688 'a' => array(
@@ -2285,9 +1695,9 @@
2285 1695 'default' => 0,
2286 1696 'validate_callback' => __CLASS__ . '::validate_boolean',
2287 1697 'jp_group' => 'carousel',
2288 1698 ),
2289 - 'carousel_display_comments' => array(
1699 + 'carousel_display_comments' => array(
2290 1700 'description' => esc_html__( 'Show comments area in carousel', 'jetpack' ),
2291 1701 'type' => 'boolean',
2292 1702 'default' => 1,
2293 1703 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2294,9 +1704,9 @@
2294 1704 'jp_group' => 'carousel',
2295 1705 ),
2296 1706
2297 1707 // Comments.
2298 - 'highlander_comment_form_prompt' => array(
1708 + 'highlander_comment_form_prompt' => array(
2299 1709 'description' => esc_html__( 'Greeting Text', 'jetpack' ),
2300 1710 'type' => 'string',
2301 1711 'default' => esc_html__( 'Leave a Reply', 'jetpack' ),
2302 1712 'sanitize_callback' => 'sanitize_text_field',
@@ -2301,9 +1711,9 @@
2301 1711 'default' => esc_html__( 'Leave a Reply', 'jetpack' ),
2302 1712 'sanitize_callback' => 'sanitize_text_field',
2303 1713 'jp_group' => 'comments',
2304 1714 ),
2305 - 'jetpack_comment_form_color_scheme' => array(
1715 + 'jetpack_comment_form_color_scheme' => array(
2306 1716 'description' => esc_html__( 'Color scheme', 'jetpack' ),
2307 1717 'type' => 'string',
2308 1718 'default' => 'light',
2309 1719 'enum' => array(
@@ -2320,39 +1730,38 @@
2320 1730 'jp_group' => 'comments',
2321 1731 ),
2322 1732
2323 1733 // Custom Content Types.
2324 - 'jetpack_portfolio' => array(
1734 + 'jetpack_portfolio' => array(
2325 1735 'description' => esc_html__( 'Enable or disable Jetpack portfolio post type.', 'jetpack' ),
2326 1736 'type' => 'boolean',
2327 1737 'default' => 0,
2328 1738 'validate_callback' => __CLASS__ . '::validate_boolean',
2329 - 'jp_group' => 'custom-content-types',
1739 + 'jp_group' => 'settings',
2330 1740 ),
2331 - 'jetpack_portfolio_posts_per_page' => array(
1741 + 'jetpack_portfolio_posts_per_page' => array(
2332 1742 'description' => esc_html__( 'Number of entries to show at most in Portfolio pages.', 'jetpack' ),
2333 1743 'type' => 'integer',
2334 1744 'default' => 10,
2335 1745 'validate_callback' => __CLASS__ . '::validate_posint',
2336 - 'jp_group' => 'custom-content-types',
1746 + 'jp_group' => 'settings',
2337 1747 ),
2338 - 'jetpack_testimonial' => array(
1748 + 'jetpack_testimonial' => array(
2339 1749 'description' => esc_html__( 'Enable or disable Jetpack testimonial post type.', 'jetpack' ),
2340 1750 'type' => 'boolean',
2341 1751 'default' => 0,
2342 1752 'validate_callback' => __CLASS__ . '::validate_boolean',
2343 - 'jp_group' => 'custom-content-types',
1753 + 'jp_group' => 'settings',
2344 1754 ),
2345 - 'jetpack_testimonial_posts_per_page' => array(
1755 + 'jetpack_testimonial_posts_per_page' => array(
2346 1756 'description' => esc_html__( 'Number of entries to show at most in Testimonial pages.', 'jetpack' ),
2347 1757 'type' => 'integer',
2348 1758 'default' => 10,
2349 1759 'validate_callback' => __CLASS__ . '::validate_posint',
2350 - 'jp_group' => 'custom-content-types',
1760 + 'jp_group' => 'settings',
2351 1761 ),
2352 -
2353 1762 // WAF.
2354 - 'jetpack_waf_automatic_rules' => array(
1763 + 'jetpack_waf_automatic_rules' => array(
2355 1764 'description' => esc_html__( 'Enable automatic rules - Protect your site against untrusted traffic sources with automatic security rules.', 'jetpack' ),
2356 1765 'type' => 'boolean',
2357 1766 'default' => Waf_Compatibility::get_default_automatic_rules_option(),
2358 1767 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2357,16 +1766,16 @@
2357 1766 'default' => Waf_Compatibility::get_default_automatic_rules_option(),
2358 1767 'validate_callback' => __CLASS__ . '::validate_boolean',
2359 1768 'jp_group' => 'waf',
2360 1769 ),
2361 - 'jetpack_waf_ip_list' => array(
2362 - 'description' => esc_html__( 'Allow / Block list - Block or allow a specific request IP.', 'jetpack' ),
1770 + 'jetpack_waf_ip_block_list_enabled' => array(
1771 + 'description' => esc_html__( 'Block list - Block a specific request IP.', 'jetpack' ),
2363 1772 'type' => 'boolean',
2364 1773 'default' => 0,
2365 1774 'validate_callback' => __CLASS__ . '::validate_boolean',
2366 1775 'jp_group' => 'waf',
2367 1776 ),
2368 - 'jetpack_waf_ip_block_list' => array(
1777 + 'jetpack_waf_ip_block_list' => array(
2369 1778 'description' => esc_html__( 'Blocked IP addresses', 'jetpack' ),
2370 1779 'type' => 'string',
2371 1780 'default' => '',
2372 1781 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2372,9 +1781,16 @@
2372 1781 'validate_callback' => __CLASS__ . '::validate_string',
2373 1782 'sanitize_callback' => 'esc_textarea',
2374 1783 'jp_group' => 'waf',
2375 1784 ),
2376 - 'jetpack_waf_ip_allow_list' => array(
1785 + 'jetpack_waf_ip_allow_list_enabled' => array(
1786 + 'description' => esc_html__( 'Allow list - Allow a specific request IP.', 'jetpack' ),
1787 + 'type' => 'boolean',
1788 + 'default' => 0,
1789 + 'validate_callback' => __CLASS__ . '::validate_boolean',
1790 + 'jp_group' => 'settings',
1791 + ),
1792 + 'jetpack_waf_ip_allow_list' => array(
2377 1793 'description' => esc_html__( 'Always allowed IP addresses', 'jetpack' ),
2378 1794 'type' => 'string',
2379 1795 'default' => '',
2380 1796 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2380,17 +1796,24 @@
2380 1796 'validate_callback' => __CLASS__ . '::validate_string',
2381 1797 'sanitize_callback' => 'esc_textarea',
2382 1798 'jp_group' => 'settings',
2383 1799 ),
2384 - 'jetpack_waf_share_data' => array(
2385 - 'description' => esc_html__( 'Share data with Jetpack.', 'jetpack' ),
1800 + 'jetpack_waf_share_data' => array(
1801 + 'description' => esc_html__( 'Share basic data with Jetpack.', 'jetpack' ),
2386 1802 'type' => 'boolean',
2387 1803 'default' => 0,
2388 1804 'validate_callback' => __CLASS__ . '::validate_boolean',
2389 1805 'jp_group' => 'waf',
2390 1806 ),
1807 + 'jetpack_waf_share_debug_data' => array(
1808 + 'description' => esc_html__( 'Share detailed data with Jetpack.', 'jetpack' ),
1809 + 'type' => 'boolean',
1810 + 'default' => 0,
1811 + 'validate_callback' => __CLASS__ . '::validate_boolean',
1812 + 'jp_group' => 'waf',
1813 + ),
2391 1814 // Galleries.
2392 - 'tiled_galleries' => array(
1815 + 'tiled_galleries' => array(
2393 1816 'description' => esc_html__( 'Display all your gallery pictures in a cool mosaic.', 'jetpack' ),
2394 1817 'type' => 'boolean',
2395 1818 'default' => 0,
2396 1819 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2396,9 +1819,9 @@
2396 1819 'validate_callback' => __CLASS__ . '::validate_boolean',
2397 1820 'jp_group' => 'tiled-gallery',
2398 1821 ),
2399 1822
2400 - 'gravatar_disable_hovercards' => array(
1823 + 'gravatar_disable_hovercards' => array(
2401 1824 'description' => esc_html__( "View people's profiles when you mouse over their Gravatars", 'jetpack' ),
2402 1825 'type' => 'string',
2403 1826 'default' => 'enabled',
2404 1827 // Not visible. This is used as the checkbox value.
@@ -2414,9 +1837,9 @@
2414 1837 'jp_group' => 'gravatar-hovercards',
2415 1838 ),
2416 1839
2417 1840 // Infinite Scroll.
2418 - 'infinite_scroll' => array(
1841 + 'infinite_scroll' => array(
2419 1842 'description' => esc_html__( 'To infinity and beyond', 'jetpack' ),
2420 1843 'type' => 'boolean',
2421 1844 'default' => 1,
2422 1845 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2421,9 +1844,9 @@
2421 1844 'default' => 1,
2422 1845 'validate_callback' => __CLASS__ . '::validate_boolean',
2423 1846 'jp_group' => 'infinite-scroll',
2424 1847 ),
2425 - 'infinite_scroll_google_analytics' => array(
1848 + 'infinite_scroll_google_analytics' => array(
2426 1849 'description' => esc_html__( 'Use Google Analytics with Infinite Scroll', 'jetpack' ),
2427 1850 'type' => 'boolean',
2428 1851 'default' => 0,
2429 1852 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2430,9 +1853,9 @@
2430 1853 'jp_group' => 'infinite-scroll',
2431 1854 ),
2432 1855
2433 1856 // Likes.
2434 - 'wpl_default' => array(
1857 + 'wpl_default' => array(
2435 1858 'description' => esc_html__( 'WordPress.com Likes are', 'jetpack' ),
2436 1859 'type' => 'string',
2437 1860 'default' => 'on',
2438 1861 'enum' => array(
@@ -2445,9 +1868,9 @@
2445 1868 ),
2446 1869 'validate_callback' => __CLASS__ . '::validate_list_item',
2447 1870 'jp_group' => 'likes',
2448 1871 ),
2449 - 'social_notifications_like' => array(
1872 + 'social_notifications_like' => array(
2450 1873 'description' => esc_html__( 'Send email notification when someone likes a post', 'jetpack' ),
2451 1874 'type' => 'boolean',
2452 1875 'default' => 1,
2453 1876 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2454,9 +1877,9 @@
2454 1877 'jp_group' => 'likes',
2455 1878 ),
2456 1879
2457 1880 // Markdown.
2458 - 'wpcom_publish_comments_with_markdown' => array(
1881 + 'wpcom_publish_comments_with_markdown' => array(
2459 1882 'description' => esc_html__( 'Use Markdown for comments.', 'jetpack' ),
2460 1883 'type' => 'boolean',
2461 1884 'default' => 0,
2462 1885 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2461,9 +1884,9 @@
2461 1884 'default' => 0,
2462 1885 'validate_callback' => __CLASS__ . '::validate_boolean',
2463 1886 'jp_group' => 'markdown',
2464 1887 ),
2465 - 'wpcom_publish_posts_with_markdown' => array(
1888 + 'wpcom_publish_posts_with_markdown' => array(
2466 1889 'description' => esc_html__( 'Use Markdown for posts.', 'jetpack' ),
2467 1890 'type' => 'boolean',
2468 1891 'default' => 0,
2469 1892 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2470,9 +1893,9 @@
2470 1893 'jp_group' => 'markdown',
2471 1894 ),
2472 1895
2473 1896 // Monitor.
2474 - 'monitor_receive_notifications' => array(
1897 + 'monitor_receive_notifications' => array(
2475 1898 'description' => esc_html__( 'Receive Monitor Email Notifications.', 'jetpack' ),
2476 1899 'type' => 'boolean',
2477 1900 'default' => 0,
2478 1901 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2479,9 +1902,9 @@
2479 1902 'jp_group' => 'monitor',
2480 1903 ),
2481 1904
2482 1905 // Post by Email.
2483 - 'post_by_email_address' => array(
1906 + 'post_by_email_address' => array(
2484 1907 'description' => esc_html__( 'Email Address', 'jetpack' ),
2485 1908 'type' => 'string',
2486 1909 'default' => 'noop',
2487 1910 'enum' => array(
@@ -2500,9 +1923,9 @@
2500 1923 'jp_group' => 'post-by-email',
2501 1924 ),
2502 1925
2503 1926 // Protect.
2504 - 'jetpack_protect_key' => array(
1927 + 'jetpack_protect_key' => array(
2505 1928 'description' => esc_html__( 'Protect API key', 'jetpack' ),
2506 1929 'type' => 'string',
2507 1930 'default' => '',
2508 1931 'validate_callback' => __CLASS__ . '::validate_alphanum',
@@ -2507,9 +1930,9 @@
2507 1930 'default' => '',
2508 1931 'validate_callback' => __CLASS__ . '::validate_alphanum',
2509 1932 'jp_group' => 'protect',
2510 1933 ),
2511 - 'jetpack_protect_global_whitelist' => array(
1934 + 'jetpack_protect_global_whitelist' => array(
2512 1935 'description' => esc_html__( 'Protect global IP allow list', 'jetpack' ),
2513 1936 'type' => 'string',
2514 1937 'default' => '',
2515 1938 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2517,9 +1940,9 @@
2517 1940 'jp_group' => 'protect',
2518 1941 ),
2519 1942
2520 1943 // Sharing.
2521 - 'sharing_services' => array(
1944 + 'sharing_services' => array(
2522 1945 'description' => esc_html__( 'Enabled Services and those hidden behind a button', 'jetpack' ),
2523 1946 'type' => 'object',
2524 1947 'default' => array(
2525 1948 'visible' => array( 'facebook', 'x' ),
@@ -2527,9 +1950,9 @@
2527 1950 ),
2528 1951 'validate_callback' => __CLASS__ . '::validate_services',
2529 1952 'jp_group' => 'sharedaddy',
2530 1953 ),
2531 - 'button_style' => array(
1954 + 'button_style' => array(
2532 1955 'description' => esc_html__( 'Button Style', 'jetpack' ),
2533 1956 'type' => 'string',
2534 1957 'default' => 'icon',
2535 1958 'enum' => array(
@@ -2546,9 +1969,9 @@
2546 1969 ),
2547 1970 'validate_callback' => __CLASS__ . '::validate_list_item',
2548 1971 'jp_group' => 'sharedaddy',
2549 1972 ),
2550 - 'sharing_label' => array(
1973 + 'sharing_label' => array(
2551 1974 'description' => esc_html__( 'Sharing Label', 'jetpack' ),
2552 1975 'type' => 'string',
2553 1976 'default' => '',
2554 1977 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2554,9 +1977,9 @@
2554 1977 'validate_callback' => __CLASS__ . '::validate_string',
2555 1978 'sanitize_callback' => 'esc_html',
2556 1979 'jp_group' => 'sharedaddy',
2557 1980 ),
2558 - 'show' => array(
1981 + 'show' => array(
2559 1982 'description' => esc_html__( 'Views where buttons are shown', 'jetpack' ),
2560 1983 'type' => 'array',
2561 1984 'items' => array(
2562 1985 'type' => 'string',
@@ -2564,9 +1987,9 @@
2564 1987 'default' => array( 'post' ),
2565 1988 'validate_callback' => __CLASS__ . '::validate_sharing_show',
2566 1989 'jp_group' => 'sharedaddy',
2567 1990 ),
2568 - 'jetpack-twitter-cards-site-tag' => array(
1991 + 'jetpack-twitter-cards-site-tag' => array(
2569 1992 'description' => esc_html__( "The Twitter username of the owner of this site's domain.", 'jetpack' ),
2570 1993 'type' => 'string',
2571 1994 'default' => '',
2572 1995 'validate_callback' => __CLASS__ . '::validate_twitter_username',
@@ -2572,9 +1995,9 @@
2572 1995 'validate_callback' => __CLASS__ . '::validate_twitter_username',
2573 1996 'sanitize_callback' => 'esc_html',
2574 1997 'jp_group' => 'sharedaddy',
2575 1998 ),
2576 - 'sharedaddy_disable_resources' => array(
1999 + 'sharedaddy_disable_resources' => array(
2577 2000 'description' => esc_html__( 'Disable CSS and JS', 'jetpack' ),
2578 2001 'type' => 'boolean',
2579 2002 'default' => 0,
2580 2003 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2579,9 +2002,9 @@
2579 2002 'default' => 0,
2580 2003 'validate_callback' => __CLASS__ . '::validate_boolean',
2581 2004 'jp_group' => 'sharedaddy',
2582 2005 ),
2583 - 'custom' => array(
2006 + 'custom' => array(
2584 2007 'description' => esc_html__( 'Custom sharing services added by user.', 'jetpack' ),
2585 2008 'type' => 'object',
2586 2009 'default' => array(
2587 2010 'sharing_name' => '',
@@ -2591,9 +2014,9 @@
2591 2014 'validate_callback' => __CLASS__ . '::validate_custom_service',
2592 2015 'jp_group' => 'sharedaddy',
2593 2016 ),
2594 2017 // Not an option, but an action that can be performed on the list of custom services passing the service ID.
2595 - 'sharing_delete_service' => array(
2018 + 'sharing_delete_service' => array(
2596 2019 'description' => esc_html__( 'Delete custom sharing service.', 'jetpack' ),
2597 2020 'type' => 'string',
2598 2021 'default' => '',
2599 2022 'validate_callback' => __CLASS__ . '::validate_custom_service_id',
@@ -2600,16 +2023,16 @@
2600 2023 'jp_group' => 'sharedaddy',
2601 2024 ),
2602 2025
2603 2026 // SSO.
2604 - 'jetpack_sso_require_two_step' => array(
2027 + 'jetpack_sso_require_two_step' => array(
2605 2028 'description' => esc_html__( 'Require Two-Step Authentication', 'jetpack' ),
2606 2029 'type' => 'boolean',
2607 - 'default' => 0,
2030 + 'default' => SSO\Helpers::is_require_two_step_checkbox_disabled(),
2608 2031 'validate_callback' => __CLASS__ . '::validate_boolean',
2609 2032 'jp_group' => 'sso',
2610 2033 ),
2611 - 'jetpack_sso_match_by_email' => array(
2034 + 'jetpack_sso_match_by_email' => array(
2612 2035 'description' => esc_html__( 'Match by Email', 'jetpack' ),
2613 2036 'type' => 'boolean',
2614 2037 'default' => 1,
2615 2038 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2616,9 +2039,9 @@
2616 2039 'jp_group' => 'sso',
2617 2040 ),
2618 2041
2619 2042 // Subscriptions.
2620 - 'stb_enabled' => array(
2043 + 'stb_enabled' => array(
2621 2044 'description' => esc_html__( "Show a <em>'follow blog'</em> option in the comment form", 'jetpack' ),
2622 2045 'type' => 'boolean',
2623 2046 'default' => 1,
2624 2047 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2623,9 +2046,9 @@
2623 2046 'default' => 1,
2624 2047 'validate_callback' => __CLASS__ . '::validate_boolean',
2625 2048 'jp_group' => 'subscriptions',
2626 2049 ),
2627 - 'stc_enabled' => array(
2050 + 'stc_enabled' => array(
2628 2051 'description' => esc_html__( "Show a <em>'follow comments'</em> option in the comment form", 'jetpack' ),
2629 2052 'type' => 'boolean',
2630 2053 'default' => 1,
2631 2054 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2630,9 +2053,79 @@
2630 2053 'default' => 1,
2631 2054 'validate_callback' => __CLASS__ . '::validate_boolean',
2632 2055 'jp_group' => 'subscriptions',
2633 2056 ),
2634 - 'sm_enabled' => array(
2057 + 'wpcom_newsletter_categories' => array(
2058 + 'description' => esc_html__( 'Array of post category ids that are marked as newsletter categories', 'jetpack' ),
2059 + 'type' => 'array',
2060 + 'default' => array(),
2061 + 'validate_callback' => __CLASS__ . '::validate_array',
2062 + 'jp_group' => 'subscriptions',
2063 + ),
2064 + 'wpcom_newsletter_categories_enabled' => array(
2065 + 'description' => esc_html__( 'Whether the newsletter categories are enabled or not', 'jetpack' ),
2066 + 'type' => 'boolean',
2067 + 'default' => 0,
2068 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2069 + 'jp_group' => 'subscriptions',
2070 + ),
2071 + 'wpcom_newsletter_send_default' => array(
2072 + 'description' => esc_html__( 'Whether to send newsletter emails by default when publishing a post', 'jetpack' ),
2073 + 'type' => 'boolean',
2074 + 'default' => 1,
2075 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2076 + 'jp_group' => 'subscriptions',
2077 + ),
2078 + 'wpcom_featured_image_in_email' => array(
2079 + 'description' => esc_html__( 'Whether to include the featured image in the email or not', 'jetpack' ),
2080 + 'type' => 'boolean',
2081 + 'default' => 0,
2082 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2083 + 'jp_group' => 'subscriptions',
2084 + ),
2085 + 'jetpack_gravatar_in_email' => array(
2086 + 'description' => esc_html__( 'Whether to show author avatar in the email byline', 'jetpack' ),
2087 + 'type' => 'boolean',
2088 + 'default' => 1,
2089 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2090 + 'jp_group' => 'subscriptions',
2091 + ),
2092 + 'jetpack_author_in_email' => array(
2093 + 'description' => esc_html__( 'Whether to show author display name in the email byline', 'jetpack' ),
2094 + 'type' => 'boolean',
2095 + 'default' => 1,
2096 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2097 + 'jp_group' => 'subscriptions',
2098 + ),
2099 + 'jetpack_post_date_in_email' => array(
2100 + 'description' => esc_html__( 'Whether to show date in the email byline', 'jetpack' ),
2101 + 'type' => 'boolean',
2102 + 'default' => 1,
2103 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2104 + 'jp_group' => 'subscriptions',
2105 + ),
2106 + 'wpcom_subscription_emails_use_excerpt' => array(
2107 + 'description' => esc_html__( 'Whether to use the excerpt in the email or not', 'jetpack' ),
2108 + 'type' => 'boolean',
2109 + 'default' => 0,
2110 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2111 + 'jp_group' => 'subscriptions',
2112 + ),
2113 + 'jetpack_subscriptions_reply_to' => array(
2114 + 'description' => esc_html__( 'Reply to email behaviour for newsletters emails', 'jetpack' ),
2115 + 'type' => 'string',
2116 + 'default' => Automattic\Jetpack\Modules\Subscriptions\Settings::$default_reply_to,
2117 + 'validate_callback' => __CLASS__ . '::validate_subscriptions_reply_to',
2118 + 'jp_group' => 'subscriptions',
2119 + ),
2120 + 'jetpack_subscriptions_from_name' => array(
2121 + 'description' => esc_html__( 'From name for newsletters emails', 'jetpack' ),
2122 + 'type' => 'string',
2123 + 'default' => '',
2124 + 'validate_callback' => __CLASS__ . '::validate_subscriptions_reply_to_name',
2125 + 'jp_group' => 'subscriptions',
2126 + ),
2127 + 'sm_enabled' => array(
2635 2128 'description' => esc_html__( 'Show popup Subscribe modal to readers.', 'jetpack' ),
2636 2129 'type' => 'boolean',
2637 2130 'default' => 0,
2638 2131 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2637,18 +2130,67 @@
2637 2130 'default' => 0,
2638 2131 'validate_callback' => __CLASS__ . '::validate_boolean',
2639 2132 'jp_group' => 'subscriptions',
2640 2133 ),
2641 - 'social_notifications_subscribe' => array(
2642 - 'description' => esc_html__( 'Send email notification when someone follows my blog', 'jetpack' ),
2134 + 'jetpack_subscribe_overlay_enabled' => array(
2135 + 'description' => esc_html__( 'Show subscribe overlay on homepage.', 'jetpack' ),
2643 2136 'type' => 'boolean',
2644 2137 'default' => 0,
2645 2138 'validate_callback' => __CLASS__ . '::validate_boolean',
2646 2139 'jp_group' => 'subscriptions',
2647 2140 ),
2141 + 'jetpack_subscribe_floating_button_enabled' => array(
2142 + 'description' => esc_html__( 'Show a floating subscribe button.', 'jetpack' ),
2143 + 'type' => 'boolean',
2144 + 'default' => 0,
2145 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2146 + 'jp_group' => 'subscriptions',
2147 + ),
2148 + 'jetpack_subscriptions_subscribe_post_end_enabled' => array(
2149 + 'description' => esc_html__( 'Add Subscribe block at the end of each post.', 'jetpack' ),
2150 + 'type' => 'boolean',
2151 + 'default' => 0,
2152 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2153 + 'jp_group' => 'subscriptions',
2154 + ),
2155 + 'jetpack_subscriptions_login_navigation_enabled' => array(
2156 + 'description' => esc_html__( 'Add Subscriber Login block to the navigation.', 'jetpack' ),
2157 + 'type' => 'boolean',
2158 + 'default' => 0,
2159 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2160 + 'jp_group' => 'subscriptions',
2161 + ),
2162 + 'jetpack_subscriptions_subscribe_navigation_enabled' => array(
2163 + 'description' => esc_html__( 'Add Subscribe block to the navigation.', 'jetpack' ),
2164 + 'type' => 'boolean',
2165 + 'default' => 0,
2166 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2167 + 'jp_group' => 'subscriptions',
2168 + ),
2169 + 'social_notifications_subscribe' => array(
2170 + 'description' => esc_html__( 'Send email notification when someone subscribes to my blog', 'jetpack' ),
2171 + 'type' => 'boolean',
2172 + 'default' => 0,
2173 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2174 + 'jp_group' => 'subscriptions',
2175 + ),
2176 + 'subscription_options' => array(
2177 + 'description' => esc_html__( 'Options used in subscription email templates and the Subscribe block: \'invitation\', \'welcome\', \'comment_follow\', \'subscribe_modal_heading\', \'free_tier_description\' and \'hide_free_tier\'.', 'jetpack' ),
2178 + 'type' => 'object',
2179 + 'default' => array(
2180 + 'invitation' => '',
2181 + 'welcome' => '',
2182 + 'comment_follow' => '',
2183 + 'subscribe_modal_heading' => '',
2184 + 'free_tier_description' => '',
2185 + 'hide_free_tier' => false,
2186 + ),
2187 + 'validate_callback' => __CLASS__ . '::validate_subscription_options',
2188 + 'jp_group' => 'subscriptions',
2189 + ),
2648 2190
2649 2191 // Related Posts.
2650 - 'show_headline' => array(
2192 + 'show_headline' => array(
2651 2193 'description' => esc_html__( 'Highlight related content with a heading', 'jetpack' ),
2652 2194 'type' => 'boolean',
2653 2195 'default' => 1,
2654 2196 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2653,9 +2195,9 @@
2653 2195 'default' => 1,
2654 2196 'validate_callback' => __CLASS__ . '::validate_boolean',
2655 2197 'jp_group' => 'related-posts',
2656 2198 ),
2657 - 'show_thumbnails' => array(
2199 + 'show_thumbnails' => array(
2658 2200 'description' => esc_html__( 'Show a thumbnail image where available', 'jetpack' ),
2659 2201 'type' => 'boolean',
2660 2202 'default' => 0,
2661 2203 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2662,9 +2204,9 @@
2662 2204 'jp_group' => 'related-posts',
2663 2205 ),
2664 2206
2665 2207 // Search.
2666 - 'instant_search_enabled' => array(
2208 + 'instant_search_enabled' => array(
2667 2209 'description' => esc_html__( 'Enable Instant Search', 'jetpack' ),
2668 2210 'type' => 'boolean',
2669 2211 'default' => 0,
2670 2212 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2670,9 +2212,9 @@
2670 2212 'validate_callback' => __CLASS__ . '::validate_boolean',
2671 2213 'jp_group' => 'search',
2672 2214 ),
2673 2215
2674 - 'has_jetpack_search_product' => array(
2216 + 'has_jetpack_search_product' => array(
2675 2217 'description' => esc_html__( 'Has an active Jetpack Search product purchase', 'jetpack' ),
2676 2218 'type' => 'boolean',
2677 2219 'default' => 0,
2678 2220 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2678,9 +2220,9 @@
2678 2220 'validate_callback' => __CLASS__ . '::validate_boolean',
2679 2221 'jp_group' => 'settings',
2680 2222 ),
2681 2223
2682 - 'search_auto_config' => array(
2224 + 'search_auto_config' => array(
2683 2225 'description' => esc_html__( 'Trigger an auto config of instant search', 'jetpack' ),
2684 2226 'type' => 'boolean',
2685 2227 'default' => 0,
2686 2228 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2687,9 +2229,9 @@
2687 2229 'jp_group' => 'search',
2688 2230 ),
2689 2231
2690 2232 // Verification Tools.
2691 - 'google' => array(
2233 + 'google' => array(
2692 2234 'description' => esc_html__( 'Google Search Console', 'jetpack' ),
2693 2235 'type' => 'string',
2694 2236 'default' => '',
2695 2237 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2694,9 +2236,9 @@
2694 2236 'default' => '',
2695 2237 'validate_callback' => __CLASS__ . '::validate_verification_service',
2696 2238 'jp_group' => 'verification-tools',
2697 2239 ),
2698 - 'bing' => array(
2240 + 'bing' => array(
2699 2241 'description' => esc_html__( 'Bing Webmaster Center', 'jetpack' ),
2700 2242 'type' => 'string',
2701 2243 'default' => '',
2702 2244 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2701,9 +2243,9 @@
2701 2243 'default' => '',
2702 2244 'validate_callback' => __CLASS__ . '::validate_verification_service',
2703 2245 'jp_group' => 'verification-tools',
2704 2246 ),
2705 - 'pinterest' => array(
2247 + 'pinterest' => array(
2706 2248 'description' => esc_html__( 'Pinterest Site Verification', 'jetpack' ),
2707 2249 'type' => 'string',
2708 2250 'default' => '',
2709 2251 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2708,9 +2250,9 @@
2708 2250 'default' => '',
2709 2251 'validate_callback' => __CLASS__ . '::validate_verification_service',
2710 2252 'jp_group' => 'verification-tools',
2711 2253 ),
2712 - 'yandex' => array(
2254 + 'yandex' => array(
2713 2255 'description' => esc_html__( 'Yandex Site Verification', 'jetpack' ),
2714 2256 'type' => 'string',
2715 2257 'default' => '',
2716 2258 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2715,9 +2257,9 @@
2715 2257 'default' => '',
2716 2258 'validate_callback' => __CLASS__ . '::validate_verification_service',
2717 2259 'jp_group' => 'verification-tools',
2718 2260 ),
2719 - 'facebook' => array(
2261 + 'facebook' => array(
2720 2262 'description' => esc_html__( 'Facebook Domain Verification', 'jetpack' ),
2721 2263 'type' => 'string',
2722 2264 'default' => '',
2723 2265 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2724,9 +2266,9 @@
2724 2266 'jp_group' => 'verification-tools',
2725 2267 ),
2726 2268
2727 2269 // WordAds.
2728 - 'enable_header_ad' => array(
2270 + 'enable_header_ad' => array(
2729 2271 'description' => esc_html__( 'Display an ad unit at the top of each page.', 'jetpack' ),
2730 2272 'type' => 'boolean',
2731 2273 'default' => 1,
2732 2274 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2731,9 +2273,9 @@
2731 2273 'default' => 1,
2732 2274 'validate_callback' => __CLASS__ . '::validate_boolean',
2733 2275 'jp_group' => 'wordads',
2734 2276 ),
2735 - 'wordads_approved' => array(
2277 + 'wordads_approved' => array(
2736 2278 'description' => esc_html__( 'Is site approved for WordAds?', 'jetpack' ),
2737 2279 'type' => 'boolean',
2738 2280 'default' => 0,
2739 2281 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2738,9 +2280,9 @@
2738 2280 'default' => 0,
2739 2281 'validate_callback' => __CLASS__ . '::validate_boolean',
2740 2282 'jp_group' => 'wordads',
2741 2283 ),
2742 - 'wordads_second_belowpost' => array(
2284 + 'wordads_second_belowpost' => array(
2743 2285 'description' => esc_html__( 'Display second ad below post?', 'jetpack' ),
2744 2286 'type' => 'boolean',
2745 2287 'default' => 1,
2746 2288 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2745,9 +2287,16 @@
2745 2287 'default' => 1,
2746 2288 'validate_callback' => __CLASS__ . '::validate_boolean',
2747 2289 'jp_group' => 'wordads',
2748 2290 ),
2749 - 'wordads_display_front_page' => array(
2291 + 'wordads_inline_enabled' => array(
2292 + 'description' => esc_html__( 'Display inline ad within post content?', 'jetpack' ),
2293 + 'type' => 'boolean',
2294 + 'default' => 1,
2295 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2296 + 'jp_group' => 'wordads',
2297 + ),
2298 + 'wordads_display_front_page' => array(
2750 2299 'description' => esc_html__( 'Display ads on the front page?', 'jetpack' ),
2751 2300 'type' => 'boolean',
2752 2301 'default' => 1,
2753 2302 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2752,9 +2301,9 @@
2752 2301 'default' => 1,
2753 2302 'validate_callback' => __CLASS__ . '::validate_boolean',
2754 2303 'jp_group' => 'wordads',
2755 2304 ),
2756 - 'wordads_display_post' => array(
2305 + 'wordads_display_post' => array(
2757 2306 'description' => esc_html__( 'Display ads on posts?', 'jetpack' ),
2758 2307 'type' => 'boolean',
2759 2308 'default' => 1,
2760 2309 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2759,9 +2308,9 @@
2759 2308 'default' => 1,
2760 2309 'validate_callback' => __CLASS__ . '::validate_boolean',
2761 2310 'jp_group' => 'wordads',
2762 2311 ),
2763 - 'wordads_display_page' => array(
2312 + 'wordads_display_page' => array(
2764 2313 'description' => esc_html__( 'Display ads on pages?', 'jetpack' ),
2765 2314 'type' => 'boolean',
2766 2315 'default' => 1,
2767 2316 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2766,9 +2315,9 @@
2766 2315 'default' => 1,
2767 2316 'validate_callback' => __CLASS__ . '::validate_boolean',
2768 2317 'jp_group' => 'wordads',
2769 2318 ),
2770 - 'wordads_display_archive' => array(
2319 + 'wordads_display_archive' => array(
2771 2320 'description' => esc_html__( 'Display ads on archive pages?', 'jetpack' ),
2772 2321 'type' => 'boolean',
2773 2322 'default' => 1,
2774 2323 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2773,9 +2322,9 @@
2773 2322 'default' => 1,
2774 2323 'validate_callback' => __CLASS__ . '::validate_boolean',
2775 2324 'jp_group' => 'wordads',
2776 2325 ),
2777 - 'wordads_custom_adstxt_enabled' => array(
2326 + 'wordads_custom_adstxt_enabled' => array(
2778 2327 'description' => esc_html__( 'Custom ads.txt', 'jetpack' ),
2779 2328 'type' => 'boolean',
2780 2329 'default' => 0,
2781 2330 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2780,9 +2329,9 @@
2780 2329 'default' => 0,
2781 2330 'validate_callback' => __CLASS__ . '::validate_boolean',
2782 2331 'jp_group' => 'wordads',
2783 2332 ),
2784 - 'wordads_custom_adstxt' => array(
2333 + 'wordads_custom_adstxt' => array(
2785 2334 'description' => esc_html__( 'Custom ads.txt entries', 'jetpack' ),
2786 2335 'type' => 'string',
2787 2336 'default' => '',
2788 2337 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2788,9 +2337,9 @@
2788 2337 'validate_callback' => __CLASS__ . '::validate_string',
2789 2338 'sanitize_callback' => 'sanitize_textarea_field',
2790 2339 'jp_group' => 'wordads',
2791 2340 ),
2792 - 'wordads_ccpa_enabled' => array(
2341 + 'wordads_ccpa_enabled' => array(
2793 2342 'description' => esc_html__( 'Enable support for California Consumer Privacy Act', 'jetpack' ),
2794 2343 'type' => 'boolean',
2795 2344 'default' => 0,
2796 2345 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2795,9 +2344,9 @@
2795 2344 'default' => 0,
2796 2345 'validate_callback' => __CLASS__ . '::validate_boolean',
2797 2346 'jp_group' => 'wordads',
2798 2347 ),
2799 - 'wordads_ccpa_privacy_policy_url' => array(
2348 + 'wordads_ccpa_privacy_policy_url' => array(
2800 2349 'description' => esc_html__( 'Privacy Policy URL', 'jetpack' ),
2801 2350 'type' => 'string',
2802 2351 'default' => '',
2803 2352 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2803,11 +2352,18 @@
2803 2352 'validate_callback' => __CLASS__ . '::validate_string',
2804 2353 'sanitize_callback' => 'sanitize_text_field',
2805 2354 'jp_group' => 'wordads',
2806 2355 ),
2356 + 'wordads_cmp_enabled' => array(
2357 + 'description' => esc_html__( 'Enable GDPR Consent Management Banner for WordAds', 'jetpack' ),
2358 + 'type' => 'boolean',
2359 + 'default' => 0,
2360 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2361 + 'jp_group' => 'wordads',
2362 + ),
2807 2363
2808 2364 // Google Analytics.
2809 - 'google_analytics_tracking_id' => array(
2365 + 'google_analytics_tracking_id' => array(
2810 2366 'description' => esc_html__( 'Google Analytics', 'jetpack' ),
2811 2367 'type' => 'string',
2812 2368 'default' => '',
2813 2369 'validate_callback' => __CLASS__ . '::validate_alphanum',
@@ -2812,11 +2368,16 @@
2812 2368 'default' => '',
2813 2369 'validate_callback' => __CLASS__ . '::validate_alphanum',
2814 2370 'jp_group' => 'google-analytics',
2815 2371 ),
2372 + 'jetpack_wga' => array(
2373 + 'description' => esc_html__( 'Google Analytics', 'jetpack' ),
2374 + 'type' => 'object',
2375 + 'jp_group' => 'settings',
2376 + ),
2816 2377
2817 2378 // Stats.
2818 - 'admin_bar' => array(
2379 + 'admin_bar' => array(
2819 2380 'description' => esc_html__( 'Include a small chart in your admin bar with a 48-hour traffic snapshot.', 'jetpack' ),
2820 2381 'type' => 'boolean',
2821 2382 'default' => 1,
2822 2383 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2821,9 +2382,9 @@
2821 2382 'default' => 1,
2822 2383 'validate_callback' => __CLASS__ . '::validate_boolean',
2823 2384 'jp_group' => 'stats',
2824 2385 ),
2825 - 'enable_odyssey_stats' => array(
2386 + 'enable_odyssey_stats' => array(
2826 2387 'description' => esc_html__( 'Preview the new Jetpack Stats experience (Experimental).', 'jetpack' ),
2827 2388 'type' => 'boolean',
2828 2389 'default' => 1,
2829 2390 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2828,9 +2389,9 @@
2828 2389 'default' => 1,
2829 2390 'validate_callback' => __CLASS__ . '::validate_boolean',
2830 2391 'jp_group' => 'stats',
2831 2392 ),
2832 - 'roles' => array(
2393 + 'roles' => array(
2833 2394 'description' => esc_html__( 'Select the roles that will be able to view stats reports.', 'jetpack' ),
2834 2395 'type' => 'array',
2835 2396 'items' => array(
2836 2397 'type' => 'string',
@@ -2839,9 +2400,9 @@
2839 2400 'validate_callback' => __CLASS__ . '::validate_stats_roles',
2840 2401 'sanitize_callback' => __CLASS__ . '::sanitize_stats_allowed_roles',
2841 2402 'jp_group' => 'stats',
2842 2403 ),
2843 - 'count_roles' => array(
2404 + 'count_roles' => array(
2844 2405 'description' => esc_html__( 'Count the page views of registered users who are logged in.', 'jetpack' ),
2845 2406 'type' => 'array',
2846 2407 'items' => array(
2847 2408 'type' => 'string',
@@ -2849,9 +2410,9 @@
2849 2410 'default' => array( 'administrator' ),
2850 2411 'validate_callback' => __CLASS__ . '::validate_stats_roles',
2851 2412 'jp_group' => 'stats',
2852 2413 ),
2853 - 'blog_id' => array(
2414 + 'blog_id' => array(
2854 2415 'description' => esc_html__( 'Blog ID.', 'jetpack' ),
2855 2416 'type' => 'boolean',
2856 2417 'default' => 0,
2857 2418 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2856,9 +2417,9 @@
2856 2417 'default' => 0,
2857 2418 'validate_callback' => __CLASS__ . '::validate_boolean',
2858 2419 'jp_group' => 'stats',
2859 2420 ),
2860 - 'do_not_track' => array(
2421 + 'do_not_track' => array(
2861 2422 'description' => esc_html__( 'Do not track.', 'jetpack' ),
2862 2423 'type' => 'boolean',
2863 2424 'default' => 1,
2864 2425 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2863,9 +2424,9 @@
2863 2424 'default' => 1,
2864 2425 'validate_callback' => __CLASS__ . '::validate_boolean',
2865 2426 'jp_group' => 'stats',
2866 2427 ),
2867 - 'version' => array(
2428 + 'version' => array(
2868 2429 'description' => esc_html__( 'Version.', 'jetpack' ),
2869 2430 'type' => 'integer',
2870 2431 'default' => 9,
2871 2432 'validate_callback' => __CLASS__ . '::validate_posint',
@@ -2870,9 +2431,9 @@
2870 2431 'default' => 9,
2871 2432 'validate_callback' => __CLASS__ . '::validate_posint',
2872 2433 'jp_group' => 'stats',
2873 2434 ),
2874 - 'collapse_nudges' => array(
2435 + 'collapse_nudges' => array(
2875 2436 'description' => esc_html__( 'Collapse upgrade nudges', 'jetpack' ),
2876 2437 'type' => 'boolean',
2877 2438 'default' => 0,
2878 2439 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2879,9 +2440,9 @@
2879 2440 'jp_group' => 'stats',
2880 2441 ),
2881 2442
2882 2443 // Whether to share stats views with WordPress.com Reader.
2883 - 'wpcom_reader_views_enabled' => array(
2444 + 'wpcom_reader_views_enabled' => array(
2884 2445 'description' => esc_html__( 'Show post views in the WordPress.com Reader.', 'jetpack' ),
2885 2446 'type' => 'boolean',
2886 2447 'default' => 1,
2887 2448 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2888,9 +2449,9 @@
2888 2449 'jp_group' => 'settings',
2889 2450 ),
2890 2451
2891 2452 // Akismet - Not a module, but a plugin. The options can be passed and handled differently.
2892 - 'akismet_show_user_comments_approved' => array(
2453 + 'akismet_show_user_comments_approved' => array(
2893 2454 'description' => '',
2894 2455 'type' => 'boolean',
2895 2456 'default' => 0,
2896 2457 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2896,9 +2457,9 @@
2896 2457 'validate_callback' => __CLASS__ . '::validate_boolean',
2897 2458 'jp_group' => 'settings',
2898 2459 ),
2899 2460
2900 - 'wordpress_api_key' => array(
2461 + 'wordpress_api_key' => array(
2901 2462 'description' => '',
2902 2463 'type' => 'string',
2903 2464 'default' => '',
2904 2465 'validate_callback' => __CLASS__ . '::validate_alphanum',
@@ -2905,9 +2466,9 @@
2905 2466 'jp_group' => 'settings',
2906 2467 ),
2907 2468
2908 2469 // Empty stats card dismiss.
2909 - 'dismiss_empty_stats_card' => array(
2470 + 'dismiss_empty_stats_card' => array(
2910 2471 'description' => '',
2911 2472 'type' => 'boolean',
2912 2473 'default' => 0,
2913 2474 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2914,9 +2475,9 @@
2914 2475 'jp_group' => 'settings',
2915 2476 ),
2916 2477
2917 2478 // Backup Getting Started card on dashboard.
2918 - 'dismiss_dash_backup_getting_started' => array(
2479 + 'dismiss_dash_backup_getting_started' => array(
2919 2480 'description' => '',
2920 2481 'type' => 'boolean',
2921 2482 'default' => 0,
2922 2483 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2923,9 +2484,9 @@
2923 2484 'jp_group' => 'settings',
2924 2485 ),
2925 2486
2926 2487 // Agencies Learn More card on dashboard.
2927 - 'dismiss_dash_agencies_learn_more' => array(
2488 + 'dismiss_dash_agencies_learn_more' => array(
2928 2489 'description' => '',
2929 2490 'type' => 'boolean',
2930 2491 'default' => 0,
2931 2492 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2931,9 +2492,9 @@
2931 2492 'validate_callback' => __CLASS__ . '::validate_boolean',
2932 2493 'jp_group' => 'settings',
2933 2494 ),
2934 2495
2935 - 'lang_id' => array(
2496 + 'lang_id' => array(
2936 2497 'description' => esc_html__( 'Primary language for the site.', 'jetpack' ),
2937 2498 'type' => 'string',
2938 2499 'default' => 'en_US',
2939 2500 'jp_group' => 'settings',
@@ -2938,32 +2499,10 @@
2938 2499 'default' => 'en_US',
2939 2500 'jp_group' => 'settings',
2940 2501 ),
2941 2502
2942 - 'onboarding' => array(
2943 - 'description' => '',
2944 - 'type' => 'object',
2945 - 'default' => array(
2946 - 'siteTitle' => '',
2947 - 'siteDescription' => '',
2948 - 'siteType' => 'personal',
2949 - 'homepageFormat' => 'posts',
2950 - 'addContactForm' => 0,
2951 - 'businessAddress' => array(
2952 - 'name' => '',
2953 - 'street' => '',
2954 - 'city' => '',
2955 - 'state' => '',
2956 - 'zip' => '',
2957 - ),
2958 - 'installWooCommerce' => false,
2959 - ),
2960 - 'validate_callback' => __CLASS__ . '::validate_onboarding',
2961 - 'jp_group' => 'settings',
2962 - ),
2963 -
2964 2503 // SEO Tools.
2965 - 'advanced_seo_front_page_description' => array(
2504 + 'advanced_seo_front_page_description' => array(
2966 2505 'description' => esc_html__( 'Front page meta description.', 'jetpack' ),
2967 2506 'type' => 'string',
2968 2507 'default' => '',
2969 2508 'sanitize_callback' => 'Jetpack_SEO_Utils::sanitize_front_page_meta_description',
@@ -2969,9 +2508,9 @@
2969 2508 'sanitize_callback' => 'Jetpack_SEO_Utils::sanitize_front_page_meta_description',
2970 2509 'jp_group' => 'seo-tools',
2971 2510 ),
2972 2511
2973 - 'advanced_seo_title_formats' => array(
2512 + 'advanced_seo_title_formats' => array(
2974 2513 'description' => esc_html__( 'SEO page title structures.', 'jetpack' ),
2975 2514 'type' => 'object',
2976 2515 'default' => array(
2977 2516 'archives' => array(),
@@ -2984,10 +2523,34 @@
2984 2523 'validate_callback' => 'Jetpack_SEO_Titles::are_valid_title_formats',
2985 2524 'sanitize_callback' => 'Jetpack_SEO_Titles::sanitize_title_formats',
2986 2525 ),
2987 2526
2527 + // AI tab (Jetpack > SEO). Plain option the SEO package reads to serve
2528 + // /llms.txt. The front-end behavior is gated inside the package; this
2529 + // only round-trips the persisted state alongside the other seo-tools
2530 + // settings.
2531 + 'jetpack_seo_llms_txt_enabled' => array(
2532 + 'description' => esc_html__( 'Generate an llms.txt file to guide AI assistants around your content.', 'jetpack' ),
2533 + 'type' => 'boolean',
2534 + 'default' => 0,
2535 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2536 + 'jp_group' => 'seo-tools',
2537 + ),
2538 +
2539 + // AI tab (Jetpack > SEO). Sparse per-crawler override map the SEO
2540 + // package reads to emit robots.txt directives for blocked AI crawlers.
2541 + // Stored as `slug => bool` (true = blocked); catalog validation and
2542 + // default-pruning happen in `Ai_Crawlers::get_overrides()`.
2543 + 'jetpack_seo_ai_crawler_overrides' => array(
2544 + 'description' => esc_html__( 'AI crawler allow/block overrides.', 'jetpack' ),
2545 + 'type' => 'object',
2546 + 'default' => array(),
2547 + 'jp_group' => 'seo-tools',
2548 + 'sanitize_callback' => __CLASS__ . '::sanitize_ai_crawler_overrides',
2549 + ),
2550 +
2988 2551 // VideoPress.
2989 - 'videopress_private_enabled_for_site' => array(
2552 + 'videopress_private_enabled_for_site' => array(
2990 2553 'description' => esc_html__( 'Video Privacy: Restrict views to members of this site', 'jetpack' ),
2991 2554 'type' => 'boolean',
2992 2555 'default' => 0,
2993 2556 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2994,8 +2557,21 @@
2994 2557 'jp_group' => 'videopress',
2995 2558 ),
2996 2559 );
2997 2560
2561 + // SEO Tools - SEO Enhancer.
2562 + // TODO: move this to the main options array? The filter was there while developing the feature.
2563 + // It might come in handy to hold its availability behind the filter since it still depends on AI to be available.
2564 + if ( apply_filters( 'ai_seo_enhancer_enabled', true ) ) {
2565 + $options['ai_seo_enhancer_enabled'] = array(
2566 + 'description' => esc_html__( 'Automatically generate SEO title, SEO description, and image alt text for new posts.', 'jetpack' ),
2567 + 'type' => 'boolean',
2568 + 'default' => 0,
2569 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2570 + 'jp_group' => 'seo-tools',
2571 + );
2572 + }
2573 +
2998 2574 // Add modules to list so they can be toggled.
2999 2575 $modules = Jetpack::get_available_modules();
3000 2576 if ( is_array( $modules ) && ! empty( $modules ) ) {
3001 2577 $module_args = array(
@@ -3041,8 +2617,10 @@
3041 2617 * Validates that the parameters are proper values that can be set during Jetpack onboarding.
3042 2618 *
3043 2619 * @since 5.4.0
3044 2620 *
2621 + * @deprecated since 13.9
2622 + *
3045 2623 * @param array $onboarding_data Values to check.
3046 2624 * @param WP_REST_Request $request The request sent to the WP REST API.
3047 2625 * @param string $param Name of the parameter passed to endpoint holding $value.
3048 2626 *
@@ -3047,24 +2625,10 @@
3047 2625 * @param string $param Name of the parameter passed to endpoint holding $value.
3048 2626 *
3049 2627 * @return bool|WP_Error
3050 2628 */
3051 - public static function validate_onboarding( $onboarding_data, $request, $param ) {
3052 - if ( ! is_array( $onboarding_data ) ) {
3053 - return new WP_Error( 'invalid_param', esc_html__( 'Not valid onboarding data.', 'jetpack' ) );
3054 - }
3055 - foreach ( $onboarding_data as $value ) {
3056 - if ( is_string( $value ) ) {
3057 - $onboarding_choice = self::validate_string( $value, $request, $param );
3058 - } elseif ( is_array( $value ) ) {
3059 - $onboarding_choice = self::validate_onboarding( $value, $request, $param );
3060 - } else {
3061 - $onboarding_choice = self::validate_boolean( $value, $request, $param );
3062 - }
3063 - if ( is_wp_error( $onboarding_choice ) ) {
3064 - return $onboarding_choice;
3065 - }
3066 - }
2629 + public static function validate_onboarding( $onboarding_data, $request, $param ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
2630 + _deprecated_function( __METHOD__, '13.9' );
3067 2631 return true;
3068 2632 }
3069 2633
3070 2634 /**
@@ -3260,14 +2824,14 @@
3260 2824 *
3261 2825 * @return bool|WP_Error
3262 2826 */
3263 2827 public static function validate_verification_service( $value, $request, $param ) {
3264 - if ( ! empty( $value ) && ! ( is_string( $value ) && ( preg_match( '/^[a-z0-9_-]+$/i', $value ) || jetpack_verification_get_code( $value ) !== false ) ) ) {
2828 + if ( ! empty( $value ) && ( ! is_string( $value ) || false === jetpack_verification_validate_code( $value ) ) ) {
3265 2829 return new WP_Error(
3266 2830 'invalid_param',
3267 2831 sprintf(
3268 2832 /* Translators: Placeholder is a verification string used to verify a service like Google Webmaster Console. */
3269 - esc_html__( '%s must be an alphanumeric string or a verification tag.', 'jetpack' ),
2833 + esc_html__( '%s must be a valid verification code or verification tag.', 'jetpack' ),
3270 2834 $param
3271 2835 )
3272 2836 );
3273 2837 }
@@ -3278,9 +2842,9 @@
3278 2842 * Validates that the parameter is among the roles allowed for Stats.
3279 2843 *
3280 2844 * @since 4.3.0
3281 2845 *
3282 - * @param string|bool $value Value to check.
2846 + * @param mixed $value Value to check.
3283 2847 * @param WP_REST_Request $request The request sent to the WP REST API.
3284 2848 * @param string $param Name of the parameter passed to endpoint holding $value.
3285 2849 *
3286 2850 * @return bool|WP_Error
@@ -3285,16 +2849,37 @@
3285 2849 *
3286 2850 * @return bool|WP_Error
3287 2851 */
3288 2852 public static function validate_stats_roles( $value, $request, $param ) {
3289 - if ( ! empty( $value ) && ! array_intersect( self::$stats_roles, $value ) ) {
2853 + // An empty value clears the setting; sanitize_stats_allowed_roles() falls back to 'administrator'.
2854 + if ( empty( $value ) ) {
2855 + return true;
2856 + }
2857 +
2858 + // Enforce the schema's list-of-strings contract before array_intersect() below sees the value.
2859 + if ( ! is_array( $value ) || count( array_filter( $value, 'is_string' ) ) !== count( $value ) ) {
3290 2860 return new WP_Error(
3291 2861 'invalid_param',
3292 2862 sprintf(
2863 + /* Translators: Placeholder is a parameter name. */
2864 + esc_html__( '%s must be an array of user roles.', 'jetpack' ),
2865 + $param
2866 + )
2867 + );
2868 + }
2869 +
2870 + if ( ! function_exists( 'get_editable_roles' ) ) {
2871 + require_once ABSPATH . 'wp-admin/includes/user.php';
2872 + }
2873 + $editable_roles = array_keys( get_editable_roles() );
2874 + if ( ! array_intersect( $editable_roles, $value ) ) {
2875 + return new WP_Error(
2876 + 'invalid_param',
2877 + sprintf(
3293 2878 /* Translators: first variable is the name of a parameter passed to endpoint holding the role that will be checked, the second is a list of roles allowed to see stats. The parameter is checked against this list. */
3294 2879 esc_html__( '%1$s must be %2$s.', 'jetpack' ),
3295 2880 $param,
3296 - implode( ', ', self::$stats_roles )
2881 + implode( ', ', $editable_roles )
3297 2882 )
3298 2883 );
3299 2884 }
3300 2885 return true;
@@ -3337,8 +2922,59 @@
3337 2922 return true;
3338 2923 }
3339 2924
3340 2925 /**
2926 + * Validates that the parameter is among the valid reply-to types for subscriptions.
2927 + *
2928 + * @since 4.3.0
2929 + *
2930 + * @param string|bool $value Value to check.
2931 + * @param WP_REST_Request $request The request sent to the WP REST API.
2932 + * @param string $param Name of the parameter passed to endpoint holding $value.
2933 + *
2934 + * @return bool|WP_Error
2935 + */
2936 + public static function validate_subscriptions_reply_to( $value, $request, $param ) {
2937 + require_once JETPACK__PLUGIN_DIR . 'modules/subscriptions/class-settings.php';
2938 + if ( ! empty( $value ) && ! Automattic\Jetpack\Modules\Subscriptions\Settings::is_valid_reply_to( $value ) ) {
2939 + return new WP_Error(
2940 + 'invalid_param',
2941 + sprintf(
2942 + /* Translators: Placeholder is a parameter name. */
2943 + esc_html__( '%s must be a valid type.', 'jetpack' ),
2944 + $param
2945 + )
2946 + );
2947 + }
2948 + return true;
2949 + }
2950 +
2951 + /**
2952 + * Validates that the parameter is among the valid reply-to types for subscriptions.
2953 + *
2954 + * @since 4.3.0
2955 + *
2956 + * @param string|bool $value Value to check.
2957 + * @param WP_REST_Request $request The request sent to the WP REST API.
2958 + * @param string $param Name of the parameter passed to endpoint holding $value.
2959 + *
2960 + * @return bool|WP_Error
2961 + */
2962 + public static function validate_subscriptions_reply_to_name( $value, $request, $param ) {
2963 + if ( ! empty( $value ) && ! is_string( $value ) ) {
2964 + return new WP_Error(
2965 + 'invalid_param',
2966 + sprintf(
2967 + /* Translators: Placeholder is a parameter name. */
2968 + esc_html__( '%s must be a valid type.', 'jetpack' ),
2969 + $param
2970 + )
2971 + );
2972 + }
2973 + return true;
2974 + }
2975 +
2976 + /**
3341 2977 * Validates that the parameter is among the views where the Sharing can be displayed.
3342 2978 *
3343 2979 * @since 4.3.0
3344 2980 *
@@ -3553,16 +3189,72 @@
3553 3189 return true;
3554 3190 }
3555 3191
3556 3192 /**
3193 + * Validates the subscription_options parameter.
3194 + *
3195 + * @param array $values Value to check.
3196 + *
3197 + * @return bool|WP_Error
3198 + */
3199 + public static function validate_subscription_options( $values ) {
3200 + // A REST "object" decodes to a PHP associative array. Reject any other
3201 + // type (object, string, int, null, ...) up front so the array_keys()
3202 + // loop below never runs against a non-array and triggers a PHP warning.
3203 + if ( ! is_array( $values ) ) {
3204 + return new WP_Error(
3205 + 'invalid_param',
3206 + /* Translators: subscription_options is a variable name, and shouldn't be translated. */
3207 + esc_html__( 'subscription_options must be an object.', 'jetpack' )
3208 + );
3209 + }
3210 + foreach ( array_keys( $values ) as $key ) {
3211 + if ( ! in_array( $key, array( 'welcome', 'invitation', 'comment_follow', 'subscribe_modal_heading', 'free_tier_description', 'hide_free_tier' ), true ) ) {
3212 + return new WP_Error(
3213 + 'invalid_param',
3214 + sprintf(
3215 + /* Translators: Placeholder is the invalid param being sent. */
3216 + esc_html__( '%s is not one of the allowed members of subscription_options.', 'jetpack' ),
3217 + $key
3218 + )
3219 + );
3220 + }
3221 + }
3222 + return true;
3223 + }
3224 +
3225 + /**
3226 + * Validates that the parameter is an array.
3227 + *
3228 + * @param array $values Value to check.
3229 + * @param WP_REST_Request $request The request sent to the WP REST API.
3230 + * @param string $param Name of the parameter passed to the endpoint holding $value.
3231 + *
3232 + * @return bool|WP_Error
3233 + */
3234 + public static function validate_array( $values, $request, $param ) {
3235 + if ( ! is_array( $values ) ) {
3236 + return new WP_Error(
3237 + 'invalid_param',
3238 + sprintf(
3239 + /* Translators: Placeholder is a parameter name. */
3240 + esc_html__( '%s must be an object.', 'jetpack' ),
3241 + $param
3242 + )
3243 + );
3244 + }
3245 + return true;
3246 + }
3247 +
3248 + /**
3557 3249 * If for some reason the roles allowed to see Stats are empty (for example, user tampering with checkboxes),
3558 3250 * return an array with only 'administrator' as the allowed role and save it for 'roles' option.
3559 3251 *
3560 3252 * @since 4.3.0
3561 3253 *
3562 - * @param string|bool $value Value to check.
3254 + * @param mixed $value Value to check.
3563 3255 *
3564 - * @return bool|array
3256 + * @return mixed The value as submitted, or an array holding only 'administrator' when it is empty.
3565 3257 */
3566 3258 public static function sanitize_stats_allowed_roles( $value ) {
3567 3259 if ( empty( $value ) ) {
3568 3260 return array( 'administrator' );
@@ -3570,8 +3262,31 @@
3570 3262 return $value;
3571 3263 }
3572 3264
3573 3265 /**
3266 + * Sanitize the AI crawler override map.
3267 + *
3268 + * Keeps the value package-agnostic: each key is normalized with sanitize_key()
3269 + * and each value cast to bool. Catalog validation and default-pruning happen in
3270 + * `Automattic\Jetpack\SEO\Ai_Crawlers::get_overrides()`.
3271 + *
3272 + * @param mixed $value The submitted override map.
3273 + *
3274 + * @return array<string, bool> Sanitized `slug => bool` map.
3275 + */
3276 + public static function sanitize_ai_crawler_overrides( $value ) {
3277 + if ( ! is_array( $value ) ) {
3278 + return array();
3279 + }
3280 +
3281 + $sanitized = array();
3282 + foreach ( $value as $k => $v ) {
3283 + $sanitized[ sanitize_key( $k ) ] = (bool) $v;
3284 + }
3285 + return $sanitized;
3286 + }
3287 +
3288 + /**
3574 3289 * Get the currently accessed route and return the module slug in it.
3575 3290 *
3576 3291 * @since 4.3.0
3577 3292 *
@@ -3580,9 +3295,9 @@
3580 3295 * @return array|string
3581 3296 */
3582 3297 public static function get_module_requested( $route = '/module/(?P<slug>[a-z\-]+)' ) {
3583 3298
3584 - if ( empty( $GLOBALS['wp']->query_vars['rest_route'] ) ) {
3299 + if ( empty( $GLOBALS['wp']->query_vars['rest_route'] ) || ! is_string( $GLOBALS['wp']->query_vars['rest_route'] ) ) {
3585 3300 return '';
3586 3301 }
3587 3302
3588 3303 preg_match( "#$route#", $GLOBALS['wp']->query_vars['rest_route'], $module );
@@ -3633,8 +3348,40 @@
3633 3348 return $modules;
3634 3349 }
3635 3350
3636 3351 /**
3352 + * Remove options the current user cannot read.
3353 + *
3354 + * Covers every `jetpack_waf_*` option, plus the two Protect options that expose the
3355 + * same data under a different name: `jetpack_protect_global_whitelist` is populated
3356 + * from `jetpack_waf_ip_allow_list`, and `jetpack_protect_key` is a shared secret.
3357 + *
3358 + * @since 16.2
3359 + *
3360 + * @param array $options Option definitions keyed by option name.
3361 + * @return array
3362 + */
3363 + public static function filter_options_for_response( $options ) {
3364 + if ( current_user_can( 'manage_options' ) ) {
3365 + return $options;
3366 + }
3367 +
3368 + $restricted = array(
3369 + 'jetpack_protect_key',
3370 + 'jetpack_protect_global_whitelist',
3371 + );
3372 +
3373 + return array_filter(
3374 + $options,
3375 + static function ( $option_name ) use ( $restricted ) {
3376 + return 0 !== strpos( $option_name, 'jetpack_waf_' )
3377 + && ! in_array( $option_name, $restricted, true );
3378 + },
3379 + ARRAY_FILTER_USE_KEY
3380 + );
3381 + }
3382 +
3383 + /**
3637 3384 * Remove 'validate_callback' item from options available for module.
3638 3385 * Fetch current option value and add to array of module options.
3639 3386 * Prepare values of module options that need special handling, like those saved in wpcom.
3640 3387 *
@@ -3697,9 +3444,9 @@
3697 3444 $options = self::split_options( $options, $sharer->get_global_options() );
3698 3445 $options['sharing_services']['current_value'] = $sharer->get_blog_services();
3699 3446 $other_sharedaddy_options = array( 'jetpack-twitter-cards-site-tag', 'sharedaddy_disable_resources', 'sharing_delete_service' );
3700 3447 foreach ( $other_sharedaddy_options as $key ) {
3701 - $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
3448 + $default_value = $options[ $key ]['default'] ?? '';
3702 3449 $current_value = get_option( $key, $default_value );
3703 3450 $options[ $key ]['current_value'] = self::cast_value( $current_value, $options[ $key ] );
3704 3451 }
3705 3452 break;
@@ -3710,9 +3457,9 @@
3710 3457 break;
3711 3458 default:
3712 3459 // These option are just stored as plain WordPress options.
3713 3460 foreach ( $options as $key => $value ) {
3714 - $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
3461 + $default_value = $options[ $key ]['default'] ?? '';
3715 3462 $current_value = get_option( $key, $default_value );
3716 3463 $options[ $key ]['current_value'] = self::cast_value( $current_value, $options[ $key ] );
3717 3464 }
3718 3465 }
@@ -3722,14 +3469,17 @@
3722 3469 // We don't need validate_callback in the response.
3723 3470 if ( isset( $options[ $key ]['validate_callback'] ) ) {
3724 3471 unset( $options[ $key ]['validate_callback'] );
3725 3472 }
3726 - $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
3473 + $default_value = $options[ $key ]['default'] ?? '';
3727 3474 if ( ! array_key_exists( 'current_value', $options[ $key ] ) ) {
3728 3475 $options[ $key ]['current_value'] = self::cast_value( $default_value, $options[ $key ] );
3729 3476 }
3730 3477 }
3731 - return $options;
3478 +
3479 + // Filter last: the switch above assigns current_value by key without isset(),
3480 + // so filtering earlier would let those assignments re-add a removed option.
3481 + return self::filter_options_for_response( $options );
3732 3482 }
3733 3483
3734 3484 /**
3735 3485 * Splits module options saved as arrays like relatedposts or verification_services_codes into separate options to be returned in the response.
@@ -4234,60 +3984,52 @@
4234 3984 return rest_ensure_response( array( 'success' => $updated_option ) );
4235 3985 }
4236 3986
4237 3987 /**
4238 - * Fetch introdution offers.
3988 + * Return the list of available features.
4239 3989 *
4240 - * @since 10.9
4241 - *
4242 - * @return array|WP_Error
3990 + * @return array
4243 3991 */
4244 - public static function get_intro_offers() {
4245 - $site_id = Jetpack_Options::get_option( 'id' );
4246 -
4247 - if ( ! $site_id ) {
4248 - return new WP_Error(
4249 - 'site_id_missing',
4250 - esc_html__( 'Site ID is missing.', 'jetpack' ),
4251 - array( 'status' => 400 )
4252 - );
3992 + public static function get_features_available() {
3993 + $raw_modules = Jetpack::get_available_modules();
3994 + $modules = array();
3995 + foreach ( $raw_modules as $module ) {
3996 + $modules[] = Jetpack::get_module_slug( $module );
4253 3997 }
4254 3998
4255 - $response = Client::wpcom_json_api_request_as_user(
4256 - '/introductory-offers',
4257 - '2',
4258 - array(
4259 - 'method' => 'GET',
4260 - 'headers' => array(
4261 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
4262 - ),
4263 - )
4264 - );
3999 + return $modules;
4000 + }
4265 4001
4266 - $response_code = wp_remote_retrieve_response_code( $response );
4267 -
4268 - if ( 200 !== $response_code ) {
4269 - return new WP_Error(
4270 - 'intro_offers_fetch_failed',
4271 - esc_html__( 'Could not retrieve intro offers.', 'jetpack' ),
4272 - array( 'status' => $response_code )
4273 - );
4002 + /**
4003 + * Returns what features are enabled. Uses the slug of the modules files.
4004 + *
4005 + * @return array
4006 + */
4007 + public static function get_features_enabled() {
4008 + $raw_modules = Jetpack::get_active_modules();
4009 + $modules = array();
4010 + foreach ( $raw_modules as $module ) {
4011 + $modules[] = Jetpack::get_module_slug( $module );
4274 4012 }
4275 4013
4276 - $data = json_decode( wp_remote_retrieve_body( $response ) );
4014 + return $modules;
4015 + }
4277 4016
4278 - if ( ! isset( $data ) ) {
4279 - return new WP_Error(
4280 - 'intro_offers_error',
4281 - esc_html__( 'Could not parse intro offers.', 'jetpack' ),
4282 - array( 'status' => 204 ) // no content.
4017 + /**
4018 + * Verify that the API client is allowed to replace user token.
4019 + *
4020 + * @since 1.29.0
4021 + *
4022 + * @return bool|WP_Error
4023 + */
4024 + public static function get_features_permission_check() {
4025 + if ( ! Rest_Authentication::is_signed_with_blog_token() ) {
4026 + $message = esc_html__(
4027 + 'You do not have the correct user permissions to perform this action. Please contact your site admin if you think this is a mistake.',
4028 + 'jetpack'
4283 4029 );
4030 + return new WP_Error( 'invalid_permission_fetch_features', $message, array( 'status' => rest_authorization_required_code() ) );
4284 4031 }
4285 4032
4286 - return rest_ensure_response(
4287 - array(
4288 - 'code' => 'success',
4289 - 'data' => $data,
4290 - )
4291 - );
4033 + return true;
4292 4034 }
4293 4035 } // class end