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 +416 -859 13.5.2 → 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,19 +605,8 @@
754 605 'permission_callback' => __CLASS__ . '::manage_modules_permission_check',
755 606 )
756 607 );
757 608
758 - // Get Jetpack introduction offers
759 - register_rest_route(
760 - 'jetpack/v4',
761 - '/intro-offers',
762 - array(
763 - 'methods' => WP_REST_Server::READABLE,
764 - 'callback' => __CLASS__ . '::get_intro_offers',
765 - 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
766 - )
767 - );
768 -
769 609 // Save subscriber token and redirect
770 610 register_rest_route(
771 611 'jetpack/v4',
772 612 '/subscribers/auth',
@@ -785,42 +625,59 @@
785 625 ),
786 626 ),
787 627 )
788 628 );
629 +
630 + /**
631 + * Get the list of available Jetpack features.
632 + *
633 + * @since 13.9
634 + */
635 + register_rest_route(
636 + 'jetpack/v4',
637 + '/features/available',
638 + array(
639 + 'methods' => WP_REST_Server::READABLE,
640 + 'callback' => array( static::class, 'get_features_available' ),
641 + 'permission_callback' => array( static::class, 'get_features_permission_check' ),
642 + )
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 + );
789 659 }
790 660
791 661 /**
792 662 * Ask WPCOM for a JWT token to use for OpenAI conversations.
793 - * 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.
794 668 */
795 669 public static function get_openai_jwt() {
796 - $blog_id = \Jetpack_Options::get_option( 'id' );
670 + _deprecated_function( __METHOD__, 'jetpack-16.2', '\Automattic\Jetpack\Connection\REST_Jetpack_AI_JWT::get_jwt' );
797 671
798 - $response = \Automattic\Jetpack\Connection\Client::wpcom_json_api_request_as_user(
799 - "/sites/$blog_id/jetpack-openai-query/jwt",
800 - '2',
801 - array(
802 - 'method' => 'POST',
803 - 'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ),
804 - ),
805 - wp_json_encode( array() ),
806 - 'wpcom'
807 - );
672 + $response = ( new REST_Jetpack_AI_JWT() )->get_jwt();
808 673
809 674 if ( is_wp_error( $response ) ) {
810 675 return $response;
811 676 }
812 677
813 - $json = json_decode( wp_remote_retrieve_body( $response ) );
814 -
815 - if ( ! isset( $json->token ) ) {
816 - return new WP_Error( 'no-token', 'No token returned from WPCOM' );
817 - }
818 -
819 - return array(
820 - 'token' => $json->token,
821 - 'blog_id' => $blog_id,
822 - );
678 + // Pre-deprecation callers expect the raw array, not a WP_REST_Response.
679 + return $response->get_data();
823 680 }
824 681
825 682 /**
826 683 * Set subscriber cookie and redirect
@@ -831,191 +688,27 @@
831 688 */
832 689 public static function set_subscriber_cookie_and_redirect( $request ) {
833 690 require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/premium-content/_inc/subscription-service/include.php';
834 691 $subscription_service = \Automattic\Jetpack\Extensions\Premium_Content\subscription_service();
835 - $token = $subscription_service->get_and_set_token_from_request();
836 - $payload = $subscription_service->decode_token( $token );
837 - $is_valid_token = ! empty( $payload );
838 - if ( $is_valid_token ) {
839 - return new WP_REST_Response( null, 302, array( 'location' => $request['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 ) );
840 699 }
841 - return new WP_Error( 'invalid-token', 'Invalid Token' );
842 - }
843 700
844 - /**
845 - * Get the data for the recommendations
846 - *
847 - * @return array Recommendations data
848 - */
849 - public static function get_recommendations_data() {
850 - return Jetpack_Recommendations::get_recommendations_data();
851 - }
852 -
853 - /**
854 - * Update the data for the recommendations
855 - *
856 - * @param WP_REST_Request $request The request.
857 - *
858 - * @return bool true
859 - */
860 - public static function update_recommendations_data( $request ) {
861 - $data = $request['data'];
862 - Jetpack_Recommendations::update_recommendations_data( $data );
863 -
864 - return true;
865 - }
866 -
867 - /**
868 - * Get the data for the recommendations
869 - *
870 - * @return array Recommendations data
871 - */
872 - public static function get_recommendations_step() {
873 - return Jetpack_Recommendations::get_recommendations_step();
874 - }
875 -
876 - /**
877 - * Update the step for the recommendations
878 - *
879 - * @param WP_REST_Request $request The request.
880 - *
881 - * @return bool true
882 - */
883 - public static function update_recommendations_step( $request ) {
884 - $step = $request['step'];
885 - Jetpack_Recommendations::update_recommendations_step( $step );
886 -
887 - return true;
888 - }
889 -
890 - /**
891 - * Get product suggestions for the recommendations
892 - *
893 - * @return string|WP_Error The response from the wpcom product suggestions endpoint as a JSON object.
894 - */
895 - public static function get_recommendations_product_suggestions() {
896 - $blog_id = Jetpack_Options::get_option( 'id' );
897 - if ( ! $blog_id ) {
898 - 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 ) );
899 705 }
900 706
901 - $user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected( get_current_user_id() );
902 - if ( ! $user_connected ) {
903 - return wp_json_encode( array() );
904 - }
905 -
906 - $request_path = sprintf( '/sites/%s/jetpack-recommendations/product-suggestions?locale=' . get_user_locale(), $blog_id );
907 - $wpcom_request = Client::wpcom_json_api_request_as_user(
908 - $request_path,
909 - '2',
910 - array(
911 - 'method' => 'GET',
912 - 'headers' => array(
913 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
914 - ),
915 - )
916 - );
917 -
918 - $response_code = wp_remote_retrieve_response_code( $wpcom_request );
919 - if ( 200 === $response_code ) {
920 - return json_decode( wp_remote_retrieve_body( $wpcom_request ) );
921 - } else {
922 - return new WP_Error(
923 - 'failed_to_fetch_data',
924 - esc_html__( 'Unable to fetch the requested data.', 'jetpack' ),
925 - array( 'status' => $response_code )
926 - );
927 - }
707 + return new WP_REST_Response( null, 302, array( 'location' => $redirect_url ) );
928 708 }
929 709
930 710 /**
931 - * Get the upsell for the recommendations
932 - *
933 - * @return string The response from the wpcom upsell endpoint as a JSON object
934 - */
935 - public static function get_recommendations_upsell() {
936 - $blog_id = Jetpack_Options::get_option( 'id' );
937 - if ( ! $blog_id ) {
938 - return new WP_Error( 'site_not_registered', esc_html__( 'Site not registered.', 'jetpack' ) );
939 - }
940 -
941 - $user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected( get_current_user_id() );
942 - if ( ! $user_connected ) {
943 - $response = array(
944 - 'hide_upsell' => true,
945 - );
946 -
947 - return $response;
948 - }
949 -
950 - $request_path = sprintf( '/sites/%s/jetpack-recommendations/upsell?locale=' . get_user_locale(), $blog_id );
951 - $wpcom_request = Client::wpcom_json_api_request_as_user(
952 - $request_path,
953 - '2',
954 - array(
955 - 'method' => 'GET',
956 - 'headers' => array(
957 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
958 - ),
959 - )
960 - );
961 -
962 - $response_code = wp_remote_retrieve_response_code( $wpcom_request );
963 - if ( 200 === $response_code ) {
964 - return json_decode( wp_remote_retrieve_body( $wpcom_request ) );
965 - } else {
966 - return new WP_Error(
967 - 'failed_to_fetch_data',
968 - esc_html__( 'Unable to fetch the requested data.', 'jetpack' ),
969 - array( 'status' => $response_code )
970 - );
971 - }
972 - }
973 -
974 - /**
975 - * Get conditional recommendations data.
976 - *
977 - * @return array Conditional recommendations data.
978 - */
979 - public static function get_conditional_recommendations() {
980 - return Jetpack_Recommendations::get_conditional_recommendations();
981 - }
982 -
983 - /**
984 - * Validate the recommendations data
985 - *
986 - * @param array $value Value to check received by request.
987 - * @param WP_REST_Request $request The request sent to the WP REST API.
988 - * @param string $param Name of the parameter passed to endpoint holding $value.
989 - *
990 - * @return bool|WP_Error
991 - */
992 - public static function validate_recommendations_data( $value, $request, $param ) {
993 - if ( ! is_array( $value ) ) {
994 - /* translators: Name of a parameter that must be an object */
995 - return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an object.', 'jetpack' ), $param ) );
996 - }
997 -
998 - foreach ( $value as $answer ) {
999 - if ( is_array( $answer ) ) {
1000 - $validate = self::validate_array_of_strings( $answer, $request, $param );
1001 - } elseif ( is_string( $answer ) ) {
1002 - $validate = self::validate_string( $answer, $request, $param );
1003 - } elseif ( $answer === null ) {
1004 - $validate = true;
1005 - } else {
1006 - $validate = self::validate_boolean( $answer, $request, $param );
1007 - }
1008 -
1009 - if ( is_wp_error( $validate ) ) {
1010 - return $validate;
1011 - }
1012 - }
1013 -
1014 - return true;
1015 - }
1016 -
1017 - /**
1018 711 * Return a purchase token used for site-connected (non user-authenticated) checkout.
1019 712 *
1020 713 * @return string|WP_Error The current purchase token or WP_Error with error details.
1021 714 */
@@ -1170,8 +863,9 @@
1170 863 || Jetpack::is_plugin_active( 'mojo-under-construction/mojo-contruction.php' ) && 1 == $under_construction_activation_status // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual
1171 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
1172 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
1173 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 + ||
1174 868 /**
1175 869 * Allow plugins to mark a site as "under construction".
1176 870 *
1177 871 * @since 6.7.0
@@ -1177,9 +871,9 @@
1177 871 * @since 6.7.0
1178 872 *
1179 873 * @param false bool Is the site under construction? Default to false.
1180 874 */
1181 - || true === apply_filters( 'jetpack_is_under_construction_plugin', false )
875 + true === apply_filters( 'jetpack_is_under_construction_plugin', false )
1182 876 ) {
1183 877 return new WP_Error( 'forbidden', __( 'Site is under construction and cannot be verified', 'jetpack' ) );
1184 878 }
1185 879
@@ -1318,24 +1012,20 @@
1318 1012
1319 1013 /**
1320 1014 * Verify that a user can use the /connection/user endpoint. Has to be a registered user and be currently linked.
1321 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 + *
1322 1021 * @since 4.3.0
1323 1022 *
1324 - * @uses Automattic\Jetpack\Connection\Manager::is_user_connected();)
1325 - *
1326 1023 * @return bool|WP_Error True if user is able to unlink.
1327 1024 */
1328 1025 public static function unlink_user_permission_callback() {
1329 - if ( current_user_can( 'jetpack_connect_user' ) && ( new Connection_Manager( 'jetpack' ) )->is_user_connected( get_current_user_id() ) ) {
1330 - return true;
1331 - }
1332 -
1333 - return new WP_Error(
1334 - 'invalid_user_permission_unlink_user',
1335 - REST_Connector::get_user_permissions_error_msg(),
1336 - array( 'status' => rest_authorization_required_code() )
1337 - );
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();
1338 1028 }
1339 1029
1340 1030 /**
1341 1031 * Verify that user can manage Jetpack modules.
@@ -1470,139 +1160,8 @@
1470 1160 );
1471 1161 }
1472 1162
1473 1163 /**
1474 - * Test connection status for this Jetpack site.
1475 - *
1476 - * @since 6.8.0
1477 - *
1478 - * @return array|WP_Error WP_Error returned if connection test does not succeed.
1479 - */
1480 - public static function jetpack_connection_test() {
1481 - require_once JETPACK__PLUGIN_DIR . '_inc/lib/debugger.php';
1482 - $cxntests = new Jetpack_Cxn_Tests();
1483 -
1484 - if ( $cxntests->pass() ) {
1485 - return rest_ensure_response(
1486 - array(
1487 - 'code' => 'success',
1488 - 'message' => __( 'All connection tests passed.', 'jetpack' ),
1489 - )
1490 - );
1491 - } else {
1492 - return $cxntests->output_fails_as_wp_error();
1493 - }
1494 - }
1495 -
1496 - /**
1497 - * Test connection permission check method.
1498 - *
1499 - * @since 7.1.0
1500 - *
1501 - * @return bool
1502 - */
1503 - public static function view_jetpack_connection_test_check() {
1504 - // phpcs:disable WordPress.Security.NonceVerification.Recommended -- This is verifying the trusted caller via a shared private key and timestamp.
1505 - if ( ! isset( $_GET['signature'] ) || ! isset( $_GET['timestamp'] ) || ! isset( $_GET['url'] ) ) {
1506 - return false;
1507 - }
1508 - $signature = base64_decode( wp_unslash( $_GET['signature'] ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
1509 -
1510 - $signature_data = wp_json_encode(
1511 - array(
1512 - 'rest_route' => isset( $_GET['rest_route'] ) ? filter_var( wp_unslash( $_GET['rest_route'] ) ) : null,
1513 - 'timestamp' => (int) $_GET['timestamp'],
1514 - 'url' => esc_url_raw( wp_unslash( $_GET['url'] ) ),
1515 - )
1516 - );
1517 -
1518 - if (
1519 - ! function_exists( 'openssl_verify' )
1520 - || 1 !== openssl_verify(
1521 - $signature_data,
1522 - $signature,
1523 - JETPACK__DEBUGGER_PUBLIC_KEY
1524 - )
1525 - ) {
1526 - return false;
1527 - }
1528 -
1529 - // signature timestamp must be within 5min of current time.
1530 - if ( abs( time() - (int) $_GET['timestamp'] ) > 300 ) {
1531 - return false;
1532 - }
1533 -
1534 - // phpcs:enable WordPress.Security.NonceVerification.Recommended
1535 -
1536 - return true;
1537 - }
1538 -
1539 - /**
1540 - * Test connection status for this Jetpack site, encrypt the results for decryption by a third-party.
1541 - *
1542 - * @since 7.1.0
1543 - *
1544 - * @return array|mixed|object|WP_Error
1545 - */
1546 - public static function jetpack_connection_test_for_external() {
1547 - // 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.
1548 - add_filter( 'jetpack_debugger_run_self_test', '__return_false' );
1549 - require_once JETPACK__PLUGIN_DIR . '_inc/lib/debugger.php';
1550 - $cxntests = new Jetpack_Cxn_Tests();
1551 -
1552 - if ( $cxntests->pass() ) {
1553 - $result = array(
1554 - 'code' => 'success',
1555 - 'message' => __( 'All connection tests passed.', 'jetpack' ),
1556 - );
1557 - } else {
1558 - $error = $cxntests->output_fails_as_wp_error(); // Using this so the output is similar both ways.
1559 - $errors = array();
1560 -
1561 - // Borrowed from WP_REST_Server::error_to_response().
1562 - foreach ( (array) $error->errors as $code => $messages ) {
1563 - foreach ( (array) $messages as $message ) {
1564 - $errors[] = array(
1565 - 'code' => $code,
1566 - 'message' => $message,
1567 - 'data' => $error->get_error_data( $code ),
1568 - );
1569 - }
1570 - }
1571 -
1572 - $result = ( ! empty( $errors ) ) ? $errors[0] : null;
1573 - if ( count( $errors ) > 1 ) {
1574 - // Remove the primary error.
1575 - array_shift( $errors );
1576 - $result['additional_errors'] = $errors;
1577 - }
1578 - }
1579 -
1580 - $result = wp_json_encode( $result );
1581 -
1582 - $encrypted = $cxntests->encrypt_string_for_wpcom( $result );
1583 -
1584 - if ( ! $encrypted || ! is_array( $encrypted ) ) {
1585 - return rest_ensure_response(
1586 - array(
1587 - 'code' => 'action_required',
1588 - 'message' => 'Please request results from the in-plugin debugger',
1589 - )
1590 - );
1591 - }
1592 -
1593 - return rest_ensure_response(
1594 - array(
1595 - 'code' => 'response',
1596 - 'debug' => array(
1597 - 'data' => $encrypted['data'],
1598 - 'key' => $encrypted['key'],
1599 - ),
1600 - )
1601 - );
1602 - }
1603 -
1604 - /**
1605 1164 * Fetch information about the Rewind status of the site.
1606 1165 */
1607 1166 public static function rewind_data() {
1608 1167 $site_id = Jetpack_Options::get_option( 'id' );
@@ -1645,9 +1204,9 @@
1645 1204 return rest_ensure_response(
1646 1205 array(
1647 1206 'code' => 'success',
1648 1207 'message' => esc_html__( 'Backup & Scan data correctly received.', 'jetpack' ),
1649 - 'data' => wp_json_encode( $rewind_data ),
1208 + 'data' => wp_json_encode( $rewind_data, JSON_UNESCAPED_SLASHES ),
1650 1209 )
1651 1210 );
1652 1211 }
1653 1212
@@ -1728,9 +1287,9 @@
1728 1287 return rest_ensure_response(
1729 1288 array(
1730 1289 'code' => 'success',
1731 1290 'message' => esc_html__( 'Scan state correctly received.', 'jetpack' ),
1732 - 'data' => wp_json_encode( $scan_state ),
1291 + 'data' => wp_json_encode( $scan_state, JSON_UNESCAPED_SLASHES ),
1733 1292 )
1734 1293 );
1735 1294 }
1736 1295
@@ -1787,10 +1346,10 @@
1787 1346 *
1788 1347 * @return string|WP_Error A raw URL if the connection URL could be built; error message otherwise.
1789 1348 */
1790 1349 public static function build_connect_url( $request = array() ) {
1791 - $from = isset( $request['from'] ) ? $request['from'] : false;
1792 - $redirect = isset( $request['redirect'] ) ? $request['redirect'] : false;
1350 + $from = $request['from'] ?? false;
1351 + $redirect = $request['redirect'] ?? false;
1793 1352
1794 1353 $url = Jetpack::init()->build_connect_url( true, $redirect, $from );
1795 1354 if ( $url ) {
1796 1355 return rest_ensure_response( $url );
@@ -1813,9 +1372,9 @@
1813 1372 */
1814 1373 public static function get_user_connection_data() {
1815 1374 _deprecated_function( __METHOD__, 'jetpack-10.0.0', '\Automattic\Jetpack\Connection\REST_Connector::get_user_connection_data' );
1816 1375
1817 - 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';
1818 1377
1819 1378 $connection_owner = ( new Connection_Manager() )->get_connection_owner();
1820 1379 $owner_display_name = false === $connection_owner ? null : $connection_owner->data->display_name;
1821 1380
@@ -1828,30 +1387,21 @@
1828 1387
1829 1388 /**
1830 1389 * Unlinks current user from the WordPress.com Servers.
1831 1390 *
1832 - * @since 4.3.0
1391 + * @param WP_REST_Request $request The request sent to the WP REST API.
1833 1392 * @uses Automattic\Jetpack\Connection\Manager->disconnect_user
1834 1393 *
1835 - * @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()
1836 1396 *
1397 + * @since 4.3.0
1398 + *
1837 1399 * @return bool|WP_Error True if user successfully unlinked.
1838 1400 */
1839 1401 public static function unlink_user( $request ) {
1840 -
1841 - if ( ! isset( $request['linked'] ) || false !== $request['linked'] ) {
1842 - return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
1843 - }
1844 -
1845 - if ( ( new Connection_Manager( 'jetpack' ) )->disconnect_user() ) {
1846 - return rest_ensure_response(
1847 - array(
1848 - 'code' => 'success',
1849 - )
1850 - );
1851 - }
1852 -
1853 - 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 );
1854 1404 }
1855 1405
1856 1406 /**
1857 1407 * Gets current user's tracking settings.
@@ -1910,9 +1460,9 @@
1910 1460 'Content-Type' => 'application/json',
1911 1461 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
1912 1462 ),
1913 1463 ),
1914 - wp_json_encode( $request->get_params() )
1464 + wp_json_encode( $request->get_params(), JSON_UNESCAPED_SLASHES )
1915 1465 );
1916 1466 if ( ! is_wp_error( $response ) ) {
1917 1467 $response = json_decode( wp_remote_retrieve_body( $response ), true );
1918 1468 }
@@ -1924,93 +1474,30 @@
1924 1474 /**
1925 1475 * Fetch site data from .com including the site's current plan and the site's products.
1926 1476 *
1927 1477 * @since 5.5.0
1478 + * @deprecated 16.2 Use Automattic\Jetpack\Connection\Manager::get_connected_site_data().
1928 1479 *
1929 1480 * @return stdClass|WP_Error
1930 1481 */
1931 1482 public static function site_data() {
1932 - $site_id = Jetpack_Options::get_option( 'id' );
1483 + _deprecated_function( __METHOD__, 'jetpack-16.2', 'Automattic\Jetpack\Connection\Manager::get_connected_site_data' );
1933 1484
1934 - if ( ! $site_id ) {
1935 - return new WP_Error( 'site_id_missing', '', array( 'api_error_code' => __( 'site_id_missing', 'jetpack' ) ) );
1936 - }
1485 + return ( new Connection_Manager() )->get_connected_site_data();
1486 + }
1937 1487
1938 - $args = array( 'headers' => array() );
1939 -
1940 - // Allow use a store sandbox. Internal ref: PCYsg-IA-p2.
1941 - if ( isset( $_COOKIE ) && isset( $_COOKIE['store_sandbox'] ) ) {
1942 - $secret = filter_var( wp_unslash( $_COOKIE['store_sandbox'] ) );
1943 - $args['headers']['Cookie'] = "store_sandbox=$secret;";
1944 - }
1945 -
1946 - $response = Client::wpcom_json_api_request_as_blog( sprintf( '/sites/%d', $site_id ) . '?force=wpcom', '1.1', $args );
1947 - $body = wp_remote_retrieve_body( $response );
1948 - $data = $body ? json_decode( $body ) : null;
1949 -
1950 - if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
1951 - $error_info = array(
1952 - 'api_error_code' => null,
1953 - 'api_http_code' => wp_remote_retrieve_response_code( $response ),
1954 - );
1955 -
1956 - if ( is_wp_error( $response ) ) {
1957 - $error_info['api_error_code'] = $response->get_error_code() ? wp_strip_all_tags( $response->get_error_code() ) : null;
1958 - } elseif ( $data && ! empty( $data->error ) ) {
1959 - $error_info['api_error_code'] = $data->error;
1960 - }
1961 -
1962 - return new WP_Error( 'site_data_fetch_failed', '', $error_info );
1963 - }
1964 -
1965 - Jetpack_Plan::update_from_sites_response( $response );
1966 -
1967 - return $data;
1968 - }
1969 1488 /**
1970 1489 * Get site data, including for example, the site's current plan.
1971 1490 *
1491 + * @since 4.3.0
1492 + * @deprecated 16.2 Use Automattic\Jetpack\Connection\REST_Connector::site_data_response().
1493 + *
1972 1494 * @return WP_Error|WP_HTTP_Response|WP_REST_Response
1973 - * @since 4.3.0
1974 1495 */
1975 1496 public static function get_site_data() {
1976 - $site_data = self::site_data();
1497 + _deprecated_function( __METHOD__, 'jetpack-16.2', 'Automattic\Jetpack\Connection\REST_Connector::site_data_response' );
1977 1498
1978 - if ( ! is_wp_error( $site_data ) ) {
1979 -
1980 - /**
1981 - * Fires when the site data was successfully returned from the /sites/%d wpcom endpoint.
1982 - *
1983 - * @since 8.7.0
1984 - */
1985 - do_action( 'jetpack_get_site_data_success' );
1986 - return rest_ensure_response(
1987 - array(
1988 - 'code' => 'success',
1989 - 'message' => esc_html__( 'Site data correctly received.', 'jetpack' ),
1990 - 'data' => wp_json_encode( $site_data ),
1991 - )
1992 - );
1993 - }
1994 -
1995 - $error_data = $site_data->get_error_data();
1996 -
1997 - if ( empty( $error_data['api_error_code'] ) ) {
1998 - $error_message = esc_html__( 'Failed fetching site data from WordPress.com. If the problem persists, try reconnecting Jetpack.', 'jetpack' );
1999 - } else {
2000 - /* translators: %s is an error code (e.g. `token_mismatch`) */
2001 - $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'] );
2002 - }
2003 -
2004 - return new WP_Error(
2005 - $site_data->get_error_code(),
2006 - $error_message,
2007 - array(
2008 - 'status' => 400,
2009 - 'api_error_code' => empty( $error_data['api_error_code'] ) ? null : $error_data['api_error_code'],
2010 - 'api_http_code' => empty( $error_data['api_http_code'] ) ? null : $error_data['api_http_code'],
2011 - )
2012 - );
1499 + return REST_Connector::site_data_response();
2013 1500 }
2014 1501
2015 1502 /**
2016 1503 * Fetch AL data for this site and return it.
@@ -2070,64 +1557,8 @@
2070 1557 );
2071 1558 }
2072 1559
2073 1560 /**
2074 - * Fetch the discount for this site and return it.
2075 - *
2076 - * @since 10.8
2077 - *
2078 - * @return array|WP_Error
2079 - */
2080 - public static function get_site_discount() {
2081 - $site_id = Jetpack_Options::get_option( 'id' );
2082 -
2083 - if ( ! $site_id ) {
2084 - return new WP_Error(
2085 - 'site_id_missing',
2086 - esc_html__( 'Site ID is missing.', 'jetpack' ),
2087 - array( 'status' => 400 )
2088 - );
2089 - }
2090 -
2091 - $response = Client::wpcom_json_api_request_as_user(
2092 - "/sites/$site_id/discount",
2093 - '2',
2094 - array(
2095 - 'method' => 'GET',
2096 - 'headers' => array(
2097 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
2098 - ),
2099 - )
2100 - );
2101 -
2102 - $response_code = wp_remote_retrieve_response_code( $response );
2103 - $data = json_decode( wp_remote_retrieve_body( $response ) );
2104 -
2105 - if ( 200 !== $response_code ) {
2106 - return new WP_Error(
2107 - 'discount_fetch_failed',
2108 - is_object( $data ) && property_exists( $data, 'error' ) ? $data->error : esc_html__( 'Could not retrieve site discount.', 'jetpack' ),
2109 - array( 'status' => $response_code )
2110 - );
2111 - }
2112 -
2113 - if ( ! isset( $data ) ) {
2114 - return new WP_Error(
2115 - 'discount_parse_error',
2116 - esc_html__( 'Could not parse discount', 'jetpack' ),
2117 - array( 'status' => 204 ) // no content.
2118 - );
2119 - }
2120 -
2121 - return rest_ensure_response(
2122 - array(
2123 - 'code' => 'success',
2124 - 'data' => $data,
2125 - )
2126 - );
2127 - }
2128 -
2129 - /**
2130 1561 * Reset Jetpack options
2131 1562 *
2132 1563 * @since 4.3.0
2133 1564 *
@@ -2225,9 +1656,9 @@
2225 1656 public static function get_updateable_data_list( $selector = '' ) {
2226 1657
2227 1658 $options = array(
2228 1659 // Blocks.
2229 - 'jetpack_blocks_disabled' => array(
1660 + 'jetpack_blocks_disabled' => array(
2230 1661 'description' => esc_html__( 'Jetpack Blocks disabled.', 'jetpack' ),
2231 1662 'type' => 'boolean',
2232 1663 'default' => false,
2233 1664 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2234,9 +1665,9 @@
2234 1665 'jp_group' => 'settings',
2235 1666 ),
2236 1667
2237 1668 // Carousel
2238 - 'carousel_background_color' => array(
1669 + 'carousel_background_color' => array(
2239 1670 'description' => esc_html__( 'Color scheme.', 'jetpack' ),
2240 1671 'type' => 'string',
2241 1672 'default' => 'black',
2242 1673 'enum' => array(
@@ -2249,9 +1680,9 @@
2249 1680 ),
2250 1681 'validate_callback' => __CLASS__ . '::validate_list_item',
2251 1682 'jp_group' => 'carousel',
2252 1683 ),
2253 - 'carousel_display_exif' => array(
1684 + 'carousel_display_exif' => array(
2254 1685 'description' => wp_kses(
2255 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' ) ),
2256 1687 array(
2257 1688 'a' => array(
@@ -2264,9 +1695,9 @@
2264 1695 'default' => 0,
2265 1696 'validate_callback' => __CLASS__ . '::validate_boolean',
2266 1697 'jp_group' => 'carousel',
2267 1698 ),
2268 - 'carousel_display_comments' => array(
1699 + 'carousel_display_comments' => array(
2269 1700 'description' => esc_html__( 'Show comments area in carousel', 'jetpack' ),
2270 1701 'type' => 'boolean',
2271 1702 'default' => 1,
2272 1703 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2273,9 +1704,9 @@
2273 1704 'jp_group' => 'carousel',
2274 1705 ),
2275 1706
2276 1707 // Comments.
2277 - 'highlander_comment_form_prompt' => array(
1708 + 'highlander_comment_form_prompt' => array(
2278 1709 'description' => esc_html__( 'Greeting Text', 'jetpack' ),
2279 1710 'type' => 'string',
2280 1711 'default' => esc_html__( 'Leave a Reply', 'jetpack' ),
2281 1712 'sanitize_callback' => 'sanitize_text_field',
@@ -2280,9 +1711,9 @@
2280 1711 'default' => esc_html__( 'Leave a Reply', 'jetpack' ),
2281 1712 'sanitize_callback' => 'sanitize_text_field',
2282 1713 'jp_group' => 'comments',
2283 1714 ),
2284 - 'jetpack_comment_form_color_scheme' => array(
1715 + 'jetpack_comment_form_color_scheme' => array(
2285 1716 'description' => esc_html__( 'Color scheme', 'jetpack' ),
2286 1717 'type' => 'string',
2287 1718 'default' => 'light',
2288 1719 'enum' => array(
@@ -2299,39 +1730,38 @@
2299 1730 'jp_group' => 'comments',
2300 1731 ),
2301 1732
2302 1733 // Custom Content Types.
2303 - 'jetpack_portfolio' => array(
1734 + 'jetpack_portfolio' => array(
2304 1735 'description' => esc_html__( 'Enable or disable Jetpack portfolio post type.', 'jetpack' ),
2305 1736 'type' => 'boolean',
2306 1737 'default' => 0,
2307 1738 'validate_callback' => __CLASS__ . '::validate_boolean',
2308 - 'jp_group' => 'custom-content-types',
1739 + 'jp_group' => 'settings',
2309 1740 ),
2310 - 'jetpack_portfolio_posts_per_page' => array(
1741 + 'jetpack_portfolio_posts_per_page' => array(
2311 1742 'description' => esc_html__( 'Number of entries to show at most in Portfolio pages.', 'jetpack' ),
2312 1743 'type' => 'integer',
2313 1744 'default' => 10,
2314 1745 'validate_callback' => __CLASS__ . '::validate_posint',
2315 - 'jp_group' => 'custom-content-types',
1746 + 'jp_group' => 'settings',
2316 1747 ),
2317 - 'jetpack_testimonial' => array(
1748 + 'jetpack_testimonial' => array(
2318 1749 'description' => esc_html__( 'Enable or disable Jetpack testimonial post type.', 'jetpack' ),
2319 1750 'type' => 'boolean',
2320 1751 'default' => 0,
2321 1752 'validate_callback' => __CLASS__ . '::validate_boolean',
2322 - 'jp_group' => 'custom-content-types',
1753 + 'jp_group' => 'settings',
2323 1754 ),
2324 - 'jetpack_testimonial_posts_per_page' => array(
1755 + 'jetpack_testimonial_posts_per_page' => array(
2325 1756 'description' => esc_html__( 'Number of entries to show at most in Testimonial pages.', 'jetpack' ),
2326 1757 'type' => 'integer',
2327 1758 'default' => 10,
2328 1759 'validate_callback' => __CLASS__ . '::validate_posint',
2329 - 'jp_group' => 'custom-content-types',
1760 + 'jp_group' => 'settings',
2330 1761 ),
2331 -
2332 1762 // WAF.
2333 - 'jetpack_waf_automatic_rules' => array(
1763 + 'jetpack_waf_automatic_rules' => array(
2334 1764 'description' => esc_html__( 'Enable automatic rules - Protect your site against untrusted traffic sources with automatic security rules.', 'jetpack' ),
2335 1765 'type' => 'boolean',
2336 1766 'default' => Waf_Compatibility::get_default_automatic_rules_option(),
2337 1767 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2336,16 +1766,16 @@
2336 1766 'default' => Waf_Compatibility::get_default_automatic_rules_option(),
2337 1767 'validate_callback' => __CLASS__ . '::validate_boolean',
2338 1768 'jp_group' => 'waf',
2339 1769 ),
2340 - 'jetpack_waf_ip_list' => array(
2341 - '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' ),
2342 1772 'type' => 'boolean',
2343 1773 'default' => 0,
2344 1774 'validate_callback' => __CLASS__ . '::validate_boolean',
2345 1775 'jp_group' => 'waf',
2346 1776 ),
2347 - 'jetpack_waf_ip_block_list' => array(
1777 + 'jetpack_waf_ip_block_list' => array(
2348 1778 'description' => esc_html__( 'Blocked IP addresses', 'jetpack' ),
2349 1779 'type' => 'string',
2350 1780 'default' => '',
2351 1781 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2351,9 +1781,16 @@
2351 1781 'validate_callback' => __CLASS__ . '::validate_string',
2352 1782 'sanitize_callback' => 'esc_textarea',
2353 1783 'jp_group' => 'waf',
2354 1784 ),
2355 - '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(
2356 1793 'description' => esc_html__( 'Always allowed IP addresses', 'jetpack' ),
2357 1794 'type' => 'string',
2358 1795 'default' => '',
2359 1796 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2359,9 +1796,9 @@
2359 1796 'validate_callback' => __CLASS__ . '::validate_string',
2360 1797 'sanitize_callback' => 'esc_textarea',
2361 1798 'jp_group' => 'settings',
2362 1799 ),
2363 - 'jetpack_waf_share_data' => array(
1800 + 'jetpack_waf_share_data' => array(
2364 1801 'description' => esc_html__( 'Share basic data with Jetpack.', 'jetpack' ),
2365 1802 'type' => 'boolean',
2366 1803 'default' => 0,
2367 1804 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2366,9 +1803,9 @@
2366 1803 'default' => 0,
2367 1804 'validate_callback' => __CLASS__ . '::validate_boolean',
2368 1805 'jp_group' => 'waf',
2369 1806 ),
2370 - 'jetpack_waf_share_debug_data' => array(
1807 + 'jetpack_waf_share_debug_data' => array(
2371 1808 'description' => esc_html__( 'Share detailed data with Jetpack.', 'jetpack' ),
2372 1809 'type' => 'boolean',
2373 1810 'default' => 0,
2374 1811 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2374,9 +1811,9 @@
2374 1811 'validate_callback' => __CLASS__ . '::validate_boolean',
2375 1812 'jp_group' => 'waf',
2376 1813 ),
2377 1814 // Galleries.
2378 - 'tiled_galleries' => array(
1815 + 'tiled_galleries' => array(
2379 1816 'description' => esc_html__( 'Display all your gallery pictures in a cool mosaic.', 'jetpack' ),
2380 1817 'type' => 'boolean',
2381 1818 'default' => 0,
2382 1819 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2382,9 +1819,9 @@
2382 1819 'validate_callback' => __CLASS__ . '::validate_boolean',
2383 1820 'jp_group' => 'tiled-gallery',
2384 1821 ),
2385 1822
2386 - 'gravatar_disable_hovercards' => array(
1823 + 'gravatar_disable_hovercards' => array(
2387 1824 'description' => esc_html__( "View people's profiles when you mouse over their Gravatars", 'jetpack' ),
2388 1825 'type' => 'string',
2389 1826 'default' => 'enabled',
2390 1827 // Not visible. This is used as the checkbox value.
@@ -2400,9 +1837,9 @@
2400 1837 'jp_group' => 'gravatar-hovercards',
2401 1838 ),
2402 1839
2403 1840 // Infinite Scroll.
2404 - 'infinite_scroll' => array(
1841 + 'infinite_scroll' => array(
2405 1842 'description' => esc_html__( 'To infinity and beyond', 'jetpack' ),
2406 1843 'type' => 'boolean',
2407 1844 'default' => 1,
2408 1845 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2407,9 +1844,9 @@
2407 1844 'default' => 1,
2408 1845 'validate_callback' => __CLASS__ . '::validate_boolean',
2409 1846 'jp_group' => 'infinite-scroll',
2410 1847 ),
2411 - 'infinite_scroll_google_analytics' => array(
1848 + 'infinite_scroll_google_analytics' => array(
2412 1849 'description' => esc_html__( 'Use Google Analytics with Infinite Scroll', 'jetpack' ),
2413 1850 'type' => 'boolean',
2414 1851 'default' => 0,
2415 1852 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2416,9 +1853,9 @@
2416 1853 'jp_group' => 'infinite-scroll',
2417 1854 ),
2418 1855
2419 1856 // Likes.
2420 - 'wpl_default' => array(
1857 + 'wpl_default' => array(
2421 1858 'description' => esc_html__( 'WordPress.com Likes are', 'jetpack' ),
2422 1859 'type' => 'string',
2423 1860 'default' => 'on',
2424 1861 'enum' => array(
@@ -2431,9 +1868,9 @@
2431 1868 ),
2432 1869 'validate_callback' => __CLASS__ . '::validate_list_item',
2433 1870 'jp_group' => 'likes',
2434 1871 ),
2435 - 'social_notifications_like' => array(
1872 + 'social_notifications_like' => array(
2436 1873 'description' => esc_html__( 'Send email notification when someone likes a post', 'jetpack' ),
2437 1874 'type' => 'boolean',
2438 1875 'default' => 1,
2439 1876 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2440,9 +1877,9 @@
2440 1877 'jp_group' => 'likes',
2441 1878 ),
2442 1879
2443 1880 // Markdown.
2444 - 'wpcom_publish_comments_with_markdown' => array(
1881 + 'wpcom_publish_comments_with_markdown' => array(
2445 1882 'description' => esc_html__( 'Use Markdown for comments.', 'jetpack' ),
2446 1883 'type' => 'boolean',
2447 1884 'default' => 0,
2448 1885 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2447,9 +1884,9 @@
2447 1884 'default' => 0,
2448 1885 'validate_callback' => __CLASS__ . '::validate_boolean',
2449 1886 'jp_group' => 'markdown',
2450 1887 ),
2451 - 'wpcom_publish_posts_with_markdown' => array(
1888 + 'wpcom_publish_posts_with_markdown' => array(
2452 1889 'description' => esc_html__( 'Use Markdown for posts.', 'jetpack' ),
2453 1890 'type' => 'boolean',
2454 1891 'default' => 0,
2455 1892 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2456,9 +1893,9 @@
2456 1893 'jp_group' => 'markdown',
2457 1894 ),
2458 1895
2459 1896 // Monitor.
2460 - 'monitor_receive_notifications' => array(
1897 + 'monitor_receive_notifications' => array(
2461 1898 'description' => esc_html__( 'Receive Monitor Email Notifications.', 'jetpack' ),
2462 1899 'type' => 'boolean',
2463 1900 'default' => 0,
2464 1901 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2465,9 +1902,9 @@
2465 1902 'jp_group' => 'monitor',
2466 1903 ),
2467 1904
2468 1905 // Post by Email.
2469 - 'post_by_email_address' => array(
1906 + 'post_by_email_address' => array(
2470 1907 'description' => esc_html__( 'Email Address', 'jetpack' ),
2471 1908 'type' => 'string',
2472 1909 'default' => 'noop',
2473 1910 'enum' => array(
@@ -2486,9 +1923,9 @@
2486 1923 'jp_group' => 'post-by-email',
2487 1924 ),
2488 1925
2489 1926 // Protect.
2490 - 'jetpack_protect_key' => array(
1927 + 'jetpack_protect_key' => array(
2491 1928 'description' => esc_html__( 'Protect API key', 'jetpack' ),
2492 1929 'type' => 'string',
2493 1930 'default' => '',
2494 1931 'validate_callback' => __CLASS__ . '::validate_alphanum',
@@ -2493,9 +1930,9 @@
2493 1930 'default' => '',
2494 1931 'validate_callback' => __CLASS__ . '::validate_alphanum',
2495 1932 'jp_group' => 'protect',
2496 1933 ),
2497 - 'jetpack_protect_global_whitelist' => array(
1934 + 'jetpack_protect_global_whitelist' => array(
2498 1935 'description' => esc_html__( 'Protect global IP allow list', 'jetpack' ),
2499 1936 'type' => 'string',
2500 1937 'default' => '',
2501 1938 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2503,9 +1940,9 @@
2503 1940 'jp_group' => 'protect',
2504 1941 ),
2505 1942
2506 1943 // Sharing.
2507 - 'sharing_services' => array(
1944 + 'sharing_services' => array(
2508 1945 'description' => esc_html__( 'Enabled Services and those hidden behind a button', 'jetpack' ),
2509 1946 'type' => 'object',
2510 1947 'default' => array(
2511 1948 'visible' => array( 'facebook', 'x' ),
@@ -2513,9 +1950,9 @@
2513 1950 ),
2514 1951 'validate_callback' => __CLASS__ . '::validate_services',
2515 1952 'jp_group' => 'sharedaddy',
2516 1953 ),
2517 - 'button_style' => array(
1954 + 'button_style' => array(
2518 1955 'description' => esc_html__( 'Button Style', 'jetpack' ),
2519 1956 'type' => 'string',
2520 1957 'default' => 'icon',
2521 1958 'enum' => array(
@@ -2532,9 +1969,9 @@
2532 1969 ),
2533 1970 'validate_callback' => __CLASS__ . '::validate_list_item',
2534 1971 'jp_group' => 'sharedaddy',
2535 1972 ),
2536 - 'sharing_label' => array(
1973 + 'sharing_label' => array(
2537 1974 'description' => esc_html__( 'Sharing Label', 'jetpack' ),
2538 1975 'type' => 'string',
2539 1976 'default' => '',
2540 1977 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2540,9 +1977,9 @@
2540 1977 'validate_callback' => __CLASS__ . '::validate_string',
2541 1978 'sanitize_callback' => 'esc_html',
2542 1979 'jp_group' => 'sharedaddy',
2543 1980 ),
2544 - 'show' => array(
1981 + 'show' => array(
2545 1982 'description' => esc_html__( 'Views where buttons are shown', 'jetpack' ),
2546 1983 'type' => 'array',
2547 1984 'items' => array(
2548 1985 'type' => 'string',
@@ -2550,9 +1987,9 @@
2550 1987 'default' => array( 'post' ),
2551 1988 'validate_callback' => __CLASS__ . '::validate_sharing_show',
2552 1989 'jp_group' => 'sharedaddy',
2553 1990 ),
2554 - 'jetpack-twitter-cards-site-tag' => array(
1991 + 'jetpack-twitter-cards-site-tag' => array(
2555 1992 'description' => esc_html__( "The Twitter username of the owner of this site's domain.", 'jetpack' ),
2556 1993 'type' => 'string',
2557 1994 'default' => '',
2558 1995 'validate_callback' => __CLASS__ . '::validate_twitter_username',
@@ -2558,9 +1995,9 @@
2558 1995 'validate_callback' => __CLASS__ . '::validate_twitter_username',
2559 1996 'sanitize_callback' => 'esc_html',
2560 1997 'jp_group' => 'sharedaddy',
2561 1998 ),
2562 - 'sharedaddy_disable_resources' => array(
1999 + 'sharedaddy_disable_resources' => array(
2563 2000 'description' => esc_html__( 'Disable CSS and JS', 'jetpack' ),
2564 2001 'type' => 'boolean',
2565 2002 'default' => 0,
2566 2003 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2565,9 +2002,9 @@
2565 2002 'default' => 0,
2566 2003 'validate_callback' => __CLASS__ . '::validate_boolean',
2567 2004 'jp_group' => 'sharedaddy',
2568 2005 ),
2569 - 'custom' => array(
2006 + 'custom' => array(
2570 2007 'description' => esc_html__( 'Custom sharing services added by user.', 'jetpack' ),
2571 2008 'type' => 'object',
2572 2009 'default' => array(
2573 2010 'sharing_name' => '',
@@ -2577,9 +2014,9 @@
2577 2014 'validate_callback' => __CLASS__ . '::validate_custom_service',
2578 2015 'jp_group' => 'sharedaddy',
2579 2016 ),
2580 2017 // Not an option, but an action that can be performed on the list of custom services passing the service ID.
2581 - 'sharing_delete_service' => array(
2018 + 'sharing_delete_service' => array(
2582 2019 'description' => esc_html__( 'Delete custom sharing service.', 'jetpack' ),
2583 2020 'type' => 'string',
2584 2021 'default' => '',
2585 2022 'validate_callback' => __CLASS__ . '::validate_custom_service_id',
@@ -2586,16 +2023,16 @@
2586 2023 'jp_group' => 'sharedaddy',
2587 2024 ),
2588 2025
2589 2026 // SSO.
2590 - 'jetpack_sso_require_two_step' => array(
2027 + 'jetpack_sso_require_two_step' => array(
2591 2028 'description' => esc_html__( 'Require Two-Step Authentication', 'jetpack' ),
2592 2029 'type' => 'boolean',
2593 - 'default' => 0,
2030 + 'default' => SSO\Helpers::is_require_two_step_checkbox_disabled(),
2594 2031 'validate_callback' => __CLASS__ . '::validate_boolean',
2595 2032 'jp_group' => 'sso',
2596 2033 ),
2597 - 'jetpack_sso_match_by_email' => array(
2034 + 'jetpack_sso_match_by_email' => array(
2598 2035 'description' => esc_html__( 'Match by Email', 'jetpack' ),
2599 2036 'type' => 'boolean',
2600 2037 'default' => 1,
2601 2038 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2602,9 +2039,9 @@
2602 2039 'jp_group' => 'sso',
2603 2040 ),
2604 2041
2605 2042 // Subscriptions.
2606 - 'stb_enabled' => array(
2043 + 'stb_enabled' => array(
2607 2044 'description' => esc_html__( "Show a <em>'follow blog'</em> option in the comment form", 'jetpack' ),
2608 2045 'type' => 'boolean',
2609 2046 'default' => 1,
2610 2047 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2609,9 +2046,9 @@
2609 2046 'default' => 1,
2610 2047 'validate_callback' => __CLASS__ . '::validate_boolean',
2611 2048 'jp_group' => 'subscriptions',
2612 2049 ),
2613 - 'stc_enabled' => array(
2050 + 'stc_enabled' => array(
2614 2051 'description' => esc_html__( "Show a <em>'follow comments'</em> option in the comment form", 'jetpack' ),
2615 2052 'type' => 'boolean',
2616 2053 'default' => 1,
2617 2054 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2616,9 +2053,9 @@
2616 2053 'default' => 1,
2617 2054 'validate_callback' => __CLASS__ . '::validate_boolean',
2618 2055 'jp_group' => 'subscriptions',
2619 2056 ),
2620 - 'wpcom_newsletter_categories' => array(
2057 + 'wpcom_newsletter_categories' => array(
2621 2058 'description' => esc_html__( 'Array of post category ids that are marked as newsletter categories', 'jetpack' ),
2622 2059 'type' => 'array',
2623 2060 'default' => array(),
2624 2061 'validate_callback' => __CLASS__ . '::validate_array',
@@ -2623,9 +2060,9 @@
2623 2060 'default' => array(),
2624 2061 'validate_callback' => __CLASS__ . '::validate_array',
2625 2062 'jp_group' => 'subscriptions',
2626 2063 ),
2627 - 'wpcom_newsletter_categories_enabled' => array(
2064 + 'wpcom_newsletter_categories_enabled' => array(
2628 2065 'description' => esc_html__( 'Whether the newsletter categories are enabled or not', 'jetpack' ),
2629 2066 'type' => 'boolean',
2630 2067 'default' => 0,
2631 2068 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2630,30 +2067,58 @@
2630 2067 'default' => 0,
2631 2068 'validate_callback' => __CLASS__ . '::validate_boolean',
2632 2069 'jp_group' => 'subscriptions',
2633 2070 ),
2634 - 'wpcom_featured_image_in_email' => array(
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(
2635 2079 'description' => esc_html__( 'Whether to include the featured image in the email or not', 'jetpack' ),
2636 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',
2637 2088 'default' => 1,
2638 2089 'validate_callback' => __CLASS__ . '::validate_boolean',
2639 2090 'jp_group' => 'subscriptions',
2640 2091 ),
2641 - 'wpcom_subscription_emails_use_excerpt' => array(
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(
2642 2107 'description' => esc_html__( 'Whether to use the excerpt in the email or not', 'jetpack' ),
2643 2108 'type' => 'boolean',
2644 - 'default' => 1,
2109 + 'default' => 0,
2645 2110 'validate_callback' => __CLASS__ . '::validate_boolean',
2646 2111 'jp_group' => 'subscriptions',
2647 2112 ),
2648 - 'jetpack_subscriptions_reply_to' => array(
2113 + 'jetpack_subscriptions_reply_to' => array(
2649 2114 'description' => esc_html__( 'Reply to email behaviour for newsletters emails', 'jetpack' ),
2650 2115 'type' => 'string',
2651 - 'default' => 'no-reply',
2116 + 'default' => Automattic\Jetpack\Modules\Subscriptions\Settings::$default_reply_to,
2652 2117 'validate_callback' => __CLASS__ . '::validate_subscriptions_reply_to',
2653 2118 'jp_group' => 'subscriptions',
2654 2119 ),
2655 - 'jetpack_subscriptions_from_name' => array(
2120 + 'jetpack_subscriptions_from_name' => array(
2656 2121 'description' => esc_html__( 'From name for newsletters emails', 'jetpack' ),
2657 2122 'type' => 'string',
2658 2123 'default' => '',
2659 2124 'validate_callback' => __CLASS__ . '::validate_subscriptions_reply_to_name',
@@ -2658,9 +2123,9 @@
2658 2123 'default' => '',
2659 2124 'validate_callback' => __CLASS__ . '::validate_subscriptions_reply_to_name',
2660 2125 'jp_group' => 'subscriptions',
2661 2126 ),
2662 - 'sm_enabled' => array(
2127 + 'sm_enabled' => array(
2663 2128 'description' => esc_html__( 'Show popup Subscribe modal to readers.', 'jetpack' ),
2664 2129 'type' => 'boolean',
2665 2130 'default' => 0,
2666 2131 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2665,9 +2130,9 @@
2665 2130 'default' => 0,
2666 2131 'validate_callback' => __CLASS__ . '::validate_boolean',
2667 2132 'jp_group' => 'subscriptions',
2668 2133 ),
2669 - 'jetpack_subscribe_overlay_enabled' => array(
2134 + 'jetpack_subscribe_overlay_enabled' => array(
2670 2135 'description' => esc_html__( 'Show subscribe overlay on homepage.', 'jetpack' ),
2671 2136 'type' => 'boolean',
2672 2137 'default' => 0,
2673 2138 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2672,8 +2137,15 @@
2672 2137 'default' => 0,
2673 2138 'validate_callback' => __CLASS__ . '::validate_boolean',
2674 2139 'jp_group' => 'subscriptions',
2675 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 + ),
2676 2148 'jetpack_subscriptions_subscribe_post_end_enabled' => array(
2677 2149 'description' => esc_html__( 'Add Subscribe block at the end of each post.', 'jetpack' ),
2678 2150 'type' => 'boolean',
2679 2151 'default' => 0,
@@ -2693,9 +2165,9 @@
2693 2165 'default' => 0,
2694 2166 'validate_callback' => __CLASS__ . '::validate_boolean',
2695 2167 'jp_group' => 'subscriptions',
2696 2168 ),
2697 - 'social_notifications_subscribe' => array(
2169 + 'social_notifications_subscribe' => array(
2698 2170 'description' => esc_html__( 'Send email notification when someone subscribes to my blog', 'jetpack' ),
2699 2171 'type' => 'boolean',
2700 2172 'default' => 0,
2701 2173 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2700,15 +2172,18 @@
2700 2172 'default' => 0,
2701 2173 'validate_callback' => __CLASS__ . '::validate_boolean',
2702 2174 'jp_group' => 'subscriptions',
2703 2175 ),
2704 - 'subscription_options' => array(
2705 - 'description' => esc_html__( 'Three options used in subscription email templates: \'invitation\', \'welcome\' and \'comment_follow\'.', 'jetpack' ),
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' ),
2706 2178 'type' => 'object',
2707 2179 'default' => array(
2708 - 'invitation' => '',
2709 - 'welcome' => '',
2710 - 'comment_follow' => '',
2180 + 'invitation' => '',
2181 + 'welcome' => '',
2182 + 'comment_follow' => '',
2183 + 'subscribe_modal_heading' => '',
2184 + 'free_tier_description' => '',
2185 + 'hide_free_tier' => false,
2711 2186 ),
2712 2187 'validate_callback' => __CLASS__ . '::validate_subscription_options',
2713 2188 'jp_group' => 'subscriptions',
2714 2189 ),
@@ -2713,9 +2188,9 @@
2713 2188 'jp_group' => 'subscriptions',
2714 2189 ),
2715 2190
2716 2191 // Related Posts.
2717 - 'show_headline' => array(
2192 + 'show_headline' => array(
2718 2193 'description' => esc_html__( 'Highlight related content with a heading', 'jetpack' ),
2719 2194 'type' => 'boolean',
2720 2195 'default' => 1,
2721 2196 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2720,9 +2195,9 @@
2720 2195 'default' => 1,
2721 2196 'validate_callback' => __CLASS__ . '::validate_boolean',
2722 2197 'jp_group' => 'related-posts',
2723 2198 ),
2724 - 'show_thumbnails' => array(
2199 + 'show_thumbnails' => array(
2725 2200 'description' => esc_html__( 'Show a thumbnail image where available', 'jetpack' ),
2726 2201 'type' => 'boolean',
2727 2202 'default' => 0,
2728 2203 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2729,9 +2204,9 @@
2729 2204 'jp_group' => 'related-posts',
2730 2205 ),
2731 2206
2732 2207 // Search.
2733 - 'instant_search_enabled' => array(
2208 + 'instant_search_enabled' => array(
2734 2209 'description' => esc_html__( 'Enable Instant Search', 'jetpack' ),
2735 2210 'type' => 'boolean',
2736 2211 'default' => 0,
2737 2212 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2737,9 +2212,9 @@
2737 2212 'validate_callback' => __CLASS__ . '::validate_boolean',
2738 2213 'jp_group' => 'search',
2739 2214 ),
2740 2215
2741 - 'has_jetpack_search_product' => array(
2216 + 'has_jetpack_search_product' => array(
2742 2217 'description' => esc_html__( 'Has an active Jetpack Search product purchase', 'jetpack' ),
2743 2218 'type' => 'boolean',
2744 2219 'default' => 0,
2745 2220 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2745,9 +2220,9 @@
2745 2220 'validate_callback' => __CLASS__ . '::validate_boolean',
2746 2221 'jp_group' => 'settings',
2747 2222 ),
2748 2223
2749 - 'search_auto_config' => array(
2224 + 'search_auto_config' => array(
2750 2225 'description' => esc_html__( 'Trigger an auto config of instant search', 'jetpack' ),
2751 2226 'type' => 'boolean',
2752 2227 'default' => 0,
2753 2228 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2754,9 +2229,9 @@
2754 2229 'jp_group' => 'search',
2755 2230 ),
2756 2231
2757 2232 // Verification Tools.
2758 - 'google' => array(
2233 + 'google' => array(
2759 2234 'description' => esc_html__( 'Google Search Console', 'jetpack' ),
2760 2235 'type' => 'string',
2761 2236 'default' => '',
2762 2237 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2761,9 +2236,9 @@
2761 2236 'default' => '',
2762 2237 'validate_callback' => __CLASS__ . '::validate_verification_service',
2763 2238 'jp_group' => 'verification-tools',
2764 2239 ),
2765 - 'bing' => array(
2240 + 'bing' => array(
2766 2241 'description' => esc_html__( 'Bing Webmaster Center', 'jetpack' ),
2767 2242 'type' => 'string',
2768 2243 'default' => '',
2769 2244 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2768,9 +2243,9 @@
2768 2243 'default' => '',
2769 2244 'validate_callback' => __CLASS__ . '::validate_verification_service',
2770 2245 'jp_group' => 'verification-tools',
2771 2246 ),
2772 - 'pinterest' => array(
2247 + 'pinterest' => array(
2773 2248 'description' => esc_html__( 'Pinterest Site Verification', 'jetpack' ),
2774 2249 'type' => 'string',
2775 2250 'default' => '',
2776 2251 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2775,9 +2250,9 @@
2775 2250 'default' => '',
2776 2251 'validate_callback' => __CLASS__ . '::validate_verification_service',
2777 2252 'jp_group' => 'verification-tools',
2778 2253 ),
2779 - 'yandex' => array(
2254 + 'yandex' => array(
2780 2255 'description' => esc_html__( 'Yandex Site Verification', 'jetpack' ),
2781 2256 'type' => 'string',
2782 2257 'default' => '',
2783 2258 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2782,9 +2257,9 @@
2782 2257 'default' => '',
2783 2258 'validate_callback' => __CLASS__ . '::validate_verification_service',
2784 2259 'jp_group' => 'verification-tools',
2785 2260 ),
2786 - 'facebook' => array(
2261 + 'facebook' => array(
2787 2262 'description' => esc_html__( 'Facebook Domain Verification', 'jetpack' ),
2788 2263 'type' => 'string',
2789 2264 'default' => '',
2790 2265 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2791,9 +2266,9 @@
2791 2266 'jp_group' => 'verification-tools',
2792 2267 ),
2793 2268
2794 2269 // WordAds.
2795 - 'enable_header_ad' => array(
2270 + 'enable_header_ad' => array(
2796 2271 'description' => esc_html__( 'Display an ad unit at the top of each page.', 'jetpack' ),
2797 2272 'type' => 'boolean',
2798 2273 'default' => 1,
2799 2274 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2798,9 +2273,9 @@
2798 2273 'default' => 1,
2799 2274 'validate_callback' => __CLASS__ . '::validate_boolean',
2800 2275 'jp_group' => 'wordads',
2801 2276 ),
2802 - 'wordads_approved' => array(
2277 + 'wordads_approved' => array(
2803 2278 'description' => esc_html__( 'Is site approved for WordAds?', 'jetpack' ),
2804 2279 'type' => 'boolean',
2805 2280 'default' => 0,
2806 2281 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2805,9 +2280,9 @@
2805 2280 'default' => 0,
2806 2281 'validate_callback' => __CLASS__ . '::validate_boolean',
2807 2282 'jp_group' => 'wordads',
2808 2283 ),
2809 - 'wordads_second_belowpost' => array(
2284 + 'wordads_second_belowpost' => array(
2810 2285 'description' => esc_html__( 'Display second ad below post?', 'jetpack' ),
2811 2286 'type' => 'boolean',
2812 2287 'default' => 1,
2813 2288 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2812,9 +2287,9 @@
2812 2287 'default' => 1,
2813 2288 'validate_callback' => __CLASS__ . '::validate_boolean',
2814 2289 'jp_group' => 'wordads',
2815 2290 ),
2816 - 'wordads_inline_enabled' => array(
2291 + 'wordads_inline_enabled' => array(
2817 2292 'description' => esc_html__( 'Display inline ad within post content?', 'jetpack' ),
2818 2293 'type' => 'boolean',
2819 2294 'default' => 1,
2820 2295 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2819,9 +2294,9 @@
2819 2294 'default' => 1,
2820 2295 'validate_callback' => __CLASS__ . '::validate_boolean',
2821 2296 'jp_group' => 'wordads',
2822 2297 ),
2823 - 'wordads_display_front_page' => array(
2298 + 'wordads_display_front_page' => array(
2824 2299 'description' => esc_html__( 'Display ads on the front page?', 'jetpack' ),
2825 2300 'type' => 'boolean',
2826 2301 'default' => 1,
2827 2302 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2826,9 +2301,9 @@
2826 2301 'default' => 1,
2827 2302 'validate_callback' => __CLASS__ . '::validate_boolean',
2828 2303 'jp_group' => 'wordads',
2829 2304 ),
2830 - 'wordads_display_post' => array(
2305 + 'wordads_display_post' => array(
2831 2306 'description' => esc_html__( 'Display ads on posts?', 'jetpack' ),
2832 2307 'type' => 'boolean',
2833 2308 'default' => 1,
2834 2309 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2833,9 +2308,9 @@
2833 2308 'default' => 1,
2834 2309 'validate_callback' => __CLASS__ . '::validate_boolean',
2835 2310 'jp_group' => 'wordads',
2836 2311 ),
2837 - 'wordads_display_page' => array(
2312 + 'wordads_display_page' => array(
2838 2313 'description' => esc_html__( 'Display ads on pages?', 'jetpack' ),
2839 2314 'type' => 'boolean',
2840 2315 'default' => 1,
2841 2316 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2840,9 +2315,9 @@
2840 2315 'default' => 1,
2841 2316 'validate_callback' => __CLASS__ . '::validate_boolean',
2842 2317 'jp_group' => 'wordads',
2843 2318 ),
2844 - 'wordads_display_archive' => array(
2319 + 'wordads_display_archive' => array(
2845 2320 'description' => esc_html__( 'Display ads on archive pages?', 'jetpack' ),
2846 2321 'type' => 'boolean',
2847 2322 'default' => 1,
2848 2323 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2847,9 +2322,9 @@
2847 2322 'default' => 1,
2848 2323 'validate_callback' => __CLASS__ . '::validate_boolean',
2849 2324 'jp_group' => 'wordads',
2850 2325 ),
2851 - 'wordads_custom_adstxt_enabled' => array(
2326 + 'wordads_custom_adstxt_enabled' => array(
2852 2327 'description' => esc_html__( 'Custom ads.txt', 'jetpack' ),
2853 2328 'type' => 'boolean',
2854 2329 'default' => 0,
2855 2330 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2854,9 +2329,9 @@
2854 2329 'default' => 0,
2855 2330 'validate_callback' => __CLASS__ . '::validate_boolean',
2856 2331 'jp_group' => 'wordads',
2857 2332 ),
2858 - 'wordads_custom_adstxt' => array(
2333 + 'wordads_custom_adstxt' => array(
2859 2334 'description' => esc_html__( 'Custom ads.txt entries', 'jetpack' ),
2860 2335 'type' => 'string',
2861 2336 'default' => '',
2862 2337 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2862,9 +2337,9 @@
2862 2337 'validate_callback' => __CLASS__ . '::validate_string',
2863 2338 'sanitize_callback' => 'sanitize_textarea_field',
2864 2339 'jp_group' => 'wordads',
2865 2340 ),
2866 - 'wordads_ccpa_enabled' => array(
2341 + 'wordads_ccpa_enabled' => array(
2867 2342 'description' => esc_html__( 'Enable support for California Consumer Privacy Act', 'jetpack' ),
2868 2343 'type' => 'boolean',
2869 2344 'default' => 0,
2870 2345 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2869,9 +2344,9 @@
2869 2344 'default' => 0,
2870 2345 'validate_callback' => __CLASS__ . '::validate_boolean',
2871 2346 'jp_group' => 'wordads',
2872 2347 ),
2873 - 'wordads_ccpa_privacy_policy_url' => array(
2348 + 'wordads_ccpa_privacy_policy_url' => array(
2874 2349 'description' => esc_html__( 'Privacy Policy URL', 'jetpack' ),
2875 2350 'type' => 'string',
2876 2351 'default' => '',
2877 2352 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2877,9 +2352,9 @@
2877 2352 'validate_callback' => __CLASS__ . '::validate_string',
2878 2353 'sanitize_callback' => 'sanitize_text_field',
2879 2354 'jp_group' => 'wordads',
2880 2355 ),
2881 - 'wordads_cmp_enabled' => array(
2356 + 'wordads_cmp_enabled' => array(
2882 2357 'description' => esc_html__( 'Enable GDPR Consent Management Banner for WordAds', 'jetpack' ),
2883 2358 'type' => 'boolean',
2884 2359 'default' => 0,
2885 2360 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2886,9 +2361,9 @@
2886 2361 'jp_group' => 'wordads',
2887 2362 ),
2888 2363
2889 2364 // Google Analytics.
2890 - 'google_analytics_tracking_id' => array(
2365 + 'google_analytics_tracking_id' => array(
2891 2366 'description' => esc_html__( 'Google Analytics', 'jetpack' ),
2892 2367 'type' => 'string',
2893 2368 'default' => '',
2894 2369 'validate_callback' => __CLASS__ . '::validate_alphanum',
@@ -2893,11 +2368,16 @@
2893 2368 'default' => '',
2894 2369 'validate_callback' => __CLASS__ . '::validate_alphanum',
2895 2370 'jp_group' => 'google-analytics',
2896 2371 ),
2372 + 'jetpack_wga' => array(
2373 + 'description' => esc_html__( 'Google Analytics', 'jetpack' ),
2374 + 'type' => 'object',
2375 + 'jp_group' => 'settings',
2376 + ),
2897 2377
2898 2378 // Stats.
2899 - 'admin_bar' => array(
2379 + 'admin_bar' => array(
2900 2380 'description' => esc_html__( 'Include a small chart in your admin bar with a 48-hour traffic snapshot.', 'jetpack' ),
2901 2381 'type' => 'boolean',
2902 2382 'default' => 1,
2903 2383 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2902,9 +2382,9 @@
2902 2382 'default' => 1,
2903 2383 'validate_callback' => __CLASS__ . '::validate_boolean',
2904 2384 'jp_group' => 'stats',
2905 2385 ),
2906 - 'enable_odyssey_stats' => array(
2386 + 'enable_odyssey_stats' => array(
2907 2387 'description' => esc_html__( 'Preview the new Jetpack Stats experience (Experimental).', 'jetpack' ),
2908 2388 'type' => 'boolean',
2909 2389 'default' => 1,
2910 2390 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2909,9 +2389,9 @@
2909 2389 'default' => 1,
2910 2390 'validate_callback' => __CLASS__ . '::validate_boolean',
2911 2391 'jp_group' => 'stats',
2912 2392 ),
2913 - 'roles' => array(
2393 + 'roles' => array(
2914 2394 'description' => esc_html__( 'Select the roles that will be able to view stats reports.', 'jetpack' ),
2915 2395 'type' => 'array',
2916 2396 'items' => array(
2917 2397 'type' => 'string',
@@ -2920,9 +2400,9 @@
2920 2400 'validate_callback' => __CLASS__ . '::validate_stats_roles',
2921 2401 'sanitize_callback' => __CLASS__ . '::sanitize_stats_allowed_roles',
2922 2402 'jp_group' => 'stats',
2923 2403 ),
2924 - 'count_roles' => array(
2404 + 'count_roles' => array(
2925 2405 'description' => esc_html__( 'Count the page views of registered users who are logged in.', 'jetpack' ),
2926 2406 'type' => 'array',
2927 2407 'items' => array(
2928 2408 'type' => 'string',
@@ -2930,9 +2410,9 @@
2930 2410 'default' => array( 'administrator' ),
2931 2411 'validate_callback' => __CLASS__ . '::validate_stats_roles',
2932 2412 'jp_group' => 'stats',
2933 2413 ),
2934 - 'blog_id' => array(
2414 + 'blog_id' => array(
2935 2415 'description' => esc_html__( 'Blog ID.', 'jetpack' ),
2936 2416 'type' => 'boolean',
2937 2417 'default' => 0,
2938 2418 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2937,9 +2417,9 @@
2937 2417 'default' => 0,
2938 2418 'validate_callback' => __CLASS__ . '::validate_boolean',
2939 2419 'jp_group' => 'stats',
2940 2420 ),
2941 - 'do_not_track' => array(
2421 + 'do_not_track' => array(
2942 2422 'description' => esc_html__( 'Do not track.', 'jetpack' ),
2943 2423 'type' => 'boolean',
2944 2424 'default' => 1,
2945 2425 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2944,9 +2424,9 @@
2944 2424 'default' => 1,
2945 2425 'validate_callback' => __CLASS__ . '::validate_boolean',
2946 2426 'jp_group' => 'stats',
2947 2427 ),
2948 - 'version' => array(
2428 + 'version' => array(
2949 2429 'description' => esc_html__( 'Version.', 'jetpack' ),
2950 2430 'type' => 'integer',
2951 2431 'default' => 9,
2952 2432 'validate_callback' => __CLASS__ . '::validate_posint',
@@ -2951,9 +2431,9 @@
2951 2431 'default' => 9,
2952 2432 'validate_callback' => __CLASS__ . '::validate_posint',
2953 2433 'jp_group' => 'stats',
2954 2434 ),
2955 - 'collapse_nudges' => array(
2435 + 'collapse_nudges' => array(
2956 2436 'description' => esc_html__( 'Collapse upgrade nudges', 'jetpack' ),
2957 2437 'type' => 'boolean',
2958 2438 'default' => 0,
2959 2439 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2960,9 +2440,9 @@
2960 2440 'jp_group' => 'stats',
2961 2441 ),
2962 2442
2963 2443 // Whether to share stats views with WordPress.com Reader.
2964 - 'wpcom_reader_views_enabled' => array(
2444 + 'wpcom_reader_views_enabled' => array(
2965 2445 'description' => esc_html__( 'Show post views in the WordPress.com Reader.', 'jetpack' ),
2966 2446 'type' => 'boolean',
2967 2447 'default' => 1,
2968 2448 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2969,9 +2449,9 @@
2969 2449 'jp_group' => 'settings',
2970 2450 ),
2971 2451
2972 2452 // Akismet - Not a module, but a plugin. The options can be passed and handled differently.
2973 - 'akismet_show_user_comments_approved' => array(
2453 + 'akismet_show_user_comments_approved' => array(
2974 2454 'description' => '',
2975 2455 'type' => 'boolean',
2976 2456 'default' => 0,
2977 2457 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2977,9 +2457,9 @@
2977 2457 'validate_callback' => __CLASS__ . '::validate_boolean',
2978 2458 'jp_group' => 'settings',
2979 2459 ),
2980 2460
2981 - 'wordpress_api_key' => array(
2461 + 'wordpress_api_key' => array(
2982 2462 'description' => '',
2983 2463 'type' => 'string',
2984 2464 'default' => '',
2985 2465 'validate_callback' => __CLASS__ . '::validate_alphanum',
@@ -2986,9 +2466,9 @@
2986 2466 'jp_group' => 'settings',
2987 2467 ),
2988 2468
2989 2469 // Empty stats card dismiss.
2990 - 'dismiss_empty_stats_card' => array(
2470 + 'dismiss_empty_stats_card' => array(
2991 2471 'description' => '',
2992 2472 'type' => 'boolean',
2993 2473 'default' => 0,
2994 2474 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2995,9 +2475,9 @@
2995 2475 'jp_group' => 'settings',
2996 2476 ),
2997 2477
2998 2478 // Backup Getting Started card on dashboard.
2999 - 'dismiss_dash_backup_getting_started' => array(
2479 + 'dismiss_dash_backup_getting_started' => array(
3000 2480 'description' => '',
3001 2481 'type' => 'boolean',
3002 2482 'default' => 0,
3003 2483 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -3004,9 +2484,9 @@
3004 2484 'jp_group' => 'settings',
3005 2485 ),
3006 2486
3007 2487 // Agencies Learn More card on dashboard.
3008 - 'dismiss_dash_agencies_learn_more' => array(
2488 + 'dismiss_dash_agencies_learn_more' => array(
3009 2489 'description' => '',
3010 2490 'type' => 'boolean',
3011 2491 'default' => 0,
3012 2492 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -3012,9 +2492,9 @@
3012 2492 'validate_callback' => __CLASS__ . '::validate_boolean',
3013 2493 'jp_group' => 'settings',
3014 2494 ),
3015 2495
3016 - 'lang_id' => array(
2496 + 'lang_id' => array(
3017 2497 'description' => esc_html__( 'Primary language for the site.', 'jetpack' ),
3018 2498 'type' => 'string',
3019 2499 'default' => 'en_US',
3020 2500 'jp_group' => 'settings',
@@ -3019,32 +2499,10 @@
3019 2499 'default' => 'en_US',
3020 2500 'jp_group' => 'settings',
3021 2501 ),
3022 2502
3023 - 'onboarding' => array(
3024 - 'description' => '',
3025 - 'type' => 'object',
3026 - 'default' => array(
3027 - 'siteTitle' => '',
3028 - 'siteDescription' => '',
3029 - 'siteType' => 'personal',
3030 - 'homepageFormat' => 'posts',
3031 - 'addContactForm' => 0,
3032 - 'businessAddress' => array(
3033 - 'name' => '',
3034 - 'street' => '',
3035 - 'city' => '',
3036 - 'state' => '',
3037 - 'zip' => '',
3038 - ),
3039 - 'installWooCommerce' => false,
3040 - ),
3041 - 'validate_callback' => __CLASS__ . '::validate_onboarding',
3042 - 'jp_group' => 'settings',
3043 - ),
3044 -
3045 2503 // SEO Tools.
3046 - 'advanced_seo_front_page_description' => array(
2504 + 'advanced_seo_front_page_description' => array(
3047 2505 'description' => esc_html__( 'Front page meta description.', 'jetpack' ),
3048 2506 'type' => 'string',
3049 2507 'default' => '',
3050 2508 'sanitize_callback' => 'Jetpack_SEO_Utils::sanitize_front_page_meta_description',
@@ -3050,9 +2508,9 @@
3050 2508 'sanitize_callback' => 'Jetpack_SEO_Utils::sanitize_front_page_meta_description',
3051 2509 'jp_group' => 'seo-tools',
3052 2510 ),
3053 2511
3054 - 'advanced_seo_title_formats' => array(
2512 + 'advanced_seo_title_formats' => array(
3055 2513 'description' => esc_html__( 'SEO page title structures.', 'jetpack' ),
3056 2514 'type' => 'object',
3057 2515 'default' => array(
3058 2516 'archives' => array(),
@@ -3065,10 +2523,34 @@
3065 2523 'validate_callback' => 'Jetpack_SEO_Titles::are_valid_title_formats',
3066 2524 'sanitize_callback' => 'Jetpack_SEO_Titles::sanitize_title_formats',
3067 2525 ),
3068 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 +
3069 2551 // VideoPress.
3070 - 'videopress_private_enabled_for_site' => array(
2552 + 'videopress_private_enabled_for_site' => array(
3071 2553 'description' => esc_html__( 'Video Privacy: Restrict views to members of this site', 'jetpack' ),
3072 2554 'type' => 'boolean',
3073 2555 'default' => 0,
3074 2556 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -3075,8 +2557,21 @@
3075 2557 'jp_group' => 'videopress',
3076 2558 ),
3077 2559 );
3078 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 +
3079 2574 // Add modules to list so they can be toggled.
3080 2575 $modules = Jetpack::get_available_modules();
3081 2576 if ( is_array( $modules ) && ! empty( $modules ) ) {
3082 2577 $module_args = array(
@@ -3122,8 +2617,10 @@
3122 2617 * Validates that the parameters are proper values that can be set during Jetpack onboarding.
3123 2618 *
3124 2619 * @since 5.4.0
3125 2620 *
2621 + * @deprecated since 13.9
2622 + *
3126 2623 * @param array $onboarding_data Values to check.
3127 2624 * @param WP_REST_Request $request The request sent to the WP REST API.
3128 2625 * @param string $param Name of the parameter passed to endpoint holding $value.
3129 2626 *
@@ -3128,24 +2625,10 @@
3128 2625 * @param string $param Name of the parameter passed to endpoint holding $value.
3129 2626 *
3130 2627 * @return bool|WP_Error
3131 2628 */
3132 - public static function validate_onboarding( $onboarding_data, $request, $param ) {
3133 - if ( ! is_array( $onboarding_data ) ) {
3134 - return new WP_Error( 'invalid_param', esc_html__( 'Not valid onboarding data.', 'jetpack' ) );
3135 - }
3136 - foreach ( $onboarding_data as $value ) {
3137 - if ( is_string( $value ) ) {
3138 - $onboarding_choice = self::validate_string( $value, $request, $param );
3139 - } elseif ( is_array( $value ) ) {
3140 - $onboarding_choice = self::validate_onboarding( $value, $request, $param );
3141 - } else {
3142 - $onboarding_choice = self::validate_boolean( $value, $request, $param );
3143 - }
3144 - if ( is_wp_error( $onboarding_choice ) ) {
3145 - return $onboarding_choice;
3146 - }
3147 - }
2629 + public static function validate_onboarding( $onboarding_data, $request, $param ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
2630 + _deprecated_function( __METHOD__, '13.9' );
3148 2631 return true;
3149 2632 }
3150 2633
3151 2634 /**
@@ -3341,14 +2824,14 @@
3341 2824 *
3342 2825 * @return bool|WP_Error
3343 2826 */
3344 2827 public static function validate_verification_service( $value, $request, $param ) {
3345 - 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 ) ) ) {
3346 2829 return new WP_Error(
3347 2830 'invalid_param',
3348 2831 sprintf(
3349 2832 /* Translators: Placeholder is a verification string used to verify a service like Google Webmaster Console. */
3350 - 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' ),
3351 2834 $param
3352 2835 )
3353 2836 );
3354 2837 }
@@ -3359,9 +2842,9 @@
3359 2842 * Validates that the parameter is among the roles allowed for Stats.
3360 2843 *
3361 2844 * @since 4.3.0
3362 2845 *
3363 - * @param string|bool $value Value to check.
2846 + * @param mixed $value Value to check.
3364 2847 * @param WP_REST_Request $request The request sent to the WP REST API.
3365 2848 * @param string $param Name of the parameter passed to endpoint holding $value.
3366 2849 *
3367 2850 * @return bool|WP_Error
@@ -3366,16 +2849,37 @@
3366 2849 *
3367 2850 * @return bool|WP_Error
3368 2851 */
3369 2852 public static function validate_stats_roles( $value, $request, $param ) {
3370 - 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 ) ) {
3371 2860 return new WP_Error(
3372 2861 'invalid_param',
3373 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(
3374 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. */
3375 2879 esc_html__( '%1$s must be %2$s.', 'jetpack' ),
3376 2880 $param,
3377 - implode( ', ', self::$stats_roles )
2881 + implode( ', ', $editable_roles )
3378 2882 )
3379 2883 );
3380 2884 }
3381 2885 return true;
@@ -3692,9 +3196,12 @@
3692 3196 *
3693 3197 * @return bool|WP_Error
3694 3198 */
3695 3199 public static function validate_subscription_options( $values ) {
3696 - if ( is_object( $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 ) ) {
3697 3204 return new WP_Error(
3698 3205 'invalid_param',
3699 3206 /* Translators: subscription_options is a variable name, and shouldn't be translated. */
3700 3207 esc_html__( 'subscription_options must be an object.', 'jetpack' )
@@ -3700,9 +3207,9 @@
3700 3207 esc_html__( 'subscription_options must be an object.', 'jetpack' )
3701 3208 );
3702 3209 }
3703 3210 foreach ( array_keys( $values ) as $key ) {
3704 - if ( ! in_array( $key, array( 'welcome', 'invitation', 'comment_follow' ), true ) ) {
3211 + if ( ! in_array( $key, array( 'welcome', 'invitation', 'comment_follow', 'subscribe_modal_heading', 'free_tier_description', 'hide_free_tier' ), true ) ) {
3705 3212 return new WP_Error(
3706 3213 'invalid_param',
3707 3214 sprintf(
3708 3215 /* Translators: Placeholder is the invalid param being sent. */
@@ -3743,11 +3250,11 @@
3743 3250 * return an array with only 'administrator' as the allowed role and save it for 'roles' option.
3744 3251 *
3745 3252 * @since 4.3.0
3746 3253 *
3747 - * @param string|bool $value Value to check.
3254 + * @param mixed $value Value to check.
3748 3255 *
3749 - * @return bool|array
3256 + * @return mixed The value as submitted, or an array holding only 'administrator' when it is empty.
3750 3257 */
3751 3258 public static function sanitize_stats_allowed_roles( $value ) {
3752 3259 if ( empty( $value ) ) {
3753 3260 return array( 'administrator' );
@@ -3755,8 +3262,31 @@
3755 3262 return $value;
3756 3263 }
3757 3264
3758 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 + /**
3759 3289 * Get the currently accessed route and return the module slug in it.
3760 3290 *
3761 3291 * @since 4.3.0
3762 3292 *
@@ -3765,9 +3295,9 @@
3765 3295 * @return array|string
3766 3296 */
3767 3297 public static function get_module_requested( $route = '/module/(?P<slug>[a-z\-]+)' ) {
3768 3298
3769 - 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'] ) ) {
3770 3300 return '';
3771 3301 }
3772 3302
3773 3303 preg_match( "#$route#", $GLOBALS['wp']->query_vars['rest_route'], $module );
@@ -3818,8 +3348,40 @@
3818 3348 return $modules;
3819 3349 }
3820 3350
3821 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 + /**
3822 3384 * Remove 'validate_callback' item from options available for module.
3823 3385 * Fetch current option value and add to array of module options.
3824 3386 * Prepare values of module options that need special handling, like those saved in wpcom.
3825 3387 *
@@ -3882,9 +3444,9 @@
3882 3444 $options = self::split_options( $options, $sharer->get_global_options() );
3883 3445 $options['sharing_services']['current_value'] = $sharer->get_blog_services();
3884 3446 $other_sharedaddy_options = array( 'jetpack-twitter-cards-site-tag', 'sharedaddy_disable_resources', 'sharing_delete_service' );
3885 3447 foreach ( $other_sharedaddy_options as $key ) {
3886 - $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
3448 + $default_value = $options[ $key ]['default'] ?? '';
3887 3449 $current_value = get_option( $key, $default_value );
3888 3450 $options[ $key ]['current_value'] = self::cast_value( $current_value, $options[ $key ] );
3889 3451 }
3890 3452 break;
@@ -3895,9 +3457,9 @@
3895 3457 break;
3896 3458 default:
3897 3459 // These option are just stored as plain WordPress options.
3898 3460 foreach ( $options as $key => $value ) {
3899 - $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
3461 + $default_value = $options[ $key ]['default'] ?? '';
3900 3462 $current_value = get_option( $key, $default_value );
3901 3463 $options[ $key ]['current_value'] = self::cast_value( $current_value, $options[ $key ] );
3902 3464 }
3903 3465 }
@@ -3907,14 +3469,17 @@
3907 3469 // We don't need validate_callback in the response.
3908 3470 if ( isset( $options[ $key ]['validate_callback'] ) ) {
3909 3471 unset( $options[ $key ]['validate_callback'] );
3910 3472 }
3911 - $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
3473 + $default_value = $options[ $key ]['default'] ?? '';
3912 3474 if ( ! array_key_exists( 'current_value', $options[ $key ] ) ) {
3913 3475 $options[ $key ]['current_value'] = self::cast_value( $default_value, $options[ $key ] );
3914 3476 }
3915 3477 }
3916 - 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 );
3917 3482 }
3918 3483
3919 3484 /**
3920 3485 * Splits module options saved as arrays like relatedposts or verification_services_codes into separate options to be returned in the response.
@@ -4419,60 +3984,52 @@
4419 3984 return rest_ensure_response( array( 'success' => $updated_option ) );
4420 3985 }
4421 3986
4422 3987 /**
4423 - * Fetch introdution offers.
3988 + * Return the list of available features.
4424 3989 *
4425 - * @since 10.9
4426 - *
4427 - * @return array|WP_Error
3990 + * @return array
4428 3991 */
4429 - public static function get_intro_offers() {
4430 - $site_id = Jetpack_Options::get_option( 'id' );
4431 -
4432 - if ( ! $site_id ) {
4433 - return new WP_Error(
4434 - 'site_id_missing',
4435 - esc_html__( 'Site ID is missing.', 'jetpack' ),
4436 - array( 'status' => 400 )
4437 - );
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 );
4438 3997 }
4439 3998
4440 - $response = Client::wpcom_json_api_request_as_user(
4441 - '/introductory-offers',
4442 - '2',
4443 - array(
4444 - 'method' => 'GET',
4445 - 'headers' => array(
4446 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
4447 - ),
4448 - )
4449 - );
3999 + return $modules;
4000 + }
4450 4001
4451 - $response_code = wp_remote_retrieve_response_code( $response );
4452 -
4453 - if ( 200 !== $response_code ) {
4454 - return new WP_Error(
4455 - 'intro_offers_fetch_failed',
4456 - esc_html__( 'Could not retrieve intro offers.', 'jetpack' ),
4457 - array( 'status' => $response_code )
4458 - );
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 );
4459 4012 }
4460 4013
4461 - $data = json_decode( wp_remote_retrieve_body( $response ) );
4014 + return $modules;
4015 + }
4462 4016
4463 - if ( ! isset( $data ) ) {
4464 - return new WP_Error(
4465 - 'intro_offers_error',
4466 - esc_html__( 'Could not parse intro offers.', 'jetpack' ),
4467 - 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'
4468 4029 );
4030 + return new WP_Error( 'invalid_permission_fetch_features', $message, array( 'status' => rest_authorization_required_code() ) );
4469 4031 }
4470 4032
4471 - return rest_ensure_response(
4472 - array(
4473 - 'code' => 'success',
4474 - 'data' => $data,
4475 - )
4476 - );
4033 + return true;
4477 4034 }
4478 4035 } // class end