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 +624 -854 12.6.4 → 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,225 +605,107 @@
754 605 'permission_callback' => __CLASS__ . '::manage_modules_permission_check',
755 606 )
756 607 );
757 608
758 - // Get Jetpack introduction offers
609 + // Save subscriber token and redirect
759 610 register_rest_route(
760 611 'jetpack/v4',
761 - '/intro-offers',
612 + '/subscribers/auth',
762 613 array(
763 614 'methods' => WP_REST_Server::READABLE,
764 - 'callback' => __CLASS__ . '::get_intro_offers',
765 - 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
615 + 'callback' => __CLASS__ . '::set_subscriber_cookie_and_redirect',
616 + 'permission_callback' => '__return_true',
617 + 'args' => array(
618 + 'redirect_url' => array(
619 + 'required' => true,
620 + 'description' => __( 'The URL to redirect to.', 'jetpack' ),
621 + 'validate_callback' => 'wp_http_validate_url',
622 + 'sanitize_callback' => 'sanitize_url',
623 + 'type' => 'string',
624 + 'format' => 'uri',
625 + ),
626 + ),
766 627 )
767 628 );
768 - }
769 629
770 - /**
771 - * Ask WPCOM for a JWT token to use for OpenAI conversations.
772 - * TODO: Clean me up. This is ugly hack code.
773 - */
774 - public static function get_openai_jwt() {
775 - $blog_id = \Jetpack_Options::get_option( 'id' );
776 -
777 - $response = \Automattic\Jetpack\Connection\Client::wpcom_json_api_request_as_user(
778 - "/sites/$blog_id/jetpack-openai-query/jwt",
779 - '2',
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',
780 638 array(
781 - 'method' => 'POST',
782 - 'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ),
783 - ),
784 - wp_json_encode( array() ),
785 - 'wpcom'
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 + )
786 643 );
787 644
788 - if ( is_wp_error( $response ) ) {
789 - return $response;
790 - }
791 -
792 - $json = json_decode( wp_remote_retrieve_body( $response ) );
793 -
794 - if ( ! isset( $json->token ) ) {
795 - return new WP_Error( 'no-token', 'No token returned from WPCOM' );
796 - }
797 -
798 - return array(
799 - 'token' => $json->token,
800 - 'blog_id' => $blog_id,
801 - );
802 - }
803 -
804 - /**
805 - * Get the data for the recommendations
806 - *
807 - * @return array Recommendations data
808 - */
809 - public static function get_recommendations_data() {
810 - return Jetpack_Recommendations::get_recommendations_data();
811 - }
812 -
813 - /**
814 - * Update the data for the recommendations
815 - *
816 - * @param WP_REST_Request $request The request.
817 - *
818 - * @return bool true
819 - */
820 - public static function update_recommendations_data( $request ) {
821 - $data = $request['data'];
822 - Jetpack_Recommendations::update_recommendations_data( $data );
823 -
824 - return true;
825 - }
826 -
827 - /**
828 - * Get the data for the recommendations
829 - *
830 - * @return array Recommendations data
831 - */
832 - public static function get_recommendations_step() {
833 - return Jetpack_Recommendations::get_recommendations_step();
834 - }
835 -
836 - /**
837 - * Update the step for the recommendations
838 - *
839 - * @param WP_REST_Request $request The request.
840 - *
841 - * @return bool true
842 - */
843 - public static function update_recommendations_step( $request ) {
844 - $step = $request['step'];
845 - Jetpack_Recommendations::update_recommendations_step( $step );
846 -
847 - return true;
848 - }
849 -
850 - /**
851 - * Get product suggestions for the recommendations
852 - *
853 - * @return string|WP_Error The response from the wpcom product suggestions endpoint as a JSON object.
854 - */
855 - public static function get_recommendations_product_suggestions() {
856 - $blog_id = Jetpack_Options::get_option( 'id' );
857 - if ( ! $blog_id ) {
858 - return new WP_Error( 'site_not_registered', esc_html__( 'Site not registered.', 'jetpack' ) );
859 - }
860 -
861 - $user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected( get_current_user_id() );
862 - if ( ! $user_connected ) {
863 - return wp_json_encode( array() );
864 - }
865 -
866 - $request_path = sprintf( '/sites/%s/jetpack-recommendations/product-suggestions?locale=' . get_user_locale(), $blog_id );
867 - $wpcom_request = Client::wpcom_json_api_request_as_user(
868 - $request_path,
869 - '2',
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',
870 653 array(
871 - 'method' => 'GET',
872 - 'headers' => array(
873 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
874 - ),
654 + 'methods' => WP_REST_Server::READABLE,
655 + 'callback' => array( static::class, 'get_features_enabled' ),
656 + 'permission_callback' => array( static::class, 'get_features_permission_check' ),
875 657 )
876 658 );
877 -
878 - $response_code = wp_remote_retrieve_response_code( $wpcom_request );
879 - if ( 200 === $response_code ) {
880 - return json_decode( wp_remote_retrieve_body( $wpcom_request ) );
881 - } else {
882 - return new WP_Error(
883 - 'failed_to_fetch_data',
884 - esc_html__( 'Unable to fetch the requested data.', 'jetpack' ),
885 - array( 'status' => $response_code )
886 - );
887 - }
888 659 }
889 660
890 661 /**
891 - * Get the upsell for the recommendations
662 + * Ask WPCOM for a JWT token to use for OpenAI conversations.
892 663 *
893 - * @return string The response from the wpcom upsell endpoint as a JSON object
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.
894 668 */
895 - public static function get_recommendations_upsell() {
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' ) );
899 - }
669 + public static function get_openai_jwt() {
670 + _deprecated_function( __METHOD__, 'jetpack-16.2', '\Automattic\Jetpack\Connection\REST_Jetpack_AI_JWT::get_jwt' );
900 671
901 - $user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected( get_current_user_id() );
902 - if ( ! $user_connected ) {
903 - $response = array(
904 - 'hide_upsell' => true,
905 - );
672 + $response = ( new REST_Jetpack_AI_JWT() )->get_jwt();
906 673
674 + if ( is_wp_error( $response ) ) {
907 675 return $response;
908 676 }
909 677
910 - $request_path = sprintf( '/sites/%s/jetpack-recommendations/upsell?locale=' . get_user_locale(), $blog_id );
911 - $wpcom_request = Client::wpcom_json_api_request_as_user(
912 - $request_path,
913 - '2',
914 - array(
915 - 'method' => 'GET',
916 - 'headers' => array(
917 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
918 - ),
919 - )
920 - );
921 -
922 - $response_code = wp_remote_retrieve_response_code( $wpcom_request );
923 - if ( 200 === $response_code ) {
924 - return json_decode( wp_remote_retrieve_body( $wpcom_request ) );
925 - } else {
926 - return new WP_Error(
927 - 'failed_to_fetch_data',
928 - esc_html__( 'Unable to fetch the requested data.', 'jetpack' ),
929 - array( 'status' => $response_code )
930 - );
931 - }
678 + // Pre-deprecation callers expect the raw array, not a WP_REST_Response.
679 + return $response->get_data();
932 680 }
933 681
934 682 /**
935 - * Get conditional recommendations data.
683 + * Set subscriber cookie and redirect
936 684 *
937 - * @return array Conditional recommendations data.
938 - */
939 - public static function get_conditional_recommendations() {
940 - return Jetpack_Recommendations::get_conditional_recommendations();
941 - }
942 -
943 - /**
944 - * Validate the recommendations data
685 + * @param \WP_Rest_Request $request The URL to redirect to.
945 686 *
946 - * @param array $value Value to check received by request.
947 - * @param WP_REST_Request $request The request sent to the WP REST API.
948 - * @param string $param Name of the parameter passed to endpoint holding $value.
949 - *
950 - * @return bool|WP_Error
687 + * @return WP_Error|WP_REST_Response
951 688 */
952 - public static function validate_recommendations_data( $value, $request, $param ) {
953 - if ( ! is_array( $value ) ) {
954 - /* translators: Name of a parameter that must be an object */
955 - return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an object.', 'jetpack' ), $param ) );
689 + public static function set_subscriber_cookie_and_redirect( $request ) {
690 + require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/premium-content/_inc/subscription-service/include.php';
691 + $subscription_service = \Automattic\Jetpack\Extensions\Premium_Content\subscription_service();
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 ) );
956 699 }
957 700
958 - foreach ( $value as $answer ) {
959 - if ( is_array( $answer ) ) {
960 - $validate = self::validate_array_of_strings( $answer, $request, $param );
961 - } elseif ( is_string( $answer ) ) {
962 - $validate = self::validate_string( $answer, $request, $param );
963 - } elseif ( $answer === null ) {
964 - $validate = true;
965 - } else {
966 - $validate = self::validate_boolean( $answer, $request, $param );
967 - }
968 -
969 - if ( is_wp_error( $validate ) ) {
970 - return $validate;
971 - }
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 ) );
972 705 }
973 706
974 - return true;
707 + return new WP_REST_Response( null, 302, array( 'location' => $redirect_url ) );
975 708 }
976 709
977 710 /**
978 711 * Return a purchase token used for site-connected (non user-authenticated) checkout.
@@ -1102,9 +835,9 @@
1102 835 * @since 6.6.0
1103 836 *
1104 837 * @param WP_REST_Request $request The request sent to the WP REST API.
1105 838 *
1106 - * @return array|wp-error
839 + * @return array|WP_Error
1107 840 */
1108 841 public static function is_site_verified_and_token( $request ) {
1109 842 /**
1110 843 * Return an error if the site uses a Maintenance / Coming Soon plugin
@@ -1130,8 +863,9 @@
1130 863 || Jetpack::is_plugin_active( 'mojo-under-construction/mojo-contruction.php' ) && 1 == $under_construction_activation_status // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual
1131 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
1132 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
1133 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 + ||
1134 868 /**
1135 869 * Allow plugins to mark a site as "under construction".
1136 870 *
1137 871 * @since 6.7.0
@@ -1137,9 +871,9 @@
1137 871 * @since 6.7.0
1138 872 *
1139 873 * @param false bool Is the site under construction? Default to false.
1140 874 */
1141 - || true === apply_filters( 'jetpack_is_under_construction_plugin', false )
875 + true === apply_filters( 'jetpack_is_under_construction_plugin', false )
1142 876 ) {
1143 877 return new WP_Error( 'forbidden', __( 'Site is under construction and cannot be verified', 'jetpack' ) );
1144 878 }
1145 879
@@ -1211,9 +945,9 @@
1211 945 * @since 4.3.0
1212 946 *
1213 947 * @param WP_REST_Request $request The request sent to the WP REST API.
1214 948 *
1215 - * @return array|wp-error
949 + * @return array|WP_Error
1216 950 */
1217 951 public static function dismiss_notice( $request ) {
1218 952 $notice = $request['notice'];
1219 953
@@ -1278,24 +1012,20 @@
1278 1012
1279 1013 /**
1280 1014 * Verify that a user can use the /connection/user endpoint. Has to be a registered user and be currently linked.
1281 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 + *
1282 1021 * @since 4.3.0
1283 1022 *
1284 - * @uses Automattic\Jetpack\Connection\Manager::is_user_connected();)
1285 - *
1286 1023 * @return bool|WP_Error True if user is able to unlink.
1287 1024 */
1288 1025 public static function unlink_user_permission_callback() {
1289 - if ( current_user_can( 'jetpack_connect_user' ) && ( new Connection_Manager( 'jetpack' ) )->is_user_connected( get_current_user_id() ) ) {
1290 - return true;
1291 - }
1292 -
1293 - return new WP_Error(
1294 - 'invalid_user_permission_unlink_user',
1295 - REST_Connector::get_user_permissions_error_msg(),
1296 - array( 'status' => rest_authorization_required_code() )
1297 - );
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();
1298 1028 }
1299 1029
1300 1030 /**
1301 1031 * Verify that user can manage Jetpack modules.
@@ -1430,139 +1160,8 @@
1430 1160 );
1431 1161 }
1432 1162
1433 1163 /**
1434 - * Test connection status for this Jetpack site.
1435 - *
1436 - * @since 6.8.0
1437 - *
1438 - * @return array|WP_Error WP_Error returned if connection test does not succeed.
1439 - */
1440 - public static function jetpack_connection_test() {
1441 - require_once JETPACK__PLUGIN_DIR . '_inc/lib/debugger.php';
1442 - $cxntests = new Jetpack_Cxn_Tests();
1443 -
1444 - if ( $cxntests->pass() ) {
1445 - return rest_ensure_response(
1446 - array(
1447 - 'code' => 'success',
1448 - 'message' => __( 'All connection tests passed.', 'jetpack' ),
1449 - )
1450 - );
1451 - } else {
1452 - return $cxntests->output_fails_as_wp_error();
1453 - }
1454 - }
1455 -
1456 - /**
1457 - * Test connection permission check method.
1458 - *
1459 - * @since 7.1.0
1460 - *
1461 - * @return bool
1462 - */
1463 - public static function view_jetpack_connection_test_check() {
1464 - // phpcs:disable WordPress.Security.NonceVerification.Recommended -- This is verifying the trusted caller via a shared private key and timestamp.
1465 - if ( ! isset( $_GET['signature'] ) || ! isset( $_GET['timestamp'] ) || ! isset( $_GET['url'] ) ) {
1466 - return false;
1467 - }
1468 - $signature = base64_decode( wp_unslash( $_GET['signature'] ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
1469 -
1470 - $signature_data = wp_json_encode(
1471 - array(
1472 - 'rest_route' => isset( $_GET['rest_route'] ) ? filter_var( wp_unslash( $_GET['rest_route'] ) ) : null,
1473 - 'timestamp' => (int) $_GET['timestamp'],
1474 - 'url' => esc_url_raw( wp_unslash( $_GET['url'] ) ),
1475 - )
1476 - );
1477 -
1478 - if (
1479 - ! function_exists( 'openssl_verify' )
1480 - || 1 !== openssl_verify(
1481 - $signature_data,
1482 - $signature,
1483 - JETPACK__DEBUGGER_PUBLIC_KEY
1484 - )
1485 - ) {
1486 - return false;
1487 - }
1488 -
1489 - // signature timestamp must be within 5min of current time.
1490 - if ( abs( time() - (int) $_GET['timestamp'] ) > 300 ) {
1491 - return false;
1492 - }
1493 -
1494 - // phpcs:enable WordPress.Security.NonceVerification.Recommended
1495 -
1496 - return true;
1497 - }
1498 -
1499 - /**
1500 - * Test connection status for this Jetpack site, encrypt the results for decryption by a third-party.
1501 - *
1502 - * @since 7.1.0
1503 - *
1504 - * @return array|mixed|object|WP_Error
1505 - */
1506 - public static function jetpack_connection_test_for_external() {
1507 - // 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.
1508 - add_filter( 'jetpack_debugger_run_self_test', '__return_false' );
1509 - require_once JETPACK__PLUGIN_DIR . '_inc/lib/debugger.php';
1510 - $cxntests = new Jetpack_Cxn_Tests();
1511 -
1512 - if ( $cxntests->pass() ) {
1513 - $result = array(
1514 - 'code' => 'success',
1515 - 'message' => __( 'All connection tests passed.', 'jetpack' ),
1516 - );
1517 - } else {
1518 - $error = $cxntests->output_fails_as_wp_error(); // Using this so the output is similar both ways.
1519 - $errors = array();
1520 -
1521 - // Borrowed from WP_REST_Server::error_to_response().
1522 - foreach ( (array) $error->errors as $code => $messages ) {
1523 - foreach ( (array) $messages as $message ) {
1524 - $errors[] = array(
1525 - 'code' => $code,
1526 - 'message' => $message,
1527 - 'data' => $error->get_error_data( $code ),
1528 - );
1529 - }
1530 - }
1531 -
1532 - $result = ( ! empty( $errors ) ) ? $errors[0] : null;
1533 - if ( count( $errors ) > 1 ) {
1534 - // Remove the primary error.
1535 - array_shift( $errors );
1536 - $result['additional_errors'] = $errors;
1537 - }
1538 - }
1539 -
1540 - $result = wp_json_encode( $result );
1541 -
1542 - $encrypted = $cxntests->encrypt_string_for_wpcom( $result );
1543 -
1544 - if ( ! $encrypted || ! is_array( $encrypted ) ) {
1545 - return rest_ensure_response(
1546 - array(
1547 - 'code' => 'action_required',
1548 - 'message' => 'Please request results from the in-plugin debugger',
1549 - )
1550 - );
1551 - }
1552 -
1553 - return rest_ensure_response(
1554 - array(
1555 - 'code' => 'response',
1556 - 'debug' => array(
1557 - 'data' => $encrypted['data'],
1558 - 'key' => $encrypted['key'],
1559 - ),
1560 - )
1561 - );
1562 - }
1563 -
1564 - /**
1565 1164 * Fetch information about the Rewind status of the site.
1566 1165 */
1567 1166 public static function rewind_data() {
1568 1167 $site_id = Jetpack_Options::get_option( 'id' );
@@ -1605,9 +1204,9 @@
1605 1204 return rest_ensure_response(
1606 1205 array(
1607 1206 'code' => 'success',
1608 1207 'message' => esc_html__( 'Backup & Scan data correctly received.', 'jetpack' ),
1609 - 'data' => wp_json_encode( $rewind_data ),
1208 + 'data' => wp_json_encode( $rewind_data, JSON_UNESCAPED_SLASHES ),
1610 1209 )
1611 1210 );
1612 1211 }
1613 1212
@@ -1688,9 +1287,9 @@
1688 1287 return rest_ensure_response(
1689 1288 array(
1690 1289 'code' => 'success',
1691 1290 'message' => esc_html__( 'Scan state correctly received.', 'jetpack' ),
1692 - 'data' => wp_json_encode( $scan_state ),
1291 + 'data' => wp_json_encode( $scan_state, JSON_UNESCAPED_SLASHES ),
1693 1292 )
1694 1293 );
1695 1294 }
1696 1295
@@ -1737,41 +1336,8 @@
1737 1336 return new WP_Error( 'disconnect_failed', esc_html__( 'Was not able to disconnect the site. Please try again.', 'jetpack' ), array( 'status' => 400 ) );
1738 1337 }
1739 1338
1740 1339 /**
1741 - * Registers the Jetpack site
1742 - *
1743 - * @deprecated since Jetpack 9.7.0
1744 - * @see Automattic\Jetpack\Connection\REST_Connector::connection_register()
1745 - *
1746 - * @param WP_REST_Request $request The request sent to the WP REST API.
1747 - *
1748 - * @return bool|WP_Error True if Jetpack successfully registered
1749 - */
1750 - public static function register_site( $request ) {
1751 - _deprecated_function( __METHOD__, 'jetpack-9.7.0', '\Automattic\Jetpack\Connection\REST_Connector::connection_register' );
1752 -
1753 - if ( ! wp_verify_nonce( $request->get_param( 'registration_nonce' ), 'jetpack-registration-nonce' ) ) {
1754 - return new WP_Error( 'invalid_nonce', __( 'Unable to verify your request.', 'jetpack' ), array( 'status' => 403 ) );
1755 - }
1756 -
1757 - if ( isset( $request['from'] ) ) {
1758 - Jetpack::connection()->add_register_request_param( 'from', (string) $request['from'] );
1759 - }
1760 - $response = Jetpack::connection()->try_registration();
1761 -
1762 - if ( is_wp_error( $response ) ) {
1763 - return $response;
1764 - }
1765 -
1766 - return rest_ensure_response(
1767 - array(
1768 - 'authorizeUrl' => Jetpack::build_authorize_url( false ),
1769 - )
1770 - );
1771 - }
1772 -
1773 - /**
1774 1340 * Gets a new connect raw URL with fresh nonce.
1775 1341 *
1776 1342 * @uses Jetpack::disconnect();
1777 1343 * @since 4.3.0
@@ -1780,10 +1346,10 @@
1780 1346 *
1781 1347 * @return string|WP_Error A raw URL if the connection URL could be built; error message otherwise.
1782 1348 */
1783 1349 public static function build_connect_url( $request = array() ) {
1784 - $from = isset( $request['from'] ) ? $request['from'] : false;
1785 - $redirect = isset( $request['redirect'] ) ? $request['redirect'] : false;
1350 + $from = $request['from'] ?? false;
1351 + $redirect = $request['redirect'] ?? false;
1786 1352
1787 1353 $url = Jetpack::init()->build_connect_url( true, $redirect, $from );
1788 1354 if ( $url ) {
1789 1355 return rest_ensure_response( $url );
@@ -1806,9 +1372,9 @@
1806 1372 */
1807 1373 public static function get_user_connection_data() {
1808 1374 _deprecated_function( __METHOD__, 'jetpack-10.0.0', '\Automattic\Jetpack\Connection\REST_Connector::get_user_connection_data' );
1809 1375
1810 - 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';
1811 1377
1812 1378 $connection_owner = ( new Connection_Manager() )->get_connection_owner();
1813 1379 $owner_display_name = false === $connection_owner ? null : $connection_owner->data->display_name;
1814 1380
@@ -1821,30 +1387,21 @@
1821 1387
1822 1388 /**
1823 1389 * Unlinks current user from the WordPress.com Servers.
1824 1390 *
1825 - * @since 4.3.0
1391 + * @param WP_REST_Request $request The request sent to the WP REST API.
1826 1392 * @uses Automattic\Jetpack\Connection\Manager->disconnect_user
1827 1393 *
1828 - * @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()
1829 1396 *
1397 + * @since 4.3.0
1398 + *
1830 1399 * @return bool|WP_Error True if user successfully unlinked.
1831 1400 */
1832 1401 public static function unlink_user( $request ) {
1833 -
1834 - if ( ! isset( $request['linked'] ) || false !== $request['linked'] ) {
1835 - return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
1836 - }
1837 -
1838 - if ( ( new Connection_Manager( 'jetpack' ) )->disconnect_user() ) {
1839 - return rest_ensure_response(
1840 - array(
1841 - 'code' => 'success',
1842 - )
1843 - );
1844 - }
1845 -
1846 - 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 );
1847 1404 }
1848 1405
1849 1406 /**
1850 1407 * Gets current user's tracking settings.
@@ -1903,9 +1460,9 @@
1903 1460 'Content-Type' => 'application/json',
1904 1461 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
1905 1462 ),
1906 1463 ),
1907 - wp_json_encode( $request->get_params() )
1464 + wp_json_encode( $request->get_params(), JSON_UNESCAPED_SLASHES )
1908 1465 );
1909 1466 if ( ! is_wp_error( $response ) ) {
1910 1467 $response = json_decode( wp_remote_retrieve_body( $response ), true );
1911 1468 }
@@ -1917,93 +1474,30 @@
1917 1474 /**
1918 1475 * Fetch site data from .com including the site's current plan and the site's products.
1919 1476 *
1920 1477 * @since 5.5.0
1478 + * @deprecated 16.2 Use Automattic\Jetpack\Connection\Manager::get_connected_site_data().
1921 1479 *
1922 1480 * @return stdClass|WP_Error
1923 1481 */
1924 1482 public static function site_data() {
1925 - $site_id = Jetpack_Options::get_option( 'id' );
1483 + _deprecated_function( __METHOD__, 'jetpack-16.2', 'Automattic\Jetpack\Connection\Manager::get_connected_site_data' );
1926 1484
1927 - if ( ! $site_id ) {
1928 - return new WP_Error( 'site_id_missing', '', array( 'api_error_code' => __( 'site_id_missing', 'jetpack' ) ) );
1929 - }
1485 + return ( new Connection_Manager() )->get_connected_site_data();
1486 + }
1930 1487
1931 - $args = array( 'headers' => array() );
1932 -
1933 - // Allow use a store sandbox. Internal ref: PCYsg-IA-p2.
1934 - if ( isset( $_COOKIE ) && isset( $_COOKIE['store_sandbox'] ) ) {
1935 - $secret = filter_var( wp_unslash( $_COOKIE['store_sandbox'] ) );
1936 - $args['headers']['Cookie'] = "store_sandbox=$secret;";
1937 - }
1938 -
1939 - $response = Client::wpcom_json_api_request_as_blog( sprintf( '/sites/%d', $site_id ) . '?force=wpcom', '1.1', $args );
1940 - $body = wp_remote_retrieve_body( $response );
1941 - $data = $body ? json_decode( $body ) : null;
1942 -
1943 - if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
1944 - $error_info = array(
1945 - 'api_error_code' => null,
1946 - 'api_http_code' => wp_remote_retrieve_response_code( $response ),
1947 - );
1948 -
1949 - if ( is_wp_error( $response ) ) {
1950 - $error_info['api_error_code'] = $response->get_error_code() ? wp_strip_all_tags( $response->get_error_code() ) : null;
1951 - } elseif ( $data && ! empty( $data->error ) ) {
1952 - $error_info['api_error_code'] = $data->error;
1953 - }
1954 -
1955 - return new WP_Error( 'site_data_fetch_failed', '', $error_info );
1956 - }
1957 -
1958 - Jetpack_Plan::update_from_sites_response( $response );
1959 -
1960 - return $data;
1961 - }
1962 1488 /**
1963 1489 * Get site data, including for example, the site's current plan.
1964 1490 *
1491 + * @since 4.3.0
1492 + * @deprecated 16.2 Use Automattic\Jetpack\Connection\REST_Connector::site_data_response().
1493 + *
1965 1494 * @return WP_Error|WP_HTTP_Response|WP_REST_Response
1966 - * @since 4.3.0
1967 1495 */
1968 1496 public static function get_site_data() {
1969 - $site_data = self::site_data();
1497 + _deprecated_function( __METHOD__, 'jetpack-16.2', 'Automattic\Jetpack\Connection\REST_Connector::site_data_response' );
1970 1498
1971 - if ( ! is_wp_error( $site_data ) ) {
1972 -
1973 - /**
1974 - * Fires when the site data was successfully returned from the /sites/%d wpcom endpoint.
1975 - *
1976 - * @since 8.7.0
1977 - */
1978 - do_action( 'jetpack_get_site_data_success' );
1979 - return rest_ensure_response(
1980 - array(
1981 - 'code' => 'success',
1982 - 'message' => esc_html__( 'Site data correctly received.', 'jetpack' ),
1983 - 'data' => wp_json_encode( $site_data ),
1984 - )
1985 - );
1986 - }
1987 -
1988 - $error_data = $site_data->get_error_data();
1989 -
1990 - if ( empty( $error_data['api_error_code'] ) ) {
1991 - $error_message = esc_html__( 'Failed fetching site data from WordPress.com. If the problem persists, try reconnecting Jetpack.', 'jetpack' );
1992 - } else {
1993 - /* translators: %s is an error code (e.g. `token_mismatch`) */
1994 - $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'] );
1995 - }
1996 -
1997 - return new WP_Error(
1998 - $site_data->get_error_code(),
1999 - $error_message,
2000 - array(
2001 - 'status' => 400,
2002 - 'api_error_code' => empty( $error_data['api_error_code'] ) ? null : $error_data['api_error_code'],
2003 - 'api_http_code' => empty( $error_data['api_http_code'] ) ? null : $error_data['api_http_code'],
2004 - )
2005 - );
1499 + return REST_Connector::site_data_response();
2006 1500 }
2007 1501
2008 1502 /**
2009 1503 * Fetch AL data for this site and return it.
@@ -2063,64 +1557,8 @@
2063 1557 );
2064 1558 }
2065 1559
2066 1560 /**
2067 - * Fetch the discount for this site and return it.
2068 - *
2069 - * @since 10.8
2070 - *
2071 - * @return array|WP_Error
2072 - */
2073 - public static function get_site_discount() {
2074 - $site_id = Jetpack_Options::get_option( 'id' );
2075 -
2076 - if ( ! $site_id ) {
2077 - return new WP_Error(
2078 - 'site_id_missing',
2079 - esc_html__( 'Site ID is missing.', 'jetpack' ),
2080 - array( 'status' => 400 )
2081 - );
2082 - }
2083 -
2084 - $response = Client::wpcom_json_api_request_as_user(
2085 - "/sites/$site_id/discount",
2086 - '2',
2087 - array(
2088 - 'method' => 'GET',
2089 - 'headers' => array(
2090 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
2091 - ),
2092 - )
2093 - );
2094 -
2095 - $response_code = wp_remote_retrieve_response_code( $response );
2096 - $data = json_decode( wp_remote_retrieve_body( $response ) );
2097 -
2098 - if ( 200 !== $response_code ) {
2099 - return new WP_Error(
2100 - 'discount_fetch_failed',
2101 - is_object( $data ) && property_exists( $data, 'error' ) ? $data->error : esc_html__( 'Could not retrieve site discount.', 'jetpack' ),
2102 - array( 'status' => $response_code )
2103 - );
2104 - }
2105 -
2106 - if ( ! isset( $data ) ) {
2107 - return new WP_Error(
2108 - 'discount_parse_error',
2109 - esc_html__( 'Could not parse discount', 'jetpack' ),
2110 - array( 'status' => 204 ) // no content.
2111 - );
2112 - }
2113 -
2114 - return rest_ensure_response(
2115 - array(
2116 - 'code' => 'success',
2117 - 'data' => $data,
2118 - )
2119 - );
2120 - }
2121 -
2122 - /**
2123 1561 * Reset Jetpack options
2124 1562 *
2125 1563 * @since 4.3.0
2126 1564 *
@@ -2218,9 +1656,9 @@
2218 1656 public static function get_updateable_data_list( $selector = '' ) {
2219 1657
2220 1658 $options = array(
2221 1659 // Blocks.
2222 - 'jetpack_blocks_disabled' => array(
1660 + 'jetpack_blocks_disabled' => array(
2223 1661 'description' => esc_html__( 'Jetpack Blocks disabled.', 'jetpack' ),
2224 1662 'type' => 'boolean',
2225 1663 'default' => false,
2226 1664 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2227,9 +1665,9 @@
2227 1665 'jp_group' => 'settings',
2228 1666 ),
2229 1667
2230 1668 // Carousel
2231 - 'carousel_background_color' => array(
1669 + 'carousel_background_color' => array(
2232 1670 'description' => esc_html__( 'Color scheme.', 'jetpack' ),
2233 1671 'type' => 'string',
2234 1672 'default' => 'black',
2235 1673 'enum' => array(
@@ -2242,9 +1680,9 @@
2242 1680 ),
2243 1681 'validate_callback' => __CLASS__ . '::validate_list_item',
2244 1682 'jp_group' => 'carousel',
2245 1683 ),
2246 - 'carousel_display_exif' => array(
1684 + 'carousel_display_exif' => array(
2247 1685 'description' => wp_kses(
2248 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' ) ),
2249 1687 array(
2250 1688 'a' => array(
@@ -2257,9 +1695,9 @@
2257 1695 'default' => 0,
2258 1696 'validate_callback' => __CLASS__ . '::validate_boolean',
2259 1697 'jp_group' => 'carousel',
2260 1698 ),
2261 - 'carousel_display_comments' => array(
1699 + 'carousel_display_comments' => array(
2262 1700 'description' => esc_html__( 'Show comments area in carousel', 'jetpack' ),
2263 1701 'type' => 'boolean',
2264 1702 'default' => 1,
2265 1703 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2266,9 +1704,9 @@
2266 1704 'jp_group' => 'carousel',
2267 1705 ),
2268 1706
2269 1707 // Comments.
2270 - 'highlander_comment_form_prompt' => array(
1708 + 'highlander_comment_form_prompt' => array(
2271 1709 'description' => esc_html__( 'Greeting Text', 'jetpack' ),
2272 1710 'type' => 'string',
2273 1711 'default' => esc_html__( 'Leave a Reply', 'jetpack' ),
2274 1712 'sanitize_callback' => 'sanitize_text_field',
@@ -2273,9 +1711,9 @@
2273 1711 'default' => esc_html__( 'Leave a Reply', 'jetpack' ),
2274 1712 'sanitize_callback' => 'sanitize_text_field',
2275 1713 'jp_group' => 'comments',
2276 1714 ),
2277 - 'jetpack_comment_form_color_scheme' => array(
1715 + 'jetpack_comment_form_color_scheme' => array(
2278 1716 'description' => esc_html__( 'Color scheme', 'jetpack' ),
2279 1717 'type' => 'string',
2280 1718 'default' => 'light',
2281 1719 'enum' => array(
@@ -2292,39 +1730,38 @@
2292 1730 'jp_group' => 'comments',
2293 1731 ),
2294 1732
2295 1733 // Custom Content Types.
2296 - 'jetpack_portfolio' => array(
1734 + 'jetpack_portfolio' => array(
2297 1735 'description' => esc_html__( 'Enable or disable Jetpack portfolio post type.', 'jetpack' ),
2298 1736 'type' => 'boolean',
2299 1737 'default' => 0,
2300 1738 'validate_callback' => __CLASS__ . '::validate_boolean',
2301 - 'jp_group' => 'custom-content-types',
1739 + 'jp_group' => 'settings',
2302 1740 ),
2303 - 'jetpack_portfolio_posts_per_page' => array(
1741 + 'jetpack_portfolio_posts_per_page' => array(
2304 1742 'description' => esc_html__( 'Number of entries to show at most in Portfolio pages.', 'jetpack' ),
2305 1743 'type' => 'integer',
2306 1744 'default' => 10,
2307 1745 'validate_callback' => __CLASS__ . '::validate_posint',
2308 - 'jp_group' => 'custom-content-types',
1746 + 'jp_group' => 'settings',
2309 1747 ),
2310 - 'jetpack_testimonial' => array(
1748 + 'jetpack_testimonial' => array(
2311 1749 'description' => esc_html__( 'Enable or disable Jetpack testimonial post type.', 'jetpack' ),
2312 1750 'type' => 'boolean',
2313 1751 'default' => 0,
2314 1752 'validate_callback' => __CLASS__ . '::validate_boolean',
2315 - 'jp_group' => 'custom-content-types',
1753 + 'jp_group' => 'settings',
2316 1754 ),
2317 - 'jetpack_testimonial_posts_per_page' => array(
1755 + 'jetpack_testimonial_posts_per_page' => array(
2318 1756 'description' => esc_html__( 'Number of entries to show at most in Testimonial pages.', 'jetpack' ),
2319 1757 'type' => 'integer',
2320 1758 'default' => 10,
2321 1759 'validate_callback' => __CLASS__ . '::validate_posint',
2322 - 'jp_group' => 'custom-content-types',
1760 + 'jp_group' => 'settings',
2323 1761 ),
2324 -
2325 1762 // WAF.
2326 - 'jetpack_waf_automatic_rules' => array(
1763 + 'jetpack_waf_automatic_rules' => array(
2327 1764 'description' => esc_html__( 'Enable automatic rules - Protect your site against untrusted traffic sources with automatic security rules.', 'jetpack' ),
2328 1765 'type' => 'boolean',
2329 1766 'default' => Waf_Compatibility::get_default_automatic_rules_option(),
2330 1767 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2329,16 +1766,16 @@
2329 1766 'default' => Waf_Compatibility::get_default_automatic_rules_option(),
2330 1767 'validate_callback' => __CLASS__ . '::validate_boolean',
2331 1768 'jp_group' => 'waf',
2332 1769 ),
2333 - 'jetpack_waf_ip_list' => array(
2334 - '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' ),
2335 1772 'type' => 'boolean',
2336 1773 'default' => 0,
2337 1774 'validate_callback' => __CLASS__ . '::validate_boolean',
2338 1775 'jp_group' => 'waf',
2339 1776 ),
2340 - 'jetpack_waf_ip_block_list' => array(
1777 + 'jetpack_waf_ip_block_list' => array(
2341 1778 'description' => esc_html__( 'Blocked IP addresses', 'jetpack' ),
2342 1779 'type' => 'string',
2343 1780 'default' => '',
2344 1781 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2344,9 +1781,16 @@
2344 1781 'validate_callback' => __CLASS__ . '::validate_string',
2345 1782 'sanitize_callback' => 'esc_textarea',
2346 1783 'jp_group' => 'waf',
2347 1784 ),
2348 - '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(
2349 1793 'description' => esc_html__( 'Always allowed IP addresses', 'jetpack' ),
2350 1794 'type' => 'string',
2351 1795 'default' => '',
2352 1796 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2352,17 +1796,24 @@
2352 1796 'validate_callback' => __CLASS__ . '::validate_string',
2353 1797 'sanitize_callback' => 'esc_textarea',
2354 1798 'jp_group' => 'settings',
2355 1799 ),
2356 - 'jetpack_waf_share_data' => array(
2357 - 'description' => esc_html__( 'Share data with Jetpack.', 'jetpack' ),
1800 + 'jetpack_waf_share_data' => array(
1801 + 'description' => esc_html__( 'Share basic data with Jetpack.', 'jetpack' ),
2358 1802 'type' => 'boolean',
2359 1803 'default' => 0,
2360 1804 'validate_callback' => __CLASS__ . '::validate_boolean',
2361 1805 'jp_group' => 'waf',
2362 1806 ),
1807 + 'jetpack_waf_share_debug_data' => array(
1808 + 'description' => esc_html__( 'Share detailed data with Jetpack.', 'jetpack' ),
1809 + 'type' => 'boolean',
1810 + 'default' => 0,
1811 + 'validate_callback' => __CLASS__ . '::validate_boolean',
1812 + 'jp_group' => 'waf',
1813 + ),
2363 1814 // Galleries.
2364 - 'tiled_galleries' => array(
1815 + 'tiled_galleries' => array(
2365 1816 'description' => esc_html__( 'Display all your gallery pictures in a cool mosaic.', 'jetpack' ),
2366 1817 'type' => 'boolean',
2367 1818 'default' => 0,
2368 1819 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2368,9 +1819,9 @@
2368 1819 'validate_callback' => __CLASS__ . '::validate_boolean',
2369 1820 'jp_group' => 'tiled-gallery',
2370 1821 ),
2371 1822
2372 - 'gravatar_disable_hovercards' => array(
1823 + 'gravatar_disable_hovercards' => array(
2373 1824 'description' => esc_html__( "View people's profiles when you mouse over their Gravatars", 'jetpack' ),
2374 1825 'type' => 'string',
2375 1826 'default' => 'enabled',
2376 1827 // Not visible. This is used as the checkbox value.
@@ -2386,9 +1837,9 @@
2386 1837 'jp_group' => 'gravatar-hovercards',
2387 1838 ),
2388 1839
2389 1840 // Infinite Scroll.
2390 - 'infinite_scroll' => array(
1841 + 'infinite_scroll' => array(
2391 1842 'description' => esc_html__( 'To infinity and beyond', 'jetpack' ),
2392 1843 'type' => 'boolean',
2393 1844 'default' => 1,
2394 1845 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2393,9 +1844,9 @@
2393 1844 'default' => 1,
2394 1845 'validate_callback' => __CLASS__ . '::validate_boolean',
2395 1846 'jp_group' => 'infinite-scroll',
2396 1847 ),
2397 - 'infinite_scroll_google_analytics' => array(
1848 + 'infinite_scroll_google_analytics' => array(
2398 1849 'description' => esc_html__( 'Use Google Analytics with Infinite Scroll', 'jetpack' ),
2399 1850 'type' => 'boolean',
2400 1851 'default' => 0,
2401 1852 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2402,9 +1853,9 @@
2402 1853 'jp_group' => 'infinite-scroll',
2403 1854 ),
2404 1855
2405 1856 // Likes.
2406 - 'wpl_default' => array(
1857 + 'wpl_default' => array(
2407 1858 'description' => esc_html__( 'WordPress.com Likes are', 'jetpack' ),
2408 1859 'type' => 'string',
2409 1860 'default' => 'on',
2410 1861 'enum' => array(
@@ -2417,9 +1868,9 @@
2417 1868 ),
2418 1869 'validate_callback' => __CLASS__ . '::validate_list_item',
2419 1870 'jp_group' => 'likes',
2420 1871 ),
2421 - 'social_notifications_like' => array(
1872 + 'social_notifications_like' => array(
2422 1873 'description' => esc_html__( 'Send email notification when someone likes a post', 'jetpack' ),
2423 1874 'type' => 'boolean',
2424 1875 'default' => 1,
2425 1876 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2426,9 +1877,9 @@
2426 1877 'jp_group' => 'likes',
2427 1878 ),
2428 1879
2429 1880 // Markdown.
2430 - 'wpcom_publish_comments_with_markdown' => array(
1881 + 'wpcom_publish_comments_with_markdown' => array(
2431 1882 'description' => esc_html__( 'Use Markdown for comments.', 'jetpack' ),
2432 1883 'type' => 'boolean',
2433 1884 'default' => 0,
2434 1885 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2433,9 +1884,9 @@
2433 1884 'default' => 0,
2434 1885 'validate_callback' => __CLASS__ . '::validate_boolean',
2435 1886 'jp_group' => 'markdown',
2436 1887 ),
2437 - 'wpcom_publish_posts_with_markdown' => array(
1888 + 'wpcom_publish_posts_with_markdown' => array(
2438 1889 'description' => esc_html__( 'Use Markdown for posts.', 'jetpack' ),
2439 1890 'type' => 'boolean',
2440 1891 'default' => 0,
2441 1892 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2442,9 +1893,9 @@
2442 1893 'jp_group' => 'markdown',
2443 1894 ),
2444 1895
2445 1896 // Monitor.
2446 - 'monitor_receive_notifications' => array(
1897 + 'monitor_receive_notifications' => array(
2447 1898 'description' => esc_html__( 'Receive Monitor Email Notifications.', 'jetpack' ),
2448 1899 'type' => 'boolean',
2449 1900 'default' => 0,
2450 1901 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2451,9 +1902,9 @@
2451 1902 'jp_group' => 'monitor',
2452 1903 ),
2453 1904
2454 1905 // Post by Email.
2455 - 'post_by_email_address' => array(
1906 + 'post_by_email_address' => array(
2456 1907 'description' => esc_html__( 'Email Address', 'jetpack' ),
2457 1908 'type' => 'string',
2458 1909 'default' => 'noop',
2459 1910 'enum' => array(
@@ -2472,9 +1923,9 @@
2472 1923 'jp_group' => 'post-by-email',
2473 1924 ),
2474 1925
2475 1926 // Protect.
2476 - 'jetpack_protect_key' => array(
1927 + 'jetpack_protect_key' => array(
2477 1928 'description' => esc_html__( 'Protect API key', 'jetpack' ),
2478 1929 'type' => 'string',
2479 1930 'default' => '',
2480 1931 'validate_callback' => __CLASS__ . '::validate_alphanum',
@@ -2479,9 +1930,9 @@
2479 1930 'default' => '',
2480 1931 'validate_callback' => __CLASS__ . '::validate_alphanum',
2481 1932 'jp_group' => 'protect',
2482 1933 ),
2483 - 'jetpack_protect_global_whitelist' => array(
1934 + 'jetpack_protect_global_whitelist' => array(
2484 1935 'description' => esc_html__( 'Protect global IP allow list', 'jetpack' ),
2485 1936 'type' => 'string',
2486 1937 'default' => '',
2487 1938 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2489,19 +1940,19 @@
2489 1940 'jp_group' => 'protect',
2490 1941 ),
2491 1942
2492 1943 // Sharing.
2493 - 'sharing_services' => array(
1944 + 'sharing_services' => array(
2494 1945 'description' => esc_html__( 'Enabled Services and those hidden behind a button', 'jetpack' ),
2495 1946 'type' => 'object',
2496 1947 'default' => array(
2497 - 'visible' => array( 'twitter', 'facebook' ),
1948 + 'visible' => array( 'facebook', 'x' ),
2498 1949 'hidden' => array(),
2499 1950 ),
2500 1951 'validate_callback' => __CLASS__ . '::validate_services',
2501 1952 'jp_group' => 'sharedaddy',
2502 1953 ),
2503 - 'button_style' => array(
1954 + 'button_style' => array(
2504 1955 'description' => esc_html__( 'Button Style', 'jetpack' ),
2505 1956 'type' => 'string',
2506 1957 'default' => 'icon',
2507 1958 'enum' => array(
@@ -2518,9 +1969,9 @@
2518 1969 ),
2519 1970 'validate_callback' => __CLASS__ . '::validate_list_item',
2520 1971 'jp_group' => 'sharedaddy',
2521 1972 ),
2522 - 'sharing_label' => array(
1973 + 'sharing_label' => array(
2523 1974 'description' => esc_html__( 'Sharing Label', 'jetpack' ),
2524 1975 'type' => 'string',
2525 1976 'default' => '',
2526 1977 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2526,9 +1977,9 @@
2526 1977 'validate_callback' => __CLASS__ . '::validate_string',
2527 1978 'sanitize_callback' => 'esc_html',
2528 1979 'jp_group' => 'sharedaddy',
2529 1980 ),
2530 - 'show' => array(
1981 + 'show' => array(
2531 1982 'description' => esc_html__( 'Views where buttons are shown', 'jetpack' ),
2532 1983 'type' => 'array',
2533 1984 'items' => array(
2534 1985 'type' => 'string',
@@ -2536,9 +1987,9 @@
2536 1987 'default' => array( 'post' ),
2537 1988 'validate_callback' => __CLASS__ . '::validate_sharing_show',
2538 1989 'jp_group' => 'sharedaddy',
2539 1990 ),
2540 - 'jetpack-twitter-cards-site-tag' => array(
1991 + 'jetpack-twitter-cards-site-tag' => array(
2541 1992 'description' => esc_html__( "The Twitter username of the owner of this site's domain.", 'jetpack' ),
2542 1993 'type' => 'string',
2543 1994 'default' => '',
2544 1995 'validate_callback' => __CLASS__ . '::validate_twitter_username',
@@ -2544,9 +1995,9 @@
2544 1995 'validate_callback' => __CLASS__ . '::validate_twitter_username',
2545 1996 'sanitize_callback' => 'esc_html',
2546 1997 'jp_group' => 'sharedaddy',
2547 1998 ),
2548 - 'sharedaddy_disable_resources' => array(
1999 + 'sharedaddy_disable_resources' => array(
2549 2000 'description' => esc_html__( 'Disable CSS and JS', 'jetpack' ),
2550 2001 'type' => 'boolean',
2551 2002 'default' => 0,
2552 2003 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2551,9 +2002,9 @@
2551 2002 'default' => 0,
2552 2003 'validate_callback' => __CLASS__ . '::validate_boolean',
2553 2004 'jp_group' => 'sharedaddy',
2554 2005 ),
2555 - 'custom' => array(
2006 + 'custom' => array(
2556 2007 'description' => esc_html__( 'Custom sharing services added by user.', 'jetpack' ),
2557 2008 'type' => 'object',
2558 2009 'default' => array(
2559 2010 'sharing_name' => '',
@@ -2562,10 +2013,10 @@
2562 2013 ),
2563 2014 'validate_callback' => __CLASS__ . '::validate_custom_service',
2564 2015 'jp_group' => 'sharedaddy',
2565 2016 ),
2566 - // Not an option, but an action that can be perfomed on the list of custom services passing the service ID.
2567 - 'sharing_delete_service' => array(
2017 + // Not an option, but an action that can be performed on the list of custom services passing the service ID.
2018 + 'sharing_delete_service' => array(
2568 2019 'description' => esc_html__( 'Delete custom sharing service.', 'jetpack' ),
2569 2020 'type' => 'string',
2570 2021 'default' => '',
2571 2022 'validate_callback' => __CLASS__ . '::validate_custom_service_id',
@@ -2572,16 +2023,16 @@
2572 2023 'jp_group' => 'sharedaddy',
2573 2024 ),
2574 2025
2575 2026 // SSO.
2576 - 'jetpack_sso_require_two_step' => array(
2027 + 'jetpack_sso_require_two_step' => array(
2577 2028 'description' => esc_html__( 'Require Two-Step Authentication', 'jetpack' ),
2578 2029 'type' => 'boolean',
2579 - 'default' => 0,
2030 + 'default' => SSO\Helpers::is_require_two_step_checkbox_disabled(),
2580 2031 'validate_callback' => __CLASS__ . '::validate_boolean',
2581 2032 'jp_group' => 'sso',
2582 2033 ),
2583 - 'jetpack_sso_match_by_email' => array(
2034 + 'jetpack_sso_match_by_email' => array(
2584 2035 'description' => esc_html__( 'Match by Email', 'jetpack' ),
2585 2036 'type' => 'boolean',
2586 2037 'default' => 1,
2587 2038 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2588,9 +2039,9 @@
2588 2039 'jp_group' => 'sso',
2589 2040 ),
2590 2041
2591 2042 // Subscriptions.
2592 - 'stb_enabled' => array(
2043 + 'stb_enabled' => array(
2593 2044 'description' => esc_html__( "Show a <em>'follow blog'</em> option in the comment form", 'jetpack' ),
2594 2045 'type' => 'boolean',
2595 2046 'default' => 1,
2596 2047 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2595,9 +2046,9 @@
2595 2046 'default' => 1,
2596 2047 'validate_callback' => __CLASS__ . '::validate_boolean',
2597 2048 'jp_group' => 'subscriptions',
2598 2049 ),
2599 - 'stc_enabled' => array(
2050 + 'stc_enabled' => array(
2600 2051 'description' => esc_html__( "Show a <em>'follow comments'</em> option in the comment form", 'jetpack' ),
2601 2052 'type' => 'boolean',
2602 2053 'default' => 1,
2603 2054 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2602,9 +2053,79 @@
2602 2053 'default' => 1,
2603 2054 'validate_callback' => __CLASS__ . '::validate_boolean',
2604 2055 'jp_group' => 'subscriptions',
2605 2056 ),
2606 - 'sm_enabled' => array(
2057 + 'wpcom_newsletter_categories' => array(
2058 + 'description' => esc_html__( 'Array of post category ids that are marked as newsletter categories', 'jetpack' ),
2059 + 'type' => 'array',
2060 + 'default' => array(),
2061 + 'validate_callback' => __CLASS__ . '::validate_array',
2062 + 'jp_group' => 'subscriptions',
2063 + ),
2064 + 'wpcom_newsletter_categories_enabled' => array(
2065 + 'description' => esc_html__( 'Whether the newsletter categories are enabled or not', 'jetpack' ),
2066 + 'type' => 'boolean',
2067 + 'default' => 0,
2068 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2069 + 'jp_group' => 'subscriptions',
2070 + ),
2071 + 'wpcom_newsletter_send_default' => array(
2072 + 'description' => esc_html__( 'Whether to send newsletter emails by default when publishing a post', 'jetpack' ),
2073 + 'type' => 'boolean',
2074 + 'default' => 1,
2075 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2076 + 'jp_group' => 'subscriptions',
2077 + ),
2078 + 'wpcom_featured_image_in_email' => array(
2079 + 'description' => esc_html__( 'Whether to include the featured image in the email or not', 'jetpack' ),
2080 + 'type' => 'boolean',
2081 + 'default' => 0,
2082 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2083 + 'jp_group' => 'subscriptions',
2084 + ),
2085 + 'jetpack_gravatar_in_email' => array(
2086 + 'description' => esc_html__( 'Whether to show author avatar in the email byline', 'jetpack' ),
2087 + 'type' => 'boolean',
2088 + 'default' => 1,
2089 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2090 + 'jp_group' => 'subscriptions',
2091 + ),
2092 + 'jetpack_author_in_email' => array(
2093 + 'description' => esc_html__( 'Whether to show author display name in the email byline', 'jetpack' ),
2094 + 'type' => 'boolean',
2095 + 'default' => 1,
2096 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2097 + 'jp_group' => 'subscriptions',
2098 + ),
2099 + 'jetpack_post_date_in_email' => array(
2100 + 'description' => esc_html__( 'Whether to show date in the email byline', 'jetpack' ),
2101 + 'type' => 'boolean',
2102 + 'default' => 1,
2103 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2104 + 'jp_group' => 'subscriptions',
2105 + ),
2106 + 'wpcom_subscription_emails_use_excerpt' => array(
2107 + 'description' => esc_html__( 'Whether to use the excerpt in the email or not', 'jetpack' ),
2108 + 'type' => 'boolean',
2109 + 'default' => 0,
2110 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2111 + 'jp_group' => 'subscriptions',
2112 + ),
2113 + 'jetpack_subscriptions_reply_to' => array(
2114 + 'description' => esc_html__( 'Reply to email behaviour for newsletters emails', 'jetpack' ),
2115 + 'type' => 'string',
2116 + 'default' => Automattic\Jetpack\Modules\Subscriptions\Settings::$default_reply_to,
2117 + 'validate_callback' => __CLASS__ . '::validate_subscriptions_reply_to',
2118 + 'jp_group' => 'subscriptions',
2119 + ),
2120 + 'jetpack_subscriptions_from_name' => array(
2121 + 'description' => esc_html__( 'From name for newsletters emails', 'jetpack' ),
2122 + 'type' => 'string',
2123 + 'default' => '',
2124 + 'validate_callback' => __CLASS__ . '::validate_subscriptions_reply_to_name',
2125 + 'jp_group' => 'subscriptions',
2126 + ),
2127 + 'sm_enabled' => array(
2607 2128 'description' => esc_html__( 'Show popup Subscribe modal to readers.', 'jetpack' ),
2608 2129 'type' => 'boolean',
2609 2130 'default' => 0,
2610 2131 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2609,18 +2130,67 @@
2609 2130 'default' => 0,
2610 2131 'validate_callback' => __CLASS__ . '::validate_boolean',
2611 2132 'jp_group' => 'subscriptions',
2612 2133 ),
2613 - 'social_notifications_subscribe' => array(
2614 - 'description' => esc_html__( 'Send email notification when someone follows my blog', 'jetpack' ),
2134 + 'jetpack_subscribe_overlay_enabled' => array(
2135 + 'description' => esc_html__( 'Show subscribe overlay on homepage.', 'jetpack' ),
2615 2136 'type' => 'boolean',
2616 2137 'default' => 0,
2617 2138 'validate_callback' => __CLASS__ . '::validate_boolean',
2618 2139 'jp_group' => 'subscriptions',
2619 2140 ),
2141 + 'jetpack_subscribe_floating_button_enabled' => array(
2142 + 'description' => esc_html__( 'Show a floating subscribe button.', 'jetpack' ),
2143 + 'type' => 'boolean',
2144 + 'default' => 0,
2145 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2146 + 'jp_group' => 'subscriptions',
2147 + ),
2148 + 'jetpack_subscriptions_subscribe_post_end_enabled' => array(
2149 + 'description' => esc_html__( 'Add Subscribe block at the end of each post.', 'jetpack' ),
2150 + 'type' => 'boolean',
2151 + 'default' => 0,
2152 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2153 + 'jp_group' => 'subscriptions',
2154 + ),
2155 + 'jetpack_subscriptions_login_navigation_enabled' => array(
2156 + 'description' => esc_html__( 'Add Subscriber Login block to the navigation.', 'jetpack' ),
2157 + 'type' => 'boolean',
2158 + 'default' => 0,
2159 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2160 + 'jp_group' => 'subscriptions',
2161 + ),
2162 + 'jetpack_subscriptions_subscribe_navigation_enabled' => array(
2163 + 'description' => esc_html__( 'Add Subscribe block to the navigation.', 'jetpack' ),
2164 + 'type' => 'boolean',
2165 + 'default' => 0,
2166 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2167 + 'jp_group' => 'subscriptions',
2168 + ),
2169 + 'social_notifications_subscribe' => array(
2170 + 'description' => esc_html__( 'Send email notification when someone subscribes to my blog', 'jetpack' ),
2171 + 'type' => 'boolean',
2172 + 'default' => 0,
2173 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2174 + 'jp_group' => 'subscriptions',
2175 + ),
2176 + 'subscription_options' => array(
2177 + 'description' => esc_html__( 'Options used in subscription email templates and the Subscribe block: \'invitation\', \'welcome\', \'comment_follow\', \'subscribe_modal_heading\', \'free_tier_description\' and \'hide_free_tier\'.', 'jetpack' ),
2178 + 'type' => 'object',
2179 + 'default' => array(
2180 + 'invitation' => '',
2181 + 'welcome' => '',
2182 + 'comment_follow' => '',
2183 + 'subscribe_modal_heading' => '',
2184 + 'free_tier_description' => '',
2185 + 'hide_free_tier' => false,
2186 + ),
2187 + 'validate_callback' => __CLASS__ . '::validate_subscription_options',
2188 + 'jp_group' => 'subscriptions',
2189 + ),
2620 2190
2621 2191 // Related Posts.
2622 - 'show_headline' => array(
2192 + 'show_headline' => array(
2623 2193 'description' => esc_html__( 'Highlight related content with a heading', 'jetpack' ),
2624 2194 'type' => 'boolean',
2625 2195 'default' => 1,
2626 2196 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2625,9 +2195,9 @@
2625 2195 'default' => 1,
2626 2196 'validate_callback' => __CLASS__ . '::validate_boolean',
2627 2197 'jp_group' => 'related-posts',
2628 2198 ),
2629 - 'show_thumbnails' => array(
2199 + 'show_thumbnails' => array(
2630 2200 'description' => esc_html__( 'Show a thumbnail image where available', 'jetpack' ),
2631 2201 'type' => 'boolean',
2632 2202 'default' => 0,
2633 2203 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2634,9 +2204,9 @@
2634 2204 'jp_group' => 'related-posts',
2635 2205 ),
2636 2206
2637 2207 // Search.
2638 - 'instant_search_enabled' => array(
2208 + 'instant_search_enabled' => array(
2639 2209 'description' => esc_html__( 'Enable Instant Search', 'jetpack' ),
2640 2210 'type' => 'boolean',
2641 2211 'default' => 0,
2642 2212 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2642,9 +2212,9 @@
2642 2212 'validate_callback' => __CLASS__ . '::validate_boolean',
2643 2213 'jp_group' => 'search',
2644 2214 ),
2645 2215
2646 - 'has_jetpack_search_product' => array(
2216 + 'has_jetpack_search_product' => array(
2647 2217 'description' => esc_html__( 'Has an active Jetpack Search product purchase', 'jetpack' ),
2648 2218 'type' => 'boolean',
2649 2219 'default' => 0,
2650 2220 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2650,9 +2220,9 @@
2650 2220 'validate_callback' => __CLASS__ . '::validate_boolean',
2651 2221 'jp_group' => 'settings',
2652 2222 ),
2653 2223
2654 - 'search_auto_config' => array(
2224 + 'search_auto_config' => array(
2655 2225 'description' => esc_html__( 'Trigger an auto config of instant search', 'jetpack' ),
2656 2226 'type' => 'boolean',
2657 2227 'default' => 0,
2658 2228 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2659,9 +2229,9 @@
2659 2229 'jp_group' => 'search',
2660 2230 ),
2661 2231
2662 2232 // Verification Tools.
2663 - 'google' => array(
2233 + 'google' => array(
2664 2234 'description' => esc_html__( 'Google Search Console', 'jetpack' ),
2665 2235 'type' => 'string',
2666 2236 'default' => '',
2667 2237 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2666,9 +2236,9 @@
2666 2236 'default' => '',
2667 2237 'validate_callback' => __CLASS__ . '::validate_verification_service',
2668 2238 'jp_group' => 'verification-tools',
2669 2239 ),
2670 - 'bing' => array(
2240 + 'bing' => array(
2671 2241 'description' => esc_html__( 'Bing Webmaster Center', 'jetpack' ),
2672 2242 'type' => 'string',
2673 2243 'default' => '',
2674 2244 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2673,9 +2243,9 @@
2673 2243 'default' => '',
2674 2244 'validate_callback' => __CLASS__ . '::validate_verification_service',
2675 2245 'jp_group' => 'verification-tools',
2676 2246 ),
2677 - 'pinterest' => array(
2247 + 'pinterest' => array(
2678 2248 'description' => esc_html__( 'Pinterest Site Verification', 'jetpack' ),
2679 2249 'type' => 'string',
2680 2250 'default' => '',
2681 2251 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2680,9 +2250,9 @@
2680 2250 'default' => '',
2681 2251 'validate_callback' => __CLASS__ . '::validate_verification_service',
2682 2252 'jp_group' => 'verification-tools',
2683 2253 ),
2684 - 'yandex' => array(
2254 + 'yandex' => array(
2685 2255 'description' => esc_html__( 'Yandex Site Verification', 'jetpack' ),
2686 2256 'type' => 'string',
2687 2257 'default' => '',
2688 2258 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2687,9 +2257,9 @@
2687 2257 'default' => '',
2688 2258 'validate_callback' => __CLASS__ . '::validate_verification_service',
2689 2259 'jp_group' => 'verification-tools',
2690 2260 ),
2691 - 'facebook' => array(
2261 + 'facebook' => array(
2692 2262 'description' => esc_html__( 'Facebook Domain Verification', 'jetpack' ),
2693 2263 'type' => 'string',
2694 2264 'default' => '',
2695 2265 'validate_callback' => __CLASS__ . '::validate_verification_service',
@@ -2696,9 +2266,9 @@
2696 2266 'jp_group' => 'verification-tools',
2697 2267 ),
2698 2268
2699 2269 // WordAds.
2700 - 'enable_header_ad' => array(
2270 + 'enable_header_ad' => array(
2701 2271 'description' => esc_html__( 'Display an ad unit at the top of each page.', 'jetpack' ),
2702 2272 'type' => 'boolean',
2703 2273 'default' => 1,
2704 2274 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2703,9 +2273,9 @@
2703 2273 'default' => 1,
2704 2274 'validate_callback' => __CLASS__ . '::validate_boolean',
2705 2275 'jp_group' => 'wordads',
2706 2276 ),
2707 - 'wordads_approved' => array(
2277 + 'wordads_approved' => array(
2708 2278 'description' => esc_html__( 'Is site approved for WordAds?', 'jetpack' ),
2709 2279 'type' => 'boolean',
2710 2280 'default' => 0,
2711 2281 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2710,9 +2280,9 @@
2710 2280 'default' => 0,
2711 2281 'validate_callback' => __CLASS__ . '::validate_boolean',
2712 2282 'jp_group' => 'wordads',
2713 2283 ),
2714 - 'wordads_second_belowpost' => array(
2284 + 'wordads_second_belowpost' => array(
2715 2285 'description' => esc_html__( 'Display second ad below post?', 'jetpack' ),
2716 2286 'type' => 'boolean',
2717 2287 'default' => 1,
2718 2288 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2717,9 +2287,16 @@
2717 2287 'default' => 1,
2718 2288 'validate_callback' => __CLASS__ . '::validate_boolean',
2719 2289 'jp_group' => 'wordads',
2720 2290 ),
2721 - 'wordads_display_front_page' => array(
2291 + 'wordads_inline_enabled' => array(
2292 + 'description' => esc_html__( 'Display inline ad within post content?', 'jetpack' ),
2293 + 'type' => 'boolean',
2294 + 'default' => 1,
2295 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2296 + 'jp_group' => 'wordads',
2297 + ),
2298 + 'wordads_display_front_page' => array(
2722 2299 'description' => esc_html__( 'Display ads on the front page?', 'jetpack' ),
2723 2300 'type' => 'boolean',
2724 2301 'default' => 1,
2725 2302 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2724,9 +2301,9 @@
2724 2301 'default' => 1,
2725 2302 'validate_callback' => __CLASS__ . '::validate_boolean',
2726 2303 'jp_group' => 'wordads',
2727 2304 ),
2728 - 'wordads_display_post' => array(
2305 + 'wordads_display_post' => array(
2729 2306 'description' => esc_html__( 'Display ads on posts?', 'jetpack' ),
2730 2307 'type' => 'boolean',
2731 2308 'default' => 1,
2732 2309 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2731,9 +2308,9 @@
2731 2308 'default' => 1,
2732 2309 'validate_callback' => __CLASS__ . '::validate_boolean',
2733 2310 'jp_group' => 'wordads',
2734 2311 ),
2735 - 'wordads_display_page' => array(
2312 + 'wordads_display_page' => array(
2736 2313 'description' => esc_html__( 'Display ads on pages?', 'jetpack' ),
2737 2314 'type' => 'boolean',
2738 2315 'default' => 1,
2739 2316 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2738,9 +2315,9 @@
2738 2315 'default' => 1,
2739 2316 'validate_callback' => __CLASS__ . '::validate_boolean',
2740 2317 'jp_group' => 'wordads',
2741 2318 ),
2742 - 'wordads_display_archive' => array(
2319 + 'wordads_display_archive' => array(
2743 2320 'description' => esc_html__( 'Display ads on archive pages?', 'jetpack' ),
2744 2321 'type' => 'boolean',
2745 2322 'default' => 1,
2746 2323 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2745,9 +2322,9 @@
2745 2322 'default' => 1,
2746 2323 'validate_callback' => __CLASS__ . '::validate_boolean',
2747 2324 'jp_group' => 'wordads',
2748 2325 ),
2749 - 'wordads_custom_adstxt_enabled' => array(
2326 + 'wordads_custom_adstxt_enabled' => array(
2750 2327 'description' => esc_html__( 'Custom ads.txt', 'jetpack' ),
2751 2328 'type' => 'boolean',
2752 2329 'default' => 0,
2753 2330 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2752,9 +2329,9 @@
2752 2329 'default' => 0,
2753 2330 'validate_callback' => __CLASS__ . '::validate_boolean',
2754 2331 'jp_group' => 'wordads',
2755 2332 ),
2756 - 'wordads_custom_adstxt' => array(
2333 + 'wordads_custom_adstxt' => array(
2757 2334 'description' => esc_html__( 'Custom ads.txt entries', 'jetpack' ),
2758 2335 'type' => 'string',
2759 2336 'default' => '',
2760 2337 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2760,9 +2337,9 @@
2760 2337 'validate_callback' => __CLASS__ . '::validate_string',
2761 2338 'sanitize_callback' => 'sanitize_textarea_field',
2762 2339 'jp_group' => 'wordads',
2763 2340 ),
2764 - 'wordads_ccpa_enabled' => array(
2341 + 'wordads_ccpa_enabled' => array(
2765 2342 'description' => esc_html__( 'Enable support for California Consumer Privacy Act', 'jetpack' ),
2766 2343 'type' => 'boolean',
2767 2344 'default' => 0,
2768 2345 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2767,9 +2344,9 @@
2767 2344 'default' => 0,
2768 2345 'validate_callback' => __CLASS__ . '::validate_boolean',
2769 2346 'jp_group' => 'wordads',
2770 2347 ),
2771 - 'wordads_ccpa_privacy_policy_url' => array(
2348 + 'wordads_ccpa_privacy_policy_url' => array(
2772 2349 'description' => esc_html__( 'Privacy Policy URL', 'jetpack' ),
2773 2350 'type' => 'string',
2774 2351 'default' => '',
2775 2352 'validate_callback' => __CLASS__ . '::validate_string',
@@ -2775,11 +2352,18 @@
2775 2352 'validate_callback' => __CLASS__ . '::validate_string',
2776 2353 'sanitize_callback' => 'sanitize_text_field',
2777 2354 'jp_group' => 'wordads',
2778 2355 ),
2356 + 'wordads_cmp_enabled' => array(
2357 + 'description' => esc_html__( 'Enable GDPR Consent Management Banner for WordAds', 'jetpack' ),
2358 + 'type' => 'boolean',
2359 + 'default' => 0,
2360 + 'validate_callback' => __CLASS__ . '::validate_boolean',
2361 + 'jp_group' => 'wordads',
2362 + ),
2779 2363
2780 2364 // Google Analytics.
2781 - 'google_analytics_tracking_id' => array(
2365 + 'google_analytics_tracking_id' => array(
2782 2366 'description' => esc_html__( 'Google Analytics', 'jetpack' ),
2783 2367 'type' => 'string',
2784 2368 'default' => '',
2785 2369 'validate_callback' => __CLASS__ . '::validate_alphanum',
@@ -2784,11 +2368,16 @@
2784 2368 'default' => '',
2785 2369 'validate_callback' => __CLASS__ . '::validate_alphanum',
2786 2370 'jp_group' => 'google-analytics',
2787 2371 ),
2372 + 'jetpack_wga' => array(
2373 + 'description' => esc_html__( 'Google Analytics', 'jetpack' ),
2374 + 'type' => 'object',
2375 + 'jp_group' => 'settings',
2376 + ),
2788 2377
2789 2378 // Stats.
2790 - 'admin_bar' => array(
2379 + 'admin_bar' => array(
2791 2380 'description' => esc_html__( 'Include a small chart in your admin bar with a 48-hour traffic snapshot.', 'jetpack' ),
2792 2381 'type' => 'boolean',
2793 2382 'default' => 1,
2794 2383 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2793,9 +2382,9 @@
2793 2382 'default' => 1,
2794 2383 'validate_callback' => __CLASS__ . '::validate_boolean',
2795 2384 'jp_group' => 'stats',
2796 2385 ),
2797 - 'enable_odyssey_stats' => array(
2386 + 'enable_odyssey_stats' => array(
2798 2387 'description' => esc_html__( 'Preview the new Jetpack Stats experience (Experimental).', 'jetpack' ),
2799 2388 'type' => 'boolean',
2800 2389 'default' => 1,
2801 2390 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2800,9 +2389,9 @@
2800 2389 'default' => 1,
2801 2390 'validate_callback' => __CLASS__ . '::validate_boolean',
2802 2391 'jp_group' => 'stats',
2803 2392 ),
2804 - 'roles' => array(
2393 + 'roles' => array(
2805 2394 'description' => esc_html__( 'Select the roles that will be able to view stats reports.', 'jetpack' ),
2806 2395 'type' => 'array',
2807 2396 'items' => array(
2808 2397 'type' => 'string',
@@ -2811,9 +2400,9 @@
2811 2400 'validate_callback' => __CLASS__ . '::validate_stats_roles',
2812 2401 'sanitize_callback' => __CLASS__ . '::sanitize_stats_allowed_roles',
2813 2402 'jp_group' => 'stats',
2814 2403 ),
2815 - 'count_roles' => array(
2404 + 'count_roles' => array(
2816 2405 'description' => esc_html__( 'Count the page views of registered users who are logged in.', 'jetpack' ),
2817 2406 'type' => 'array',
2818 2407 'items' => array(
2819 2408 'type' => 'string',
@@ -2821,9 +2410,9 @@
2821 2410 'default' => array( 'administrator' ),
2822 2411 'validate_callback' => __CLASS__ . '::validate_stats_roles',
2823 2412 'jp_group' => 'stats',
2824 2413 ),
2825 - 'blog_id' => array(
2414 + 'blog_id' => array(
2826 2415 'description' => esc_html__( 'Blog ID.', 'jetpack' ),
2827 2416 'type' => 'boolean',
2828 2417 'default' => 0,
2829 2418 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2828,9 +2417,9 @@
2828 2417 'default' => 0,
2829 2418 'validate_callback' => __CLASS__ . '::validate_boolean',
2830 2419 'jp_group' => 'stats',
2831 2420 ),
2832 - 'do_not_track' => array(
2421 + 'do_not_track' => array(
2833 2422 'description' => esc_html__( 'Do not track.', 'jetpack' ),
2834 2423 'type' => 'boolean',
2835 2424 'default' => 1,
2836 2425 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2835,9 +2424,9 @@
2835 2424 'default' => 1,
2836 2425 'validate_callback' => __CLASS__ . '::validate_boolean',
2837 2426 'jp_group' => 'stats',
2838 2427 ),
2839 - 'version' => array(
2428 + 'version' => array(
2840 2429 'description' => esc_html__( 'Version.', 'jetpack' ),
2841 2430 'type' => 'integer',
2842 2431 'default' => 9,
2843 2432 'validate_callback' => __CLASS__ . '::validate_posint',
@@ -2842,9 +2431,9 @@
2842 2431 'default' => 9,
2843 2432 'validate_callback' => __CLASS__ . '::validate_posint',
2844 2433 'jp_group' => 'stats',
2845 2434 ),
2846 - 'collapse_nudges' => array(
2435 + 'collapse_nudges' => array(
2847 2436 'description' => esc_html__( 'Collapse upgrade nudges', 'jetpack' ),
2848 2437 'type' => 'boolean',
2849 2438 'default' => 0,
2850 2439 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2851,9 +2440,9 @@
2851 2440 'jp_group' => 'stats',
2852 2441 ),
2853 2442
2854 2443 // Whether to share stats views with WordPress.com Reader.
2855 - 'wpcom_reader_views_enabled' => array(
2444 + 'wpcom_reader_views_enabled' => array(
2856 2445 'description' => esc_html__( 'Show post views in the WordPress.com Reader.', 'jetpack' ),
2857 2446 'type' => 'boolean',
2858 2447 'default' => 1,
2859 2448 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2860,9 +2449,9 @@
2860 2449 'jp_group' => 'settings',
2861 2450 ),
2862 2451
2863 2452 // Akismet - Not a module, but a plugin. The options can be passed and handled differently.
2864 - 'akismet_show_user_comments_approved' => array(
2453 + 'akismet_show_user_comments_approved' => array(
2865 2454 'description' => '',
2866 2455 'type' => 'boolean',
2867 2456 'default' => 0,
2868 2457 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2868,9 +2457,9 @@
2868 2457 'validate_callback' => __CLASS__ . '::validate_boolean',
2869 2458 'jp_group' => 'settings',
2870 2459 ),
2871 2460
2872 - 'wordpress_api_key' => array(
2461 + 'wordpress_api_key' => array(
2873 2462 'description' => '',
2874 2463 'type' => 'string',
2875 2464 'default' => '',
2876 2465 'validate_callback' => __CLASS__ . '::validate_alphanum',
@@ -2877,9 +2466,9 @@
2877 2466 'jp_group' => 'settings',
2878 2467 ),
2879 2468
2880 2469 // Empty stats card dismiss.
2881 - 'dismiss_empty_stats_card' => array(
2470 + 'dismiss_empty_stats_card' => array(
2882 2471 'description' => '',
2883 2472 'type' => 'boolean',
2884 2473 'default' => 0,
2885 2474 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2886,9 +2475,9 @@
2886 2475 'jp_group' => 'settings',
2887 2476 ),
2888 2477
2889 2478 // Backup Getting Started card on dashboard.
2890 - 'dismiss_dash_backup_getting_started' => array(
2479 + 'dismiss_dash_backup_getting_started' => array(
2891 2480 'description' => '',
2892 2481 'type' => 'boolean',
2893 2482 'default' => 0,
2894 2483 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2895,9 +2484,9 @@
2895 2484 'jp_group' => 'settings',
2896 2485 ),
2897 2486
2898 2487 // Agencies Learn More card on dashboard.
2899 - 'dismiss_dash_agencies_learn_more' => array(
2488 + 'dismiss_dash_agencies_learn_more' => array(
2900 2489 'description' => '',
2901 2490 'type' => 'boolean',
2902 2491 'default' => 0,
2903 2492 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2903,9 +2492,9 @@
2903 2492 'validate_callback' => __CLASS__ . '::validate_boolean',
2904 2493 'jp_group' => 'settings',
2905 2494 ),
2906 2495
2907 - 'lang_id' => array(
2496 + 'lang_id' => array(
2908 2497 'description' => esc_html__( 'Primary language for the site.', 'jetpack' ),
2909 2498 'type' => 'string',
2910 2499 'default' => 'en_US',
2911 2500 'jp_group' => 'settings',
@@ -2910,32 +2499,10 @@
2910 2499 'default' => 'en_US',
2911 2500 'jp_group' => 'settings',
2912 2501 ),
2913 2502
2914 - 'onboarding' => array(
2915 - 'description' => '',
2916 - 'type' => 'object',
2917 - 'default' => array(
2918 - 'siteTitle' => '',
2919 - 'siteDescription' => '',
2920 - 'siteType' => 'personal',
2921 - 'homepageFormat' => 'posts',
2922 - 'addContactForm' => 0,
2923 - 'businessAddress' => array(
2924 - 'name' => '',
2925 - 'street' => '',
2926 - 'city' => '',
2927 - 'state' => '',
2928 - 'zip' => '',
2929 - ),
2930 - 'installWooCommerce' => false,
2931 - ),
2932 - 'validate_callback' => __CLASS__ . '::validate_onboarding',
2933 - 'jp_group' => 'settings',
2934 - ),
2935 -
2936 2503 // SEO Tools.
2937 - 'advanced_seo_front_page_description' => array(
2504 + 'advanced_seo_front_page_description' => array(
2938 2505 'description' => esc_html__( 'Front page meta description.', 'jetpack' ),
2939 2506 'type' => 'string',
2940 2507 'default' => '',
2941 2508 'sanitize_callback' => 'Jetpack_SEO_Utils::sanitize_front_page_meta_description',
@@ -2941,9 +2508,9 @@
2941 2508 'sanitize_callback' => 'Jetpack_SEO_Utils::sanitize_front_page_meta_description',
2942 2509 'jp_group' => 'seo-tools',
2943 2510 ),
2944 2511
2945 - 'advanced_seo_title_formats' => array(
2512 + 'advanced_seo_title_formats' => array(
2946 2513 'description' => esc_html__( 'SEO page title structures.', 'jetpack' ),
2947 2514 'type' => 'object',
2948 2515 'default' => array(
2949 2516 'archives' => array(),
@@ -2956,10 +2523,34 @@
2956 2523 'validate_callback' => 'Jetpack_SEO_Titles::are_valid_title_formats',
2957 2524 'sanitize_callback' => 'Jetpack_SEO_Titles::sanitize_title_formats',
2958 2525 ),
2959 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 +
2960 2551 // VideoPress.
2961 - 'videopress_private_enabled_for_site' => array(
2552 + 'videopress_private_enabled_for_site' => array(
2962 2553 'description' => esc_html__( 'Video Privacy: Restrict views to members of this site', 'jetpack' ),
2963 2554 'type' => 'boolean',
2964 2555 'default' => 0,
2965 2556 'validate_callback' => __CLASS__ . '::validate_boolean',
@@ -2966,8 +2557,21 @@
2966 2557 'jp_group' => 'videopress',
2967 2558 ),
2968 2559 );
2969 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 +
2970 2574 // Add modules to list so they can be toggled.
2971 2575 $modules = Jetpack::get_available_modules();
2972 2576 if ( is_array( $modules ) && ! empty( $modules ) ) {
2973 2577 $module_args = array(
@@ -3013,8 +2617,10 @@
3013 2617 * Validates that the parameters are proper values that can be set during Jetpack onboarding.
3014 2618 *
3015 2619 * @since 5.4.0
3016 2620 *
2621 + * @deprecated since 13.9
2622 + *
3017 2623 * @param array $onboarding_data Values to check.
3018 2624 * @param WP_REST_Request $request The request sent to the WP REST API.
3019 2625 * @param string $param Name of the parameter passed to endpoint holding $value.
3020 2626 *
@@ -3019,24 +2625,10 @@
3019 2625 * @param string $param Name of the parameter passed to endpoint holding $value.
3020 2626 *
3021 2627 * @return bool|WP_Error
3022 2628 */
3023 - public static function validate_onboarding( $onboarding_data, $request, $param ) {
3024 - if ( ! is_array( $onboarding_data ) ) {
3025 - return new WP_Error( 'invalid_param', esc_html__( 'Not valid onboarding data.', 'jetpack' ) );
3026 - }
3027 - foreach ( $onboarding_data as $value ) {
3028 - if ( is_string( $value ) ) {
3029 - $onboarding_choice = self::validate_string( $value, $request, $param );
3030 - } elseif ( is_array( $value ) ) {
3031 - $onboarding_choice = self::validate_onboarding( $value, $request, $param );
3032 - } else {
3033 - $onboarding_choice = self::validate_boolean( $value, $request, $param );
3034 - }
3035 - if ( is_wp_error( $onboarding_choice ) ) {
3036 - return $onboarding_choice;
3037 - }
3038 - }
2629 + public static function validate_onboarding( $onboarding_data, $request, $param ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
2630 + _deprecated_function( __METHOD__, '13.9' );
3039 2631 return true;
3040 2632 }
3041 2633
3042 2634 /**
@@ -3232,14 +2824,14 @@
3232 2824 *
3233 2825 * @return bool|WP_Error
3234 2826 */
3235 2827 public static function validate_verification_service( $value, $request, $param ) {
3236 - 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 ) ) ) {
3237 2829 return new WP_Error(
3238 2830 'invalid_param',
3239 2831 sprintf(
3240 2832 /* Translators: Placeholder is a verification string used to verify a service like Google Webmaster Console. */
3241 - 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' ),
3242 2834 $param
3243 2835 )
3244 2836 );
3245 2837 }
@@ -3250,9 +2842,9 @@
3250 2842 * Validates that the parameter is among the roles allowed for Stats.
3251 2843 *
3252 2844 * @since 4.3.0
3253 2845 *
3254 - * @param string|bool $value Value to check.
2846 + * @param mixed $value Value to check.
3255 2847 * @param WP_REST_Request $request The request sent to the WP REST API.
3256 2848 * @param string $param Name of the parameter passed to endpoint holding $value.
3257 2849 *
3258 2850 * @return bool|WP_Error
@@ -3257,16 +2849,37 @@
3257 2849 *
3258 2850 * @return bool|WP_Error
3259 2851 */
3260 2852 public static function validate_stats_roles( $value, $request, $param ) {
3261 - 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 ) ) {
3262 2860 return new WP_Error(
3263 2861 'invalid_param',
3264 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(
3265 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. */
3266 2879 esc_html__( '%1$s must be %2$s.', 'jetpack' ),
3267 2880 $param,
3268 - implode( ', ', self::$stats_roles )
2881 + implode( ', ', $editable_roles )
3269 2882 )
3270 2883 );
3271 2884 }
3272 2885 return true;
@@ -3309,8 +2922,59 @@
3309 2922 return true;
3310 2923 }
3311 2924
3312 2925 /**
2926 + * Validates that the parameter is among the valid reply-to types for subscriptions.
2927 + *
2928 + * @since 4.3.0
2929 + *
2930 + * @param string|bool $value Value to check.
2931 + * @param WP_REST_Request $request The request sent to the WP REST API.
2932 + * @param string $param Name of the parameter passed to endpoint holding $value.
2933 + *
2934 + * @return bool|WP_Error
2935 + */
2936 + public static function validate_subscriptions_reply_to( $value, $request, $param ) {
2937 + require_once JETPACK__PLUGIN_DIR . 'modules/subscriptions/class-settings.php';
2938 + if ( ! empty( $value ) && ! Automattic\Jetpack\Modules\Subscriptions\Settings::is_valid_reply_to( $value ) ) {
2939 + return new WP_Error(
2940 + 'invalid_param',
2941 + sprintf(
2942 + /* Translators: Placeholder is a parameter name. */
2943 + esc_html__( '%s must be a valid type.', 'jetpack' ),
2944 + $param
2945 + )
2946 + );
2947 + }
2948 + return true;
2949 + }
2950 +
2951 + /**
2952 + * Validates that the parameter is among the valid reply-to types for subscriptions.
2953 + *
2954 + * @since 4.3.0
2955 + *
2956 + * @param string|bool $value Value to check.
2957 + * @param WP_REST_Request $request The request sent to the WP REST API.
2958 + * @param string $param Name of the parameter passed to endpoint holding $value.
2959 + *
2960 + * @return bool|WP_Error
2961 + */
2962 + public static function validate_subscriptions_reply_to_name( $value, $request, $param ) {
2963 + if ( ! empty( $value ) && ! is_string( $value ) ) {
2964 + return new WP_Error(
2965 + 'invalid_param',
2966 + sprintf(
2967 + /* Translators: Placeholder is a parameter name. */
2968 + esc_html__( '%s must be a valid type.', 'jetpack' ),
2969 + $param
2970 + )
2971 + );
2972 + }
2973 + return true;
2974 + }
2975 +
2976 + /**
3313 2977 * Validates that the parameter is among the views where the Sharing can be displayed.
3314 2978 *
3315 2979 * @since 4.3.0
3316 2980 *
@@ -3525,16 +3189,72 @@
3525 3189 return true;
3526 3190 }
3527 3191
3528 3192 /**
3193 + * Validates the subscription_options parameter.
3194 + *
3195 + * @param array $values Value to check.
3196 + *
3197 + * @return bool|WP_Error
3198 + */
3199 + public static function validate_subscription_options( $values ) {
3200 + // A REST "object" decodes to a PHP associative array. Reject any other
3201 + // type (object, string, int, null, ...) up front so the array_keys()
3202 + // loop below never runs against a non-array and triggers a PHP warning.
3203 + if ( ! is_array( $values ) ) {
3204 + return new WP_Error(
3205 + 'invalid_param',
3206 + /* Translators: subscription_options is a variable name, and shouldn't be translated. */
3207 + esc_html__( 'subscription_options must be an object.', 'jetpack' )
3208 + );
3209 + }
3210 + foreach ( array_keys( $values ) as $key ) {
3211 + if ( ! in_array( $key, array( 'welcome', 'invitation', 'comment_follow', 'subscribe_modal_heading', 'free_tier_description', 'hide_free_tier' ), true ) ) {
3212 + return new WP_Error(
3213 + 'invalid_param',
3214 + sprintf(
3215 + /* Translators: Placeholder is the invalid param being sent. */
3216 + esc_html__( '%s is not one of the allowed members of subscription_options.', 'jetpack' ),
3217 + $key
3218 + )
3219 + );
3220 + }
3221 + }
3222 + return true;
3223 + }
3224 +
3225 + /**
3226 + * Validates that the parameter is an array.
3227 + *
3228 + * @param array $values Value to check.
3229 + * @param WP_REST_Request $request The request sent to the WP REST API.
3230 + * @param string $param Name of the parameter passed to the endpoint holding $value.
3231 + *
3232 + * @return bool|WP_Error
3233 + */
3234 + public static function validate_array( $values, $request, $param ) {
3235 + if ( ! is_array( $values ) ) {
3236 + return new WP_Error(
3237 + 'invalid_param',
3238 + sprintf(
3239 + /* Translators: Placeholder is a parameter name. */
3240 + esc_html__( '%s must be an object.', 'jetpack' ),
3241 + $param
3242 + )
3243 + );
3244 + }
3245 + return true;
3246 + }
3247 +
3248 + /**
3529 3249 * If for some reason the roles allowed to see Stats are empty (for example, user tampering with checkboxes),
3530 3250 * return an array with only 'administrator' as the allowed role and save it for 'roles' option.
3531 3251 *
3532 3252 * @since 4.3.0
3533 3253 *
3534 - * @param string|bool $value Value to check.
3254 + * @param mixed $value Value to check.
3535 3255 *
3536 - * @return bool|array
3256 + * @return mixed The value as submitted, or an array holding only 'administrator' when it is empty.
3537 3257 */
3538 3258 public static function sanitize_stats_allowed_roles( $value ) {
3539 3259 if ( empty( $value ) ) {
3540 3260 return array( 'administrator' );
@@ -3542,8 +3262,31 @@
3542 3262 return $value;
3543 3263 }
3544 3264
3545 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 + /**
3546 3289 * Get the currently accessed route and return the module slug in it.
3547 3290 *
3548 3291 * @since 4.3.0
3549 3292 *
@@ -3552,9 +3295,9 @@
3552 3295 * @return array|string
3553 3296 */
3554 3297 public static function get_module_requested( $route = '/module/(?P<slug>[a-z\-]+)' ) {
3555 3298
3556 - 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'] ) ) {
3557 3300 return '';
3558 3301 }
3559 3302
3560 3303 preg_match( "#$route#", $GLOBALS['wp']->query_vars['rest_route'], $module );
@@ -3605,8 +3348,40 @@
3605 3348 return $modules;
3606 3349 }
3607 3350
3608 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 + /**
3609 3384 * Remove 'validate_callback' item from options available for module.
3610 3385 * Fetch current option value and add to array of module options.
3611 3386 * Prepare values of module options that need special handling, like those saved in wpcom.
3612 3387 *
@@ -3669,9 +3444,9 @@
3669 3444 $options = self::split_options( $options, $sharer->get_global_options() );
3670 3445 $options['sharing_services']['current_value'] = $sharer->get_blog_services();
3671 3446 $other_sharedaddy_options = array( 'jetpack-twitter-cards-site-tag', 'sharedaddy_disable_resources', 'sharing_delete_service' );
3672 3447 foreach ( $other_sharedaddy_options as $key ) {
3673 - $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
3448 + $default_value = $options[ $key ]['default'] ?? '';
3674 3449 $current_value = get_option( $key, $default_value );
3675 3450 $options[ $key ]['current_value'] = self::cast_value( $current_value, $options[ $key ] );
3676 3451 }
3677 3452 break;
@@ -3682,9 +3457,9 @@
3682 3457 break;
3683 3458 default:
3684 3459 // These option are just stored as plain WordPress options.
3685 3460 foreach ( $options as $key => $value ) {
3686 - $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
3461 + $default_value = $options[ $key ]['default'] ?? '';
3687 3462 $current_value = get_option( $key, $default_value );
3688 3463 $options[ $key ]['current_value'] = self::cast_value( $current_value, $options[ $key ] );
3689 3464 }
3690 3465 }
@@ -3694,14 +3469,17 @@
3694 3469 // We don't need validate_callback in the response.
3695 3470 if ( isset( $options[ $key ]['validate_callback'] ) ) {
3696 3471 unset( $options[ $key ]['validate_callback'] );
3697 3472 }
3698 - $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
3473 + $default_value = $options[ $key ]['default'] ?? '';
3699 3474 if ( ! array_key_exists( 'current_value', $options[ $key ] ) ) {
3700 3475 $options[ $key ]['current_value'] = self::cast_value( $default_value, $options[ $key ] );
3701 3476 }
3702 3477 }
3703 - 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 );
3704 3482 }
3705 3483
3706 3484 /**
3707 3485 * Splits module options saved as arrays like relatedposts or verification_services_codes into separate options to be returned in the response.
@@ -4206,60 +3984,52 @@
4206 3984 return rest_ensure_response( array( 'success' => $updated_option ) );
4207 3985 }
4208 3986
4209 3987 /**
4210 - * Fetch introdution offers.
3988 + * Return the list of available features.
4211 3989 *
4212 - * @since 10.9
4213 - *
4214 - * @return array|WP_Error
3990 + * @return array
4215 3991 */
4216 - public static function get_intro_offers() {
4217 - $site_id = Jetpack_Options::get_option( 'id' );
4218 -
4219 - if ( ! $site_id ) {
4220 - return new WP_Error(
4221 - 'site_id_missing',
4222 - esc_html__( 'Site ID is missing.', 'jetpack' ),
4223 - array( 'status' => 400 )
4224 - );
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 );
4225 3997 }
4226 3998
4227 - $response = Client::wpcom_json_api_request_as_user(
4228 - '/introductory-offers',
4229 - '2',
4230 - array(
4231 - 'method' => 'GET',
4232 - 'headers' => array(
4233 - 'X-Forwarded-For' => ( new Visitor() )->get_ip( true ),
4234 - ),
4235 - )
4236 - );
3999 + return $modules;
4000 + }
4237 4001
4238 - $response_code = wp_remote_retrieve_response_code( $response );
4239 -
4240 - if ( 200 !== $response_code ) {
4241 - return new WP_Error(
4242 - 'intro_offers_fetch_failed',
4243 - esc_html__( 'Could not retrieve intro offers.', 'jetpack' ),
4244 - array( 'status' => $response_code )
4245 - );
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 );
4246 4012 }
4247 4013
4248 - $data = json_decode( wp_remote_retrieve_body( $response ) );
4014 + return $modules;
4015 + }
4249 4016
4250 - if ( ! isset( $data ) ) {
4251 - return new WP_Error(
4252 - 'intro_offers_error',
4253 - esc_html__( 'Could not parse intro offers.', 'jetpack' ),
4254 - 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'
4255 4029 );
4030 + return new WP_Error( 'invalid_permission_fetch_features', $message, array( 'status' => rest_authorization_required_code() ) );
4256 4031 }
4257 4032
4258 - return rest_ensure_response(
4259 - array(
4260 - 'code' => 'success',
4261 - 'data' => $data,
4262 - )
4263 - );
4033 + return true;
4264 4034 }
4265 4035 } // class end