Wala shell

Advanced PHP File Manager

Server IP: 127.0.0.1 | PHP Version: 8.3.30 | Domains Hosted: 54

Name	Size	Last Modified	Actions
📁 ..	-	2025-10-27 18:36
📄 admin.php <?php /** * Admin class * * Handles admin settings related REST API endpoints for the SureRank plugin. * * @package SureRank\Inc\API / namespace SureRank\Inc\API; use SureRank\Inc\Admin\Update_Timestamp; use SureRank\Inc\Functions\Get; use SureRank\Inc\Functions\Helper; use SureRank\Inc\Functions\Send_Json; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Functions\Update; use SureRank\Inc\Meta_Variables\Post; use SureRank\Inc\Meta_Variables\Site; use SureRank\Inc\Meta_Variables\Term; use SureRank\Inc\Traits\Get_Instance; use WP_REST_Request; use WP_REST_Server; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Class Admin * * Handles admin settings related REST API endpoints. / class Admin extends Api_Base { use Get_Instance; /* * Route Editor / protected const EDITOR = '/admin/editor'; /* * Route Get Admin Settings / protected const ADMIN_SETTINGS = '/admin/global-settings'; /* * Route Get Site Settings / protected const SITE_SETTINGS = '/admin/site-settings'; /* * Constructor * * @since 1.0.0 / public function __construct() { } /* * Register API routes. * * @since 1.0.0 * @return void / public function register_routes() { $namespace = $this->get_api_namespace(); $this->register_all_admin_routes( $namespace ); } /* * Retrieves email logs with optional filters and search. * * @param WP_REST_Request<array<string, mixed>> $request The REST request object. * @return void / public function get_initials( $request ) { $post_id = $request->get_param( 'post_id' ); $term_id = $request->get_param( 'term_id' ); if ( empty( $post_id ) && empty( $term_id ) ) { Send_Json::error( [ 'message' => __( 'Post id or term id is required', 'surerank' ) ] ); } Send_Json::success( [ 'variables' => $this->get_variables( $request->get_param( 'post_id' ), $request->get_param( 'term_id' ) ), 'other' => $this->get_other_data(), ] ); } /* * Get variables * * @param int\|null $post_id Post ID. * @param int\|null $term_id Term ID. * @since 1.0.0 * @return array<string, array<string, mixed>> Array of variable groups keyed by type (e.g., term, post, site). / public function get_variables( $post_id = null, $term_id = null ) { $meta_variable_instances = []; if ( ! empty( $term_id ) ) { $meta_variable_instances['term'] = Term::get_instance(); } if ( ! empty( $post_id ) ) { $meta_variable_instances['post'] = Post::get_instance(); } $meta_variable_instances['site'] = Site::get_instance(); $variables = []; foreach ( $meta_variable_instances as $key => $instance ) { if ( ! empty( $post_id ) && method_exists( $instance, 'set_post' ) ) { $instance->set_post( $post_id ); } if ( ! empty( $term_id ) && method_exists( $instance, 'set_term' ) ) { $instance->set_term( $term_id ); } $variables[ $key ] = $instance->get_all_values(); } return $variables; } /* * Get other data. * * @since 1.0.0 * @return array<string, string> / public function get_other_data() { $data = []; // Get site favicon icon. $data['favicon_url'] = $this->get_favicon(); return $data; } /* * Get admin settings * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @since 1.0.0 * @return void / public function get_admin_settings( $request ) { $data = Settings::get(); $data['surerank_analytics_optin'] = Get::option( 'surerank_analytics_optin' ) === 'yes' ? true : false; $decode_data = Utils::decode_html_entities_recursive( $data ) ?? $data; Send_Json::success( [ 'data' => $decode_data ] ); } /* * Update admin settings * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @since 1.0.0 * @return void / public function update_admin_settings( $request ) { $data = $request->get_param( 'data' ); if ( empty( $data ) ) { Send_Json::error( [ 'message' => __( 'No data found', 'surerank' ) ] ); } $this->update_global_options( $data ); } /* * Update global options. * * @param array<string, mixed> $data Data. * @since 1.0.0 * @return void / public function update_global_options( $data ) { // Allow pro plugin to handle extended meta templates toggle detection BEFORE getting any settings. do_action( 'surerank_admin_settings_before_processing', $data ); $db_options = Settings::get(); $updated_options = $this->get_updated_options( $data, $db_options ); Helper::update_flush_rules( $updated_options ); $data = $this->process_social_profile_updates( $data, $updated_options ); $data = array_merge( $db_options, $data ); $data = $this->process_surerank_analytics_optin( $data ); if ( Update::option( SURERANK_SETTINGS, $data ) ) { Update_Timestamp::timestamp_option(); } Send_Json::success( [ 'message' => __( 'Settings updated', 'surerank' ) ] ); } /* * Process surerank analytics optin * * @param array<string, mixed> $data Data. * @since 1.0.0 * @return array<string, mixed> / public function process_surerank_analytics_optin( $data ) { if ( ! isset( $data['surerank_analytics_optin'] ) ) { return $data; } $surerank_analytics_optin = $data['surerank_analytics_optin'] ? 'yes' : 'no'; Update::option( 'surerank_analytics_optin', $surerank_analytics_optin ); unset( $data['surerank_analytics_optin'] ); return $data; } /* * Get site settings * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @since 1.0.0 * @return void / public function get_site_settings( $request ) { $data = $this->prepare_site_settings_data(); Send_Json::success( [ 'data' => $data ] ); } /* * Get updated options * * @param array<string, mixed\|array> $data First array. * @param array<string, mixed\|array> $db_options Second array. * @param string $parent_key Parent key. * * @return array<int, string> Updated option keys. / public function get_updated_options( $data, $db_options, $parent_key = '' ) { $diff_keys = []; foreach ( $data as $key => $value ) { if ( 'default_global_meta' === $key ) { continue; } if ( is_array( $value ) ) { if ( isset( $db_options[ $key ] ) && is_array( $db_options[ $key ] ) ) { $nested_diff = $this->get_updated_options( $value, $db_options[ $key ], $key ); if ( ! empty( $nested_diff ) ) { $diff_keys[] = $key; } } else { $diff_keys[] = $key; } } else { if ( ! isset( $db_options[ $key ] ) \|\| $db_options[ $key ] !== $value ) { $diff_keys[] = $key; } } } return array_unique( $diff_keys ); } /* * Process Onboarding Data * * @param array<string, mixed> $data Data. * @param array<string, mixed> $settings Settings. * @since 1.0.0 * @return void / public function process_onboarding_data( $data, &$settings ) { Onboarding::get_instance()->set_social_schema( $data, $settings ); } /* * Register all admin routes * * @param string $namespace The API namespace. * @return void / private function register_all_admin_routes( $namespace ) { $this->register_editor_route( $namespace ); $this->register_admin_settings_routes( $namespace ); $this->register_site_settings_route( $namespace ); } /* * Register editor route * * @param string $namespace The API namespace. * @return void / private function register_editor_route( $namespace ) { register_rest_route( $namespace, self::EDITOR, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_initials' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_editor_args(), ] ); } /* * Register admin settings routes * * @param string $namespace The API namespace. * @return void / private function register_admin_settings_routes( $namespace ) { $this->register_get_admin_settings_route( $namespace ); $this->register_update_admin_settings_route( $namespace ); } /* * Register get admin settings route * * @param string $namespace The API namespace. * @return void / private function register_get_admin_settings_route( $namespace ) { register_rest_route( $namespace, self::ADMIN_SETTINGS, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_admin_settings' ], 'permission_callback' => [ $this, 'validate_permission' ], ] ); } /* * Register update admin settings route * * @param string $namespace The API namespace. * @return void / private function register_update_admin_settings_route( $namespace ) { register_rest_route( $namespace, self::ADMIN_SETTINGS, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'update_admin_settings' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_admin_settings_update_args(), ] ); } /* * Register site settings route * * @param string $namespace The API namespace. * @return void / private function register_site_settings_route( $namespace ) { register_rest_route( $namespace, self::SITE_SETTINGS, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_site_settings' ], 'permission_callback' => [ $this, 'validate_permission' ], ] ); } /* * Get editor route arguments * * @return array<string, array<string, mixed>> / private function get_editor_args() { return [ 'post_id' => [ 'type' => 'integer', 'sanitize_callback' => 'absint', ], 'term_id' => [ 'type' => 'integer', 'sanitize_callback' => 'absint', ], ]; } /* * Get admin settings update arguments * * @return array<string, array<string, mixed>> / private function get_admin_settings_update_args() { return [ 'data' => [ 'type' => 'object', 'required' => true, 'sanitize_callback' => [ $this, 'sanitize_array_data' ], ], ]; } /* * Process social profile updates * * @param array<string, mixed> $data Data. * @param array<string> $updated_options Updated options. * @return array<string, mixed> / private function process_social_profile_updates( $data, $updated_options ) { if ( $this->should_update_social_profiles( $updated_options ) ) { $data = $this->update_social_profile_data( $data ); $this->process_onboarding_data( $data, $data ); } return $data; } /* * Check if social profiles should be updated * * @param array<string> $updated_options Updated options. * @return bool / private function should_update_social_profiles( $updated_options ) { return is_array( $updated_options ) && array_intersect( [ 'social_profiles', 'facebook_page_url', 'twitter_profile_username' ], $updated_options ); } /* * Update social profile data * * @param array<string, mixed> $data Data. * @return array<string, mixed> / private function update_social_profile_data( $data ) { $data['social_profiles']['facebook'] = $data['facebook_page_url'] ?? ''; if ( ! empty( $data['twitter_profile_username'] ) ) { $data['social_profiles']['twitter'] = str_replace( '@', '', $data['twitter_profile_username'] ); } return $data; } /* * Prepare site settings data * * @return array<string, mixed> / private function prepare_site_settings_data() { $data = []; $data['site'] = $this->get_site_variables(); $data['is_wc_active'] = class_exists( 'WooCommerce' ); $home_page_data = $this->get_home_page_data(); return array_merge( $data, $home_page_data ); } /* * Get home page data * * @return array<string, mixed> / private function get_home_page_data() { $show_option = Get::option( 'show_on_front' ); $page_on_front = Get::option( 'page_on_front' ); $home_page_id = intval( $page_on_front ); $featured_image = get_the_post_thumbnail_url( $home_page_id, 'full' ); $data = [ 'home_page_static' => $show_option, 'home_page_featured_image' => $featured_image ? $featured_image : false, ]; if ( $this->is_static_home_page( $show_option, $page_on_front ) ) { $data = array_merge( $data, $this->get_static_home_page_data( $home_page_id ) ); } return $data; } /* * Check if home page is static * * @param string $show_option Show on front option. * @param mixed $page_on_front Page on front ID. * @return bool / private function is_static_home_page( $show_option, $page_on_front ) { return 'page' === $show_option && ! empty( $page_on_front ) && ( is_string( $page_on_front ) \|\| is_int( $page_on_front ) ); } /* * Get static home page data * * @param int $home_page_id Home page ID. * @return array<string, mixed> / private function get_static_home_page_data( $home_page_id ) { $page_url = get_edit_post_link( $home_page_id ); return [ 'home_page_id' => $home_page_id, 'home_page_edit_url' => $this->sanitize_edit_url( $page_url ), ]; } /* * Sanitize edit URL * * @param mixed $page_url Page URL. * @return string */ private function sanitize_edit_url( $page_url ) { return '' !== $page_url && is_string( $page_url ) ? html_entity_decode( $page_url, ENT_QUOTES \| ENT_HTML5, 'UTF-8' ) : ''; } }	13.22 KB	2025-10-27 18:36
📄 analyzer.php <?php /** * Analyzer API class. * * Handles SEO-related REST API endpoints for the SureRank plugin. * * @package SureRank\Inc\API / namespace SureRank\Inc\API; use DOMXPath; use SureRank\Inc\Analyzer\Scraper; use SureRank\Inc\Analyzer\SeoAnalyzer; use SureRank\Inc\Analyzer\Utils; use SureRank\Inc\Functions\Get; use SureRank\Inc\Functions\Requests; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Functions\Update; use SureRank\Inc\GoogleSearchConsole\Controller; use SureRank\Inc\Traits\Get_Instance; use SureRank\Inc\Traits\Logger; use WP_Error; use WP_REST_Request; use WP_REST_Response; use WP_REST_Server; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Class Analyzer * * Handles SEO analysis REST API endpoints. / class Analyzer extends Api_Base { use Get_Instance; use Logger; /* * Route for general SEO checks. * * @var string / private $general_checks = '/checks/general'; /* * Route for settings checks. * * @var string / private $settings_checks = '/checks/settings'; /* * Route for other SEO checks. * * @var string / private $other_checks = '/checks/other'; /* * Route for broken links check. * * @var string / private $broken_links_check = '/checks/broken-link'; /* * Page Seo Status * * @var string / private $page_seo_checks = '/checks/page'; /* * Taxonomy Seo Status * * @var string / private $taxonomy_seo_checks = '/checks/taxonomy'; /* * Route for sitemap check. * * @var string / private $ignore_checks = '/checks/ignore-site-check'; /* * Route for post-specific ignore checks. * * @var string / private $ignore_post_checks = '/checks/ignore-page-check'; /* * Register API routes. * * @return void / public function register_routes() { $namespace = $this->get_api_namespace(); $this->register_all_analyzer_routes( $namespace ); } /* * Get page SEO checks. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return WP_REST_Response\|WP_Error / public function get_page_seo_checks( $request ) { $post_id = $request->get_param( 'post_id' ); $validation_error = $this->validate_post_id( $post_id ); if ( $validation_error ) { return $validation_error; } $post = get_post( (int) $post_id ); if ( ! $post ) { return $this->create_error_response( __( 'Invalid Post ID.', 'surerank' ) ); } if ( $this->is_post_cache_valid( $post, $post_id ) ) { $cached_response = $this->get_cached_post_checks( $post_id ); if ( $cached_response ) { return $cached_response; } } return $this->run_and_return_post_checks( $post_id ); } /* * Get taxonomy seo checks. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return WP_REST_Response\|WP_Error / public function get_taxonomy_seo_checks( $request ) { $term_id = $request->get_param( 'term_id' ); if ( ! $term_id ) { return $this->create_error_response( __( 'Taxonomy and term ID are required.', 'surerank' ) ); } if ( $this->is_taxonomy_cache_valid( $term_id ) ) { $cached_response = $this->get_cached_taxonomy_checks( $term_id ); if ( $cached_response ) { return $cached_response; } } return $this->run_and_return_taxonomy_checks( $term_id ); } /* * Get general SEO checks for a URL or homepage. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return WP_REST_Response\|WP_Error / public function get_general_checks( $request ) { $url = $request->get_param( 'url' ); $force = $request->get_param( 'force' ); if ( $this->cache_exists( 'general' ) && ! $force ) { return rest_ensure_response( $this->get_cached_response( 'general' ) ); } return rest_ensure_response( $this->run_general_checks( $url ) ); } /* * Ignore site-wide checks. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return WP_REST_Response\|WP_Error / public function ignore_checks( $request ) { $id = $request->get_param( 'id' ); $ignore_checks = $this->get_ignore_checks(); if ( ! in_array( $id, $ignore_checks, true ) ) { $ignore_checks[] = $id; } $seo_checks = Get::option( 'surerank_site_seo_checks', [] ); foreach ( $seo_checks as $key => $check ) { if ( isset( $check[ $id ] ) ) { $check[ $id ]['ignore'] = true; $seo_checks[ $key ] = $check; } } Update::option( 'surerank_site_seo_checks', $seo_checks ); Update::option( 'surerank_ignored_site_checks_list', array_values( $ignore_checks ) ); return rest_ensure_response( [ 'status' => 'success', 'message' => __( 'Checks ignored.', 'surerank' ), ] ); } /* * Delete ignore checks. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return WP_REST_Response\|WP_Error / public function delete_ignore_checks( $request ) { $id = $request->get_param( 'id' ); $ignore_checks = $this->get_ignore_checks(); if ( in_array( $id, $ignore_checks, true ) ) { $ignore_checks = array_diff( $ignore_checks, [ $id ] ); } $seo_checks = Get::option( 'surerank_site_seo_checks', [] ); foreach ( $seo_checks as $key => $check ) { if ( isset( $check[ $id ] ) ) { if ( isset( $check[ $id ]['ignore'] ) ) { unset( $check[ $id ]['ignore'] ); $seo_checks[ $key ] = $check; } } } Update::option( 'surerank_site_seo_checks', $seo_checks ); Update::option( 'surerank_ignored_site_checks_list', array_values( $ignore_checks ) ); return rest_ensure_response( [ 'success' => true, 'checks' => $ignore_checks, 'status' => 'success', 'message' => __( 'Checks unignored.', 'surerank' ), ] ); } /* * Get ignored checks list. * * @param array<string, mixed> $post_checks List of post checks. * @param int $post_id Post or term ID. * @param string $check_type Type of check, either 'post' or 'taxonomy'. * @return array<string, mixed> / public function get_updated_ignored_check_list( $post_checks, $post_id, $check_type = 'post' ) { $ignored_checks = $this->get_ignored_post_taxo_check( $post_id, $check_type ); if ( ! empty( $ignored_checks ) && is_array( $ignored_checks ) ) { foreach ( $post_checks as $key => $check ) { if ( in_array( $key, $ignored_checks, true ) ) { $post_checks[ $key ]['ignore'] = true; } } } return $post_checks; } /* * Get ignored checks. * * @param int $post_id Post or term ID. * @param string $check_type Type of check, either 'post' or 'taxonomy'. * @return array<string, mixed> / public function get_ignored_post_taxo_check( $post_id, $check_type = 'post' ) { $ignored_checks = null; if ( $check_type === 'taxonomy' ) { $ignored_checks = $this->get_ignore_taxonomy_checks( $post_id ); } else { $ignored_checks = $this->get_ignore_post_checks( $post_id ); } if ( empty( $ignored_checks ) \|\| ! is_array( $ignored_checks ) ) { $ignored_checks = []; } return $ignored_checks; } /* * Update ignored post or taxonomy checks. * * @param int $post_id Post or term ID. * @param string $check_type Type of check, either 'post' or 'taxonomy'. * @param array<string> $checks List of checks to ignore. * @return void / public function update_ignored_post_taxo_check( $post_id, $check_type = 'post', $checks = [] ) { if ( $check_type === 'taxonomy' ) { Update::term_meta( $post_id, 'surerank_ignored_post_checks', array_values( $checks ) ); } else { Update::post_meta( $post_id, 'surerank_ignored_post_checks', array_values( $checks ) ); } } /* * Ignore post-specific checks. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return WP_REST_Response\|WP_Error / public function ignore_post_taxo_check( $request ) { $id = $request->get_param( 'id' ); $post_id = $request->get_param( 'post_id' ); $check_type = $request->get_param( 'check_type' ); $ignore_checks = $this->get_ignored_post_taxo_check( $post_id, $check_type ); if ( ! in_array( $id, $ignore_checks, true ) ) { $ignore_checks[] = $id; $this->update_ignored_post_taxo_check( $post_id, $check_type, $ignore_checks ); } return rest_ensure_response( [ 'success' => true, 'status' => 'success', 'message' => __( 'Check ignored for post.', 'surerank' ), 'checks' => $ignore_checks, ] ); } /* * Delete post-specific ignore checks. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return WP_REST_Response\|WP_Error / public function delete_ignore_post_taxo_check( $request ) { $id = $request->get_param( 'id' ); $post_id = $request->get_param( 'post_id' ); $check_type = $request->get_param( 'check_type' ); $ignore_checks = $this->get_ignored_post_taxo_check( $post_id, $check_type ); if ( in_array( $id, $ignore_checks, true ) ) { $ignore_checks = array_values( array_diff( $ignore_checks, [ $id ] ) ); $this->update_ignored_post_taxo_check( $post_id, $check_type, $ignore_checks ); } return rest_ensure_response( [ 'success' => true, 'status' => 'success', 'message' => __( 'Check unignored for post.', 'surerank' ), 'checks' => $ignore_checks, ] ); } /* * Get ignored checks. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return WP_REST_Response\|WP_Error / public function get_ignore_post_taxo_check( $request ) { $post_id = (int) $request->get_param( 'post_id' ); $check_type = $request->get_param( 'check_type' ); $ignore_checks = $this->get_ignored_post_taxo_check( $post_id, $check_type ); return rest_ensure_response( [ 'success' => true, 'status' => 'success', 'message' => __( 'Ignored checks retrieved.', 'surerank' ), 'checks' => $ignore_checks, ] ); } /* * Get settings checks. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return WP_REST_Response\|WP_Error / public function get_settings_checks( $request ) { $force = $request->get_param( 'force' ); if ( $this->cache_exists( 'settings' ) && ! $force ) { return rest_ensure_response( $this->get_cached_response( 'settings' ) ); } return rest_ensure_response( $this->run_settings_checks() ); } /* * Get other SEO checks for a URL or homepage. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return WP_REST_Response\|WP_Error / public function get_other_checks( $request ) { $force = $request->get_param( 'force' ); if ( $this->cache_exists( 'other' ) && ! $force ) { return rest_ensure_response( $this->get_cached_response( 'other' ) ); } return rest_ensure_response( $this->run_other_checks() ); } /* * Get authentication status. * * @return array<string, mixed> / public function get_auth_status() { $auth_status = Controller::get_instance()->get_auth_status() && Settings::get( 'enable_google_console' ); $working_label = __( 'Google Search Console is connected.', 'surerank' ); $not_working_label = __( 'Google Search Console is not connected.', 'surerank' ); $helptext = [ __( 'Google Search Console is a free tool that shows how your site is doing in Google search — how many people are finding it, what they’re searching for, and which pages are getting the most attention.', 'surerank' ), __( 'Connecting Search Console to your site doesn’t change anything on the front end — but it gives you a behind-the-scenes view of what’s working. SureRank uses this connection to show useful insights directly in your dashboard.', 'surerank' ), sprintf( '<h6> %s </h6>', __( 'Why it matters:', 'surerank' ) ), sprintf( "Without <a href='%s'>Search Console</a>, you're flying blind. With it, you get a clear picture of your visibility, clicks, and search appearance — so you can make smarter decisions.", $this->get_search_console_url() ), sprintf( '<h6> %s </h6>', __( 'What you can do:', 'surerank' ) ), sprintf( "If you haven’t already, set up Google Search Console and connect it in the <a href='%s'>SureRank Search Console</a>. It only takes a minute, and once connected, you’ll start seeing real data about how your site is doing in search.", $this->get_search_console_url() ), ]; return [ 'exists' => true, 'status' => $auth_status ? 'success' : 'suggestion', 'description' => $helptext, 'message' => $auth_status ? $working_label : $not_working_label, ]; } /* * Get list of installed SEO plugins with detection info. * * @return array{active_plugins: array<int, string>, detected_plugins: array<int, array<string, string>>} * @since 1.4.0 / public function get_installed_seo_plugins_data(): array { $seo_plugins = [ 'seo-by-rank-math/rank-math.php' => [ 'name' => 'Rank Math', 'pro_slug' => 'seo-by-rank-math-pro/rank-math-pro.php', ], 'wordpress-seo/wp-seo.php' => [ 'name' => 'Yoast SEO', 'pro_slug' => 'wordpress-seo-premium/wp-seo-premium.php', ], 'autodescription/autodescription.php' => [ 'name' => 'The SEO Framework', 'pro_slug' => '', ], 'all-in-one-seo-pack/all_in_one_seo_pack.php' => [ 'name' => 'AIOSEO', 'pro_slug' => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php', ], 'wp-seopress/seopress.php' => [ 'name' => 'SEOPress', 'pro_slug' => 'wp-seopress-pro/wp-seopress-pro.php', ], 'slim-seo/slim-seo.php' => [ 'name' => 'Slim SEO', 'pro_slug' => 'slim-seo-pro/slim-seo-pro.php', ], 'squirrly-seo/squirrly.php' => [ 'name' => 'Squirrly SEO', 'pro_slug' => '', ], ]; $active_plugins = apply_filters( 'active_plugins', get_option( 'active_plugins', [] ) ); $detected_plugins = []; foreach ( $seo_plugins as $file => $data ) { if ( in_array( $file, $active_plugins, true ) ) { $detected_plugins[] = [ 'name' => $data['name'], 'slug' => $file, 'pro_slug' => $data['pro_slug'], ]; } } return [ 'active_plugins' => $active_plugins, 'detected_plugins' => $detected_plugins, ]; } /* * Analyze installed SEO plugins. * * @return array<string, mixed> / public function get_installed_seo_plugins(): array { $description = [ __( 'SEO plugins help manage how your site appears in search engines. They control important things like titles, meta descriptions, canonical tags, and structured data. ', 'surerank' ), ]; $plugin_data = $this->get_installed_seo_plugins_data(); $detected_plugins = array_map( static function( $plugin ) { return [ 'name' => $plugin['name'] ]; }, $plugin_data['detected_plugins'] ); $active_count = count( $detected_plugins ); $title = __( 'No other SEO plugin detected on the site.', 'surerank' ); if ( $active_count > 0 ) { if ( $active_count > 1 ) { $title = __( 'More than one SEO plugin detected on the site.', 'surerank' ); } else { / translators: %s is the list of active plugins / $title = sprintf( __( 'Another SEO plugin, %s, detected on the site.', 'surerank' ), implode( ', ', array_column( $detected_plugins, 'name' ) ) ); } / translators: %s is the list of active plugins / $description[] = sprintf( __( 'Currently active plugins : %s', 'surerank' ), implode( ', ', array_column( $detected_plugins, 'name' ) ) ); $description[] = __( 'But here’s something many site owners don’t realize — using more than one SEO plugin at the same time can lead to issues.', 'surerank' ); } $description[] = sprintf( '<h6> %s </h6>', __( 'Why this matters:', 'surerank' ) ); $description[] = __( 'Most SEO plugins try to manage the same parts of your site. When two plugins do this together, they can send mixed signals to search engines. This might affect how your content is indexed or shown in results. It also makes it harder to know which tool is changing what.', 'surerank' ); $description[] = sprintf( '<h6> %s </h6>', __( 'What to keep in mind:', 'surerank' ) ); $description[] = __( 'Keeping just one SEO plugin active ensures your settings stay clean and consistent. It’s easier to manage, avoids conflicts, and helps search engines read your site clearly.', 'surerank' ); $description[] = __( 'SureRank is designed to handle everything you need in one place — so there’s no need for multiple plugins doing the same job.', 'surerank' ); return [ 'exists' => true, 'status' => $active_count > 0 ? 'error' : 'success', 'description' => $description, 'message' => $title, ]; } /* * Analyze site tagline. * * @return array<string, mixed> / public function get_site_tag_line(): array { $tagline = get_bloginfo( 'description' ); $is_set = ! empty( $tagline ); $title = $is_set ? __( 'Site tagline is set in WordPress settings.', 'surerank' ) : __( 'Site tagline is not set in WordPress settings.', 'surerank' ); $description = [ __( 'Your site tagline is a simple line that helps explain what your website is about. It often shows up in the browser tab, homepage, or in search snippets — depending on your theme or SEO settings.', 'surerank' ), __( 'Leaving it blank, using a default message like “Just another WordPress site,” or writing something unclear doesn’t help people or search engines understand your site.', 'surerank' ), sprintf( '<h6> %s </h6>', __( 'Why this matters:', 'surerank' ) ), __( 'A good tagline can instantly tell visitors what your site offers — and make it more appealing in search results. Think of it like a mini pitch that follows your site name.', 'surerank' ), sprintf( '<h6> %s </h6>', __( 'What you can do:', 'surerank' ) ), __( 'Write one short sentence that describes your site’s purpose or audience. For example: ', 'surerank' ), __( '“Simple budgeting tools for everyday people”', 'surerank' ), __( '“Home workouts and fitness tips that fit your schedule”', 'surerank' ), __( 'Keep it short, specific, and friendly. You can change it from the WordPress settings.', 'surerank' ), sprintf( / translators: %s is the URL of the surerank settings page / __( 'Set the site tagline on <a href="%s">General settings page</a>.', 'surerank' ), $this->get_wordpress_settings_url( 'general' ) ), ]; return [ 'exists' => true, 'status' => $is_set ? 'success' : 'warning', 'description' => $description, 'message' => $title, ]; } /* * Analyze robots.txt. * * @return array<string, mixed> / public function robots_txt() { $robots_url = home_url( '/robots.txt' ); $working_label = __( 'Robots.txt file is accessible.', 'surerank' ); $not_working_label = __( 'Robots.txt file is not accessible.', 'surerank' ); $helptext = [ __( 'Your site uses a small file called robots.txt to guide search engines on where they can and can’t go. It’s like a set of instructions that says, “You’re welcome to look here — but please don’t touch this part.”', 'surerank' ), __( 'Most of the time, WordPress creates this automatically. But if the file is missing or misconfigured, search engines might avoid pages they’re actually allowed to visit — or worse, miss important content altogether.', 'surerank' ), sprintf( '<h6> %s </h6>', __( 'Why it matters:', 'surerank' ) ), __( 'Without a robots.txt file, search engines may not crawl your site properly, or they might spend too much time on pages that don’t matter. With a working file, your site can be explored more efficiently.', 'surerank' ), sprintf( '<h6> %s </h6>', __( 'What you can do:', 'surerank' ) ), __( 'Check if your robots.txt file is available by visiting yourdomain.com/robots.txt in your browser. If it opens and lists some basic rules (even if you don’t understand them), that means it’s active. ', 'surerank' ), __( 'SureRank takes care of this by default — so if it’s missing, we’ll help you fix it easily.', 'surerank' ), ]; $response = Scraper::get_instance()->fetch_status( $robots_url ); if ( is_wp_error( $response ) \|\| $response !== 200 ) { return [ 'exists' => false, 'status' => 'warning', 'description' => $helptext, 'message' => $not_working_label, ]; } return [ 'exists' => true, 'status' => 'success', 'description' => $helptext, 'message' => $working_label, ]; } /* * Analyze site indexed. * * @return array<string, mixed> / public function index_status() { $index_status = get_option( 'blog_public' ); $no_index = $this->settings['no_index'] ?? []; $working_label = __( 'Search engine visibility is not blocked in WordPress settings.', 'surerank' ); $not_working_label = __( 'Search engine visibility is blocked in WordPress settings.', 'surerank' ); $helptext = [ __( 'Search engine visibility settings need to be enabled. The “Discourage search engines from indexing this site” option in WordPress settings must remain unchecked to allow normal crawling and indexing.', 'surerank' ), sprintf( / translators: %s is the URL of the surerank settings page / __( 'Set the search engine visibility on <a href="%s">WordPress Reading settings page</a>.', 'surerank' ), $this->get_wordpress_settings_url( 'reading' ) ), ]; $sensitive_post_types = [ 'post', 'page', 'product', 'product_variation', 'product_category', 'product_tag' ]; $noindex_types = array_intersect( $no_index, $sensitive_post_types ); if ( ! empty( $noindex_types ) ) { return [ 'exists' => false, 'status' => 'error', 'description' => $helptext, 'message' => $not_working_label, ]; } if ( ! $index_status ) { return [ 'exists' => false, 'status' => 'error', 'description' => $helptext, 'message' => $not_working_label, ]; } return [ 'exists' => true, 'status' => 'success', 'description' => $helptext, 'message' => $working_label, ]; } /* * Analyze sitemaps. * * @return array<string, mixed> / public function sitemaps(): array { $working_label = __( 'XML sitemap is accessible to search engines.', 'surerank' ); $not_working_label = __( 'XML sitemap is not accessible to search engines.', 'surerank' ); $helptext = [ __( 'A sitemap is like a guide or map that helps search engines explore your website more efficiently. It lists out the important pages on your site and gives search engines a clear path to follow — like a floor plan showing where everything is. This way, nothing important gets missed.', 'surerank' ), __( 'Think of it like this: if your website was a story, the sitemap would be the chapter list — helping Google and other search engines jump to the right sections. It doesn’t change how your site looks to visitors, but it makes a big difference in how your site is discovered and understood behind the scenes.', 'surerank' ), sprintf( '<h6> %s </h6>', __( 'Why it matters:', 'surerank' ) ), __( 'Without a sitemap, search engines might miss some of your pages or take longer to find new ones. That can slow down how quickly your updates appear in search results. With a sitemap, they get a clear overview of your content and can index it faster and more accurately — which can help improve visibility.', 'surerank' ), sprintf( '<h6> %s </h6>', __( 'What you can do:', 'surerank' ) ), __( 'Check that your sitemap is active and accessible. You can usually visit it at a link like yourdomain.com/sitemap.xml. If it opens and shows a list of links (even if it looks a bit technical), that means it’s working.', 'surerank' ), __( 'If you’ve connected tools like Google Search Console, you can also submit the sitemap there — but that’s optional. The key is to make sure it’s available and up to date so search engines can do their job properly.', 'surerank' ), ]; $sitemap_url = home_url( '/sitemap_index.xml' ); $sitemap = Scraper::get_instance()->fetch( $sitemap_url ); if ( is_wp_error( $sitemap ) \|\| empty( $sitemap ) ) { return [ 'exists' => false, 'status' => 'warning', 'description' => $helptext, 'message' => $not_working_label, ]; } if ( ! $this->is_valid_xml( $sitemap ) ) { return [ 'exists' => false, 'status' => 'warning', 'description' => $helptext, 'message' => $not_working_label, ]; } return [ 'exists' => true, 'status' => 'success', 'description' => $helptext, 'message' => $working_label, ]; } /* * Get surerank settings url. * * @param string $page Page slug. * @param string $parent Parent slug. * @return string / public function get_surerank_settings_url( string $page = '', string $parent = '' ) { if ( ! empty( $parent ) ) { return admin_url( 'admin.php?page=surerank' . ( $page ? "#/{$parent}/{$page}" : '' ) ); } return admin_url( 'admin.php?page=surerank' . ( $page ? "#/{$page}" : '' ) ); } /* * Get broken links check. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return WP_REST_Response\|WP_Error / public function get_broken_links_status( $request ) { $url = $request->get_param( 'url' ) ?? ''; $post_id = $request->get_param( 'post_id' ) ?? 0; $urls = $request->get_param( 'urls' ) ?? []; $post = get_post( $post_id ); if ( ! $post ) { return $this->create_broken_link_error_response( __( 'Post not found', 'surerank' ) ); } $response = $this->fetch_url_status( $url ); if ( is_wp_error( $response ) ) { return $this->handle_broken_link_error( $url, $post_id, $urls, $response ); } $status_code = (int) wp_remote_retrieve_response_code( $response ); if ( $status_code >= 400 ) { return $this->handle_broken_link_status_error( $url, $post_id, $urls, $status_code, $response ); } $this->remove_broken_links( $url, $post_id, $urls ); return rest_ensure_response( [ 'success' => true, 'message' => __( 'Link is not broken', 'surerank' ), ] ); } /* * Remove broken links. * * @param string $url URL. * @param int $post_id Post ID. * @param array<string> $urls URLs. * @return void / public function remove_broken_links( $url, $post_id, $urls ) { $seo_checks = Get::post_meta( $post_id, SURERANK_SEO_CHECKS, true ); $broken_links = $seo_checks['broken_links'] ?? []; $existing_broken_links = Utils::existing_broken_links( $broken_links, $urls ); foreach ( $existing_broken_links as $key => $existing_link ) { if ( is_array( $existing_link ) && isset( $existing_link['url'] ) && $existing_link['url'] === $url ) { unset( $existing_broken_links[ $key ] ); } } $seo_checks['broken_links'] = $existing_broken_links; Update::post_meta( $post_id, SURERANK_SEO_CHECKS, $seo_checks ); } /* * Run checks. * * @param int $post_id Post ID. * @return array<string, mixed>\|WP_Error / public function run_checks( $post_id ) { return Post::get_instance()->run_checks( $post_id ); } /* * Run taxonomy checks. * * @param int $term_id Term ID. * @return array<string, mixed>\|WP_Error / public function run_taxonomy_checks( $term_id ) { return Term::get_instance()->run_checks( $term_id ); } /* * Run general checks. * * @param string $url URL to run checks on. * @return array<string, mixed>\|WP_Error / public function run_general_checks( string $url ) { $analyzer = SeoAnalyzer::get_instance( $url ); $xpath = $analyzer->get_xpath(); if ( ! $xpath instanceof DOMXPath ) { return $this->create_analysis_error( $xpath ); } $response = $this->execute_general_checks( $analyzer, $xpath ); $this->update_site_seo_checks( $response, 'general' ); return $response; } /* * Run settings checks. * * @return array<string, mixed> / public function run_settings_checks() { $ignore_checks = $this->get_ignore_checks(); $response = [ 'sitemaps' => fn() => $this->sitemaps(), 'index_status' => fn() => $this->index_status(), 'robots_txt' => fn() => $this->robots_txt(), ]; foreach ( $response as $key => $callback ) { $response[ $key ] = array_merge( (array) $callback(), [ 'ignore' => in_array( $key, $ignore_checks, true ) ] ); } $this->update_site_seo_checks( $response, 'settings' ); return $response; } /* * Run other checks. * * @return array<string, mixed> / public function run_other_checks() { $response = [ 'other_seo_plugins' => fn() => $this->get_installed_seo_plugins(), 'site_tag_line' => fn() => $this->get_site_tag_line(), 'auth_status' => fn() => $this->get_auth_status(), ]; foreach ( $response as $key => $callback ) { $response[ $key ] = array_merge( (array) $callback(), [ 'ignore' => in_array( $key, $this->get_ignore_checks(), true ) ] ); } $this->update_site_seo_checks( $response, 'other' ); return $response; } /* * Register all analyzer routes * * @param string $namespace The API namespace. * @return void / private function register_all_analyzer_routes( $namespace ) { $this->register_general_checks_route( $namespace ); $this->register_settings_checks_route( $namespace ); $this->register_other_checks_route( $namespace ); $this->register_broken_links_route( $namespace ); $this->register_page_seo_checks_route( $namespace ); $this->register_taxonomy_seo_checks_route( $namespace ); $this->register_ignore_checks_routes( $namespace ); $this->register_ignore_post_checks_routes( $namespace ); } /* * Register general checks route * * @param string $namespace The API namespace. * @return void / private function register_general_checks_route( $namespace ) { register_rest_route( $namespace, $this->general_checks, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_general_checks' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_general_checks_args(), ] ); } /* * Register settings checks route * * @param string $namespace The API namespace. * @return void / private function register_settings_checks_route( $namespace ) { register_rest_route( $namespace, $this->settings_checks, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_settings_checks' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_force_args(), ] ); } /* * Register other checks route * * @param string $namespace The API namespace. * @return void / private function register_other_checks_route( $namespace ) { register_rest_route( $namespace, $this->other_checks, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_other_checks' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_force_args(), ] ); } /* * Register broken links route * * @param string $namespace The API namespace. * @return void / private function register_broken_links_route( $namespace ) { register_rest_route( $namespace, $this->broken_links_check, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'get_broken_links_status' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_broken_links_args(), ] ); } /* * Register page SEO checks route * * @param string $namespace The API namespace. * @return void / private function register_page_seo_checks_route( $namespace ) { register_rest_route( $namespace, $this->page_seo_checks, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_page_seo_checks' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_post_id_args(), ] ); } /* * Register taxonomy SEO checks route * * @param string $namespace The API namespace. * @return void / private function register_taxonomy_seo_checks_route( $namespace ) { register_rest_route( $namespace, $this->taxonomy_seo_checks, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_taxonomy_seo_checks' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_term_id_args(), ] ); } /* * Register ignore checks routes * * @param string $namespace The API namespace. * @return void / private function register_ignore_checks_routes( $namespace ) { $this->register_create_ignore_check_route( $namespace ); $this->register_delete_ignore_check_route( $namespace ); } /* * Register ignore post checks routes * * @param string $namespace The API namespace. * @return void / private function register_ignore_post_checks_routes( $namespace ) { $this->register_create_ignore_post_check_route( $namespace ); $this->register_delete_ignore_post_check_route( $namespace ); $this->register_get_ignore_post_check_route( $namespace ); } /* * Register create ignore check route * * @param string $namespace The API namespace. * @return void / private function register_create_ignore_check_route( $namespace ) { register_rest_route( $namespace, $this->ignore_checks, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'ignore_checks' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_id_args(), ] ); } /* * Register delete ignore check route * * @param string $namespace The API namespace. * @return void / private function register_delete_ignore_check_route( $namespace ) { register_rest_route( $namespace, $this->ignore_checks, [ 'methods' => WP_REST_Server::DELETABLE, 'callback' => [ $this, 'delete_ignore_checks' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_sanitized_id_args(), ] ); } /* * Register create ignore post check route * * @param string $namespace The API namespace. * @return void / private function register_create_ignore_post_check_route( $namespace ) { register_rest_route( $namespace, $this->ignore_post_checks, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'ignore_post_taxo_check' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_ignore_post_check_args(), ] ); } /* * Register delete ignore post check route * * @param string $namespace The API namespace. * @return void / private function register_delete_ignore_post_check_route( $namespace ) { register_rest_route( $namespace, $this->ignore_post_checks, [ 'methods' => WP_REST_Server::DELETABLE, 'callback' => [ $this, 'delete_ignore_post_taxo_check' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_ignore_post_check_args(), ] ); } /* * Register get ignore post check route * * @param string $namespace The API namespace. * @return void / private function register_get_ignore_post_check_route( $namespace ) { register_rest_route( $namespace, $this->ignore_post_checks, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_ignore_post_taxo_check' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_post_id_with_check_type_args(), ] ); } /* * Create analysis error response. * * @param mixed $xpath XPath error data. * @return WP_Error / private function create_analysis_error( $xpath ): WP_Error { return new WP_Error( 'analysis_failed', is_array( $xpath ) && isset( $xpath['message'] ) ? $xpath['message'] : 'Analysis failed', [ 'status' => 500, 'details' => is_array( $xpath ) && isset( $xpath['details'] ) ? $xpath['details'] : [], ] ); } /* * Execute general checks. * * @param SeoAnalyzer $analyzer Analyzer instance. * @param DOMXPath $xpath XPath instance. * @return array<string, mixed> / private function execute_general_checks( SeoAnalyzer $analyzer, DOMXPath $xpath ): array { $checks = $this->get_general_check_callbacks( $analyzer, $xpath ); $response = []; foreach ( $checks as $key => $callback ) { $response[ $key ] = $this->execute_single_check( $key, $callback ); } return $response; } /* * Get general check callbacks. * * @param SeoAnalyzer $analyzer Analyzer instance. * @param DOMXPath $xpath XPath instance. * @return array<string, callable> / private function get_general_check_callbacks( SeoAnalyzer $analyzer, DOMXPath $xpath ): array { return [ 'title' => static fn() => $analyzer->analyze_title( $xpath ), 'meta_description' => static fn() => $analyzer->analyze_meta_description( $xpath ), 'headings_h1' => static fn() => $analyzer->analyze_heading_h1( $xpath ), 'headings_h2' => static fn() => $analyzer->analyze_heading_h2( $xpath ), 'images' => static fn() => $analyzer->analyze_images( $xpath ), 'links' => static fn() => $analyzer->analyze_links( $xpath ), 'canonical' => static fn() => $analyzer->analyze_canonical( $xpath ), 'indexing' => static fn() => $analyzer->analyze_indexing( $xpath ), 'reachability' => static fn() => $analyzer->analyze_reachability(), 'secure_connection' => static fn() => $analyzer->analyze_secure_connection(), 'www_canonical' => static fn() => $analyzer->analyze_www_canonicalization(), 'open_graph_tags' => static fn() => $analyzer->open_graph_tags( $xpath ), 'schema_meta_data' => static fn() => $analyzer->schema_meta_data( $xpath ), ]; } /* * Execute a single check. * * @param string $key Check key. * @param callable $callback Check callback. * @return array<string, mixed> / private function execute_single_check( string $key, callable $callback ): array { $result = (array) $callback(); $result['ignore'] = $this->is_check_ignored( $key ); return $result; } /* * Check if a check should be ignored. * * @param string $key Check key. * @return bool / private function is_check_ignored( string $key ): bool { return in_array( $key, $this->get_ignore_checks(), true ); } /* * Check if the sitemap is valid XML. * * @param string $sitemap Sitemap content. * @return bool / private function is_valid_xml( string $sitemap ): bool { /* * Here we are checking if the sitemap is valid XML. * First we supressing the errors. * Then we load the sitemap as simplexml. * Then we clear the errors. * Then we restore the errors suppression. / libxml_use_internal_errors( true ); $xml = simplexml_load_string( $sitemap ); $xml_errors = libxml_get_errors(); libxml_clear_errors(); libxml_use_internal_errors( false ); return $xml !== false && empty( $xml_errors ); } /* * Get WordPress settings page url. * * @param string $page Page slug. * @return string / private function get_wordpress_settings_url( string $page = 'general' ): string { return admin_url( 'options-' . $page . '.php' ); } /* * Get SureRank dashboard url. * * @return string / private function get_search_console_url() { // Check if Google Search Console feature is enabled. if ( ! Settings::get( 'enable_google_console' ) ) { return admin_url( 'admin.php?page=surerank#/tools/manage-features' ); } return admin_url( 'admin.php?page=surerank#/search-console' ); } /* * Get ignore checks. * * @return array<string> / private function get_ignore_checks() { return Get::option( 'surerank_ignored_site_checks_list', [] ); } /* * Save broken links. * * @param string $url URL. * @param int $post_id Post ID. * @param array<string> $urls URLs. * @param int\|null $status_code HTTP status code. * @param int\|string $error_message Error message. * @return bool / private function save_broken_links( string $url, int $post_id, array $urls, $status_code = null, $error_message = null ) { $seo_checks = Get::post_meta( $post_id, SURERANK_SEO_CHECKS, true ); $broken_links = $seo_checks['broken_links'] ?? []; $existing_broken_links = Utils::existing_broken_links( $broken_links, $urls ); $broken_link_details = [ 'url' => $url, 'status' => $status_code, 'details' => $error_message ? $error_message : __( 'The link is broken.', 'surerank' ), ]; $url_found = false; foreach ( $existing_broken_links as $key => $existing_link ) { if ( is_array( $existing_link ) && isset( $existing_link['url'] ) && $existing_link['url'] === $url ) { $existing_broken_links[ $key ] = $broken_link_details; $url_found = true; break; } } if ( ! $url_found ) { $existing_broken_links[] = $broken_link_details; } $final_array = []; $final_array['broken_links'] = [ 'status' => 'error', 'description' => [ __( 'These broken links were found on the page: ', 'surerank' ), [ 'list' => $existing_broken_links, ], ], 'message' => __( 'One or more broken links found on the page.', 'surerank' ), ]; return Update::post_seo_checks( $post_id, $final_array ); } /* * Get post-specific ignore checks. * * @param int $post_id Post ID. * @return array<string> / private function get_ignore_post_checks( $post_id ) { return Get::post_meta( $post_id, 'surerank_ignored_post_checks', true ); } /* * Get taxonomy-specific ignore checks. * * @param int $term_id Term ID. * @return array<string> / private function get_ignore_taxonomy_checks( $term_id ) { return Get::term_meta( $term_id, 'surerank_ignored_post_checks', true ); } /* * Update the site SEO checks. * * @param array<string, mixed> $response Response data. * @param string $type Type of checks. * @return void / private function update_site_seo_checks( array &$response, string $type ) { $existing_seo_checks = Get::option( 'surerank_site_seo_checks', [] ); $seo_checks = ! is_array( $existing_seo_checks ) ? [] : $existing_seo_checks; $seo_checks[ $type ] = $response; Update::option( 'surerank_site_seo_checks', $seo_checks ); } /* * Check if the cache exists. * * @param string $type Type of checks. * @return bool / private function cache_exists( string $type ) { $seo_checks = Get::option( 'surerank_site_seo_checks', [] ); return isset( $seo_checks[ $type ] ) && ! empty( $seo_checks[ $type ] ); } /* * Get cached response. * * @param string $type Type of checks. * @return array<string, mixed> / private function get_cached_response( string $type ) { $seo_checks = Get::option( 'surerank_site_seo_checks', [] ); return $seo_checks[ $type ] ?? []; } /* * Get general checks route arguments * * @return array<string, array<string, mixed>> / private function get_general_checks_args() { return [ 'url' => [ 'type' => 'string', 'validate_callback' => static function ( $param, $request, $key ) { return filter_var( $param, FILTER_VALIDATE_URL ); }, 'required' => true, ], ]; } /* * Get force arguments * * @return array<string, array<string, mixed>> / private function get_force_args() { return [ 'force' => [ 'type' => 'boolean', 'required' => false, ], ]; } /* * Get broken links route arguments * * @return array<string, array<string, mixed>> / private function get_broken_links_args() { return [ 'url' => [ 'type' => 'string', 'required' => true, ], 'user_agent' => [ 'type' => 'string', 'required' => true, ], 'post_id' => [ 'type' => 'integer', 'required' => true, 'validate_callback' => static function ( $param, $request, $key ) { return $param > 0; }, ], 'urls' => [ 'type' => 'array', 'required' => true, ], ]; } /* * Get post ID arguments * * @return array<string, array<string, mixed>> / private function get_post_id_args() { return [ 'post_id' => [ 'type' => 'integer', 'required' => true, ], ]; } /* * Get term ID arguments * * @return array<string, array<string, mixed>> / private function get_term_id_args() { return [ 'term_id' => [ 'type' => 'integer', 'required' => true, ], ]; } /* * Get ID arguments * * @return array<string, array<string, mixed>> / private function get_id_args() { return [ 'id' => [ 'type' => 'string', 'required' => true, ], ]; } /* * Get sanitized ID arguments * * @return array<string, array<string, mixed>> / private function get_sanitized_id_args() { return [ 'id' => [ 'type' => 'string', 'required' => true, 'sanitize_callback' => 'sanitize_text_field', ], ]; } /* * Get ignore post check arguments * * @return array<string, array<string, mixed>> / private function get_ignore_post_check_args() { return [ 'id' => [ 'type' => 'string', 'required' => true, 'sanitize_callback' => 'sanitize_text_field', ], 'post_id' => [ 'type' => 'integer', 'required' => true, ], 'check_type' => [ 'type' => 'string', 'default' => 'post', 'enum' => [ 'post', 'taxonomy', ], 'description' => __( 'Type of check to delete. Can be "post" or "taxonomy".', 'surerank' ), ], ]; } /* * Get post ID with check type arguments * * @return array<string, array<string, mixed>> / private function get_post_id_with_check_type_args() { return [ 'post_id' => [ 'type' => 'integer', 'required' => true, ], 'check_type' => [ 'type' => 'string', 'default' => 'post', 'enum' => [ 'post', 'taxonomy', ], 'description' => __( 'Type of check to delete. Can be "post" or "taxonomy".', 'surerank' ), ], ]; } /* * Validate post ID * * @param mixed $post_id Post ID to validate. * @return WP_REST_Response\|null / private function validate_post_id( $post_id ) { if ( ! $post_id ) { return $this->create_error_response( __( 'Post ID is required.', 'surerank' ) ); } return null; } /* * Create error response * * @param string $message Error message. * @return WP_REST_Response / private function create_error_response( $message ) { return rest_ensure_response( [ 'status' => 'error', 'message' => $message, ] ); } /* * Check if post cache is valid * * @param \WP_Post $post Post object. * @param int $post_id Post ID. * @return bool / private function is_post_cache_valid( $post, $post_id ) { $post_modified_time = $post->post_modified_gmt ? strtotime( $post->post_modified_gmt ) : 0; $checks_last_updated = Get::post_meta( $post_id, SURERANK_SEO_CHECKS_LAST_UPDATED, true ); $settings_updated = Get::option( SURERANK_SEO_LAST_UPDATED ); $checks_last_updated = ! empty( $checks_last_updated ) ? (int) $checks_last_updated : 0; $settings_updated = ! empty( $settings_updated ) ? (int) $settings_updated : 0; return $checks_last_updated !== 0 && $post_modified_time <= $checks_last_updated && ( $settings_updated === 0 \|\| $checks_last_updated >= $settings_updated ); } /* * Get cached post checks * * @param int $post_id Post ID. * @return WP_REST_Response\|null / private function get_cached_post_checks( $post_id ) { $post_checks = Get::post_meta( $post_id, 'surerank_seo_checks', true ); if ( ! empty( $post_checks ) ) { $post_checks = $this->get_updated_ignored_check_list( $post_checks, $post_id, 'post' ); return rest_ensure_response( [ 'status' => 'success', 'message' => __( 'SEO checks retrieved from cache.', 'surerank' ), 'checks' => $post_checks, ] ); } return null; } /* * Run and return post checks * * @param int $post_id Post ID. * @return WP_REST_Response / private function run_and_return_post_checks( $post_id ) { $post_checks = $this->run_checks( $post_id ); if ( ! is_wp_error( $post_checks ) ) { $post_checks = $this->get_updated_ignored_check_list( $post_checks, $post_id, 'post' ); } return rest_ensure_response( [ 'status' => 'success', 'message' => __( 'SEO checks completed.', 'surerank' ), 'checks' => $post_checks, ] ); } /* * Check if taxonomy cache is valid * * @param int $term_id Term ID. * @return bool / private function is_taxonomy_cache_valid( $term_id ) { $term_modified_time = Get::term_meta( $term_id, SURERANK_TAXONOMY_UPDATED_AT, true ); $checks_last_updated = Get::term_meta( $term_id, SURERANK_SEO_CHECKS_LAST_UPDATED, true ); $settings_updated = Get::option( SURERANK_SEO_LAST_UPDATED ); $term_modified_time = ! empty( $term_modified_time ) ? (int) $term_modified_time : 0; $checks_last_updated = ! empty( $checks_last_updated ) ? (int) $checks_last_updated : 0; $settings_updated = ! empty( $settings_updated ) ? (int) $settings_updated : 0; return $checks_last_updated !== 0 && $term_modified_time <= $checks_last_updated && ( $settings_updated === 0 \|\| $checks_last_updated >= $settings_updated ); } /* * Get cached taxonomy checks * * @param int $term_id Term ID. * @return WP_REST_Response\|null / private function get_cached_taxonomy_checks( $term_id ) { $term_checks = Get::term_meta( $term_id, 'surerank_seo_checks', true ); if ( ! empty( $term_checks ) ) { $term_checks = $this->get_updated_ignored_check_list( $term_checks, $term_id, 'taxonomy' ); return rest_ensure_response( [ 'status' => 'success', 'message' => __( 'Taxonomy SEO checks retrieved from cache.', 'surerank' ), 'checks' => $term_checks, ] ); } return null; } /* * Run and return taxonomy checks * * @param int $term_id Term ID. * @return WP_REST_Response / private function run_and_return_taxonomy_checks( $term_id ) { $term_checks = $this->run_taxonomy_checks( $term_id ); if ( ! is_wp_error( $term_checks ) ) { $term_checks = $this->get_updated_ignored_check_list( $term_checks, $term_id, 'taxonomy' ); } return rest_ensure_response( [ 'status' => 'success', 'message' => __( 'Taxonomy SEO checks found.', 'surerank' ), 'checks' => $term_checks, ] ); } /* * Fetch URL status * * @param string $url URL to check. * @return array<string, mixed>\|WP_Error / private function fetch_url_status( $url ) { return Requests::get( $url, apply_filters( 'surerank_broken_link_request_args', [ 'limit_response_size' => 1, 'timeout' => 10, // phpcs:ignore WordPressVIPMinimum.Performance.RemoteRequestTimeout.timeout_timeout ] ) ); } /* * Create broken link error response * * @param string $message Error message. * @return WP_REST_Response / private function create_broken_link_error_response( $message ) { return rest_ensure_response( [ 'success' => false, 'message' => $message, ] ); } /* * Handle broken link error * * @param string $url URL. * @param int $post_id Post ID. * @param array<string> $urls URLs array. * @param WP_Error $response Error response. * @return WP_REST_Response / private function handle_broken_link_error( $url, $post_id, $urls, $response ) { $this->save_broken_links( $url, $post_id, $urls, 500, $response->get_error_message() ); self::log( 'Link is broken: ' . $url . ' with Error: ' . $response->get_error_message() ); return rest_ensure_response( [ 'success' => false, 'message' => __( 'Link is broken', 'surerank' ), 'status' => $response->get_error_code(), 'details' => $response->get_error_message(), ] ); } /* * Handle broken link status error * * @param string $url URL. * @param int $post_id Post ID. * @param array<string> $urls URLs array. * @param int $status_code HTTP status code. * @param array<string, mixed> $response HTTP response. * @return WP_REST_Response */ private function handle_broken_link_status_error( $url, $post_id, $urls, $status_code, $response ) { $this->save_broken_links( $url, $post_id, $urls, $status_code, wp_remote_retrieve_response_message( $response ) ); self::log( 'Link is broken: ' . $url . ' with status code: ' . $status_code ); return rest_ensure_response( [ 'success' => false, 'message' => __( 'Link is broken', 'surerank' ), 'details' => wp_remote_retrieve_response_message( $response ), 'status' => $status_code, ] ); } }	52.63 KB	2025-10-27 18:36
📄 api-base.php <?php /** * API base. * * @package SureRank; * @since 1.0.0 / namespace SureRank\Inc\API; use SureRank\Inc\Functions\Helper; use SureRank\Inc\Functions\Sanitize; use SureRank\Inc\Meta_Variables\Site; use WP_Error; use WP_REST_Controller; use WP_REST_Request; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Api_Base * * @since 1.0.0 / abstract class Api_Base extends WP_REST_Controller { /* * Endpoint namespace. * * @var string / protected $namespace = 'surerank/v1'; /* * Constructor * * @since 1.0.0 / public function __construct() { } /* * Get API namespace. * * @since 1.0.0 * @return string / public function get_api_namespace() { return $this->namespace; } /* * Validate the nonce for REST API requests. * * @param WP_REST_Request<array<string, mixed>> $request The REST request object. * @return bool\|WP_Error True if valid, WP_REST_Response if invalid. / public function validate_permission( $request ) { if ( ! current_user_can( 'manage_options' ) ) { return new WP_Error( 'surerank_rest_cannot_access', __( 'You do not have permission to perform this action.', 'surerank' ), [ 'status' => rest_authorization_required_code() ] ); } // Retrieve the nonce from the request header. $nonce = $request->get_header( 'X-WP-Nonce' ); // Check if nonce is null or empty. if ( empty( $nonce ) \|\| ! is_string( $nonce ) ) { return new WP_Error( 'surerank_nonce_verification_failed', __( 'Nonce is missing.', 'surerank' ), [ 'status' => rest_authorization_required_code() ] ); } // Verify the nonce. if ( ! wp_verify_nonce( $nonce, 'wp_rest' ) ) { return new WP_Error( 'surerank_nonce_verification_failed', __( 'Nonce is invalid.', 'surerank' ), [ 'status' => rest_authorization_required_code() ] ); } return true; } /* * Get favicon image URL. * * @since 1.0.0 * @return string / public function get_favicon() { return esc_url( get_site_icon_url( 16 ) ); } /* * Get site variables * * @since 1.0.0 * @return array<string, mixed> / public function get_site_variables() { $site = Site::get_instance(); $site_variables = $site->get_all_values(); $variables = []; // Add favicon icon if variable is available and should be a array. if ( ! empty( $site_variables ) && is_array( $site_variables ) ) { // Keep in key and array format. foreach ( $site_variables as $key => $value ) { // Verify that value should be an array. if ( ! isset( $value['value'] ) ) { continue; } $variables[ $key ] = $value['value']; } $variables['favicon'] = $this->get_favicon(); $variables['title'] = __( 'Sample Post', 'surerank' ); $variables['current_year'] = gmdate( 'Y' ); $variables['current_month'] = gmdate( 'F' ); } else { $variables = []; } $variables['page'] = Helper::format_paged_info( 2, 5 ); return $variables; } /* * Sanitize object data * * @since 1.0.0 * @param array<string, mixed>\|array<int, string> $data Data to sanitize. * @return array<string, mixed>\|array<int, string> */ public function sanitize_array_data( $data ) { return Sanitize::array_deep( [ Sanitize::class, 'sanitize_with_placeholders' ], $data ); } }	3.26 KB	2025-10-27 18:36
📄 api-init.php <?php /** * Initialize API. * * @package SureRank\Inc\API * @since 1.0.0 / namespace SureRank\Inc\API; use SureRank\Inc\Traits\Get_Instance; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Api_Init * * @since 1.0.0 / class Api_Init { use Get_Instance; /* * Constructor * * @since 1.0.0 / private function __construct() { // Register REST API routes. add_action( 'rest_api_init', [ $this, 'register_routes' ] ); } /* * Register API routes. * * @since 1.0.0 * @return void */ public function register_routes() { $controllers = [ '\SureRank\Inc\API\Admin', '\SureRank\Inc\API\Post', '\SureRank\Inc\API\Install_Products', '\SureRank\Inc\API\Term', '\SureRank\Inc\API\Onboarding', '\SureRank\Inc\API\Analyzer', '\SureRank\Inc\API\Migrations', '\SureRank\Inc\API\Import_Export_Settings', '\SureRank\Inc\API\Sitemap', '\SureRank\Inc\API\RobotsTxt', ]; $controllers = apply_filters( 'surerank_api_controllers', $controllers ); foreach ( $controllers as $controller_class ) { if ( class_exists( $controller_class ) ) { $controller = $controller_class::get_instance(); $controller->register_routes(); } } } }	1.2 KB	2025-10-27 18:36
📄 import-export-settings.php <?php /** * Import Export Settings API * * Handles REST API endpoints for importing and exporting SureRank settings. * * @package SureRank\Inc\API * @since 1.2.0 / namespace SureRank\Inc\API; use SureRank\Inc\Functions\Send_Json; use SureRank\Inc\Import_Export\Settings_Exporter; use SureRank\Inc\Import_Export\Settings_Importer; use SureRank\Inc\Import_Export\Utils; use SureRank\Inc\Traits\Get_Instance; use WP_REST_Request; use WP_REST_Server; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Class Import_Export_Settings. * * Handles import/export settings REST API endpoints. / class Import_Export_Settings extends Api_Base { use Get_Instance; /* * Route for exporting settings. / private const EXPORT_SETTINGS = '/export-settings'; /* * Route for importing settings. / private const IMPORT_SETTINGS = '/import-settings'; /* * Settings Exporter instance. * * @var Settings_Exporter / private $exporter; /* * Settings Importer instance. * * @var Settings_Importer / private $importer; /* * Register API routes. * * @since 1.2.0 * @return void / public function register_routes() { $this->register_export_settings_route(); $this->register_import_settings_route(); } /* * Export settings based on selected categories. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return void / public function export_settings( $request ) { try { $categories = $request->get_param( 'categories' ); // Export settings using the exporter class. $export_result = $this->get_exporter()->export( $categories ); // Check if export was successful. if ( ! $export_result['success'] ) { Send_Json::error( [ 'message' => $export_result['message'], 'status' => 400, ] ); } Send_Json::success( $export_result['data'] ); } catch ( \Exception $e ) { / translators: %s: Error message from export operation / Send_Json::error( [ / translators: %s: Error message from export failure / 'message' => sprintf( __( 'Export failed: %s', 'surerank' ), $e->getMessage() ), 'status' => 500, ] ); } } /* * Import settings from uploaded data. * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return void / public function import_settings( $request ) { try { $settings_data = $request->get_param( 'settings_data' ); $options = apply_filters( 'surerank_import_settings_options', [ 'overwrite' => true, 'create_backup' => true, ] ); // Import settings using the importer class. $import_result = $this->get_importer()->import( $settings_data, $options ); if ( ! $import_result['success'] ) { Send_Json::error( [ 'message' => $import_result['message'], 'status' => 400, 'errors' => $import_result['errors'] ?? [], ] ); } Send_Json::success( $import_result ); } catch ( \Exception $e ) { Send_Json::error( [ / translators: %s: Error message from import operation / 'message' => sprintf( __( 'Import failed: %s', 'surerank' ), $e->getMessage() ), 'status' => 500, ] ); } } /* * Validate categories parameter. * * @param array<int, string> $categories Categories to validate. * @return bool / public function validate_categories( $categories ) { if ( ! is_array( $categories ) \|\| empty( $categories ) ) { return false; } $valid_categories = array_keys( $this->get_exporter()->get_categories() ); foreach ( $categories as $category ) { if ( ! is_string( $category ) \|\| ! in_array( $category, $valid_categories, true ) ) { return false; } } return true; } /* * Sanitize categories parameter. * * @param array<int, string> $categories Categories to sanitize. * @return array<int, string> / public function sanitize_categories( $categories ) { $valid_categories = array_keys( $this->get_exporter()->get_categories() ); return Utils::sanitize_categories( $categories, $valid_categories ); } /* * Register the export settings route. * * @since 1.2.0 * @return void / private function register_export_settings_route() { register_rest_route( $this->get_api_namespace(), self::EXPORT_SETTINGS, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'export_settings' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'categories' => [ 'required' => true, 'type' => 'array', 'validate_callback' => [ $this, 'validate_categories' ], 'sanitize_callback' => [ $this, 'sanitize_categories' ], ], ], ] ); } /* * Register the import settings route. * * @since 1.2.0 * @return void / private function register_import_settings_route() { register_rest_route( $this->get_api_namespace(), self::IMPORT_SETTINGS, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'import_settings' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'settings_data' => [ 'required' => true, 'type' => 'object', 'sanitize_callback' => [ $this, 'sanitize_array_data' ], ], ], ] ); } /* * Get Settings_Exporter instance. * * @return Settings_Exporter / private function get_exporter() { if ( null === $this->exporter ) { $this->exporter = Settings_Exporter::get_instance(); } return $this->exporter; } /* * Get Settings_Importer instance. * * @return Settings_Importer */ private function get_importer() { if ( null === $this->importer ) { $this->importer = Settings_Importer::get_instance(); } return $this->importer; } }	5.79 KB	2025-10-27 18:36
📄 install-products.php <?php /** * Install_Products class * * Handles installed products related REST API endpoints for the SureRank plugin. * * @package SureRank\Inc\API / namespace SureRank\Inc\API; use SureRank\Inc\Functions\Send_Json; use SureRank\Inc\Traits\Get_Instance; use WP_REST_Server; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Class Install_Products * * Handles installed products related REST API endpoints. / class Install_Products extends Api_Base { use Get_Instance; /* * Route Get Installed Plugins and Themes / protected const INSTALLED_PLUGINS_AND_THEMES = '/plugins/installed'; /* * Constructor * * @since 1.0.0 / public function __construct() { } /* * Register API routes. * * @since 1.0.0 * @return void / public function register_routes() { register_rest_route( $this->get_api_namespace(), self::INSTALLED_PLUGINS_AND_THEMES, [ 'methods' => WP_REST_Server::READABLE, // GET method. 'callback' => [ $this, 'get_installed_plugins_and_themes' ], 'permission_callback' => [ $this, 'validate_permission' ], ] ); } /* * Get the list of installed plugins and themes and active plugins and themes. * * @return void */ public function get_installed_plugins_and_themes() { // Include necessary WordPress files for plugin functions. if ( ! function_exists( 'get_plugins' ) ) { include_once ABSPATH . 'wp-admin/includes/plugin.php'; } // Get all installed plugins. $all_plugins = get_plugins(); $installed_plugins = []; $active_plugins = []; foreach ( $all_plugins as $plugin_file => $plugin_data ) { $slug = dirname( $plugin_file ); $installed_plugins[] = $slug; if ( is_plugin_active( $plugin_file ) ) { $active_plugins[] = $slug; } } // Get all installed themes. $all_themes = wp_get_themes(); $installed_themes = []; $active_theme = get_stylesheet(); $active_themes = []; foreach ( $all_themes as $theme_slug => $theme_data ) { $installed_themes[] = $theme_slug; if ( $theme_slug === $active_theme ) { $active_themes[] = $theme_slug; } } Send_Json::success( [ 'success' => true, 'data' => [ 'plugins' => [ 'installed' => $installed_plugins, 'active' => $active_plugins, ], 'themes' => [ 'installed' => $installed_themes, 'active' => $active_themes, ], ], ] ); } }	2.44 KB	2025-10-27 18:36
📄 migrations.php <?php /** * Migration API Class * * Handles migration-related REST API endpoints for the plugin. * * @package SureRank\Inc\API * @since 1.1.0 / namespace SureRank\Inc\API; use SureRank\Inc\Functions\Get; use SureRank\Inc\Functions\Send_Json; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Importers\Importer; use SureRank\Inc\Importers\ImporterUtils; use SureRank\Inc\Importers\Rankmath\RankMath; use SureRank\Inc\Importers\Seopress\Seopress; use SureRank\Inc\Importers\Yoast\Yoast; use SureRank\Inc\Traits\Get_Instance; use WP_REST_Request; use WP_REST_Server; if ( ! defined( 'ABSPATH' ) ) { exit; } /* * Class Migrations * * Handles the REST API endpoints for migrations from other SEO plugins * and for retrieving all post IDs. / class Migrations extends Api_Base { use Get_Instance; /* * Route Migrated Data / protected const MIGRATED_DATA = '/migration/migrated-data'; /* * API endpoint for migrating posts. / private const ENDPOINT_POSTS = '/migration/posts'; /* * API endpoint for migrating terms. / private const ENDPOINT_TERMS = '/migration/terms'; /* * API endpoint for migrating global settings. / private const ENDPOINT_GLOBAL = '/migration/global-settings'; /* * API endpoint for deactivating a plugin. * * @since 1.1.0 / private const ENDPOINT_DEACTIVATE = '/plugins/deactivate'; /* * Batch size for processing large datasets. / private const BATCH_SIZE = 100; /* * Map of slug ⇒ importer class. * * @var array<string, class-string> / private array $importers = [ 'rankmath' => RankMath::class, 'seopress' => Seopress::class, 'yoast' => Yoast::class, ]; /* * Register the /migration/posts, /migration/terms, /migration/global-settings routes. / public function register_routes(): void { if ( ! Settings::get( 'enable_migration' ) ) { return; } $namespace = $this->get_api_namespace(); // -------- Migrate posts -------- . register_rest_route( $namespace, self::ENDPOINT_POSTS, [ [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'migrate_posts' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'plugin_slug' => [ 'type' => 'string', 'required' => true, / translators: %s: list of plugin slugs / 'description' => sprintf( __( 'Plugin slug to migrate from (e.g. %s).', 'surerank' ), implode( ', ', array_keys( $this->importers ) ) ), 'enum' => array_keys( $this->importers ), ], 'post_ids' => [ 'type' => [ 'array', 'integer' ], 'required' => true, 'description' => __( 'Post IDs to migrate.', 'surerank' ), 'validate_callback' => fn( $param) => $this->validate_ids( $param ), ], 'cleanup' => [ 'type' => 'boolean', 'required' => false, 'default' => false, 'description' => __( 'Whether to clean up source data after import.', 'surerank' ), ], ], ], [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_all_posts' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'page' => [ 'type' => 'integer', 'required' => false, 'default' => 1, 'description' => __( 'Page number for pagination.', 'surerank' ), ], 'plugin_slug' => [ 'type' => 'string', 'required' => true, / translators: %s: list of plugin slugs / 'description' => sprintf( __( 'Plugin slug to filter posts by (e.g. %s).', 'surerank' ), implode( ', ', array_keys( $this->importers ) ) ), 'enum' => array_keys( $this->importers ), 'default' => 'rankmath', ], ], ], ] ); // -------- Migrate terms --------. register_rest_route( $namespace, self::ENDPOINT_TERMS, [ [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'migrate_terms' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'plugin_slug' => [ 'type' => 'string', 'required' => true, / translators: %s: list of plugin slugs / 'description' => sprintf( __( 'Plugin slug to migrate from (e.g. %s).', 'surerank' ), implode( ', ', array_keys( $this->importers ) ) ), 'enum' => array_keys( $this->importers ), ], 'term_ids' => [ 'type' => [ 'array', 'integer' ], 'required' => true, 'description' => __( 'Term IDs to migrate.', 'surerank' ), 'validate_callback' => fn( $param) => $this->validate_ids( $param ), ], 'cleanup' => [ 'type' => 'boolean', 'required' => false, 'default' => false, 'description' => __( 'Whether to clean up source data after import.', 'surerank' ), ], ], ], [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_all_terms' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'page' => [ 'type' => 'integer', 'required' => false, 'default' => 1, 'description' => __( 'Page number for pagination.', 'surerank' ), ], 'plugin_slug' => [ 'type' => 'string', 'required' => true, 'default' => 'rankmath', / translators: %s: list of plugin slugs / 'description' => sprintf( __( 'Plugin slug to filter terms by (e.g. %s).', 'surerank' ), implode( ', ', array_keys( $this->importers ) ) ), 'enum' => array_keys( $this->importers ), ], ], ], ] ); // -------- Migrate global settings --------. register_rest_route( $namespace, self::ENDPOINT_GLOBAL, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'migrate_global_settings' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'plugin_slug' => [ 'type' => 'string', 'required' => true, / translators: %s: list of plugin slugs / 'description' => sprintf( __( 'Plugin slug to migrate global settings from (e.g. %s).', 'surerank' ), implode( ', ', array_keys( $this->importers ) ) ), 'enum' => array_keys( $this->importers ), ], 'cleanup' => [ 'type' => 'boolean', 'required' => false, 'default' => false, 'description' => __( 'Whether to clean up source global data after import.', 'surerank' ), ], ], ] ); // -------- Deactivate plugin --------. register_rest_route( $namespace, self::ENDPOINT_DEACTIVATE, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'deactivate_plugin' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'plugin_slug' => [ 'type' => 'string', 'required' => true, 'description' => __( 'Plugin slug to deactivate.', 'surerank' ), 'enum' => array_keys( $this->importers ), ], ], ] ); // -------- Mark migration completed --------. register_rest_route( $namespace, '/migration/completed', [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'mark_migration_completed_endpoint' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'plugin_slug' => [ 'type' => 'string', 'required' => true, 'description' => __( 'Plugin slug that was migrated from.', 'surerank' ), 'enum' => array_keys( $this->importers ), ], ], ] ); // -------- Get migrated data --------. register_rest_route( $this->get_api_namespace(), self::MIGRATED_DATA, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_migrated_data' ], 'permission_callback' => [ $this, 'validate_permission' ], ] ); } /* * Get Migrated Data * * @since 1.2.0 * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return array<string, mixed> / public function get_migrated_data( $request ) { $surerank_onboarding = Get::option( 'surerank_settings_onboarding', [] ); $surerank_settings = Get::option( SURERANK_SETTINGS, [] ); return [ 'social_profiles' => $surerank_settings['social_profiles'] ?? [], 'website_details' => $surerank_onboarding, ]; } /* * Handle the migration request for posts. * * @param WP_REST_Request<array<string, mixed>> $request The REST request. * @return void / public function migrate_posts( $request ) { $ids_raw = $request->get_param( 'post_ids' ); $cleanup = (bool) $request->get_param( 'cleanup' ); $ids = is_array( $ids_raw ) ? $ids_raw : [ $ids_raw ]; $importer = $this->validate_and_get_importer( $request ); if ( ! $this->validate_importer_methods( $importer, 'post' ) ) { Send_Json::error( [ 'message' => __( 'Invalid importer methods.', 'surerank' ) ] ); } $results = $this->process_migration( $ids, $importer, 'post' ); $results = array_merge( $results, $this->handle_cleanup( $importer, $cleanup, $results['success'] ) ); $results = $this->format_response( $results, $importer, $ids, 'posts' ); Send_Json::success( $results ); } /* * Handle the migration request for terms. * * @param WP_REST_Request<array<string, mixed>> $request The REST request. * @return void / public function migrate_terms( $request ) { $ids_raw = $request->get_param( 'term_ids' ); $cleanup = (bool) $request->get_param( 'cleanup' ); $ids = is_array( $ids_raw ) ? $ids_raw : [ $ids_raw ]; $importer = $this->validate_and_get_importer( $request ); if ( ! $this->validate_importer_methods( $importer, 'term' ) ) { Send_Json::error( [ 'message' => __( 'Invalid importer methods.', 'surerank' ) ] ); } $results = $this->process_migration( $ids, $importer, 'term' ); $results = array_merge( $results, $this->handle_cleanup( $importer, $cleanup, $results['success'] ) ); $results = $this->format_response( $results, $importer, $ids, 'terms' ); Send_Json::success( $results ); } /* * Handle the migration request for global settings. * * @param WP_REST_Request<array<string, mixed>> $request The REST request. / public function migrate_global_settings( $request ): void { $plugin_slug = $request->get_param( 'plugin_slug' ); $cleanup = (bool) $request->get_param( 'cleanup' ); $importer_class = $this->importers[ $plugin_slug ]; /* * The importer class must implement Importer. * * @var Importer $importer * / $importer = new $importer_class(); // Validate that the importer implements the required interface. if ( ! $importer instanceof Importer ) { Send_Json::error( [ 'message' => sprintf( / translators: %s: importer class name / __( 'Invalid importer class: %s does not implement Importer.', 'surerank' ), $importer_class ), ] ); } $results = $importer->import_global_settings(); // Trigger action after all free migration is done. do_action( 'surerank_migration_after', $plugin_slug ); // Ensure results is an array. if ( ! is_array( $results ) ) { $results = [ 'success' => false, 'message' => __( 'Invalid response from importer.', 'surerank' ), ]; } // Only run cleanup if migration was successful. if ( $cleanup && $results['success'] && method_exists( $importer, 'cleanup' ) ) { $cleanup_resp = $importer->cleanup(); // Ensure cleanup response is valid. if ( is_array( $cleanup_resp ) ) { $results['cleanup'] = $cleanup_resp['success']; $results['cleanup_message'] = $cleanup_resp['message']; } } $plugin_name = method_exists( $importer, 'get_plugin_name' ) ? $importer->get_plugin_name() : 'Unknown'; $results['message'] = sprintf( / translators: 1: import status, 2: plugin name / __( 'Global settings %1$s from %2$s.', 'surerank' ), $results['success'] ? __( 'imported successfully', 'surerank' ) : __( 'failed to import', 'surerank' ), $plugin_name ); if ( $results['success'] ) { Send_Json::success( $results ); } else { Send_Json::error( $results ); } } /* * Retrieve all post IDs grouped by post type, excluding those already migrated. * * @param WP_REST_Request<array<string, mixed>> $request The REST request. / public function get_all_posts( $request ): void { $page = (int) $request->get_param( 'page' ); $plugin_slug = $request->get_param( 'plugin_slug' ); $batch_size = self::BATCH_SIZE; $importer_class = $this->importers[ $plugin_slug ]; /* * The importer class must implement Importer. * * @var Importer $importer * / $importer = new $importer_class(); $post_types = get_post_types( [ 'public' => true, 'show_ui' => true, ], 'names' ); unset( $post_types['attachment'] ); $post_types = array_values( $post_types ); // Calculate offset for pagination. $offset = ( $page - 1 ) $batch_size; $post_id_and_total_items = $importer->get_count_and_posts( $post_types, $batch_size, $offset ); $total_items = $post_id_and_total_items['total_items']; $post_ids = $post_id_and_total_items['post_ids']; $grouped = $this->group_items( $post_ids ); Send_Json::success( [ 'data' => $grouped, 'pagination' => [ 'current_page' => $page, 'total_pages' => (int) ceil( $total_items / $batch_size ), 'total_items' => $total_items, 'per_page' => self::BATCH_SIZE, ], ] ); } /** * Retrieve all term IDs grouped by taxonomy, excluding those already migrated. * * @param WP_REST_Request<array<string, mixed>> $request The REST request. / public function get_all_terms( $request ): void { $page = (int) $request->get_param( 'page' ); $plugin_slug = $request->get_param( 'plugin_slug' ); $batch_size = self::BATCH_SIZE; // Initialize response data. $grouped = []; $total_terms = 0; $term_ids = []; $taxonomies_objects = $this->get_public_taxonomies(); if ( empty( $taxonomies_objects ) ) { Send_Json::error( [ 'message' => __( 'No public taxonomies found.', 'surerank' ), ] ); return; } $importer_class = $this->importers[ $plugin_slug ]; /* * The importer class must implement Importer. * * @var Importer $importer / $importer = new $importer_class(); $taxonomies = array_map( static function ( $taxonomy ) { return $taxonomy->name ?? ''; }, $taxonomies_objects ); $taxonomies = array_filter( $taxonomies ); // Calculate offset for pagination. $offset = ( $page - 1 ) $batch_size; // Fetch term IDs with batching. $term_ids_and_total_items = $importer->get_count_and_terms( $taxonomies, $taxonomies_objects, $batch_size, $offset ); $total_terms = $term_ids_and_total_items['total_items'] ?? 0; $term_ids = $term_ids_and_total_items['term_ids'] ?? []; $grouped = $this->group_items( $term_ids, true, $taxonomies_objects ); Send_Json::success( [ 'data' => $grouped, 'pagination' => [ 'current_page' => $page, 'total_pages' => 'yoast' === $plugin_slug ? 1 : ( $total_terms > 0 ? (int) ceil( $total_terms / $batch_size ) : 1 ), 'total_items' => $total_terms, 'per_page' => self::BATCH_SIZE, ], ] ); } /** * Get a list of SEO plugins available for migration. * * Returns a list of installed plugins that are available for migration. * The results are cached for the duration of the request. * * @return array<string, array{name: string, active: bool}> Array of plugin slugs => plugin names that are available for migration. * @since 1.1.0 / public function get_available_plugins(): array { // Early return if no importers are configured. if ( empty( $this->importers ) ) { return []; } // Use static cache to avoid repeated processing. static $available_plugins = null; if ( null !== $available_plugins ) { return $available_plugins; } // Map of supported plugin slugs to their details. $supported_plugins = $this->get_supported_plugins(); $installed_plugins = get_plugins(); $available_plugins = []; // Single pass through the data to build the final array. foreach ( $supported_plugins as $key => $plugin ) { if ( isset( $this->importers[ $key ] ) && isset( $installed_plugins[ $plugin['slug'] ] ) ) { $available_plugins[ $key ] = [ 'name' => $plugin['name'], 'active' => $this->is_plugin_active( $plugin['slug'] ), ]; } } return $available_plugins; } /* * Check if the plugin is active or not. * * @param string $plugin Slug of the plugin to check. * @return bool True if the plugin is active, false otherwise. / public function is_plugin_active( $plugin ) { foreach ( $this->importers as $slug => $importer_class ) { if ( ! class_exists( $importer_class ) ) { continue; } $importer = new $importer_class(); if ( ! method_exists( $importer, 'get_plugin_file' ) \|\| ! method_exists( $importer, 'is_plugin_active' ) ) { continue; } if ( $importer->get_plugin_file() === $plugin ) { return (bool) $importer->is_plugin_active(); } } return false; } /* * Deactivate a plugin after migration. * * @param WP_REST_Request<array<string, mixed>> $request The REST request. * * @return void / public function deactivate_plugin( $request ): void { $plugin_slug = $request->get_param( 'plugin_slug' ); if ( ! current_user_can( 'activate_plugins' ) ) { Send_Json::error( [ 'message' => __( 'You do not have permission to deactivate plugins.', 'surerank' ) ] ); } $plugin_path = $this->get_plugin_path_from_slug( (string) $plugin_slug ); if ( ! $plugin_path ) { Send_Json::error( [ 'message' => __( 'Plugin not found.', 'surerank' ) ] ); } if ( ! $this->is_plugin_active( (string) $plugin_path ) ) { Send_Json::success( [ 'message' => __( 'Plugin is already inactive.', 'surerank' ) ] ); return; } $to_be_deactivated_plugins = $this->get_associated_plugins( (string) $plugin_path ); deactivate_plugins( (array) $to_be_deactivated_plugins ); Send_Json::success( [ 'message' => __( 'Plugin deactivated successfully.', 'surerank' ) ] ); } /* * Mark migration as completed endpoint handler. * * @param WP_REST_Request<array<string, mixed>> $request The REST request. * @return void * @since 1.1.0 / public function mark_migration_completed_endpoint( $request ): void { $plugin_slug = $request->get_param( 'plugin_slug' ); if ( empty( $plugin_slug ) \|\| ! is_string( $plugin_slug ) ) { Send_Json::error( [ 'message' => __( 'Invalid plugin slug.', 'surerank' ) ] ); } // Mark the migration as completed. self::mark_migration_completed( $plugin_slug ); Send_Json::success( [ 'message' => sprintf( // translators: %s: plugin slug. __( 'Migration from %s marked as completed successfully.', 'surerank' ), $plugin_slug ), 'migration_completed' => true, ] ); } /* * Mark migration as completed globally. * * @param string $plugin_slug The plugin slug that was migrated from. * @return void * @since 1.1.0 / public static function mark_migration_completed( string $plugin_slug ): void { $completed_migrations = get_option( 'surerank_completed_migrations', [] ); if ( ! is_array( $completed_migrations ) ) { $completed_migrations = []; } $completed_migrations[ $plugin_slug ] = [ 'timestamp' => time(), ]; update_option( 'surerank_completed_migrations', $completed_migrations ); // Set global flag that any migration has been completed. update_option( 'surerank_migration_ever_completed', true ); } /* * Check if migration has ever been completed. * * @return bool True if any migration has ever been completed. * @since 1.1.0 / public static function has_migration_ever_completed(): bool { return (bool) get_option( 'surerank_migration_ever_completed', false ); } /* * Get completed migrations information. * * @return array<string, array<string, mixed>> Array of completed migrations with details. * @since 1.1.0 / public static function get_completed_migrations(): array { $completed_migrations = get_option( 'surerank_completed_migrations', [] ); if ( ! is_array( $completed_migrations ) ) { return []; } return $completed_migrations; } /* * Check if migration from specific plugin has been completed. * * @param string $plugin_slug The plugin slug to check. * @return bool True if migration from this plugin was completed. * @since 1.1.0 / public static function is_plugin_migration_completed( string $plugin_slug ): bool { $completed_migrations = self::get_completed_migrations(); return isset( $completed_migrations[ $plugin_slug ] ); } /* * Check if any cache plugin is currently active on the website. * * This method efficiently detects the most popular WordPress cache plugins * by checking for defined constants, function existence, and class existence * rather than using is_plugin_active() which requires loading plugin data. * * @since 1.2.0 * @return array{ * 'has_cache_plugin': bool, * 'active_plugins': array<string, array{ * 'name': string, * 'slug': string, * 'detection_method': string * }> * } Array containing status and details of active cache plugins. / public static function has_active_cache_plugin(): array { // Use static cache to avoid repeated processing during the same request. static $cache_result = null; if ( null !== $cache_result ) { return $cache_result; } $active_cache_plugins = []; // Define cache plugins with their detection methods. $cache_plugins = [ // Premium Cache Plugins. 'wp-rocket' => [ 'name' => __( 'WP Rocket', 'surerank' ), 'slug' => 'wp-rocket/wp-rocket.php', 'detection_method' => 'constant', 'detection_value' => 'WP_ROCKET_VERSION', ], 'flyingpress' => [ 'name' => __( 'FlyingPress', 'surerank' ), 'slug' => 'flyingpress/flyingpress.php', 'detection_method' => 'constant', 'detection_value' => 'FLYINGPRESS_VERSION', ], 'nitropack' => [ 'name' => __( 'NitroPack', 'surerank' ), 'slug' => 'nitropack/main.php', 'detection_method' => 'class', 'detection_value' => 'NitroPack\\WordPress\\NitroPack', ], 'wp-optimize-premium' => [ 'name' => __( 'WP-Optimize Premium', 'surerank' ), 'slug' => 'wp-optimize-premium/wp-optimize.php', 'detection_method' => 'constant', 'detection_value' => 'WPO_PREMIUM', ], 'swift-performance' => [ 'name' => __( 'Swift Performance', 'surerank' ), 'slug' => 'swift-performance/performance.php', 'detection_method' => 'class', 'detection_value' => 'Swift_Performance', ], // Popular Free Cache Plugins. 'litespeed-cache' => [ 'name' => __( 'LiteSpeed Cache', 'surerank' ), 'slug' => 'litespeed-cache/litespeed-cache.php', 'detection_method' => 'constant', 'detection_value' => 'LSCWP_V', ], 'w3-total-cache' => [ 'name' => __( 'W3 Total Cache', 'surerank' ), 'slug' => 'w3-total-cache/w3-total-cache.php', 'detection_method' => 'constant', 'detection_value' => 'W3TC_VERSION', ], 'wp-super-cache' => [ 'name' => __( 'WP Super Cache', 'surerank' ), 'slug' => 'wp-super-cache/wp-super-cache.php', 'detection_method' => 'constant', 'detection_value' => 'WPCACHEHOME', ], 'wp-fastest-cache' => [ 'name' => __( 'WP Fastest Cache', 'surerank' ), 'slug' => 'wp-fastest-cache/wpFastestCache.php', 'detection_method' => 'class', 'detection_value' => 'WpFastestCache', ], 'wp-optimize' => [ 'name' => __( 'WP-Optimize', 'surerank' ), 'slug' => 'wp-optimize/wp-optimize.php', 'detection_method' => 'class', 'detection_value' => 'WP_Optimize', ], 'breeze' => [ 'name' => __( 'Breeze', 'surerank' ), 'slug' => 'breeze/breeze.php', 'detection_method' => 'constant', 'detection_value' => 'BREEZE_VERSION', ], 'cache-enabler' => [ 'name' => __( 'Cache Enabler', 'surerank' ), 'slug' => 'cache-enabler/cache-enabler.php', 'detection_method' => 'class', 'detection_value' => 'Cache_Enabler', ], 'comet-cache' => [ 'name' => __( 'Comet Cache', 'surerank' ), 'slug' => 'comet-cache/comet-cache.php', 'detection_method' => 'constant', 'detection_value' => 'COMET_CACHE_VERSION', ], 'swift-performance-lite' => [ 'name' => __( 'Swift Performance Lite', 'surerank' ), 'slug' => 'swift-performance-lite/performance.php', 'detection_method' => 'class', 'detection_value' => 'Swift_Performance_Lite', ], // Object Cache Plugins. 'redis-cache' => [ 'name' => __( 'Redis Object Cache', 'surerank' ), 'slug' => 'redis-cache/redis-cache.php', 'detection_method' => 'constant', 'detection_value' => 'WP_REDIS_VERSION', ], // Performance & Cache Plugins. 'hummingbird-performance' => [ 'name' => __( 'Hummingbird Performance', 'surerank' ), 'slug' => 'hummingbird-performance/wp-hummingbird.php', 'detection_method' => 'constant', 'detection_value' => 'WPHB_VERSION', ], 'autoptimize' => [ 'name' => __( 'Autoptimize', 'surerank' ), 'slug' => 'autoptimize/autoptimize.php', 'detection_method' => 'class', 'detection_value' => 'autoptimizeMain', ], 'sg-cachepress' => [ 'name' => __( 'SiteGround Speed Optimizer', 'surerank' ), 'slug' => 'sg-cachepress/sg-cachepress.php', 'detection_method' => 'class', 'detection_value' => 'SiteGround_Optimizer\\Supercacher\\Supercacher', ], 'cloudflare' => [ 'name' => __( 'Cloudflare', 'surerank' ), 'slug' => 'cloudflare/cloudflare.php', 'detection_method' => 'class', 'detection_value' => 'CF\\WordPress\\Hooks', ], 'hyper-cache' => [ 'name' => __( 'Hyper Cache', 'surerank' ), 'slug' => 'hyper-cache/plugin.php', 'detection_method' => 'class', 'detection_value' => 'HyperCache', ], 'perfmatters' => [ 'name' => __( 'Perfmatters', 'surerank' ), 'slug' => 'perfmatters/perfmatters.php', 'detection_method' => 'class', 'detection_value' => 'Perfmatters\\Config', ], // Specialized Cache Plugins. 'speedycache' => [ 'name' => __( 'SpeedyCache', 'surerank' ), 'slug' => 'speedycache/speedycache.php', 'detection_method' => 'class', 'detection_value' => 'SpeedyCache', ], 'docket-cache' => [ 'name' => __( 'Docket Cache', 'surerank' ), 'slug' => 'docket-cache/docket-cache.php', 'detection_method' => 'constant', 'detection_value' => 'DOCKET_CACHE_VERSION', ], 'tenweb-speed-optimizer' => [ 'name' => __( '10Web Booster', 'surerank' ), 'slug' => 'tenweb-speed-optimizer/tenweb_speed_optimizer.php', 'detection_method' => 'class', 'detection_value' => 'TenWebOptimizer', ], 'wp-cloudflare-page-cache' => [ 'name' => __( 'Super Page Cache', 'surerank' ), 'slug' => 'wp-cloudflare-page-cache/wp-cloudflare-page-cache.php', 'detection_method' => 'class', 'detection_value' => 'CF_Page_Cache', ], 'wp-rest-cache' => [ 'name' => __( 'WP REST Cache', 'surerank' ), 'slug' => 'wp-rest-cache/wp-rest-cache.php', 'detection_method' => 'class', 'detection_value' => 'WP_REST_Cache_Plugin', ], 'cache-control' => [ 'name' => __( 'Cache Control', 'surerank' ), 'slug' => 'cache-control/cache-control.php', 'detection_method' => 'class', 'detection_value' => 'Cache_Control', ], // Additional Cache Plugins. 'aruba-hispeed-cache' => [ 'name' => __( 'Aruba HiSpeed Cache', 'surerank' ), 'slug' => 'aruba-hispeed-cache/aruba-hispeed-cache.php', 'detection_method' => 'class', 'detection_value' => 'ArubaHiSpeedCacheWp', ], 'atec-cache-apcu' => [ 'name' => __( 'atec Cache APCu', 'surerank' ), 'slug' => 'atec-cache-apcu/atec-cache-apcu.php', 'detection_method' => 'class', 'detection_value' => 'ATEC_cache_apcu', ], ]; // Check each cache plugin for active status. foreach ( $cache_plugins as $key => $plugin ) { $is_active = false; switch ( $plugin['detection_method'] ) { case 'constant': $is_active = defined( $plugin['detection_value'] ); break; case 'function': $is_active = function_exists( $plugin['detection_value'] ); break; case 'class': $is_active = class_exists( $plugin['detection_value'] ); break; default: $is_active = false; break; } // If plugin is active, add it to the results. if ( $is_active ) { $active_cache_plugins[ $key ] = [ 'name' => $plugin['name'], 'slug' => $plugin['slug'], 'detection_method' => sprintf( / translators: 1: detection method, 2: detection value / __( 'Detected via %1$s: %2$s', 'surerank' ), $plugin['detection_method'], $plugin['detection_value'] ), ]; } } $cache_result = [ 'has_cache_plugin' => ! empty( $active_cache_plugins ), 'active_plugins' => $active_cache_plugins, ]; return $cache_result; } /* * Simple helper method to check if any cache plugin is active. * * This is a lightweight wrapper around has_active_cache_plugin() * that returns only a boolean value for simpler usage. * * @since 1.2.0 * @return bool True if any cache plugin is active, false otherwise. / public static function is_cache_plugin_active(): bool { $result = self::has_active_cache_plugin(); return $result['has_cache_plugin']; } /* * Get associated plugins that should be deactivated along with the main plugin. * * @param string $plugin_path The main plugin path. * @return array<string> List of associated plugin paths to deactivate. * @since 1.1.1 / private function get_associated_plugins( string $plugin_path ) { $associated_plugins = []; switch ( $plugin_path ) { case 'seo-by-rank-math/rank-math.php': $associated_plugins = [ 'seo-by-rank-math/rank-math.php', 'seo-by-rank-math-pro/rank-math-pro.php' ]; break; case 'wordpress-seo/wp-seo.php': $associated_plugins = [ 'wordpress-seo/wp-seo.php', 'wordpress-seo-premium/wp-seo-premium.php' ]; break; case 'wp-seopress/seopress.php': $associated_plugins = [ 'wp-seopress/seopress.php', 'wp-seopress-pro/seopress-pro.php' ]; break; } return $associated_plugins; } /* * Validates the plugin slug and returns the importer instance. * * @param WP_REST_Request<array<string, mixed>> $request The REST request. * @return Importer The validated importer instance. / private function validate_and_get_importer( $request ) { $plugin_slug = $request->get_param( 'plugin_slug' ); if ( ! is_string( $plugin_slug ) ) { Send_Json::error( [ 'message' => __( 'Invalid plugin slug specified.', 'surerank' ) ] ); } $importer_class = $this->importers[ $plugin_slug ]; /* * The importer class must implement Importer. * * @var Importer $importer / $importer = new $importer_class(); if ( ! $importer instanceof Importer ) { Send_Json::error( [ 'message' => sprintf( // translators: %s: importer class name. __( 'Invalid importer class: %s does not implement Importer.', 'surerank' ), $importer_class ), ] ); } return $importer; } /* * Get supported plugins for migration. * * @return array<string, array<string, string>> / private function get_supported_plugins(): array { $supported_plugins = []; foreach ( $this->importers as $slug => $importer_class ) { if ( ! class_exists( $importer_class ) ) { continue; } $importer = new $importer_class(); if ( ! method_exists( $importer, 'get_plugin_name' ) \|\| ! method_exists( $importer, 'get_plugin_file' ) ) { continue; } $supported_plugins[ $slug ] = [ 'name' => $importer->get_plugin_name(), 'slug' => $importer->get_plugin_file(), ]; } return $supported_plugins; } /* * Get plugin path from slug. * * @param string $slug The plugin slug. * @return string\|null The plugin path or null if not found. / private function get_plugin_path_from_slug( string $slug ): ?string { $supported_plugins = $this->get_supported_plugins(); return $supported_plugins[ $slug ]['slug'] ?? null; } /* * Validates the importer methods for the given type (post or term). * * @param Importer $importer The importer instance. * @param string $type The type of item ('post' or 'term'). * @return bool True if methods exist, false otherwise. / private function validate_importer_methods( Importer $importer, string $type ): bool { $detect_method = 'detect_' . $type; $import_method = 'import_' . $type; return method_exists( $importer, $detect_method ) && method_exists( $importer, $import_method ); } /* * Processes items (posts or terms) for migration. * * @param array<int> $ids The array of item IDs. * @param Importer $importer The importer instance. * @param string $type The type of item ('post' or 'term'). * @return array<int\|string, mixed> The results array with success count, failed items, and import data. / private function process_migration( array $ids, Importer $importer, string $type ): array { $results = [ 'success' => 0, 'failed_items' => [], ]; $send_import_data = []; $detect_method = 'detect_' . $type; $import_method = 'import_' . $type; foreach ( $ids as $id ) { try { $detect = $importer->$detect_method( (int) $id ); if ( is_array( $detect ) && isset( $detect['no_data_found'] ) && $detect['no_data_found'] ) { $send_import_data[ $id ] = $detect['message'] ?? __( 'No data found for this item.', 'surerank' ); $results['success']++; continue; } if ( ! $detect['success'] ) { $results['failed_items'][ $id ] = $detect['message'] ?? __( 'Detection failed.', 'surerank' ); continue; } $import = $importer->$import_method( (int) $id ); if ( ! is_array( $import ) \|\| ! isset( $import['success'] ) ) { $results['failed_items'][ $id ] = __( 'Invalid import response.', 'surerank' ); continue; } $send_import_data[ $id ] = isset( $import['data'] ) && is_array( $import['data'] ) ? $import['data'] : []; if ( $import['success'] ) { $results['success']++; } else { $results['failed_items'][ $id ] = $import['message'] ?? __( 'Import failed.', 'surerank' ); } } catch ( \Exception $e ) { $results['failed_items'][ $id ] = sprintf( // translators: %s: error message. __( 'Error: %s', 'surerank' ), $e->getMessage() ); } } $results['passed_items'] = $send_import_data; return $results; } /* * Handles cleanup after successful imports. * * @param Importer $importer The importer instance. * @param bool $cleanup Whether cleanup is requested. * @param int $success_count The number of successful imports. * @return array<string, mixed> The cleanup results. / private function handle_cleanup( Importer $importer, bool $cleanup, int $success_count ): array { $results = []; if ( $cleanup && $success_count > 0 && method_exists( $importer, 'cleanup' ) ) { $cleanup_resp = $importer->cleanup(); if ( is_array( $cleanup_resp ) ) { $results['cleanup'] = $cleanup_resp['success']; $results['cleanup_message'] = $cleanup_resp['message']; } } return $results; } /* * Formats the final migration response. * * @param array<int\|string, mixed> $results The migration results. * @param Importer $importer The importer instance. * @param array<int> $ids The array of item IDs. * @param string $item_type The type of item ('posts' or 'terms'). * @return array<string, mixed> The formatted results array. / private function format_response( array $results, Importer $importer, array $ids, string $item_type ): array { $plugin_name = method_exists( $importer, 'get_plugin_name' ) ? $importer->get_plugin_name() : 'Unknown'; $results['message'] = sprintf( // translators: 1: imported count, 2: total count, 3: item type, 4: plugin name. __( 'Imported %1$d of %2$d %3$s from %4$s.', 'surerank' ), $results['success'], count( $ids ), $item_type, $plugin_name ); return $results; } /* * Helper to validate ID arrays/values. * * @param mixed $param Incoming param. * @return bool / private function validate_ids( $param ): bool { // Accept both array and single integer. if ( is_numeric( $param ) && (int) $param > 0 ) { return true; } if ( ! is_array( $param ) \|\| empty( $param ) ) { return false; } // Validate all array elements are positive integers. return array_reduce( $param, static fn( $valid, $id) => $valid && is_numeric( $id ) && (int) $id > 0, true ); } /* * Fetch all public taxonomies, excluding unsupported ones. * * @return array<string, object> Array of taxonomy objects. / private function get_public_taxonomies(): array { return ImporterUtils::get_excluded_taxonomies(); } /* * Group IDs by taxonomy or post type. * * @param array<int\|string> $ids Array of term IDs or post IDs. * @param bool $is_taxonomy True to group terms, False to group posts. * @param array<string, object> $taxonomies_objects Array of taxonomy objects (required if $is_taxonomy is true). * * @return array<string, array<mixed>> Grouped data. */ private function group_items( array $ids, bool $is_taxonomy = false, array $taxonomies_objects = [] ): array { $grouped = []; foreach ( $ids as $id ) { if ( $is_taxonomy ) { $term = get_term( (int) $id ); if ( is_wp_error( $term ) \|\| ! $term ) { continue; } $type = $term->taxonomy; $label = $taxonomies_objects[ $type ]->label ?? $type; $key = 'term_ids'; } else { $type = get_post_type( (int) $id ); if ( false === $type ) { continue; } $object = get_post_type_object( $type ); $label = isset( $object->labels ) ? $object->labels->name : $type; $key = 'post_ids'; } if ( ! isset( $grouped[ $type ] ) ) { $grouped[ $type ] = [ 'count' => 0, 'title' => $label, $key => [], ]; } $grouped[ $type ][ $key ][] = (int) $id; $grouped[ $type ]['count']++; } return $grouped; } }	39.34 KB	2025-10-27 18:36
📄 onboarding.php <?php /** * Onboarding class * * Handles onboarding related REST API endpoints for the SureRank plugin. * * @package SureRank\Inc\API / namespace SureRank\Inc\API; use SureRank\Inc\Admin\Update_Timestamp; use SureRank\Inc\Functions\Requests; use SureRank\Inc\Functions\Send_Json; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Functions\Update; use SureRank\Inc\Traits\Get_Instance; use WP_REST_Request; use WP_REST_Server; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } const DEFAULT_USER_DETAILS = [ 'first_name' => '', 'last_name' => '', 'email' => '', 'skip' => 'no', 'lead' => false, ]; /* * Class Onboarding * * Handles onboarding related REST API endpoints. / class Onboarding extends Api_Base { use Get_Instance; /* * Route Onboarding / protected const ONBOARDING = '/onboarding'; /* * Register API routes. * * @since 1.0.0 * @return void / public function register_routes() { register_rest_route( $this->get_api_namespace(), self::ONBOARDING, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'save_website_details' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'first_name' => [ 'type' => 'string', 'sanitize_callback' => 'sanitize_text_field', 'required' => false, 'validate_callback' => static function( $value ) { return is_string( $value ); }, ], 'last_name' => [ 'type' => 'string', 'sanitize_callback' => 'sanitize_text_field', 'required' => false, 'validate_callback' => static function( $value ) { return is_string( $value ); }, ], 'email' => [ 'type' => 'string', 'sanitize_callback' => 'sanitize_email', 'required' => false, 'validate_callback' => static function( $value ) { return filter_var( $value, FILTER_VALIDATE_EMAIL ) !== false; }, ], 'website_type' => [ 'type' => 'string', 'required' => false, 'description' => __( 'Type of the website.', 'surerank' ), 'sanitize_callback' => 'sanitize_text_field', 'validate_callback' => static function( $value ) { return is_string( $value ); }, ], 'website_name' => [ 'type' => 'string', 'required' => false, 'description' => __( 'Name of the website.', 'surerank' ), 'sanitize_callback' => 'sanitize_text_field', 'validate_callback' => static function( $value ) { return is_string( $value ); }, ], 'website_owner_name' => [ 'type' => 'string', 'required' => false, 'description' => __( 'Name of the website owner.', 'surerank' ), 'sanitize_callback' => 'sanitize_text_field', 'validate_callback' => static function( $value ) { return is_string( $value ); }, ], 'website_owner_phone' => [ 'type' => 'string', 'required' => false, 'description' => __( 'Phone number of the website owner.', 'surerank' ), 'sanitize_callback' => 'sanitize_text_field', 'validate_callback' => static function( $value ) { return is_string( $value ); }, ], 'organization_type' => [ 'type' => 'string', 'required' => false, 'description' => __( 'Type of the organization.', 'surerank' ), 'sanitize_callback' => 'sanitize_text_field', 'validate_callback' => static function( $value ) { return is_string( $value ); }, ], 'about_page' => [ 'type' => 'integer', 'required' => false, 'sanitize_callback' => 'absint', ], 'contact_page' => [ 'type' => 'integer', 'required' => false, 'sanitize_callback' => 'absint', ], 'social_profiles' => [ 'type' => 'object', 'required' => false, 'description' => __( 'Social profiles URLs.', 'surerank' ), 'properties' => array_fill_keys( self::get_social_profile_keys(), [ 'type' => 'string', 'sanitize_callback' => 'esc_url_raw', 'validate_callback' => static function( $value ) { return filter_var( $value, FILTER_VALIDATE_URL ) !== false; }, ] ), ], 'website_logo' => [ 'type' => 'string', 'required' => false, ], ], ] ); } /* * Update common onboarding data. * * @since 1.0.0 * @param array<string, mixed> $data Onboarding data. * @return bool / public static function update_common_onboarding_data( $data ) { if ( empty( $data ) ) { return false; } $instance = self::get_instance(); $defaults = [ 'website_type' => '', 'website_name' => '', 'website_owner_name' => '', 'organization_type' => 'Organization', 'website_owner_phone' => '', 'website_logo' => '', 'first_name' => '', 'last_name' => '', 'email' => '', 'about_page' => 0, 'contact_page' => 0, 'social_profiles' => [], ]; $data = wp_parse_args( $data, $defaults ); $settings = Settings::get(); $instance->set_onboarding_data( $data, $settings ); $updated_onboarding = $instance->process_onboarding_data( $data, $settings ); $updated_settings = Update::option( SURERANK_SETTINGS, $settings ); if ( $updated_onboarding && $updated_settings ) { $instance->set_schemas_pages( $data, $settings ); Update_Timestamp::timestamp_option(); return true; } return false; } /* * Save Website Details * * @since 1.0.0 * @param WP_REST_Request<array<string, mixed>> $request Request object. * @return void / public function save_website_details( $request ) { $data = $request->get_params(); if ( empty( $data ) ) { Send_Json::error( [ 'message' => __( 'Invalid data provided', 'surerank' ) ] ); } if ( self::update_common_onboarding_data( $data ) ) { Send_Json::success( [ 'message' => __( 'Settings updated successfully', 'surerank' ) ] ); } Update::option( 'surerank_onboarding_completed', true ); Send_Json::error( [ 'message' => __( 'Failed to update settings', 'surerank' ) ] ); } /* * Set Schemas Pages * * @since 1.0.0 * @param array<string, mixed> $data Data. * @param array<string, mixed> $settings Settings. * @return void / public function set_schemas_pages( $data, $settings ) { $this->set_about_page( $data, $settings ); $this->set_contact_page( $data, $settings ); } /* * Set About Page * * @since 1.0.0 * @param array<string, mixed> $data Data. * @param array<string, mixed> $settings Settings. * @return bool\|int / public function set_about_page( $data, &$settings ) { $about_page = $data['about_page'] ?? 0; if ( ! $about_page ) { return false; } $default_schemas = Settings::prepare_schemas( $settings, 'page', $about_page, true ); $schema = $this->find_schema_by_type( $settings, 'WebPage' ); $default_schemas[ $schema ]['fields']['@type'] = 'AboutPage'; $default_schemas[ $schema ]['type'] = 'AboutPage'; $schemas = [ 'schemas' => $default_schemas, ]; return Update::post_meta( $about_page, 'surerank_settings_schemas', $schemas ); } /* * Set Contact Page * * @since 1.0.0 * @param array<string, mixed> $data Data. * @param array<string, mixed> $settings Settings. * @return bool\|int / public function set_contact_page( $data, &$settings ) { $contact_page = $data['contact_page'] ?? 0; if ( ! $contact_page ) { return false; } $default_schemas = Settings::prepare_schemas( $settings, 'page', $contact_page, true ); $schema = $this->find_schema_by_type( $settings, 'WebPage' ); $default_schemas[ $schema ]['fields']['@type'] = 'ContactPage'; $default_schemas[ $schema ]['type'] = 'ContactPage'; $schemas = [ 'schemas' => $default_schemas, ]; return Update::post_meta( $contact_page, 'surerank_settings_schemas', $schemas ); } /* * Save Onboarding Data * * @since 1.0.0 * @param array<string, mixed> $data Data. * @return bool / public function save_onboarding_data( $data ) { return Update::option( 'surerank_settings_onboarding', $data ); } /* * Set Website Details * * @since 1.0.0 * @param array<string, mixed> $data Data. * @param array<string, mixed> $settings Settings. * @return void / public function set_website_details( $data, &$settings ) { $this->update_schema_field( $settings, 'Organization', 'name', $data['website_name'] ); $this->update_schema_field( $settings, 'Organization', '@type', $data['organization_type'] ); $this->update_schema_field( $settings, 'Organization', 'logo', $data['website_logo'] ); $this->update_schema_field( $settings, 'Organization', 'telephone', $data['website_owner_phone'] ); $this->update_schema_field( $settings, 'Organization', 'email', $data['email'] ); $this->update_schema_field( $settings, 'Person', 'name', $data['website_owner_name'] ); $this->update_schema_field( $settings, 'Person', 'image', $data['website_logo'] ); $sanitized_name = sanitize_text_field( $data['website_name'] ); update_option( 'blogname', $sanitized_name ); } /* * Update Schema Field * * @since 1.0.0 * @param array<string, mixed> $settings Settings. * @param string $schema_type Schema type. * @param string $field Field name. * @param mixed $value Field value. * @return void / public function update_schema_field( &$settings, $schema_type, $field, $value ) { $schema_id = $this->find_schema_by_type( $settings, $schema_type ); if ( is_null( $schema_id ) ) { return; // Bail early if schema is not found. } if ( ! isset( $settings['schemas'][ $schema_id ]['fields'] ) ) { $settings['schemas'][ $schema_id ]['fields'] = []; } $settings['schemas'][ $schema_id ]['fields'][ $field ] = $value; } /* * Find Schema by Type * * @since 1.0.0 * @param array<string, mixed> $settings Settings array. * @param string $type Schema type to find. * @return string\|null Schema ID if found, null otherwise. / public function find_schema_by_type( &$settings, $type ) { if ( isset( $settings['schemas'] ) && is_array( $settings['schemas'] ) ) { foreach ( $settings['schemas'] as $schema_id => $schema ) { if ( isset( $schema['type'] ) && $schema['type'] === $type ) { return $schema_id; } } } return null; } /* * Person or Organization * * @since 1.0.0 * @param string $website_type Website type. * @return string / public function person_or_organization( $website_type ) { return in_array( $website_type, [ 'blog', 'personal' ] ) ? 'person' : 'organization'; } /* * Get Social Profile Keys * * @since 1.0.0 * @return array<string, mixed>\|array<int, array<string, mixed>> / public static function get_social_profile_keys() { return array_column( self::social_profiles(), 'id' ); } /* * Set Social Profiles * * @since 1.0.0 * @return array<string, mixed> / public static function social_profiles() { return apply_filters( 'surerank_social_profiles', [ [ 'label' => 'Facebook', 'id' => 'facebook', 'placeholder' => 'https://www.facebook.com/my-page-url', 'show_in_dashboard' => false, ], [ 'label' => 'X', 'id' => 'twitter', 'placeholder' => 'https://x.com/myaccount', 'show_in_dashboard' => false, ], [ 'label' => 'Instagram', 'id' => 'instagram', 'placeholder' => 'https://www.instagram.com/my-page-url', ], [ 'label' => 'YouTube', 'id' => 'youtube', 'placeholder' => 'https://www.youtube.com/my-channel-url', ], [ 'label' => 'LinkedIn', 'id' => 'linkedin', 'placeholder' => 'https://www.linkedin.com/company/my-company', ], [ 'label' => 'TikTok', 'id' => 'tiktok', 'placeholder' => 'https://www.tiktok.com/@username', ], [ 'label' => 'Pinterest', 'id' => 'pinterest', 'placeholder' => 'https://www.pinterest.com/my-page-url', ], [ 'label' => 'WhatsApp', 'id' => 'whatsapp', 'placeholder' => 'https://wa.me/number', ], [ 'label' => 'Telegram', 'id' => 'telegram', 'placeholder' => 'https://t.me/username', ], [ 'label' => 'Yelp', 'id' => 'yelp', 'placeholder' => 'https://www.yelp.com/biz/business-name-location', ], [ 'label' => 'BlueSky', 'id' => 'bluesky', 'placeholder' => 'https://bsky.app/profile/username', ], ] ); } /* * Set Social Schema * * @since 1.0.0 * @param array<string, mixed> $data Data. * @param array<string, mixed> $settings Settings. * @return void / public function set_social_schema( $data, &$settings ) { $same_as_urls = array_filter( $data['social_profiles'] ?? [], static function( $url ) { return ! empty( $url ); } ); $this->update_schema_field( $settings, 'Organization', 'sameAs', $same_as_urls ); } /* * Retrieves the value of a specific key from the 'surerank_onboarding_user_details' option. * * @param string $key The key to retrieve from the settings. * @param mixed $default The default value to return if the key does not exist. * @since 1.0.0 * @return mixed The value of the specified key or the default value. / public function get_user_details( ?string $key = null, $default = null ) { $settings = wp_parse_args( get_option( 'surerank_onboarding_user_details', [] ), DEFAULT_USER_DETAILS ); if ( $key === null ) { return $settings; } if ( is_array( $settings ) && array_key_exists( $key, $settings ) ) { return $settings[ $key ]; } return $default; } /* * Sets the value of the 'surerank_onboarding_user_details' option. * * @param mixed $details The value to save. * @since 1.0.0 * @return void / public function set_user_details( $details ) { update_option( 'surerank_onboarding_user_details', wp_parse_args( $details, DEFAULT_USER_DETAILS ) ); } /* * Set Onboarding Data * * We need to store the facebook page url and twitter profile username in the settings array as per the new requirement. * * @since 1.0.0 * @param array<string, mixed> $data Data. * @param array<string, mixed> $settings Settings. * @return void / private function set_onboarding_data( $data, &$settings ) { $settings['facebook_page_url'] = $data['social_profiles']['facebook'] ?? ''; $settings['twitter_profile_username'] = $data['social_profiles']['twitter'] ?? ''; } /* * Process Onboarding Data * * @since 1.0.0 * @param array<string, mixed> $data Data. * @param array<string, mixed> $settings Settings. * @return bool / private function process_onboarding_data( $data, &$settings ) { $this->set_website_details( $data, $settings ); $this->set_social_schema( $data, $settings ); $this->set_social_profiles( $data, $settings ); $lead = [ 'email' => $data['email'] ?? '', 'first_name' => $data['first_name'] ?? '', 'last_name' => $data['last_name'] ?? '', ]; $this->generate_lead( $lead ); $this->set_person_or_organization( $data, $settings ); return $this->save_onboarding_data( $data ); } /* * Set Person or Organization. * * @since 1.0.0 * @param array<string, mixed> $data Data. * @param array<string, mixed> $settings Settings. * @return void / private function set_person_or_organization( &$data, &$settings ) { $type = $this->person_or_organization( $data['website_type'] ); $data['person_or_organization'] = $type; /* * Depending on the type, we need to set the publisher to the correct schema. * We need to set the publisher for WebPage and Article. / $schema = $type === 'organization' ? '%schemas.organization%' : '%schemas.person%'; foreach ( [ 'WebPage', 'Article' ] as $context ) { $this->update_schema_field( $settings, $context, 'publisher', $schema ); } } /* * Set Social Profiles * * @since 1.0.0 * @param array<string, mixed> $data Data. * @param array<string, mixed> $settings Settings. * @return void / private function set_social_profiles( &$data, &$settings ) { $settings['social_profiles'] = $data['social_profiles']; unset( $data['social_profiles'] ); } /* * Generate Lead * * @since 1.0.0 * @param array<string,string> $lead Website data. * @return void */ private function generate_lead( $lead ) { $subscription_status = $this->get_user_details( 'lead', false ); if ( $subscription_status ) { return; } if ( empty( $lead['email'] ) \|\| empty( $lead['first_name'] ) ) { return; } $url = 'https://websitedemos.net/wp-json/surerank/v1/subscribe/'; $args = [ 'body' => [ 'EMAIL' => $lead['email'], 'FIRSTNAME' => $lead['first_name'], 'LASTNAME' => $lead['last_name'] ?? '', ], ]; $response = Requests::post( $url, $args ); if ( ! is_wp_error( $response ) \|\| wp_remote_retrieve_response_code( $response ) === 200 ) { $response = json_decode( wp_remote_retrieve_body( $response ), true ); $lead['lead'] = true; $this->set_user_details( $lead ); } } }	17.67 KB	2025-10-27 18:36
📄 post.php <?php /** * Post class * * Handles post related REST API endpoints for the SureRank plugin. * * @package SureRank\Inc\API / namespace SureRank\Inc\API; use SureRank\Inc\Functions\Defaults; use SureRank\Inc\Functions\Get; use SureRank\Inc\Functions\Helper; use SureRank\Inc\Functions\Send_Json; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Functions\Update; use SureRank\Inc\Traits\Get_Instance; use WP_Error; use WP_REST_Request; use WP_REST_Server; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Class Post * * Handles post related REST API endpoints. / class Post extends Api_Base { use Get_Instance; /* * Route Get Post Seo Data / protected const POST_SEO_DATA = '/post/settings'; /* * Route Get Post Content / protected const POST_CONTENT = '/admin/post-content'; /* * Constructor * * @since 1.0.0 / public function __construct() { } /* * Register API routes. * * @since 1.0.0 * @return void / public function register_routes() { $namespace = $this->get_api_namespace(); $this->register_all_post_routes( $namespace ); } /* * Get post seo data * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @since 1.0.0 * @return void / public function get_post_seo_data( $request ) { $post_id = $request->get_param( 'post_id' ); $post_type = $request->get_param( 'post_type' ); $is_taxonomy = $request->get_param( 'is_taxonomy' ); $data = self::get_post_data_by_id( $post_id, $post_type, $is_taxonomy ); $decode_data = Utils::decode_html_entities_recursive( $data ) ?? $data; Send_Json::success( $decode_data ); } /* * Get post data by id * * @param int $post_id Post id. * @param string $post_type Post type. * @param bool $is_taxonomy Is taxonomy. * @return array<string, mixed> / public static function get_post_data_by_id( $post_id, $post_type = 'post', $is_taxonomy = false ) { $all_options = Settings::format_array( Defaults::get_instance()->get_post_defaults( false ) ); return [ 'data' => array_intersect_key( Settings::prep_post_meta( $post_id, $post_type, $is_taxonomy ), $all_options ), 'global_default' => Settings::get(), ]; } /* * Update seo data * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @since 1.0.0 * @return void / public function update_post_seo_data( $request ) { $post_id = $request->get_param( 'post_id' ); $data = $request->get_param( 'metaData' ); self::update_post_meta_common( $post_id, $data ); if ( is_wp_error( $this->run_checks( $post_id ) ) ) { Send_Json::error( [ 'message' => __( 'Error while running SEO Checks.', 'surerank' ) ] ); } Send_Json::success( [ 'message' => __( 'Data updated', 'surerank' ) ] ); } /* * Update post meta common * This function updates the post meta for a given post ID with the provided data. * It merges existing post meta with the new data, ensuring that all options are updated correctly. * * @param int $post_id Post ID. * @param array<string, mixed> $data Data to update. * @since 1.0.0 * @return void / public static function update_post_meta_common( int $post_id, array $data ): void { $all_options = Defaults::get_instance()->get_post_defaults( false ); /* Getting post meta if exists, otherwise getting all options(defaults) / $post_meta = Get::all_post_meta( $post_id ); if ( ! empty( $post_meta ) ) { $data = array_merge( $post_meta, $data ); } $processed_options = Utils::process_option_values( $all_options, $data ); foreach ( $processed_options as $option_name => $new_option_value ) { Update::post_meta( $post_id, 'surerank_settings_' . $option_name, $new_option_value ); } } /* * Get post types * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @since 1.0.0 * @return void / public function get_post_type_data( $request ) { $data = $this->prepare_post_type_data(); Send_Json::success( [ 'data' => $data ] ); } /* * Run checks * * @param int $post_id Post ID. * @return WP_Error\|array<string, mixed> / public function run_checks( $post_id ) { if ( ! $post_id ) { return new WP_Error( 'no_post_id', __( 'No post ID provided.', 'surerank' ) ); } $post = get_post( $post_id ); if ( ! $post ) { return new WP_Error( 'no_post', __( 'No post found.', 'surerank' ) ); } return apply_filters( 'surerank_run_post_seo_checks', $post_id, $post ); } /* * Register all post routes * * @param string $namespace The API namespace. * @return void / private function register_all_post_routes( $namespace ) { $this->register_get_post_seo_data_route( $namespace ); $this->register_update_post_seo_data_route( $namespace ); $this->register_post_content_route( $namespace ); } /* * Register get post SEO data route * * @param string $namespace The API namespace. * @return void / private function register_get_post_seo_data_route( $namespace ) { register_rest_route( $namespace, self::POST_SEO_DATA, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_post_seo_data' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_post_seo_data_args(), ] ); } /* * Register update post SEO data route * * @param string $namespace The API namespace. * @return void / private function register_update_post_seo_data_route( $namespace ) { register_rest_route( $namespace, self::POST_SEO_DATA, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'update_post_seo_data' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_update_post_seo_data_args(), ] ); } /* * Register post content route * * @param string $namespace The API namespace. * @return void / private function register_post_content_route( $namespace ) { register_rest_route( $namespace, self::POST_CONTENT, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_post_type_data' ], 'permission_callback' => [ $this, 'validate_permission' ], ] ); } /* * Get post SEO data arguments * * @return array<string, array<string, mixed>> / private function get_post_seo_data_args() { return [ 'post_id' => [ 'type' => 'integer', 'required' => true, 'sanitize_callback' => 'absint', ], 'post_type' => [ 'type' => 'string', 'required' => true, 'sanitize_callback' => 'sanitize_text_field', ], ]; } /* * Get update post SEO data arguments * * @return array<string, array<string, mixed>> / private function get_update_post_seo_data_args() { return [ 'post_id' => [ 'type' => 'integer', 'required' => true, 'sanitize_callback' => 'absint', ], 'metaData' => [ 'type' => 'object', 'required' => true, 'sanitize_callback' => [ $this, 'sanitize_array_data' ], ], ]; } /* * Prepare post type data * * @return array<string, mixed> / private function prepare_post_type_data() { $data = []; $settings = Settings::get(); $data['post_types'] = Helper::get_formatted_post_types(); $data['taxonomies'] = Helper::get_formatted_taxonomies(); $data['archives'] = $this->build_archives_list( $settings ); $data['roles'] = Helper::get_role_names(); return array_filter( $data ); } /* * Build archives list * * @param array<string, mixed> $settings Settings array. * @return array<string, string> */ private function build_archives_list( $settings ) { $archives = []; if ( $settings['author_archive'] ?? false ) { $archives['author'] = __( 'Author pages', 'surerank' ); } if ( $settings['date_archive'] ?? false ) { $archives['date'] = __( 'Date archives', 'surerank' ); } $archives['search'] = __( 'Search pages', 'surerank' ); return $archives; } }	8.02 KB	2025-10-27 18:36
📄 robots-txt.php <?php /** * RobotsTxt class * * Handles installed products related REST API endpoints for the SureRank plugin. * * @package SureRank\Inc\API / namespace SureRank\Inc\API; use SureRank\Inc\Functions\Send_Json; use SureRank\Inc\Traits\Get_Instance; use WP_REST_Server; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Class RobotsTxt * * Handles robots.txt related REST API endpoints. / class RobotsTxt extends Api_Base { use Get_Instance; /* * Route Get Robots.txt / protected const ROBOTS_TXT = '/robots-txt'; /* * Register API routes. * * @since 1.2.0 * @return void / public function register_routes() { register_rest_route( $this->get_api_namespace(), self::ROBOTS_TXT, [ 'methods' => WP_REST_Server::CREATABLE, // POST method. 'callback' => [ $this, 'update_robots_txt' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'robots_txt_content' => [ 'required' => true, 'type' => 'string', ], ], ] ); } /* * Update the robots.txt content. * * @param \WP_REST_Request<array<string, mixed>> $request Request object. * @return void */ public function update_robots_txt( $request ) { $robots_content = $request->get_param( 'robots_txt_content' ); $robots_content = sanitize_textarea_field( $robots_content ); update_option( SURERANK_ROBOTS_TXT_CONTENT, $robots_content ); Send_Json::success( [ 'success' => true, 'data' => [ 'robots_txt_content' => $robots_content, ], ] ); } }	1.59 KB	2025-10-27 18:36
📄 sitemap.php <?php /** * Sitemap API class * * Handles sitemap cache generation related REST API endpoints for the SureRank plugin. * * @package SureRank\Inc\API / namespace SureRank\Inc\API; use SureRank\Inc\Functions\Cron; use SureRank\Inc\Functions\Send_Json; use SureRank\Inc\Traits\Get_Instance; use WP_REST_Request; use WP_REST_Server; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Class Sitemap * * Handles sitemap cache generation related REST API endpoints. / class Sitemap extends Api_Base { use Get_Instance; /* * Route for generating sitemap cache / protected const GENERATE_CACHE = '/sitemap/generate-cache'; /* * Register API routes. * * @since 1.2.0 * @return void / public function register_routes() { register_rest_route( $this->get_api_namespace(), self::GENERATE_CACHE, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'generate_cache' ], 'permission_callback' => [ $this, 'validate_permission' ], ] ); } /* * Generate sitemap cache. * * @param WP_REST_Request<array<string, mixed>> $request REST API request object. * @since 1.2.0 * @return void / public function generate_cache( $request ) { try { wp_schedule_single_event( time() + 10, Cron::SITEMAP_CRON_EVENT, [ 'yes' ] ); Send_Json::success( [ 'message' => __( 'Sitemap cache generation has started.', 'surerank' ), 'description' => __( 'This may take up to 5 minutes, please wait before checking the sitemap.', 'surerank' ), ] ); } catch ( \Exception $e ) { Send_Json::error( [ 'message' => sprintf( / translators: %s: Error message */ __( 'Failed to start cache generation: %s', 'surerank' ), $e->getMessage() ), ] ); } } }	1.79 KB	2025-10-27 18:36
📄 term.php <?php /** * Term class * * Handles term related REST API endpoints for the SureRank plugin. * * @package SureRank\Inc\API / namespace SureRank\Inc\API; use SureRank\Inc\Functions\Defaults; use SureRank\Inc\Functions\Get; use SureRank\Inc\Functions\Send_Json; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Functions\Update; use SureRank\Inc\Traits\Get_Instance; use WP_Error; use WP_REST_Request; use WP_REST_Server; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Class Term * * Handles term related REST API endpoints. / class Term extends Api_Base { use Get_Instance; /* * Route Get Term Seo Data / protected const TERM_SEO_DATA = '/term/settings'; /* * Constructor * * @since 1.0.0 / public function __construct() { } /* * Register API routes. * * @since 1.0.0 * @return void / public function register_routes() { $namespace = $this->get_api_namespace(); $this->register_all_term_routes( $namespace ); } /* * Get term seo data * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @since 1.0.0 * @return void / public function get_term_seo_data( $request ) { $term_id = $request->get_param( 'term_id' ); $post_type = $request->get_param( 'post_type' ); $is_taxonomy = $request->get_param( 'is_taxonomy' ); $data = self::get_term_data_by_id( $term_id, $post_type, $is_taxonomy ); Send_Json::success( $data ); } /* * Get term data by id * * @param int $term_id Term ID. * @param string $post_type Post type. * @param bool $is_taxonomy Is taxonomy. * @return array<string, mixed> / public static function get_term_data_by_id( $term_id, $post_type, $is_taxonomy ) { $all_options = Settings::format_array( Defaults::get_instance()->get_post_defaults( false ) ); $data = array_intersect_key( Settings::prep_term_meta( $term_id, $post_type, $is_taxonomy ), $all_options ); $decode_data = Utils::decode_html_entities_recursive( $data ) ?? $data; $global_defaults = Settings::get(); $decode_global_defaults = Utils::decode_html_entities_recursive( $global_defaults ) ?? $global_defaults; return [ 'data' => $decode_data, 'global_default' => $decode_global_defaults, ]; } /* * Update seo data * * @param WP_REST_Request<array<string, mixed>> $request Request object. * @since 1.0.0 * @return void / public function update_term_seo_data( $request ) { $term_id = $request->get_param( 'term_id' ); $data = $request->get_param( 'metaData' ); self::update_term_meta_common( $term_id, $data ); if ( is_wp_error( $this->run_checks( $term_id ) ) ) { Send_Json::error( [ 'message' => __( 'Error while running SEO Checks.', 'surerank' ) ] ); } Send_Json::success( [ 'message' => __( 'Data updated', 'surerank' ) ] ); } /* * Common method to process and update term meta data * * @param int $term_id Term ID to update. * @param array<string, mixed> $data Data to update. * @return void / public static function update_term_meta_common( int $term_id, array $data ) { $all_options = Defaults::get_instance()->get_post_defaults( false ); /* Getting post meta if exists, otherwise getting all options(defaults) / $term_meta = Get::all_term_meta( $term_id ); if ( ! empty( $term_meta ) ) { $data = array_merge( $term_meta, $data ); } $processed_options = Utils::process_option_values( $all_options, $data ); foreach ( $processed_options as $option_name => $new_option_value ) { Update::term_meta( $term_id, 'surerank_settings_' . $option_name, $new_option_value ); } } /* * Run checks * * @param int $term_id Term ID. * @return WP_Error\|array<string, mixed> / public function run_checks( $term_id ) { if ( ! $term_id ) { return new WP_Error( 'no_term_id', __( 'No term ID provided.', 'surerank' ) ); } $term = get_term( $term_id ); if ( ! $term \|\| is_wp_error( $term ) ) { return new WP_Error( 'no_term', __( 'No term found.', 'surerank' ) ); } return apply_filters( 'surerank_run_term_seo_checks', $term_id, $term ); } /* * Register all term routes * * @param string $namespace The API namespace. * @return void / private function register_all_term_routes( $namespace ) { $this->register_get_term_seo_data_route( $namespace ); $this->register_update_term_seo_data_route( $namespace ); } /* * Register get term SEO data route * * @param string $namespace The API namespace. * @return void / private function register_get_term_seo_data_route( $namespace ) { register_rest_route( $namespace, self::TERM_SEO_DATA, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_term_seo_data' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_term_seo_data_args(), ] ); } /* * Register update term SEO data route * * @param string $namespace The API namespace. * @return void / private function register_update_term_seo_data_route( $namespace ) { register_rest_route( $namespace, self::TERM_SEO_DATA, [ 'methods' => WP_REST_Server::CREATABLE, 'callback' => [ $this, 'update_term_seo_data' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => $this->get_update_term_seo_data_args(), ] ); } /* * Get term SEO data arguments * * @return array<string, array<string, mixed>> / private function get_term_seo_data_args() { return [ 'term_id' => [ 'type' => 'integer', 'required' => true, 'sanitize_callback' => 'absint', ], 'post_type' => [ 'type' => 'string', 'required' => true, 'sanitize_callback' => 'sanitize_text_field', ], ]; } /* * Get update term SEO data arguments * * @return array<string, array<string, mixed>> */ private function get_update_term_seo_data_args() { return [ 'term_id' => [ 'type' => 'integer', 'required' => true, 'sanitize_callback' => 'absint', ], 'metaData' => [ 'type' => 'object', 'required' => true, 'sanitize_callback' => [ $this, 'sanitize_array_data' ], ], ]; } }	6.26 KB	2025-10-27 18:36
📄 utils.php <?php /** * Utils class * Handles utility functions for the SureRank plugin API's * * @package SureRank\Inc\API / namespace SureRank\Inc\API; /* * Class Utils * * Provides utility functions for the SureRank plugin API's. / class Utils { /* * Recursively decode HTML entities in arrays, objects or strings. * * @param mixed $value Array, object, string or other. * @return mixed Decoded value of the same type. / public static function decode_html_entities_recursive( $value ) { if ( is_array( $value ) ) { foreach ( $value as $key => $item ) { $value[ $key ] = self::decode_html_entities_recursive( $item ); } return $value; } if ( is_object( $value ) ) { foreach ( get_object_vars( $value ) as $prop => $item ) { $value->{$prop} = self::decode_html_entities_recursive( $item ); } return $value; } if ( is_string( $value ) ) { return html_entity_decode( $value, ENT_QUOTES \| ENT_HTML5, 'UTF-8' ); } // leave ints, bools, null, etc. untouched. return $value; } /* * Process options data and return new option values * * @param array<string, mixed> $all_options All available options. * @param array<string, mixed> $data Data to process. * @return array<string, mixed> Processed option values. / public static function process_option_values( array $all_options, array $data ): array { $processed_options = []; foreach ( $all_options as $option_name => $option_value ) { $new_option_value = self::process_single_option_value( $option_name, $option_value, $data ); if ( ! empty( $new_option_value ) ) { $processed_options[ $option_name ] = $new_option_value; } } return $processed_options; } /* * Process a single option value * * @param string $option_name Option name. * @param mixed $option_value Option value. * @param array<string, mixed> $data Data to process. * @return mixed Processed option value. / private static function process_single_option_value( string $option_name, $option_value, array $data ) { if ( is_array( $option_value ) ) { return self::process_array_option_value( $option_name, $option_value, $data ); } return self::process_scalar_option_value( $option_name, $data ); } /* * Process array option value * * @param string $option_name Option name. * @param array<string, mixed> $option_value Option value. * @param array<string, mixed> $data Data to process. * @return array<string, mixed> / private static function process_array_option_value( string $option_name, array $option_value, array $data ): array { if ( empty( $option_value ) ) { return [ $option_name => $data[ $option_name ] ?? $option_value ]; } $new_option_value = []; foreach ( $option_value as $key => $value ) { if ( isset( $data[ $key ] ) ) { $new_option_value[ $key ] = $data[ $key ] !== '' ? $data[ $key ] : $value; } } return $new_option_value; } /* * Process scalar option value * * @param string $option_name Option name. * @param array<string, mixed> $data Data to process. * @return mixed */ private static function process_scalar_option_value( string $option_name, array $data ) { if ( ! isset( $data[ $option_name ] ) ) { return null; } return $data[ $option_name ] === '' ? false : $data[ $option_name ]; } }	3.31 KB	2025-10-27 18:36

Terminal