File "analyzer.php"
Full Path: /home/fresvfqn/waterdamagerestorationandrepairsmithtown.com/wp-content/plugins/surerank/inc/api/analyzer.php
File size: 53.02 KB
MIME-type: text/x-php
Charset: utf-8
<?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();
$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( $robots_url );
if ( is_wp_error( $response ) ) {
return [
'exists' => false,
'status' => 'error',
'description' => $helptext,
'message' => $not_working_label,
];
}
$content = trim( $response );
$is_valid = $this->is_valid_robots_txt( $content );
return [
'exists' => true,
'status' => $is_valid ? 'success' : 'warning',
'description' => $helptext,
'message' => $is_valid ? $working_label : $not_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 robots.txt is valid.
*
* @param string $robots_txt Robots.txt content.
* @return bool
*/
private function is_valid_robots_txt( string $robots_txt ) {
if ( empty( $robots_txt ) ) {
return false;
}
return preg_match( '/^(User-agent|Disallow|Allow|Sitemap):/im', $robots_txt ) === 1;
}
/**
* 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,
]
);
}
}