← All changes | includes/class-convertkit-settings.php +250 -0 3.3.4 → 3.4.3 View file →

		@@ -424,8 +424,21 @@
424	424
425	425	}
426	426
427	427	/**
	428	+ * Returns the active spam protection provider Plugin setting.
	429	+ *
	430	+ * @since 3.3.7
	431	+ *
	432	+ * @return string none|recaptcha|turnstile
	433	+ */
	434	+ public function spam_protection_provider() {
	435	+
	436	+ return $this->settings['spam_protection_provider'];
	437	+
	438	+ }
	439	+
	440	+ /**
428	441	* Returns the reCAPTCHA Site Key Plugin setting.
429	442	*
430	443	* @since 3.0.0
431	444	*
		@@ -503,8 +516,74 @@
503	516
504	517	}
505	518
506	519	/**
	520	+ * Returns the Cloudflare Turnstile Site Key Plugin setting.
	521	+ *
	522	+ * @since 3.3.7
	523	+ *
	524	+ * @return string
	525	+ */
	526	+ public function cloudflare_turnstile_site_key() {
	527	+
	528	+ return $this->settings['cloudflare_turnstile_site_key'];
	529	+
	530	+ }
	531	+
	532	+ /**
	533	+ * Returns whether the Cloudflare Turnstile Site Key has been set in the Plugin settings.
	534	+ *
	535	+ * @since 3.3.7
	536	+ *
	537	+ * @return bool
	538	+ */
	539	+ public function has_cloudflare_turnstile_site_key() {
	540	+
	541	+ return ! empty( $this->cloudflare_turnstile_site_key() );
	542	+
	543	+ }
	544	+
	545	+ /**
	546	+ * Returns the Cloudflare Turnstile Secret Key Plugin setting.
	547	+ *
	548	+ * @since 3.3.7
	549	+ *
	550	+ * @return string
	551	+ */
	552	+ public function cloudflare_turnstile_secret_key() {
	553	+
	554	+ return $this->settings['cloudflare_turnstile_secret_key'];
	555	+
	556	+ }
	557	+
	558	+ /**
	559	+ * Returns whether the Cloudflare Turnstile Secret Key has been set in the Plugin settings.
	560	+ *
	561	+ * @since 3.3.7
	562	+ *
	563	+ * @return bool
	564	+ */
	565	+ public function has_cloudflare_turnstile_secret_key() {
	566	+
	567	+ return ! empty( $this->cloudflare_turnstile_secret_key() );
	568	+
	569	+ }
	570	+
	571	+ /**
	572	+ * Returns whether the Cloudflare Turnstile Site Key and Secret Key are defined
	573	+ * in the Plugin settings.
	574	+ *
	575	+ * @since 3.3.7
	576	+ *
	577	+ * @return bool
	578	+ */
	579	+ public function has_cloudflare_turnstile_site_and_secret_keys() {
	580	+
	581	+ return $this->has_cloudflare_turnstile_site_key() && $this->has_cloudflare_turnstile_secret_key();
	582	+
	583	+ }
	584	+
	585	+ /**
507	586	* Returns whether debugging is enabled in the Plugin settings.
508	587	*
509	588	* @since 1.9.6
510	589	*
		@@ -568,8 +647,172 @@
568	647
569	648	}
570	649
571	650	/**
	651	+ * Returns this settings group's programmatic name.
	652	+ *
	653	+ * @since 3.4.0
	654	+ *
	655	+ * @return string
	656	+ */
	657	+ public function get_name() {
	658	+
	659	+ return 'general';
	660	+
	661	+ }
	662	+
	663	+ /**
	664	+ * Returns the title of this settings group.
	665	+ *
	666	+ * @since 3.4.0
	667	+ *
	668	+ * @return string
	669	+ */
	670	+ public function get_title() {
	671	+
	672	+ return __( 'General Settings', 'convertkit' );
	673	+
	674	+ }
	675	+
	676	+ /**
	677	+ * Returns the keys in this settings group that hold credentials or other
	678	+ * sensitive values.
	679	+ *
	680	+ * @since 3.4.0
	681	+ *
	682	+ * @return string[]
	683	+ */
	684	+ public function get_secret_keys() {
	685	+
	686	+ return array(
	687	+ 'access_token',
	688	+ 'refresh_token',
	689	+ 'token_expires',
	690	+ 'api_key',
	691	+ 'api_secret',
	692	+ 'recaptcha_secret_key',
	693	+ );
	694	+
	695	+ }
	696	+
	697	+ /**
	698	+ * Returns the JSON Schema describing this settings group, in the shape
	699	+ * stored by save() / returned by get(), excluding secret keys.
	700	+ *
	701	+ * @since 3.4.0
	702	+ *
	703	+ * @return array
	704	+ */
	705	+ public function get_schema() {
	706	+
	707	+ $properties = array(
	708	+ 'non_inline_form' => array(
	709	+ 'type' => 'array',
	710	+ 'items' => array( 'type' => 'integer' ),
	711	+ 'description' => __( 'IDs of non-inline Forms to display site-wide.', 'convertkit' ),
	712	+ ),
	713	+ 'non_inline_form_honor_none_setting' => array(
	714	+ 'type' => 'string',
	715	+ 'enum' => array( '', 'on' ),
	716	+ 'description' => __( 'Whether the site-wide non-inline Form honors a per-Page / per-Post "None" Form setting.', 'convertkit' ),
	717	+ ),
	718	+ 'non_inline_form_limit_per_session' => array(
	719	+ 'type' => 'string',
	720	+ 'enum' => array( '', 'on' ),
	721	+ 'description' => __( 'Whether to limit non-inline Form display to once per session.', 'convertkit' ),
	722	+ ),
	723	+ 'recaptcha_site_key' => array(
	724	+ 'type' => 'string',
	725	+ 'description' => __( 'Google reCAPTCHA v3 site key.', 'convertkit' ),
	726	+ ),
	727	+ 'recaptcha_minimum_score' => array(
	728	+ 'type' => 'number',
	729	+ 'minimum' => 0,
	730	+ 'maximum' => 1,
	731	+ 'description' => __( 'Minimum Google reCAPTCHA v3 score (0.0 - 1.0) below which a request is treated as spam.', 'convertkit' ),
	732	+ ),
	733	+ 'debug' => array(
	734	+ 'type' => 'string',
	735	+ 'enum' => array( '', 'on' ),
	736	+ 'description' => __( 'Whether debug logging is enabled.', 'convertkit' ),
	737	+ ),
	738	+ 'no_scripts' => array(
	739	+ 'type' => 'string',
	740	+ 'enum' => array( '', 'on' ),
	741	+ 'description' => __( 'Whether the Plugin\'s frontend JavaScript is disabled.', 'convertkit' ),
	742	+ ),
	743	+ 'no_css' => array(
	744	+ 'type' => 'string',
	745	+ 'enum' => array( '', 'on' ),
	746	+ 'description' => __( 'Whether the Plugin\'s frontend CSS is disabled.', 'convertkit' ),
	747	+ ),
	748	+ 'no_add_new_button' => array(
	749	+ 'type' => 'string',
	750	+ 'enum' => array( '', 'on' ),
	751	+ 'description' => __( 'Whether the "Add New" button for Landing Pages / Member Content is hidden in the WordPress Admin.', 'convertkit' ),
	752	+ ),
	753	+ 'usage_tracking' => array(
	754	+ 'type' => 'string',
	755	+ 'enum' => array( '', 'on' ),
	756	+ 'description' => __( 'Whether anonymous usage tracking is enabled.', 'convertkit' ),
	757	+ ),
	758	+ );
	759	+
	760	+ // Per-post-type Default Form settings, mirroring get_defaults().
	761	+ foreach ( convertkit_get_supported_post_types() as $post_type ) {
	762	+ $properties[ $post_type . '_form' ] = array(
	763	+ 'type' => 'integer',
	764	+ 'minimum' => -1,
	765	+ 'description' => sprintf(
	766	+ /* translators: Post type slug. */
	767	+ __( 'Default Form ID to display on %s. `-1` = Plugin Default; `0` = None; positive integer = specific Kit Form ID.', 'convertkit' ),
	768	+ $post_type
	769	+ ),
	770	+ );
	771	+
	772	+ $properties[ $post_type . '_form_position' ] = array(
	773	+ 'type' => 'string',
	774	+ 'enum' => array( 'before_content', 'after_content', 'before_after_content', 'after_element' ),
	775	+ 'description' => sprintf(
	776	+ /* translators: Post type slug. */
	777	+ __( 'Where the Default Form displays relative to the %s content.', 'convertkit' ),
	778	+ $post_type
	779	+ ),
	780	+ );
	781	+
	782	+ $properties[ $post_type . '_form_position_element' ] = array(
	783	+ 'type' => 'string',
	784	+ 'enum' => array( 'p', 'h2', 'h3', 'h4', 'h5', 'h6', 'img' ),
	785	+ 'description' => sprintf(
	786	+ /* translators: 1: Post type slug, 2: Post type slug. */
	787	+ __( 'HTML element after which to display the Default Form on %1$s. Only used when `%2$s_form_position` is `after_element`.', 'convertkit' ),
	788	+ $post_type,
	789	+ $post_type
	790	+ ),
	791	+ );
	792	+
	793	+ $properties[ $post_type . '_form_position_element_index' ] = array(
	794	+ 'type' => 'integer',
	795	+ 'minimum' => 1,
	796	+ 'maximum' => 999,
	797	+ 'description' => sprintf(
	798	+ /* translators: 1: Post type slug, 2: Post type slug. */
	799	+ __( 'Nth occurrence of the element after which to display the Default Form on %1$s. Only used when `%2$s_form_position` is `after_element`.', 'convertkit' ),
	800	+ $post_type,
	801	+ $post_type
	802	+ ),
	803	+ );
	804	+ }
	805	+
	806	+ return array(
	807	+ 'type' => 'object',
	808	+ 'additionalProperties' => false,
	809	+ 'properties' => $properties,
	810	+ );
	811	+
	812	+ }
	813	+
	814	+ /**
572	815	* The default settings, used when the ConvertKit Plugin Settings haven't been saved
573	816	* e.g. on a new installation.
574	817	*
575	818	* @since 1.9.6
		@@ -592,12 +835,19 @@
592	835	'non_inline_form' => array(), // array.
593	836	'non_inline_form_honor_none_setting' => '', // blank|on.
594	837	'non_inline_form_limit_per_session' => '', // blank|on.
595	838
	839	+ // Spam Protection.
	840	+ 'spam_protection_provider' => 'recaptcha', // recaptcha|turnstile.
	841	+
596	842	// reCAPTCHA.
597	843	'recaptcha_site_key' => '', // string.
598	844	'recaptcha_secret_key' => '', // string.
599	845	'recaptcha_minimum_score' => 0.5, // float.
	846	+
	847	+ // Cloudflare Turnstile.
	848	+ 'cloudflare_turnstile_site_key' => '', // string.
	849	+ 'cloudflare_turnstile_secret_key' => '', // string.
600	850
601	851	// Advanced.
602	852	'debug' => '', // blank|on.
603	853	'no_scripts' => '', // blank|on.