# convertkit/3.4.3/includes/class-convertkit-output-restrict-content.php Kit (formerly ConvertKit) – Email Newsletter, Email Marketing, Membership, Subscribers and Landing Pages, version 3.4.3. 2,199 lines. - Page: https://pluginprobe.com/plugins/convertkit/3.4.3/code/includes/class-convertkit-output-restrict-content.php - Raw: https://pluginprobe.com/plugins/convertkit/3.4.3/raw/includes/class-convertkit-output-restrict-content.php - Modified: 2026-09-17T13:04:24+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/convertkit/3.4.3/code/includes/class-convertkit-output-restrict-content.php#L10-L20`. ```php WP_REST_Server::CREATABLE, 'args' => array( // Email: Validate email is included in the request, is a valid email address // and sanitize the email address. 'convertkit_email' => array( 'required' => true, 'validate_callback' => function ( $param ) { return is_string( $param ) && is_email( $param ); }, 'sanitize_callback' => 'sanitize_email', ), // Post ID: Validate post ID is included in the request and is an integer. 'convertkit_post_id' => array( 'required' => true, 'validate_callback' => function ( $param ) { return is_numeric( $param ); }, 'sanitize_callback' => 'absint', ), // Resource Type: Validate resource type is a string, if included in the request. // It's not included when logging in using the Member Content Login block. 'convertkit_resource_type' => array( 'required' => false, 'validate_callback' => function ( $param ) { return is_string( $param ); }, 'sanitize_callback' => 'sanitize_text_field', ), // Resource ID: Validate resource ID is an integer, if included in the request. // It's not included when logging in using the Member Content Login block. 'convertkit_resource_id' => array( 'required' => false, 'validate_callback' => function ( $param ) { return is_numeric( $param ); }, 'sanitize_callback' => 'absint', ), // Spam protection response, if a spam protection provider is enabled. 'spam_protection_response' => array( 'required' => false, 'validate_callback' => function ( $param ) { return is_string( $param ); }, 'sanitize_callback' => 'sanitize_text_field', ), // Whether to display the heading above the login form. // It's not displayed by the Member Content Login block, as it refers to // reading the Member Content the subscriber is logging in to view. 'display_heading' => array( 'required' => false, 'default' => true, 'validate_callback' => function ( $param ) { return is_bool( $param ); }, ), ), 'callback' => function ( $request ) { // Initialize classes that will be used. $output_restrict_content = WP_ConvertKit()->get_class( 'output_restrict_content' ); $output_restrict_content->initialize_classes(); // Fetch Post ID, Resource Type and Resource ID for the view. $email = $request->get_param( 'convertkit_email' ); $post_id = $request->get_param( 'convertkit_post_id' ); $resource_type = $request->get_param( 'convertkit_resource_type' ); $resource_id = $request->get_param( 'convertkit_resource_id' ); // Check spam protection (reCAPTCHA or Cloudflare Turnstile, depending on Plugin settings). $result = $output_restrict_content->verify_spam_protection( $request->get_param( 'spam_protection_response' ) ); // If spam protection failed, build the email form view with the error message. if ( is_wp_error( $result ) ) { $output_restrict_content->error = $result; ob_start(); include CONVERTKIT_PLUGIN_PATH . '/views/frontend/restrict-content/' . ( $request->get_param( 'display_heading' ) ? 'login-modal-content-email.php' : 'login-email.php' ); $output = trim( ob_get_clean() ); return rest_ensure_response( array( 'success' => false, 'data' => $output, ) ); } // Run subscriber authentication. $result = $output_restrict_content->subscriber_authentication_send_code( $email, $post_id ); // If an error occurred, build the email form view with the error message. if ( is_wp_error( $result ) ) { // Set error to display on screen. $output_restrict_content->error = $result; // Build email form view to return for output with error message. ob_start(); include CONVERTKIT_PLUGIN_PATH . '/views/frontend/restrict-content/' . ( $request->get_param( 'display_heading' ) ? 'login-modal-content-email.php' : 'login-email.php' ); $output = trim( ob_get_clean() ); return rest_ensure_response( array( 'success' => false, 'data' => $output, ) ); } // Set token and Post ID for authentication code view. $output_restrict_content->token = $result; $output_restrict_content->post_id = $post_id; // Build authentication code view to return for output. ob_start(); include CONVERTKIT_PLUGIN_PATH . '/views/frontend/restrict-content/login-modal-content-code.php'; $output = trim( ob_get_clean() ); return rest_ensure_response( array( 'success' => true, 'data' => $output, ) ); }, // No authentication required, as this is on the frontend site. 'permission_callback' => '__return_true', ) ); // Register route to run subscriber verification. register_rest_route( 'kit/v1', '/restrict-content/subscriber-verification', array( 'methods' => WP_REST_Server::CREATABLE, 'args' => array( // Post ID: Validate post ID is an integer if included in the request. 'convertkit_post_id' => array( 'required' => false, 'validate_callback' => function ( $param ) { return is_numeric( $param ); }, 'sanitize_callback' => 'absint', ), // Token: Validate token is included in the request and is a string. 'token' => array( 'required' => true, 'validate_callback' => function ( $param ) { return is_string( $param ); }, 'sanitize_callback' => 'sanitize_text_field', ), // Subscriber Code: Validate subscriber code is included in the request and is a string. 'subscriber_code' => array( 'required' => true, 'validate_callback' => function ( $param ) { return is_string( $param ); }, 'sanitize_callback' => 'sanitize_text_field', ), ), 'callback' => function ( $request ) { // Initialize classes that will be used. $output_restrict_content = WP_ConvertKit()->get_class( 'output_restrict_content' ); $output_restrict_content->initialize_classes(); // Fetch Post ID, Resource Type and Resource ID for the view. $post_id = $request->get_param( 'convertkit_post_id' ); $token = $request->get_param( 'token' ); $subscriber_code = $request->get_param( 'subscriber_code' ); // Run subscriber authentication. $result = $output_restrict_content->subscriber_authentication_verify( $post_id, $token, $subscriber_code ); // If an error occurred, build the code form view with the error message. if ( is_wp_error( $result ) ) { // Set error to display on screen. $output_restrict_content->error = $result; // Set token and post ID for authentication code view. $output_restrict_content->token = $token; $output_restrict_content->post_id = $post_id; // Build code form view to return for output with error message. ob_start(); include CONVERTKIT_PLUGIN_PATH . '/views/frontend/restrict-content/login-modal-content-code.php'; $output = trim( ob_get_clean() ); return rest_ensure_response( array( 'success' => false, 'data' => $output, ) ); } // Return success with the URL to the Post, including the `ck-cache-bust` parameter. return rest_ensure_response( array( 'success' => true, 'url' => $output_restrict_content->get_url( $post_id, true ), ) ); }, // No authentication required, as this is on the frontend site. 'permission_callback' => '__return_true', ) ); } /** * Initialize classes that will be used. * * @since 3.1.0 */ public function initialize_classes() { $this->settings = new ConvertKit_Settings(); $this->restrict_content_settings = new ConvertKit_Settings_Restrict_Content(); $this->api = new ConvertKit_API_V4( CONVERTKIT_OAUTH_CLIENT_ID, CONVERTKIT_OAUTH_CLIENT_REDIRECT_URI, $this->settings->get_access_token(), $this->settings->get_refresh_token(), $this->settings->debug_enabled(), 'restrict_content' ); } /** * If the user isn't using JavaScript, or the Plugin's Disable JS is enabled, checks if the request is a Restrict Content request with an email address. * If so, calls the API depending on the Restrict Content resource that's required: * - tag: subscribes the email address to the tag, and calls the API to send the subscriber a magic link by email containing a code. * - form + product: calls the API to send the subscriber a magic link by email containing a code. * * See maybe_run_subscriber_verification() for logic once they click the link in the email or enter the code on screen. * * @since 2.1.0 */ public function maybe_run_subscriber_authentication() { // Bail if no nonce was specified via form submission. if ( ! array_key_exists( '_wpnonce', $_REQUEST ) ) { return; } // Bail if the request is a form submission and the nonce failed validation. if ( ! wp_verify_nonce( sanitize_key( $_REQUEST['_wpnonce'] ), 'convertkit_restrict_content_login' ) ) { return; } // Bail if the expected email or Post ID are missing from the request. if ( ! array_key_exists( 'convertkit_email', $_REQUEST ) ) { return; } if ( ! array_key_exists( 'convertkit_post_id', $_REQUEST ) ) { return; } // If the Plugin Access Token has not been configured, we can't get this subscriber's ID by email. if ( ! $this->settings->has_access_and_refresh_token() ) { return; } // Sanitize inputs. $email = sanitize_text_field( wp_unslash( $_REQUEST['convertkit_email'] ) ); $this->resource_type = ( array_key_exists( 'convertkit_resource_type', $_REQUEST ) ? sanitize_text_field( wp_unslash( $_REQUEST['convertkit_resource_type'] ) ) : '' ); $this->resource_id = ( array_key_exists( 'convertkit_resource_id', $_REQUEST ) ? absint( $_REQUEST['convertkit_resource_id'] ) : 0 ); $this->post_id = absint( $_REQUEST['convertkit_post_id'] ); // If Restrict Content is by tag, tag the subscriber. if ( $this->resource_type === 'tag' ) { // Check spam protection (reCAPTCHA or Cloudflare Turnstile, depending on Plugin settings). $spam_protection = new ConvertKit_Spam_Protection(); $spam_check = $spam_protection->verify( 'convertkit_restrict_content_tag' ); // Bail if spam protection failed. if ( is_wp_error( $spam_check ) ) { $this->error = $spam_check; return; } // Tag subscriber. $result = $this->api->tag_subscribe( $this->resource_id, $email ); // Bail if an error occurred. if ( is_wp_error( $result ) ) { $this->error = $result; return; } } else { // Check spam protection (reCAPTCHA or Cloudflare Turnstile, depending on Plugin settings). $spam_check = $this->verify_spam_protection(); // Bail if spam protection failed. if ( is_wp_error( $spam_check ) ) { $this->error = $spam_check; return; } } // Run subscriber authentication. $result = $this->subscriber_authentication_send_code( $email, $this->post_id ); // Bail if an error occurred. if ( is_wp_error( $result ) ) { $this->error = $result; return; } // Store the token so it's included in the subscriber code form. $this->token = $result; } /** * If the user isn't using JavaScript, or the Plugin's Disable JS is enabled, checks if the request contains a token and subscriber_code, * which happens when the subscriber either: * - clicked the link in the email sent by run_subscriber_authentication(), or * - entered the code from the email on the screen * * This calls the API to verify the token and subscriber code, which tells us that the email * address supplied truly belongs to the user, and that we can safely trust their subscriber ID * to be valid. * * @since 2.1.0 */ public function maybe_run_subscriber_verification() { // Bail if the expected token and subscriber code is missing. if ( ! array_key_exists( 'token', $_REQUEST ) ) { return; } if ( ! array_key_exists( 'subscriber_code', $_REQUEST ) ) { return; } // If a nonce was specified, validate it now. // It won't be provided if clicking the link in the magic link email. if ( array_key_exists( '_wpnonce', $_REQUEST ) && ! is_null( $_REQUEST['_wpnonce'] ) ) { if ( ! wp_verify_nonce( sanitize_key( $_REQUEST['_wpnonce'] ), 'convertkit_restrict_content_subscriber_code' ) ) { return; } } // If the Plugin Access Token has not been configured, we can't get this subscriber's ID by email. if ( ! $this->settings->has_access_and_refresh_token() ) { return; } // Store the token so it's included in the subscriber code form if verification fails. $this->token = sanitize_text_field( wp_unslash( $_REQUEST['token'] ) ); // Store the post ID if this is an AJAX request. // This won't be included if clicking the link in the magic link email, so fall back to using // get_the_ID() to get the post ID. if ( array_key_exists( 'convertkit_post_id', $_REQUEST ) ) { $this->post_id = absint( wp_unslash( $_REQUEST['convertkit_post_id'] ) ); } else { $this->post_id = get_the_ID(); } // Run subscriber verification. $subscriber_id = $this->subscriber_authentication_verify( $this->post_id, sanitize_text_field( wp_unslash( $_REQUEST['token'] ) ), sanitize_text_field( wp_unslash( $_REQUEST['subscriber_code'] ) ) ); // Bail if an error occurred. if ( is_wp_error( $subscriber_id ) ) { $this->error = $subscriber_id; return; } // Redirect now to reload the Post. $this->redirect( $this->post_id ); } /** * Logs the subscriber out by deleting their subscriber ID cookie, when the * log out button is clicked in the Member Content Login block. * * @since 3.4.2 */ public function maybe_run_subscriber_logout() { // Bail if no logout request was made. if ( ! array_key_exists( 'convertkit_logout', $_REQUEST ) ) { return; } // Bail if no nonce was specified. if ( ! array_key_exists( '_wpnonce', $_REQUEST ) ) { return; } // Bail if the nonce failed validation. if ( ! wp_verify_nonce( sanitize_key( $_REQUEST['_wpnonce'] ), 'convertkit_member_content_logout' ) ) { return; } // Delete the subscriber ID cookie. $subscriber = new ConvertKit_Subscriber(); $subscriber->forget(); // Reload the Post, so the login form displays. wp_safe_redirect( $this->get_url( get_the_ID(), true ) ); exit(); } /** * Verifies the spam protection response for the login form, using the spam * protection provider enabled in the Plugin's settings. * * @since 3.4.2 * * @param bool|string $response Spam protection response, if supplied by a REST API request. * @return bool|WP_Error */ public function verify_spam_protection( $response = false ) { $spam_protection = new ConvertKit_Spam_Protection(); $provider = $spam_protection->get_active_provider(); // Return true if no spam protection provider is enabled. if ( $provider === false ) { return true; } // Verify the response included in the REST API request. if ( ! empty( $response ) ) { return $provider->verify( $response, 'convertkit_member_content_login' ); } // Verify the response included in the form submission. return $spam_protection->verify( 'convertkit_member_content_login' ); } /** * Enqueues the CSS and JS required by the login form and modal. * * @since 3.4.2 */ public function enqueue_scripts_and_styles() { // Only load styles if the Disable CSS option is off. if ( ! $this->settings->css_disabled() ) { convertkit_enqueue_frontend_css(); } // Bail if scripts are disabled. if ( $this->settings->scripts_disabled() ) { return; } // Enqueue scripts. convertkit_enqueue_frontend_js(); // Define variables. wp_localize_script( 'convertkit-js', 'convertkit_restrict_content', array( 'nonce' => wp_create_nonce( 'wp_rest' ), 'subscriber_authentication_url' => rest_url( 'kit/v1/restrict-content/subscriber-authentication' ), 'subscriber_verification_url' => rest_url( 'kit/v1/restrict-content/subscriber-verification' ), 'debug' => $this->settings->debug_enabled(), ) ); } /** * Outputs the login modal in the footer, ensuring it is only output once * when a Post contains multiple Member Content Login blocks. * * @since 3.4.2 * * @param int $post_id Post ID. * @param bool|int $resource_id Resource ID. * @param bool|string $resource_type Resource Type. */ public function output_login_modal( $post_id, $resource_id = 0, $resource_type = '' ) { if ( $this->login_modal_output ) { return; } $this->login_modal_output = true; add_action( 'wp_footer', function () use ( $post_id, $resource_id, $resource_type ) { include_once CONVERTKIT_PLUGIN_PATH . '/views/frontend/restrict-content/login-modal.php'; } ); } /** * Sends an email to the subscriber with a code and link to authenticate they have access to the email address submitted. * * @since 3.1.0 * * @param string $email Email address. * @param int $post_id Post ID. * * @return WP_Error|string Error or Token. */ public function subscriber_authentication_send_code( $email, $post_id ) { // Send email to subscriber with a link to authenticate they have access to the email address submitted. $token = $this->api->subscriber_authentication_send_code( $email, $this->get_url( $post_id ) ); // Bail if an error occurred. if ( is_wp_error( $token ) ) { return $token; } // Clear any existing subscriber ID cookie, as the authentication flow has started by sending the email. $subscriber = new ConvertKit_Subscriber(); $subscriber->forget(); // Return the token. return $token; } /** * Verifies the token and subscriber code, which tells us that the email * address supplied truly belongs to the user, and that we can safely * trust their subscriber ID to be valid. * * @since 3.1.0 * * @param int $post_id Post ID. * @param string $token Token. * @param string $subscriber_code Subscriber code. * * @return WP_Error|string Error or Signed Subscriber ID. */ public function subscriber_authentication_verify( $post_id, $token, $subscriber_code ) { // Verify the token and subscriber code. $subscriber_id = $this->api->subscriber_authentication_verify( $token, $subscriber_code ); // Bail if an error occurred. if ( is_wp_error( $subscriber_id ) ) { return $subscriber_id; } // Store subscriber ID in cookie. $this->store_subscriber_id_in_cookie( $subscriber_id ); // Return signed subscriber ID. return $subscriber_id; } /** * Registers the applicable content filter for maybe restricting content, depending * on the Theme or Page Builder used. * * @since 2.7.7 */ public function register_content_filter() { // Use the standard `the_content` filter, which works for most Themes // and Page Builders. add_filter( 'the_content', array( $this, 'maybe_restrict_content' ) ); /** * Allow specific Themes and Page Builders to use a different filter * for Restrict Content functionality. * * @since 2.7.7 */ do_action( 'convertkit_restrict_content_register_content_filter' ); } /** * Displays (or hides) content on a singular Page, Post or Custom Post Type's Content, * depending on whether the visitor is an authenticated ConvertKit subscriber and has * subscribed to the ConvertKit Product or Tag. * * @since 2.1.0 * * @param string $content Post Content. * @return string Post Content with content restricted/not restricted */ public function maybe_restrict_content( $content ) { // Bail if the Restrict Content setting is not enabled on this Page. if ( ! $this->is_restricted_content() ) { return $content; } // Bail if the Page is being edited in a frontend Page Builder / Editor by a logged // in WordPress user who has the capability to edit the Page. // This ensures the User can view all content to edit it, instead of seeing the Restrict Content // view. if ( current_user_can( 'edit_post', get_the_ID() ) && WP_ConvertKit()->is_admin_or_frontend_editor() ) { return $content; } // Get resource type (Product or Tag) that the visitor must be subscribed against to access this content. $this->resource_type = $this->get_resource_type(); // Return the Post Content, unedited, if the Resource Type is false. if ( ! $this->resource_type ) { return $content; } // Get resource ID (Product ID or Tag ID) that the visitor must be subscribed against to access this content. $this->resource_id = $this->get_resource_id(); // Return the full Post Content, unedited, if the Resource ID is false, as this means // no restrict content setting has been defined for this Post. if ( ! $this->resource_id ) { return $content; } // Return the full Post Content, unedited, if the request is from a crawler. if ( $this->restrict_content_settings->permit_crawlers() && $this->is_crawler() ) { return $content; } // Return if this request is after the user entered their email address, // which means we're going through the authentication flow. if ( $this->in_authentication_flow() ) { return $this->restrict_content( $content ); } // Get the subscriber ID, either from the request or an existing cookie. $subscriber_id = $this->get_subscriber_id_from_request(); // If no subscriber ID exists, the visitor cannot view the content. if ( ! $subscriber_id ) { return $this->restrict_content( $content ); } // If the subscriber is not subscribed to the product, restrict the content. if ( ! $this->subscriber_has_access( $subscriber_id ) ) { // Show an error before the call to action, to tell the subscriber why they still cannot // view the content. switch ( $this->resource_type ) { case 'form': $message = $this->restrict_content_settings->get_by_key( 'no_access_text_form' ); break; case 'tag': $message = $this->restrict_content_settings->get_by_key( 'no_access_text_tag' ); break; case 'product': default: $message = $this->restrict_content_settings->get_by_key( 'no_access_text' ); break; } // Define error for output. $this->error = new WP_Error( 'convertkit_restrict_content_subscriber_no_access', esc_html( $message ) ); return $this->restrict_content( $content ); } // If here, the subscriber has subscribed to the product. // Show the full Post Content. return $content; } /** * Changes how WordPress' get_adjacent_post() function queries Pages, to determine what * the previous Page link is when using the Previous navigation block on a Page that * has the Restrict Content setting defined. * * By default, get_adjacent_post() will query by post_date, which we change to menu_order. * * @since 2.1.0 * * @param string $where The `WHERE` clause in the SQL. * @param bool $in_same_term Whether post should be in a same taxonomy term. * @param array $excluded_terms Array of excluded term IDs. * @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true. * @param WP_Post $post WP_Post object. * @return string Modified `WHERE` clause */ public function maybe_change_previous_post_where_clause( $where, $in_same_term, $excluded_terms, $taxonomy, $post ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter // Bail if the Restrict Content setting is not enabled on this Page. if ( ! $this->is_restricted_content() ) { return $where; } // Bail if the Page doesn't match the current Page being viewed, or has no parent Page. if ( ! $this->has_parent_page( $post ) ) { return $where; } // Build replacement where statement. $new_where = 'p.post_parent = ' . $post->post_parent . ' AND p.menu_order < ' . $post->menu_order; // Replace existing where statement with new statement. $where = 'WHERE ' . $new_where . ' ' . substr( $where, strpos( $where, 'AND p.post_type = \'' . $post->post_type . '\' ' ) ); // Return. return $where; } /** * Changes how WordPress' get_adjacent_post() function queries Pages, to determine what * the next Page link is when using the Previous navigation block on a Page that * has the Restrict Content setting defined. * * By default, get_adjacent_post() will query by post_date, which we change to menu_order. * * @since 2.1.0 * * @param string $where The `WHERE` clause in the SQL. * @param bool $in_same_term Whether post should be in a same taxonomy term. * @param array $excluded_terms Array of excluded term IDs. * @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true. * @param WP_Post $post WP_Post object. * @return string Modified `WHERE` clause */ public function maybe_change_next_post_where_clause( $where, $in_same_term, $excluded_terms, $taxonomy, $post ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter // Bail if the Restrict Content setting is not enabled on this Page. if ( ! $this->is_restricted_content() ) { return $where; } // Bail if the Page doesn't match the current Page being viewed, or has no parent Page. if ( ! $this->has_parent_page( $post ) ) { return $where; } // Build replacement where statement. $new_where = 'p.post_parent = ' . $post->post_parent . ' AND p.menu_order > ' . $post->menu_order; // Replace existing where statement with new statement. $where = 'WHERE ' . $new_where . ' ' . substr( $where, strpos( $where, 'AND p.post_type = \'' . $post->post_type . '\' ' ) ); // Return. return $where; } /** * Changes how WordPress' get_adjacent_post() function orders Pages, to determine what * the next and previous Page links are when using Previous / Next navigation blocks * on a Page that has the Restrict Content setting defined. * * By default, get_adjacent_post() will sort by Post Date, which we change to Page Order * (called menu_order in WordPress). * * @since 2.1.0 * * @param string $order_by SQL ORDER BY statement. * @param WP_Post $post WordPress Post. * @param string $order Order. * @return string Modified SQL ORDER BY statement. */ public function maybe_change_previous_next_post_order_by_clause( $order_by, $post, $order ) { // Bail if the Restrict Content setting is not enabled on this Page. if ( ! $this->is_restricted_content() ) { return $order_by; } // Bail if the Page doesn't match the current Page being viewed, or has no parent Page. if ( ! $this->has_parent_page( $post ) ) { return $order_by; } // Order by Page order (menu_order), highest to lowest, instead of post_date. return 'ORDER BY p.menu_order ' . $order . ' LIMIT 1'; } /** * Stores the given subscriber ID in the ck_subscriber_id cookie. * * @since 2.3.7 * * @param string|int $subscriber_id Subscriber ID (int if restrict by tag, signed subscriber id string if restrict by product). */ private function store_subscriber_id_in_cookie( $subscriber_id ) { // Store subscriber ID in cookie. // We don't need to use validate_and_store_subscriber_id() as we just validated the subscriber via authentication above. $subscriber = new ConvertKit_Subscriber(); $subscriber->set( $subscriber_id ); } /** * Redirects to the current URL, removing any query parameters (such as tokens), and appending * a ck-cache-bust query parameter to beat caching plugins. * * @since 2.3.7 * * @param int $post_id Post ID. */ private function redirect( $post_id ) { // Redirect to the Post, appending a query parameter to the URL to prevent caching plugins and // aggressive cache hosting configurations from serving a cached page, which would // result in maybe_restrict_content() not showing an error message or permitting // access to the content. wp_safe_redirect( $this->get_url( $post_id, true ) ); exit; } /** * Returns the URL for the current request, excluding any query parameters. * * @since 2.1.0 * * @param int $post_id Post ID. * @param bool $cache_bust Include `ck-cache-bust` parameter in URL. * @return string URL. */ public function get_url( $post_id, $cache_bust = false ) { // Get URL of Post. $url = get_permalink( $post_id ); // If no cache busting required, return the URL now. if ( ! $cache_bust ) { return $url; } // Append a query parameter to the URL to prevent caching plugins and // aggressive cache hosting configurations from serving a cached page, which would // result in maybe_restrict_content() not showing an error message or permitting // access to the content. return add_query_arg( array( 'ck-cache-bust' => microtime(), ), $url ); } /** * Determines if the request is for a WordPress Page that has the Restrict Content * setting defined. * * @since 2.1.0 * * @return bool */ private function is_restricted_content() { // Bail if not a singular Post Type. if ( ! is_singular() ) { return false; } // If the Plugin Access Token has not been configured, we can't determine the validity of this subscriber ID // or which resource(s) they have access to. if ( ! $this->settings->has_access_and_refresh_token() ) { return false; } // Get Post ID. $this->post_id = get_the_ID(); // Initialize Settings and Post Setting classes. $this->post_settings = new ConvertKit_Post( $this->post_id ); // Return whether the Post's settings are set to restrict content. return $this->post_settings->restrict_content_enabled(); } /** * Determines if the user entered a valid email address, and need to be prompted * to enter a code sent to their email address. * * @since 2.1.0 * * @return bool */ private function in_authentication_flow() { return ( $this->token !== false ); } /** * Checks if the given WordPress Page matches the Page ID viewed, and has a parent. * * @since 2.1.0 * * @param WP_Post $post WordPress Post. * @return bool Has parent page */ private function has_parent_page( $post ) { // Bail if the Page doesn't match the current Page being viewed. // This prevents us accidentally interfering with other previous / next link queries, which shouldn't happen // as we check if we're viewing a restricted content page above. if ( $post->ID !== $this->post_id ) { return false; } // Bail if the Page doesn't have a parent Page. // We don't want to modify the default sort behaviour in this instance. if ( $post->post_parent === 0 ) { return false; } return true; } /** * Get the Post's Restricted Content resource type. * * @since 2.1.0 * * @return bool|string Resource Type (product). */ private function get_resource_type() { // Initialize Post Setting classes. $this->post_settings = new ConvertKit_Post( $this->post_id ); // Get resource type. $resource_type = $this->post_settings->get_restrict_content_type(); /** * Define the ConvertKit Resource Type that the visitor must be subscribed against * to access this content, overriding the Post setting. * * Return false or an empty string to not restrict content. * * @since 2.1.0 * * @param string $resource_type Resource Type (product) * @param int $post_id Post ID */ $resource_type = apply_filters( 'convertkit_output_restrict_content_get_resource_type', $resource_type, $this->post_id ); // If resource type is blank, set it to false. if ( empty( $resource_type ) ) { $resource_type = false; } // Return. return $resource_type; } /** * Get the Post's Restricted Content resource ID. * * @since 2.1.0 * * @return int Resource ID (product ID). */ private function get_resource_id() { // Initialize Post Setting classes. $this->post_settings = new ConvertKit_Post( $this->post_id ); // Get resource ID. $resource_id = $this->post_settings->get_restrict_content_id(); /** * Define the ConvertKit Resource ID that the visitor must be subscribed against * to access this content, overriding the Post setting. * * Return 0 to not restrict content. * * @since 2.1.0 * * @param int $resource_id Resource ID * @param int $post_id Post ID */ $resource_id = apply_filters( 'convertkit_output_restrict_content_get_resource_id', $resource_id, $this->post_id ); // Return. return $resource_id; } /** * Queries the API to confirm whether the resource exists. * * @since 2.3.3 * * @return bool */ private function resource_exists() { switch ( $this->resource_type ) { case 'product': // Get Product. $products = new ConvertKit_Resource_Products( 'restrict_content' ); $product = $products->get_by_id( $this->resource_id ); // If the Product does not exist, return false. if ( ! $product ) { return false; } // Product exists in ConvertKit. return true; case 'form': // Get Form. $forms = new ConvertKit_Resource_Forms( 'restrict_content' ); $form = $forms->get_by_id( $this->resource_id ); // If the Form does not exist, return false. if ( ! $form ) { return false; } // Form exists in ConvertKit. return true; case 'tag': // Get Tag. $tags = new ConvertKit_Resource_Tags( 'restrict_content' ); $tag = $tags->get_by_id( $this->resource_id ); // If the Tag does not exist, return false. if ( ! $tag ) { return false; } // Tag exists in ConvertKit. return true; default: return false; } } /** * Determines if the given subscriber has an active subscription to * the given resource and its ID. * * @since 2.1.0 * * @param string|int $subscriber_id Signed Subscriber ID or Subscriber ID. * @return bool Can view restricted content */ private function subscriber_has_access( $subscriber_id ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter switch ( $this->resource_type ) { case 'product': return $this->subscriber_has_access_to_product_by_signed_subscriber_id( $subscriber_id, absint( $this->resource_id ) ); case 'form': return $this->subscriber_has_access_to_form_by_signed_subscriber_id( $subscriber_id, absint( $this->resource_id ) ); case 'tag': return $this->subscriber_has_access_to_tag_by_signed_subscriber_id( $subscriber_id, absint( $this->resource_id ) ); } // If here, the subscriber does not have access. return false; } /** * Determines if the given signed subscriber ID has an active subscription to * the given product. * * @since 2.7.1 * * @param string $signed_subscriber_id Signed Subscriber ID. * @param int $product_id Product ID. * @return bool Has access to product */ private function subscriber_has_access_to_product_by_signed_subscriber_id( $signed_subscriber_id, $product_id ) { // Get products that the subscriber has access to. $result = $this->api->profile( $signed_subscriber_id ); // If an error occurred, the subscriber ID is invalid. if ( is_wp_error( $result ) ) { return false; } // If no products exist, there's no access. if ( ! $result['products'] || ! count( $result['products'] ) ) { return false; } // Return if the subscriber is subscribed to the product or not. return in_array( $product_id, $result['products'], true ); } /** * Determines if the given signed subscriber ID has an active subscription to * the given form. * * @since 2.7.3 * * @param string $signed_subscriber_id Signed Subscriber ID. * @param int $form_id Form ID. * @return bool Has access to form */ private function subscriber_has_access_to_form_by_signed_subscriber_id( $signed_subscriber_id, $form_id ) { // Get products that the subscriber has access to. $result = $this->api->profile( $signed_subscriber_id ); // If an error occurred, the subscriber ID is invalid. if ( is_wp_error( $result ) ) { return false; } // If no forms exist, there's no access. if ( ! $result['forms'] || ! count( $result['forms'] ) ) { return false; } // Return if the subscriber is subscribed to the form or not. return in_array( $form_id, $result['forms'], true ); } /** * Determines if the given signed subscriber ID has an active subscription to * the given tag. * * @since 2.7.1 * * @param string $signed_subscriber_id Signed Subscriber ID. * @param int $tag_id Tag ID. * @return bool Has access to tag */ private function subscriber_has_access_to_tag_by_signed_subscriber_id( $signed_subscriber_id, $tag_id ) { // Get products that the subscriber has access to. $result = $this->api->profile( $signed_subscriber_id ); // If an error occurred, the subscriber ID is invalid. if ( is_wp_error( $result ) ) { return false; } // If no tags exist, there's no access. if ( ! $result['tags'] || ! count( $result['tags'] ) ) { return false; } // Return if the subscriber is subscribed to the tag or not. return in_array( $tag_id, $result['tags'], true ); } /** * Gets the subscriber ID from the request (either the cookie or the URL). * * @since 2.1.0 * * @return int|string Subscriber ID or Signed ID */ public function get_subscriber_id_from_request() { // Use ConvertKit_Subscriber class to fetch and validate the subscriber ID. $subscriber = new ConvertKit_Subscriber(); $subscriber_id = $subscriber->get_subscriber_id(); // If an error occurred, the subscriber ID in the request/cookie is not a valid subscriber. if ( is_wp_error( $subscriber_id ) ) { return 0; } return $subscriber_id; } /** * Restrict the given Post Content by showing a preview of the content, and appending * the call to action to subscribe or authenticate. * * @since 2.1.0 * * @param string $content Post Content. * @return string Post Content preview with call to action */ private function restrict_content( $content ) { // Check that the resource exists before restricting the content. // This handles cases where e.g. a Tag or Product has been deleted in ConvertKit, // but the Page / Post still references the (now deleted) resource to restrict content with // under the 'Member Content' setting. if ( ! $this->resource_exists() ) { // Return the full Post Content, as we can't restrict it to a Product or Tag that no longer exists. return $content; } // Fetch the content preview. $content_preview = $this->get_content_preview( $content ); /** * Define the output for the content preview when the visitor is not * an authenticated subscriber. * * @since 2.4.1 * * @param string $content_preview Content preview. * @param int $post_id Post ID. */ $content_preview = apply_filters( 'convertkit_output_restrict_content_content_preview', $content_preview, $this->post_id ); // Fetch the call to action. $call_to_action = $this->get_call_to_action( $this->post_id ); /** * Define the output for the call to action, displayed below the content preview, * when the visitor is not an authenticated subscriber. * * @since 2.4.1 * * @param string $call_to_action Call to Action. * @param int $post_id Post ID. */ $call_to_action = apply_filters( 'convertkit_output_restrict_content_call_to_action', $call_to_action, $this->post_id ); // Fetch container CSS classes. $container_css_classes = explode( ' ', $this->restrict_content_settings->get_by_key( 'container_css_classes' ) ); /** * Define the container CSS classes to wrap the content preview and call to action within. * * @since 3.1.4 * * @param array $container_css_classes Container CSS classes. * @param int $post_id Post ID. */ $container_css_classes = apply_filters( 'convertkit_output_restrict_content_container_css_classes', $container_css_classes, $this->post_id ); // Remove empty CSS classes. $container_css_classes = array_filter( $container_css_classes ); // If container CSS classes are set, return the content preview and call to action wrapped in the container. if ( count( $container_css_classes ) ) { return '
' . $content_preview . $call_to_action . '
'; } // Return the content preview and its call to action. return $content_preview . $call_to_action; } /** * Returns a preview of the given content for visitors that don't have access to restricted content. * * The preview is determined by: * - A single tag being placed between WordPress paragraphs when using the Classic Editor. * Content before the tag will be returned as the preview, unless 'noteaser' is enabled. * - A single 'Read More' block being placed between WordPress blocks when using the Gutenberg Editor. * Content before the Read More block will be returned as the preview, unless 'Hide the excerpt * on the full content page' is enabled. * * If no more tag or Read More block is present, returns the Post's excerpt. * * @since 2.1.0 * * @param string $content Post Content. * @return string Post Content Preview. */ private function get_content_preview( $content ) { global $post; // Check if the content contains a tag, which the editor might have placed // in the content through WordPress' Classic Editor. $content_breakdown = get_extended( $content ); // If the tag exists, the 'extended' key will contain the restricted content. if ( ! empty( $content_breakdown['extended'] ) ) { // Return the preview content. return $content_breakdown['main']; } // Check if the content contains a 'Read More' block, which the editor might have placed // in the content through the Gutenberg Editor. $block_editor_tag = ''; if ( strpos( $content, $block_editor_tag ) !== false ) { // Split content into an array by the tag. $content_breakdown = explode( $block_editor_tag, $content ); // Return the content before the tag. // If noteaser is enabled, this will correctly be blank. return $content_breakdown[0]; } // If here, there is no preview content available. Use the Post's excerpt. return $this->get_excerpt( $post->ID ); } /** * Returns the excerpt for the given Post. * * If no excerpt is defined, generates one from the Post's content. * * @since 2.3.7 * * @param int $post_id Post ID. * @return string Post excerpt. */ private function get_excerpt( $post_id ) { // Remove 'the_content' filter, as if the Post contains no defined excerpt, WordPress // will invoke the Post's content to build an excerpt, resulting in an infinite loop. remove_filter( 'the_content', array( $this, 'maybe_restrict_content' ) ); // Generate the Post's excerpt. $excerpt = get_the_excerpt( $post_id ); // Restore filters so other functions and Plugins aren't affected. add_filter( 'the_content', array( $this, 'maybe_restrict_content' ) ); // Return the excerpt. return wpautop( $excerpt ); } /** * Returns the HTML output for the call to action for visitors not subscribed to the required * resource type and ID. * * @since 2.1.0 * * @param int $post_id Post ID. * @return string HTML */ private function get_call_to_action( $post_id ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter // Enqueue CSS and JS. $this->enqueue_scripts_and_styles(); // Output code form if this request is after the user entered their email address, // which means we're going through the authentication flow. if ( $this->in_authentication_flow() ) { ob_start(); include CONVERTKIT_PLUGIN_PATH . '/views/frontend/restrict-content/code.php'; return trim( ob_get_clean() ); } // Get resource type and id. $resource_type = $this->resource_type; $resource_id = $this->resource_id; // This is deliberately a switch statement, because we will likely add in support // for restrict by tag and form later. switch ( $resource_type ) { case 'product': // Get header and text from settings for Products. $heading = $this->restrict_content_settings->get_by_key( 'subscribe_heading' ); $text = $this->restrict_content_settings->get_by_key( 'subscribe_text' ); // Output product restricted message and email form. // Get Product. $products = new ConvertKit_Resource_Products( 'restrict_content' ); $product = $products->get_by_id( $resource_id ); // Get commerce.js URL and enqueue. $url = $products->get_commerce_js_url(); if ( $url ) { wp_enqueue_script( 'convertkit-commerce', $url, array(), CONVERTKIT_PLUGIN_VERSION, true ); } // If scripts are enabled, output the email login form in a modal, which will be displayed // when the 'log in' link is clicked. if ( ! $this->settings->scripts_disabled() ) { $this->output_login_modal( $post_id, $resource_id, $resource_type ); } // Output. ob_start(); $button = $products->get_html( $resource_id, $this->restrict_content_settings->get_by_key( 'subscribe_button_label' ), array( 'css_classes' => array( 'wp-block-button__link', 'wp-element-button' ), ) ); include CONVERTKIT_PLUGIN_PATH . '/views/frontend/restrict-content/product.php'; return trim( ob_get_clean() ); case 'form': // Display the Form. $forms = new ConvertKit_Resource_Forms( 'restrict_content' ); $form = $forms->get_html( $resource_id, $post_id ); // If scripts are enabled, output the email login form in a modal, which will be displayed // when the 'log in' link is clicked. if ( ! $this->settings->scripts_disabled() ) { $this->output_login_modal( $post_id, $resource_id, $resource_type ); } // Output. ob_start(); include CONVERTKIT_PLUGIN_PATH . '/views/frontend/restrict-content/form.php'; return trim( ob_get_clean() ); case 'tag': // Get header and text from settings for Tags. $heading = $this->restrict_content_settings->get_by_key( 'subscribe_heading_tag' ); $text = $this->restrict_content_settings->get_by_key( 'subscribe_text_tag' ); // If scripts are enabled, output the email login form in a modal, which will be displayed // when the 'log in' link is clicked. if ( ! $this->settings->scripts_disabled() ) { $this->output_login_modal( $post_id, $resource_id, $resource_type ); } // Enqueue the active spam protection provider's client-side script. $spam = new ConvertKit_Spam_Protection(); $spam_provider = $spam->get_active_provider(); if ( $spam_provider !== false ) { $spam_provider->enqueue_scripts(); } // Output. ob_start(); include CONVERTKIT_PLUGIN_PATH . '/views/frontend/restrict-content/tag.php'; return trim( ob_get_clean() ); default: return ''; } } /** * Whether this request is from a search engine crawler. * * @since 2.4.2 * * @return bool */ private function is_crawler() { // Define permitted user agent crawlers and their IP addresses. $permitted_user_agent_ip_ranges = array( // Google. // https://developers.google.com/static/search/apis/ipranges/googlebot.json. 'Googlebot' => array( '192.178.5.0/27', '34.100.182.96/28', '34.101.50.144/28', '34.118.254.0/28', '34.118.66.0/28', '34.126.178.96/28', '34.146.150.144/28', '34.147.110.144/28', '34.151.74.144/28', '34.152.50.64/28', '34.154.114.144/28', '34.155.98.32/28', '34.165.18.176/28', '34.175.160.64/28', '34.176.130.16/28', '34.22.85.0/27', '34.64.82.64/28', '34.65.242.112/28', '34.80.50.80/28', '34.88.194.0/28', '34.89.10.80/28', '34.89.198.80/28', '34.96.162.48/28', '35.247.243.240/28', '66.249.64.0/27', '66.249.64.128/27', '66.249.64.160/27', '66.249.64.192/27', '66.249.64.224/27', '66.249.64.32/27', '66.249.64.64/27', '66.249.64.96/27', '66.249.65.0/27', '66.249.65.160/27', '66.249.65.192/27', '66.249.65.224/27', '66.249.65.32/27', '66.249.65.64/27', '66.249.65.96/27', '66.249.66.0/27', '66.249.66.128/27', '66.249.66.160/27', '66.249.66.192/27', '66.249.66.32/27', '66.249.66.64/27', '66.249.66.96/27', '66.249.68.0/27', '66.249.68.32/27', '66.249.68.64/27', '66.249.69.0/27', '66.249.69.128/27', '66.249.69.160/27', '66.249.69.192/27', '66.249.69.224/27', '66.249.69.32/27', '66.249.69.64/27', '66.249.69.96/27', '66.249.70.0/27', '66.249.70.128/27', '66.249.70.160/27', '66.249.70.192/27', '66.249.70.224/27', '66.249.70.32/27', '66.249.70.64/27', '66.249.70.96/27', '66.249.71.0/27', '66.249.71.128/27', '66.249.71.160/27', '66.249.71.192/27', '66.249.71.224/27', '66.249.71.32/27', '66.249.71.64/27', '66.249.71.96/27', '66.249.72.0/27', '66.249.72.128/27', '66.249.72.160/27', '66.249.72.192/27', '66.249.72.224/27', '66.249.72.32/27', '66.249.72.64/27', '66.249.72.96/27', '66.249.73.0/27', '66.249.73.128/27', '66.249.73.160/27', '66.249.73.192/27', '66.249.73.224/27', '66.249.73.32/27', '66.249.73.64/27', '66.249.73.96/27', '66.249.74.0/27', '66.249.74.128/27', '66.249.74.32/27', '66.249.74.64/27', '66.249.74.96/27', '66.249.75.0/27', '66.249.75.128/27', '66.249.75.160/27', '66.249.75.192/27', '66.249.75.224/27', '66.249.75.32/27', '66.249.75.64/27', '66.249.75.96/27', '66.249.76.0/27', '66.249.76.128/27', '66.249.76.160/27', '66.249.76.192/27', '66.249.76.224/27', '66.249.76.32/27', '66.249.76.64/27', '66.249.76.96/27', '66.249.77.0/27', '66.249.77.128/27', '66.249.77.160/27', '66.249.77.192/27', '66.249.77.224/27', '66.249.77.32/27', '66.249.77.64/27', '66.249.77.96/27', '66.249.78.0/27', '66.249.78.32/27', '66.249.79.0/27', '66.249.79.128/27', '66.249.79.160/27', '66.249.79.192/27', '66.249.79.224/27', '66.249.79.32/27', '66.249.79.64/27', '66.249.79.96/27', ), // Applebot. // http://search.developer.apple.com/applebot.json. 'Applebot' => array( '17.241.208.160/27', '17.241.193.160/27', '17.241.200.160/27', '17.22.237.0/24', '17.22.245.0/24', '17.22.253.0/24', '17.241.75.0/24', '17.241.219.0/24', '17.241.227.0/24', '17.246.15.0/24', '17.246.19.0/24', '17.246.23.0/24', ), // Bing. // https://www.bing.com/toolbox/bingbot.json. 'Bingbot' => array( '157.55.39.0/24', '207.46.13.0/24', '40.77.167.0/24', '13.66.139.0/24', '13.66.144.0/24', '52.167.144.0/24', '13.67.10.16/28', '13.69.66.240/28', '13.71.172.224/28', '139.217.52.0/28', '191.233.204.224/28', '20.36.108.32/28', '20.43.120.16/28', '40.79.131.208/28', '40.79.186.176/28', '52.231.148.0/28', '20.79.107.240/28', '51.105.67.0/28', '20.125.163.80/28', '40.77.188.0/22', '65.55.210.0/24', '199.30.24.0/23', '40.77.202.0/24', '40.77.139.0/25', '20.74.197.0/28', '20.15.133.160/27', '40.77.177.0/24', '40.77.178.0/23', ), // DuckDuckGo. // https://duckduckgo.com/duckduckgo-help-pages/results/duckduckbot. 'DuckDuckBot' => array( '57.152.72.128', '51.8.253.152', '40.80.242.63', '20.12.141.99', '20.49.136.28', '51.116.131.221', '51.107.40.209', '20.40.133.240', '20.50.168.91', '51.120.48.122', '20.193.45.113', '40.76.173.151', '40.76.163.7', '20.185.79.47', '52.142.26.175', '20.185.79.15', '52.142.24.149', '40.76.162.208', '40.76.163.23', '40.76.162.191', '40.76.162.247', '40.88.21.235', '20.191.45.212', '52.146.59.12', '52.146.59.156', '52.146.59.154', '52.146.58.236', '20.62.224.44', '51.104.180.53', '51.104.180.47', '51.104.180.26', '51.104.146.225', '51.104.146.235', '20.73.202.147', '20.73.132.240', '20.71.12.143', '20.56.197.58', '20.56.197.63', '20.43.150.93', '20.43.150.85', '20.44.222.1', '40.89.243.175', '13.89.106.77', '52.143.242.6', '52.143.241.111', '52.154.60.82', '20.197.209.11', '20.197.209.27', '20.226.133.105', '191.234.216.4', '191.234.216.178', '20.53.92.211', '20.53.91.2', '20.207.99.197', '20.207.97.190', '40.81.250.205', '40.64.106.11', '40.64.105.247', '20.72.242.93', '20.99.255.235', '20.113.3.121', '52.224.16.221', '52.224.21.53', '52.224.20.204', '52.224.21.19', '52.224.20.249', '52.224.20.203', '52.224.20.190', '52.224.16.229', '52.224.21.20', '52.146.63.80', '52.224.20.227', '52.224.20.193', '52.190.37.160', '52.224.21.23', '52.224.20.223', '52.224.20.181', '52.224.21.49', '52.224.21.55', '52.224.21.61', '52.224.19.152', '52.224.20.186', '52.224.21.27', '52.224.21.51', '52.224.20.174', '52.224.21.4', '51.104.164.109', '51.104.167.71', '51.104.160.177', '51.104.162.149', '51.104.167.95', '51.104.167.54', '51.104.166.111', '51.104.167.88', '51.104.161.32', '51.104.163.250', '51.104.164.189', '51.104.167.19', '51.104.160.167', '51.104.167.110', '20.191.44.119', '51.104.167.104', '20.191.44.234', '51.104.164.215', '51.104.167.52', '20.191.44.22', '51.104.167.87', '51.104.167.96', '20.191.44.16', '51.104.167.61', '51.104.164.147', '20.50.48.159', '40.114.182.172', '20.50.50.130', '20.50.50.163', '20.50.50.46', '40.114.182.153', '20.50.50.118', '20.50.49.55', '20.50.49.25', '40.114.183.251', '20.50.50.123', '20.50.49.237', '20.50.48.192', '20.50.50.134', '51.138.90.233', '40.114.183.196', '20.50.50.146', '40.114.183.88', '20.50.50.145', '20.50.50.121', '20.50.49.40', '51.138.90.206', '40.114.182.45', '51.138.90.161', '20.50.49.0', '40.119.232.215', '104.43.55.167', '40.119.232.251', '40.119.232.50', '40.119.232.146', '40.119.232.218', '104.43.54.127', '104.43.55.117', '104.43.55.116', '104.43.55.166', '52.154.169.50', '52.154.171.70', '52.154.170.229', '52.154.170.113', '52.154.171.44', '52.154.172.2', '52.143.244.81', '52.154.171.87', '52.154.171.250', '52.154.170.28', '52.154.170.122', '52.143.243.117', '52.143.247.235', '52.154.171.235', '52.154.171.196', '52.154.171.0', '52.154.170.243', '52.154.170.26', '52.154.169.200', '52.154.170.96', '52.154.170.88', '52.154.171.150', '52.154.171.205', '52.154.170.117', '52.154.170.209', '191.235.202.48', '191.233.3.202', '191.235.201.214', '191.233.3.197', '191.235.202.38', '20.53.78.144', '20.193.24.10', '20.53.78.236', '20.53.78.138', '20.53.78.123', '20.53.78.106', '20.193.27.215', '20.193.25.197', '20.193.12.126', '20.193.24.251', '20.204.242.101', '20.207.72.113', '20.204.242.19', '20.219.45.67', '20.207.72.11', '20.219.45.190', '20.204.243.55', '20.204.241.148', '20.207.72.110', '20.204.240.172', '20.207.72.21', '20.204.246.81', '20.207.107.181', '20.204.246.254', '20.219.43.246', '52.149.25.43', '52.149.61.51', '52.149.58.139', '52.149.60.38', '52.148.165.38', '52.143.95.162', '52.149.56.151', '52.149.30.45', '52.149.58.173', '52.143.95.204', '52.149.28.83', '52.149.58.69', '52.148.161.87', '52.149.58.27', '52.149.28.18', '20.79.226.26', '20.79.239.66', '20.79.238.198', '20.113.14.159', '20.75.144.152', '20.43.172.120', '20.53.134.160', '20.201.15.208', '20.93.28.24', '20.61.34.40', '52.242.224.168', '20.80.129.80', '20.195.108.47', '4.195.133.120', '4.228.76.163', '4.182.131.108', '4.209.224.56', '108.141.83.74', '4.213.46.14', '172.169.17.165', '51.8.71.117', '20.3.1.178', ), // OpenAI Search Bot. // https://platform.openai.com/docs/bots/overview-of-openai-crawlers. // https://openai.com/searchbot.json. 'OAI-SearchBot' => array( '20.42.10.176/28', '172.203.190.128/28', '104.210.140.128/28', '51.8.102.0/24', '135.234.64.0/24', ), // Perplexity Search Bot. // https://www.perplexity.com/perplexitybot.json. 'PerplexityBot' => array( '107.20.236.150/32', '3.224.62.45/32', '18.210.92.235/32', '3.222.232.239/32', '3.211.124.183/32', '3.231.139.107/32', '18.97.1.228/30', '18.97.9.96/29', ), // YandexBot. // https://yandex.com/support/webmaster/en/robot-workings/check-yandex-robots.html. 'YandexBot' => array( '5.45.192.0/18', '5.255.192.0/18', '37.9.64.0/18', '37.140.128.0/18', '77.88.0.0/18', '84.252.160.0/19', '87.250.224.0/19', '90.156.176.0/22', '93.158.128.0/18', '95.108.128.0/17', '141.8.128.0/18', '178.154.128.0/18', '213.180.192.0/19', '185.32.187.0/24', ), ); /** * Define the permitted user agents and their IP address ranges that can bypass * Restrict Content to index content for search engines. * * @since 2.4.2 * * @param array $permitted Permitted user agent and IP address ranges. */ $permitted_user_agent_ip_ranges = apply_filters( 'convertkit_output_restrict_content_is_crawler_permitted_user_agent_ip_ranges', $permitted_user_agent_ip_ranges ); // Not a crawler if no user agent defined or client IP address defined. if ( ! array_key_exists( 'HTTP_USER_AGENT', $_SERVER ) || ! array_key_exists( 'REMOTE_ADDR', $_SERVER ) ) { return false; } // Iterate through permitted crawler IP addresses. foreach ( $permitted_user_agent_ip_ranges as $permitted_user_agent => $permitted_ip_addresses ) { // Skip this user agent's IP addresses if the client user agent doesn't contain this user agent. if ( stripos( sanitize_text_field( wp_unslash( $_SERVER['HTTP_USER_AGENT'] ) ), $permitted_user_agent ) === false ) { continue; } // Check IP address. foreach ( $permitted_ip_addresses as $permitted_ip_range ) { if ( ! $this->ip_in_range( sanitize_text_field( wp_unslash( $_SERVER['REMOTE_ADDR'] ) ), $permitted_ip_range ) ) { continue; } // The client user agent and IP address match a known crawler and its IP address. // This is a crawler. return true; } } // If here, the client IP address isn't from a crawler. return false; } /** * Determines if the given IP address falls within the given CIDR range. * * @since 2.4.2 * * @param string $ip Client IP Address (e.g. 127.0.0.1). * @param string $range IP Address and bits (e.g. 127.0.0.1/27). * @return bool Client IP Address matches range. */ public function ip_in_range( $ip, $range ) { // Return false if the IP address isn't valid. if ( ! filter_var( $ip, FILTER_VALIDATE_IP ) ) { return false; } // Return false if the range doesn't include the CIDR. if ( strpos( $range, '/' ) === false ) { return false; } // Get subnet and bits from range. list( $subnet, $bits ) = explode( '/', $range ); // Return false if the CIDR isn't numerical. if ( ! is_numeric( $bits ) ) { return false; } // Cast CIDR to integer. $bits = (int) $bits; // Return false if the CIDR is not wihtin the permitted range. if ( $bits < 0 || $bits > 32 ) { return false; } // Convert to long representation. $ip = ip2long( $ip ); $subnet = ip2long( $subnet ); $mask = -1 << ( 32 - $bits ); // If the supplied subnet wasn't correctly aligned. $subnet &= $mask; return ( $ip & $mask ) === $subnet; } } ```