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
📄 checksum.php <?php /** * Sitemap Utilities * * Utility functions to manage XML headers, stylesheets, and other reusable functions for sitemaps. * * @since 1.2.0 * @package SureRank / namespace SureRank\Inc\Sitemap; use SureRank\Inc\Admin\Sync; use SureRank\Inc\Functions\Get; use SureRank\Inc\Traits\Get_Instance; use WP_Post; use WP_Term; /* * Checksum Utility Functions Class * * Provides methods for checksum generation. * * @since 1.2.0 / class Checksum { use Get_Instance; /* * Constructor. / public function __construct() { if ( ! defined( 'SURERANK_SITEMAP_CHECKSUM' ) ) { define( 'SURERANK_SITEMAP_CHECKSUM', 'surerank_sitemap_cache_checksum' ); } if ( ! defined( 'SURERANK_SITEMAP_CACHE_CHECKSUM' ) ) { define( 'SURERANK_SITEMAP_CACHE_CHECKSUM', 'surerank_sitemap_cache_updated_checksum' ); } add_action( 'wp_after_insert_post', [ $this, 'handle_content_change' ], 10, 3 ); add_action( 'before_delete_post', [ $this, 'handle_post_delete' ] ); add_action( 'created_term', [ $this, 'handle_term_change' ], 10, 3 ); add_action( 'edited_term', [ $this, 'handle_term_change' ], 10, 3 ); add_action( 'delete_term', [ $this, 'handle_term_delete' ], 10, 4 ); } /* * Handle content change for posts. * * @param int $post_id Post ID. * @param WP_Post\|null $post Post object. * @param bool $update Whether this is an existing post being updated. * @return void * @since 1.2.0 / public function handle_content_change( $post_id, $post = null, $update = false ) { // Avoid infinite loop. if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) { return; } if ( ! $post instanceof WP_Post ) { return; } if ( $this->should_exclude_post( $post_id, $post ) ) { return; } $this->update_checksum(); } /* * Handle post deletion. * * @param int $post_id Post ID. * @return void * @since 1.2.0 / public function handle_post_delete( $post_id ) { $this->update_checksum(); } /* * Handle term change. * * @param int $term_id Term ID. * @param int $tt_id Term taxonomy ID. * @param string $taxonomy Taxonomy slug. * @return void * @since 1.2.0 / public function handle_term_change( $term_id, $tt_id = null, $taxonomy = null ) { // Avoid infinite loop. if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) { return; } if ( ! $taxonomy ) { return; } if ( $this->should_exclude_term( $term_id, $taxonomy ) ) { return; } $this->update_checksum(); } /* * Handle term deletion. * * @param int $term_id Term ID. * @param int $tt_id Term taxonomy ID. * @param string $taxonomy Taxonomy slug. * @param WP_Term\|null $deleted_term Deleted term object. * @return void * @since 1.2.0 / public function handle_term_delete( $term_id, $tt_id = null, $taxonomy = null, $deleted_term = null ) { $this->update_checksum(); } /* * Update the checksum for a given post or term. * * @param string $checksum Checksum value. * @return void * @since 1.2.0 / public function update_cache_checksum( $checksum = '' ) { if ( empty( $checksum ) ) { $random_password = wp_generate_password( 20, true, true ); $timestamp = time(); $checksum = hash( 'sha256', $random_password . $timestamp ); } // Save to options table or use transient for shorter duration. update_option( SURERANK_SITEMAP_CACHE_CHECKSUM, $checksum ); } /* * Get the current checksum. * * @return string * @since 1.2.0 / public function get_checksum() { return get_option( SURERANK_SITEMAP_CHECKSUM, '' ); } /* * Get the current checksum. * * @return string * @since 1.2.0 / public function get_cache_checksum() { return get_option( SURERANK_SITEMAP_CACHE_CHECKSUM, '' ); } /* * Clear the checksum. * * @return void * @since 1.2.0 / public function clear_checksum() { delete_option( SURERANK_SITEMAP_CHECKSUM ); delete_option( SURERANK_SITEMAP_CACHE_CHECKSUM ); } /* * Update the checksum for a given post or term. * * @return void * @since 1.2.0 / public function update_checksum() { $random_password = wp_generate_password( 20, true, true ); $timestamp = time(); $checksum = hash( 'sha256', $random_password . $timestamp ); // Save to options table or use transient for shorter duration. update_option( SURERANK_SITEMAP_CHECKSUM, $checksum ); } /* * Check if a post should be excluded from sitemap processing. * * @param int $post_id Post ID. * @param WP_Post $post Post object. * @return bool True if post should be excluded, false otherwise. * @since 1.2.0 / private function should_exclude_post( $post_id, $post ) { $no_index = Utils::get_noindex_settings(); if ( in_array( $post->post_type, $no_index ) ) { return true; } if ( Get::post_meta( $post_id, 'surerank_settings_post_no_index', true ) === 'yes' ) { return true; } $included_post_types = Sync::get_instance()->get_included_post_types(); if ( empty( $included_post_types ) ) { return true; } $included_post_types = array_keys( $included_post_types ); if ( ! in_array( $post->post_type, $included_post_types, true ) ) { return true; } return false; } /* * Check if a term should be excluded from sitemap processing. * * @param int $term_id Term ID. * @param string $taxonomy Taxonomy slug. * @return bool True if term should be excluded, false otherwise. * @since 1.2.0 */ private function should_exclude_term( $term_id, $taxonomy ) { $no_index = Utils::get_noindex_settings(); if ( in_array( $taxonomy, $no_index ) ) { return true; } if ( Get::term_meta( $term_id, 'surerank_settings_post_no_index', true ) === 'yes' ) { return true; } $included_taxonomies = Sync::get_instance()->get_included_taxonomies(); if ( empty( $included_taxonomies ) ) { return true; } $included_taxonomies = array_column( $included_taxonomies, 'slug' ); if ( ! in_array( $taxonomy, $included_taxonomies, true ) ) { return true; } return false; } }	5.97 KB	2025-10-27 18:36
📄 sitemap.php <?php /** * Abstract Sitemap Class * * This file contains the abstract base class for sitemap generation. * * @package surerank * @since 1.2.0 / namespace SureRank\Inc\Sitemap; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Get; use WP_Query; use WP_Term; /* * Abstract Sitemap * Base class for sitemap generation with common functionality. * * @since 1.2.0 / abstract class Sitemap { /* * Get noindex settings. * * @return array<string, mixed>\|array<int, string> / public function get_noindex_settings() { $settings = Get::option( SURERANK_SETTINGS ); return $settings['no_index'] ?? []; } /* * Get post type prefix for sitemap URLs. * * @return string / public static function get_post_type_prefix() { return apply_filters( 'surerank_sitemap_post_type_prefix', 'post-type' ); } /* * Get taxonomy prefix for sitemap URLs. * * @return string / public static function get_taxonomy_prefix() { return apply_filters( 'surerank_sitemap_taxonomy_prefix', 'taxonomy-type' ); } /* * Check if the post is noindex. * * @param int\|null $post_id The post ID. * @param string\|null $post_type The post type. * @return bool / public function is_noindex( $post_id = null, $post_type = null ) { if ( ! $post_id \|\| ! $post_type ) { return true; } return $this->indexable( $post_id, $post_type, 'get_post_meta', 'noindex' ); } /* * Check if the term is noindex. * * @param int\|null $term_id The term ID. * @param string\|null $taxonomy The taxonomy. * @return bool / public function is_noindex_term( $term_id = null, $taxonomy = null ) { if ( ! $term_id \|\| ! $taxonomy ) { return true; } return $this->indexable( $term_id, $taxonomy, 'get_term_meta', 'noindex' ); } /* * Get meta query for indexable content based on no_index settings * * @param string $content_type The post type or taxonomy name. * @return array<int\|string, mixed> The meta query array. / public function get_indexable_meta_query( string $content_type ): array { return Utils::get_indexable_meta_query( $content_type ); } /* * Meta Query Args. * * @param array<string, mixed> $args The arguments to modify. * @return array<string, mixed>\|array<int, string> / public function meta_query_args( $args ) { $args['meta_query'] = [ //phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query [ 'key' => 'surerank_settings_post_no_index', 'value' => 'no', 'compare' => '=', ], ]; return $args; } /* * Get total count. * * @param string $type The type to get the total count for. * @return int / public function get_total_count( $type ) { $no_index = $this->get_noindex_settings(); if ( in_array( $type, $no_index, true ) ) { $total_count = $this->check_noindex( $type, 'count' ); } else { if ( post_type_exists( $type ) ) { $total_count = wp_count_posts( $type )->publish ?? 0; } else { $total_count = wp_count_terms( [ 'taxonomy' => $type ] ); } } return $total_count; } /* * Helper function to check noindex status. * * @param string $type The type to check against (post type or taxonomy). * @param string $action The action to perform (check, count, or get). * @return bool\|int / protected function check_noindex( $type, $action = 'check' ) { $taxonomy_type = str_replace( '-', '_', $type ); $count = $this->get_content_count( $type, $taxonomy_type ); if ( $action === 'count' ) { return $count; } return $count === 0 && $this->is_type_noindexed( $type, $taxonomy_type ); } /* * Get posts query for sitemap generation. * * @param string $type Post type. * @param int\|null $page Page number (optional for HTML sitemaps). * @param int\|null $offset Number of posts to retrieve (optional for HTML sitemaps). * @param array<string, mixed> $additional_args Additional arguments. * @return WP_Query\|null / protected function get_posts_query( $type, $page = null, $offset = null, $additional_args = [] ) { if ( $this->check_noindex( $type, 'check' ) ) { return null; } $no_index = $this->get_noindex_settings(); $args = [ 'post_type' => $type, 'post_status' => 'publish', 'cache_results' => true, 'post__not_in' => apply_filters( 'surerank_exclude_posts_from_sitemap', [] ), ]; $args = array_merge( $args, $additional_args ); if ( $page !== null && $offset !== null ) { $args['posts_per_page'] = $offset; $args['paged'] = $page; } else { $args['posts_per_page'] = -1; } if ( in_array( $type, $no_index, true ) ) { $args = $this->meta_query_args( $args ); } return new WP_Query( $args ); } /* * Get terms query for sitemap generation. * * @param string $taxonomy Taxonomy name. * @param int\|null $page Page number (optional for HTML sitemaps). * @param int\|null $offset Number of terms to retrieve (optional for HTML sitemaps). * @return array<int, int\|string\|WP_Term>\|bool / protected function get_terms_query( $taxonomy, $page = null, $offset = null ) { if ( $this->check_noindex( $taxonomy, 'check' ) ) { return false; } $no_index = $this->get_noindex_settings(); $args = [ 'taxonomy' => $taxonomy, 'hide_empty' => true, ]; if ( $page !== null && $offset !== null ) { $calculated_offset = ( $page - 1 ) $offset; $args['number'] = $offset; $args['offset'] = $calculated_offset; } if ( in_array( $taxonomy, $no_index, true ) ) { $args = $this->meta_query_args( $args ); } $terms = get_terms( $args ); if ( is_wp_error( $terms ) ) { return false; } if ( empty( $terms ) \|\| ! is_array( $terms ) ) { return false; } return $terms; } /** * Helper function to check noindex status. * * @param mixed $id The ID to check (post ID or term ID). * @param string $type The type to check against (post type or taxonomy). * @param string $meta_key The meta key to look up. * @param string $settings_key The settings key to fall back to. * @return bool / protected function indexable( $id, $type, $meta_key, $settings_key ) { if ( ! $id ) { return true; } $meta = $meta_key === 'get_post_meta' ? get_post_meta( $id, 'surerank_settings_post_no_index', true ) : get_term_meta( $id, 'surerank_settings_post_no_index', true ); if ( $meta === 'yes' ) { return true; } if ( $meta === 'no' ) { return false; } $no_index = $this->get_noindex_settings(); if ( in_array( $type, $no_index, true ) ) { return true; } return false; } /* * Get content count for a type. * * @param string $type The type to check. * @param string $taxonomy_type The taxonomy type. * @return int Content count. / private function get_content_count( string $type, string $taxonomy_type ): int { if ( taxonomy_exists( $taxonomy_type ) ) { return $this->get_taxonomy_count( $taxonomy_type ); } if ( post_type_exists( $type ) ) { return $this->get_post_type_count( $type ); } return 0; } /* * Get taxonomy count. * * @param string $taxonomy_type The taxonomy type. * @return int Term count. / private function get_taxonomy_count( string $taxonomy_type ): int { $args = [ 'taxonomy' => $taxonomy_type, 'hide_empty' => false, ]; $args = $this->meta_query_args( $args ); $terms = get_terms( $args ); return is_array( $terms ) ? count( $terms ) : 0; } /* * Get post type count. * * @param string $type The post type. * @return int Post count. / private function get_post_type_count( string $type ): int { $args = [ 'post_type' => $type, 'posts_per_page' => 1, 'fields' => 'ids', ]; $args = $this->meta_query_args( $args ); $query = new WP_Query( $args ); return $query->found_posts; } /* * Check if type is in noindex settings. * * @param string $type The type to check. * @param string $taxonomy_type The taxonomy type. * @return bool True if noindexed. */ private function is_type_noindexed( string $type, string $taxonomy_type ): bool { $no_index = $this->get_noindex_settings(); if ( taxonomy_exists( $taxonomy_type ) ) { return in_array( $taxonomy_type, $no_index, true ); } return in_array( $type, $no_index, true ); } }	8.2 KB	2025-10-27 18:36
📄 stylesheet.php <?php /** * Sitemap Stylesheet Class * * Handles the generation of XML stylesheets for sitemaps. * * @package SureRank * @since 0.0.1 / namespace SureRank\Inc\Sitemap; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Class Stylesheet * * Generates sitemap stylesheets dynamically. / class Stylesheet { /* * Generates the XML for the sitemap stylesheet. * * @param string $sitemap_title The title of the sitemap. * @param string $sitemap_slug The slug of the sitemap. * @return string The generated XML stylesheet as a string. */ public function generate( string $sitemap_title, string $sitemap_slug ): string { ob_start(); echo '<?xml version="1.0" encoding="UTF-8"?>'; // Direct echo to avoid PHP parsing issues. ?> <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:s="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1"> <xsl:output method="html" encoding="UTF-8" indent="yes" /> <xsl:template match="/"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title><?php echo esc_html( $sitemap_title ); ?></title> <link href="https://fonts.googleapis.com/css2?family=Figtree:ital,wght@0,300..900;1,300..900&display=swap" rel="stylesheet" /> <style> body { font-family: Figtree, sans-serif; background-color: #fff; color: #333; line-height: 1.6; margin: 0; } h1, h2 { color: #fff; margin: 0px; margin-bottom: 8px; } p { color: #E5E7EB; margin: 0px; font-size: 14px; font-weight: 400; } table { width: 100%; border-collapse: separate; border-spacing: 0; background-color: #fff; border-radius: 8px; box-shadow: 0px 4px 8px rgba(0, 0, 0, 0.05); border: 1px solid #E5E7EB; } th, td { padding: 12px; text-align: left; } th { background-color: #F9FAFB; color: #111827; font-weight: 500; font-size: 14px; border-radius: 8px 8px 0 0; } td { background-color: #fdfdfd; color: #4B5563; padding: 22px 12px; font-size: 14px; font-weight: 400; border-top: 1px solid #E5E7EB; border-radius: 0px 0px 8px 8px; } td a { color: #4330D2; text-decoration: none; font-weight: 400; } a { color: #E5E7EB; text-decoration: underline; font-size: 14px; font-weight: 400; } a:hover { text-decoration: underline; } .date { color: #4B5563; font-size: 0.9em; } .image-list { font-style: italic; color: #4B5563; } ul { list-style-type: none; padding: 0; margin: 0; } li { margin-bottom: 10px; } .sitemap-container { background-color: #4330D2; padding: 32px; } .sitemap-content { padding: 16px; margin: 0 auto; max-width: 1100px; margin-top:16px; } .sitemap-count { font-size: 14px; font-weight: 400; color: #111827; padding-bottom: 16px; } .sitemap-index { font-size: 12px; font-weight: 600; color: #4330D2; text-decoration: none; padding-bottom: 16px; } .sitemap-index div { margin-bottom: 20px; } </style> </head> <body> <div class="sitemap-container"> <h2><?php echo esc_html( $sitemap_title ); ?></h2> <p>This XML Sitemap was generated by the <a target="_blank" href="https://surerank.com">SureRank WordPress SEO Plugin</a>. It helps search engines like Google, Bing, etc. crawl your website’s posts, pages, products, images, and archives.</p> <p><a target="_blank" href="https://www.sitemaps.org/protocol.html">Learn more about XML Sitemaps.</a></p> </div> <div class="sitemap-content"> <xsl:choose> <xsl:when test="s:sitemapindex"> <p class="sitemap-count" style="font-size: 16px;"> This XML Sitemap Index file contains <b><xsl:value-of select="count(s:sitemapindex/s:sitemap)" /> <xsl:choose> <xsl:when test="count(s:sitemapindex/s:sitemap) = 1"> sitemap</xsl:when> <xsl:otherwise> sitemaps</xsl:otherwise> </xsl:choose>.</b></p> <table> <thead> <tr> <th>Sitemap</th> <th>Last Modified</th> </tr> </thead> <tbody> <xsl:for-each select="s:sitemapindex/s:sitemap"> <tr> <td> <a href="{s:loc}"> <xsl:value-of select="s:loc" /> </a> </td> <td> <xsl:value-of select="s:lastmod" /> </td> </tr> </xsl:for-each> </tbody> </table> </xsl:when> <xsl:when test="count(s:urlset/s:url) = 0"> <p class="sitemap-count">No Indexable URLs found for this sitemap.</p> <a href="<?php echo esc_url( home_url( $sitemap_slug ) ); ?>" class="sitemap-index"> <div style="display: flex; align-items: center; gap: 8px;"> <svg width="14" height="14" viewBox="0 0 14 14" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M11.0846 7H2.91797" stroke="#4330D2" stroke-width="1.25" stroke-linecap="round" stroke-linejoin="round"/> <path d="M7.0013 11.0837L2.91797 7.00033L7.0013 2.91699" stroke="#4330D2" stroke-width="1.25" stroke-linecap="round" stroke-linejoin="round"/> </svg> Back to Sitemap Index </div> </a> </xsl:when> <xsl:otherwise> <p class="sitemap-count" style="font-size: 16px;"> This XML Sitemap contains <b><xsl:value-of select="count(s:urlset/s:url)" /></b> URLs.</p> <a href="<?php echo esc_url( home_url( $sitemap_slug ) ); ?>" class="sitemap-index"> <div style="display: flex; align-items: center; gap: 8px;"> <svg width="14" height="14" viewBox="0 0 14 14" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M11.0846 7H2.91797" stroke="#4330D2" stroke-width="1.25" stroke-linecap="round" stroke-linejoin="round"/> <path d="M7.0013 11.0837L2.91797 7.00033L7.0013 2.91699" stroke="#4330D2" stroke-width="1.25" stroke-linecap="round" stroke-linejoin="round"/> </svg> Back to Sitemap Index </div> </a> <table> <thead> <tr> <th>URL</th> <th>Images</th> <th>Last Modified</th> </tr> </thead> <tbody> <xsl:for-each select="s:urlset/s:url"> <tr> <td> <a href="{s:loc}"> <xsl:value-of select="s:loc" /> </a> </td> <td class="image-list"> <xsl:choose> <xsl:when test="image:image"> <xsl:value-of select="count(image:image)" /> </xsl:when> <xsl:otherwise>0</xsl:otherwise> </xsl:choose> </td> <td class="date"> <xsl:value-of select="s:lastmod" /> </td> </tr> </xsl:for-each> </tbody> </table> </xsl:otherwise> </xsl:choose> </div> </body> </html> </xsl:template> </xsl:stylesheet> <?php return (string) ob_get_clean(); } }	7.48 KB	2025-10-27 18:36
📄 utils.php <?php /** * Sitemap Utilities * * Utility functions to manage XML headers, stylesheets, and other reusable functions for sitemaps. * * @since 0.0.1 * @package SureRank / namespace SureRank\Inc\Sitemap; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use DOMDocument; use DOMElement; use DOMProcessingInstruction; use RuntimeException; use SureRank\Inc\Functions\Get; use SureRank\Inc\Traits\Get_Instance; /* * Sitemap Utility Functions Class * * Provides methods for generating XML for sitemap indexes and main sitemaps. * * @since 1.0.0 / class Utils { use Get_Instance; /* * Generates the XML for the sitemap index. * * @param array<string, mixed>\|array<int, string> $sitemap List of sitemap URLs to include in the index. * @return string XML string for the sitemap index. * @throws RuntimeException If XML generation fails. / public static function sitemap_index( array $sitemap ): string { self::output_headers(); $dom = self::create_dom(); $xsl_stylesheet = self::add_stylesheet( $dom, 'sitemap-stylesheet.xsl' ); $dom->appendChild( $xsl_stylesheet ); $sitemap_index = self::create_urlset( 'sitemapindex', $dom ); // Add each sitemap URL to the <sitemapindex>. foreach ( $sitemap as $url ) { $sitemap_element = $dom->createElement( 'sitemap' ); $loc = $dom->createElement( 'loc', esc_url( (string) $url['link'] ) ); $formatted_lastmod = (string) $url['updated']; $lastmod = $dom->createElement( 'lastmod', esc_xml( (string) $formatted_lastmod ) ); $sitemap_element->appendChild( $loc ); $sitemap_element->appendChild( $lastmod ); $sitemap_index->appendChild( $sitemap_element ); } // Return the XML as a string or throw an exception if saveXML fails. $xml_string = $dom->saveXML(); if ( false === $xml_string ) { throw new RuntimeException( 'Failed to generate sitemap index XML.' ); } return $xml_string; } /* * Generates the XML for the main sitemap with individual URLs. * * @param array<string, mixed>\|array<int, string> $sitemap Array of URL data, each containing 'link', 'updated', and optional 'images'. * @return string XML string for the main sitemap. * @throws RuntimeException If XML generation fails. / public static function sitemap_main( array $sitemap ): string { self::output_headers(); $dom = self::create_dom(); $xslt = self::add_stylesheet( $dom, 'sitemap-stylesheet.xsl' ); $dom->appendChild( $xslt ); // Create the root <urlset> element. $urlset = self::create_urlset( 'urlset', $dom ); $urlset->setAttribute( 'xmlns', 'http://www.sitemaps.org/schemas/sitemap/0.9' ); $urlset->setAttribute( 'xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance' ); $urlset->setAttribute( 'xsi:schemaLocation', 'http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd' ); $urlset->setAttribute( 'xmlns:image', 'http://www.google.com/schemas/sitemap-image/1.1' ); foreach ( $sitemap as $url ) { $url_element = $dom->createElement( 'url' ); $loc = $dom->createElement( 'loc', esc_url( (string) $url['link'] ) ); $url_element->appendChild( $loc ); $lastmod = $dom->createElement( 'lastmod', esc_xml( (string) $url['updated'] ) ); $url_element->appendChild( $lastmod ); // Add each image if available. if ( isset( $url['images_data'] ) ) { foreach ( $url['images_data'] as $image ) { $image_element = $dom->createElement( 'image:image' ); $image_loc = $dom->createElement( 'image:loc', esc_url( (string) $image['link'] ) ); $image_element->appendChild( $image_loc ); $url_element->appendChild( $image_element ); } } // Append the <url> element to <urlset>. $urlset->appendChild( $url_element ); } // Return the XML as a string or throw an exception if saveXML fails. $xml_string = $dom->saveXML(); if ( false === $xml_string ) { throw new RuntimeException( 'Failed to generate main sitemap XML.' ); } return $xml_string; } /* * Outputs necessary headers for XML display. * * @return void / public static function output_headers() { $headers = [ 'Pragma' => 'public', 'Cache-Control' => 'no-cache, no-store, must-revalidate, max-age=0', 'Content-Type' => 'application/xml; charset=UTF-8', ]; foreach ( $headers as $header => $value ) { header( "{$header}: {$value}" ); } } /* * Creates and initializes a new DOMDocument for XML. * * @return DOMDocument Initialized DOMDocument instance. / public static function create_dom(): DOMDocument { $doc = new DOMDocument( '1.0', 'UTF-8' ); $doc->formatOutput = true; return $doc; } /* * Creates and appends a root XML element for the sitemap. * * @param string $element Name of the root element (e.g., 'sitemapindex' or 'urlset'). * @param DOMDocument $dom The DOMDocument instance to append to. * @return DOMElement The created root element. / public static function create_urlset( string $element, DOMDocument $dom ): DOMElement { $urlset = $dom->createElement( $element ); $urlset->setAttribute( 'xmlns', 'http://www.sitemaps.org/schemas/sitemap/0.9' ); $dom->appendChild( $urlset ); return $urlset; } /* * Adds an XSL stylesheet to the DOM. * * @param DOMDocument $dom The DOMDocument instance to add the stylesheet to. * @param string $url Path to the XSL stylesheet. * @return DOMProcessingInstruction The created stylesheet instruction. / public static function add_stylesheet( DOMDocument $dom, string $url ): DOMProcessingInstruction { return $dom->createProcessingInstruction( 'xml-stylesheet', 'type="text/xsl" href="' . esc_url( site_url( '/' ) . $url ) . '"' ); } /* * Retrieves all images associated with a specific post. * * @param int $post_id The ID of the post. * @return array<string, mixed> Array of image URLs. / public static function get_images_from_post( int $post_id ) { $images = []; $thumbnail_url = self::get_thumbnail_image( $post_id ); if ( ! empty( $thumbnail_url ) ) { $images[] = $thumbnail_url; } $images = array_merge( $images, self::get_images_from_post_content( $post_id ) ); $images = array_merge( $images, self::get_images_from_gallery_shortcode( $post_id ) ); $attachment_image = self::get_attachment_image( $post_id ); if ( ! empty( $attachment_image ) ) { $images[] = $attachment_image; } return $images; } /* * Retrieves the post's thumbnail image. * * @param int $post_id Post ID. * @return string Thumbnail image URL or empty string if no thumbnail. / public static function get_thumbnail_image( int $post_id ): string { $thumbnail_id = get_post_thumbnail_id( $post_id ); $thumbnail_url = $thumbnail_id ? wp_get_attachment_url( $thumbnail_id ) : ''; return $thumbnail_url ? $thumbnail_url : ''; // Ensure it returns a string. } /* * Extracts images from the post content. * * @param int $post_id Post ID. * @return array<string, mixed>\|array<int, string> Array of image URLs. / public static function get_images_from_post_content( int $post_id ) { $images = []; $content = get_post_field( 'post_content', $post_id ); preg_match_all( '/<img[^>]+src="([^">]+)"/i', $content, $matches ); if ( ! empty( $matches[1] ) ) { $images = $matches[1]; } return $images; } /* * Retrieves image URL if post is an image attachment. * * @param int $post_id Post ID. * @return string\|null Image URL if attachment is an image, null otherwise. / public static function get_attachment_image( int $post_id ): ?string { if ( 'attachment' === get_post_type( $post_id ) && wp_attachment_is_image( $post_id ) ) { $attachment_url = wp_get_attachment_url( $post_id ); return $attachment_url ? $attachment_url : null; // Ensure it returns string or null. } return null; } /* * Extracts images from gallery shortcodes in the post content. * * @param int $post_id Post ID. * @return array<string, mixed>\|array<int, string> Array of image URLs from the gallery shortcode. / public static function get_images_from_gallery_shortcode( int $post_id ) { $images = []; $content = get_post_field( 'post_content', $post_id ); if ( preg_match_all( '/' . get_shortcode_regex( [ 'gallery' ] ) . '/s', $content, $matches, PREG_SET_ORDER ) ) { foreach ( $matches as $shortcode ) { if ( 'gallery' === $shortcode[2] ) { $attributes = shortcode_parse_atts( $shortcode[3] ); if ( ! empty( $attributes['ids'] ) ) { $ids = explode( ',', $attributes['ids'] ); foreach ( $ids as $id ) { $image_url = wp_get_attachment_url( (int) $id ); if ( $image_url ) { $images[] = $image_url; } } } } } } return $images; } /* * Outputs the stylesheet for the sitemap. * * @param string $stylesheet The stylesheet to output. * @since 1.0.0 * @return void / public static function output_stylesheet( $stylesheet ) { self::output_headers(); $sitemap_title = esc_html( get_bloginfo( 'name' ) . ' Sitemap' ); $sitemap_slug = Xml_Sitemap::get_slug(); $stylesheet_obj = new Stylesheet(); $stylesheet_content = $stylesheet_obj->generate( $sitemap_title, $sitemap_slug ); echo apply_filters( 'surerank_sitemap_output_stylesheet', $stylesheet_content, $stylesheet ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped exit; } /* * Get noindex settings. * * @return array<string, mixed>\|array<int, string> / public static function get_noindex_settings() { $settings = Get::option( SURERANK_SETTINGS ); return $settings['no_index'] ?? []; } /* * Get meta query for indexable content based on no_index settings * * @param string $content_type The post type or taxonomy name. * @return array<int\|string, mixed> The meta query array. */ public static function get_indexable_meta_query( string $content_type ): array { $no_index_settings = self::get_noindex_settings(); if ( in_array( $content_type, $no_index_settings, true ) ) { return [ [ 'key' => 'surerank_settings_post_no_index', 'value' => 'no', 'compare' => '=', ], ]; } return [ 'relation' => 'OR', [ 'key' => 'surerank_settings_post_no_index', 'value' => 'yes', 'compare' => '!=', ], [ 'key' => 'surerank_settings_post_no_index', 'compare' => 'NOT EXISTS', ], ]; } }	10.27 KB	2025-10-27 18:36
📄 xml-sitemap.php <?php /** * Common Meta Data * * This file handles functionality to generate sitemap in frontend. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Sitemap; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Cache; use SureRank\Inc\Functions\Helper; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Schema\Helper as Schema_Helper; use SureRank\Inc\Traits\Get_Instance; use WP_Query; /* * XML Sitemap * Handles functionality to generate XML sitemaps. * * @since 1.0.0 / class Xml_Sitemap extends Sitemap { use Get_Instance; /* * Sitemap slug to be used across the class. * * @var string / private static $sitemap_slug = 'sitemap_index'; /* * Constructor * * Sets up the sitemap functionality if XML sitemaps are enabled in settings. * * @since 1.0.0 * @return void / public function __construct() { add_filter( 'surerank_flush_rewrite_settings', [ $this, 'flush_settings' ], 10, 1 ); if ( ! Settings::get( 'enable_xml_sitemap' ) ) { return; } add_filter( 'wp_sitemaps_enabled', '__return_false' ); add_action( 'template_redirect', [ $this, 'template_redirect' ] ); add_action( 'parse_query', [ $this, 'parse_query' ], 1 ); } /* * Array of settings to flush rewrite rules on update settings * * @param array<string, mixed> $settings Existing settings to flush. * @since 1.0.0 * @return array<string, mixed> / public function flush_settings( $settings ) { $settings[] = 'enable_xml_sitemap'; $settings[] = 'enable_xml_image_sitemap'; return $settings; } /* * Returns the sitemap slug. * * @since 1.0.0 * @return string / public static function get_slug(): string { $sitemap_slug = apply_filters( 'surerank_sitemap_slug', self::$sitemap_slug ); $sitemap_slug = empty( $sitemap_slug ) ? self::$sitemap_slug : $sitemap_slug; return $sitemap_slug . '.xml'; } /* * Redirects default WordPress sitemap requests to custom sitemap URLs. * * @since 1.0.0 * @return void / public function template_redirect() { if ( ! isset( $_SERVER['REQUEST_URI'] ) ) { return; } $current_url = sanitize_text_field( wp_unslash( $_SERVER['REQUEST_URI'] ) ); $current_url = explode( '/', $current_url ); $last_url = end( $current_url ); $sitemap = [ 'sitemap.xml', 'wp-sitemap.xml', 'index.xml', ]; if ( in_array( $last_url, $sitemap, true ) ) { wp_safe_redirect( '/' . self::get_slug(), 301 ); exit; } } /* * Parses custom query variables and triggers sitemap generation. * * @param \WP_Query $query Current query object. * @since 1.0.0 * @return void / public function parse_query( \WP_Query $query ) { if ( ! $query->is_main_query() && ! is_admin() ) { return; } $type = sanitize_text_field( get_query_var( 'surerank_sitemap' ) ); $style = sanitize_text_field( get_query_var( 'surerank_sitemap_type' ) ); if ( ! $type && ! $style ) { return; } if ( $style ) { Utils::output_stylesheet( $style ); } $page = absint( get_query_var( 'surerank_sitemap_page' ) ) ? absint( get_query_var( 'surerank_sitemap_page' ) ) : 1; $threshold = apply_filters( 'surerank_sitemap_threshold', 200 ); do_action( 'surerank_sitemap_before_generation', $type, $page, $threshold ); // Dynamically handle CPTs. if ( post_type_exists( $type ) ) { $this->generate_main_sitemap( $type, $page, $threshold ); return; } $this->generate_sitemap( $type, $page, $threshold ); do_action( 'surerank_sitemap_after_generation', $type, $page, $threshold ); } /* * Generates the appropriate sitemap based on the requested type. * * @param string $type Sitemap type requested. * @param int $page Current page number for paginated sitemaps. * @param int $threshold Threshold for splitting sitemaps. * @since 1.0.0 * @return void / public function generate_sitemap( string $type, int $page, $threshold ) { $sitemap = []; if ( '1' === $type ) { $sitemap_index = Cache::get_file( 'sitemap_index.json' ); $sitemap = $sitemap_index ? json_decode( $sitemap_index, true ) : $this->generate_index_sitemap( $threshold ); $this->sitemapindex( $sitemap ); } $this->generate_main_sitemap( $type, $page, $threshold ); } /* * Generates a sitemap for WooCommerce product categories. * * @return array<string, mixed>\|array<int, string> List of product category URLs for the sitemap. / public function generate_product_cat_sitemap() { remove_all_actions( 'parse_query' ); $args = [ 'taxonomy' => 'product_cat', 'hide_empty' => false, 'number' => 0, ]; $product_cats = get_terms( $args ); $sitemap = []; if ( is_array( $product_cats ) ) { foreach ( $product_cats as $product_cat ) { $sitemap[] = get_term_link( $product_cat->term_id ); } } return $sitemap; } /* * Generates the index sitemap based on content thresholds. * * @param int $threshold Threshold for splitting sitemaps. * @return array<int, array{link: string, updated: string}> List of URLs for the index sitemap. / public function generate_index_sitemap( int $threshold ) { $sitemap_types = $this->collect_sitemap_types(); $sitemap = []; foreach ( $sitemap_types as $type => $total ) { if ( ! $this->should_include_type( $type, $total ) ) { continue; } $last_modified = $this->get_type_last_modified( $type ); $sitemap = array_merge( $sitemap, $this->build_sitemap_entries( $type, $total, $threshold, $last_modified ) ); } return $sitemap; } /* * Generates the main sitemap for a specific type, page, and offset. * * @param string $type Post type or taxonomy. * @param int $page Current page number. * @param int $offset Number of posts to retrieve. * @since 1.0.0 * @return void / public function generate_main_sitemap( string $type, int $page, int $offset = 1000 ) { remove_all_actions( 'parse_query' ); $sitemap = []; $prefix_param = sanitize_text_field( get_query_var( 'surerank_prefix' ) ); if ( Cache::file_exists( 'sitemap_index.json' ) ) { $sitemap = $this->get_sitemap_from_cache( $type, $page, $prefix_param ); $this->generate_main_sitemap_xml( $sitemap ); } // Handle CPTs dynamically. if ( post_type_exists( $type ) ) { $sitemap = $this->generate_post_sitemap( $type, $page, $offset ); } elseif ( 'author' === $type ) { $sitemap = $this->generate_author_sitemap( $page, $offset ); } elseif ( 'category' === $type ) { $sitemap = $this->generate_category_sitemap( $page, $offset ); } elseif ( 'post-tag' === $type ) { $sitemap = $this->generate_post_tag_sitemap( $page, $offset ); } elseif ( 'product-category' === $type ) { $sitemap = $this->generate_product_category_sitemap( $page, $offset ); } elseif ( taxonomy_exists( $type ) ) { $sitemap = $this->generate_taxonomy_sitemap( $type, $page, $offset ); } do_action( 'surerank_sitemap_generated', $sitemap, $type, $page ); // this action can be used to modify the sitemap data. $this->generate_main_sitemap_xml( $sitemap ); } /* * Outputs the sitemap index as XML. * * @param array<string, mixed>\|array<int, string> $sitemap Sitemap index data. * @since 1.0.0 * @return void / public function sitemapindex( array $sitemap ) { echo Utils::sitemap_index( $sitemap ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- XML is safely generated in sitemap_index exit; } /* * Outputs the main sitemap as XML. * * @param array<string, mixed>\|array<int, string> $sitemap Sitemap data for main sitemap. * @since 1.0.0 * @return void / public function generate_main_sitemap_xml( array $sitemap ) { echo Utils::sitemap_main( $sitemap ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- XML is safely generated in sitemap_main exit; } /* * Get sitemap url * * @return string / public function get_sitemap_url() { return home_url( self::get_slug() ); } /* * Collect all sitemap types with their counts. * * @return array<string, int> Array of type => count. / private function collect_sitemap_types() { $sitemap_types = []; // Add post types. $sitemap_types = array_merge( $sitemap_types, $this->get_post_type_counts() ); // Add taxonomies. return array_merge( $sitemap_types, $this->get_taxonomy_counts() ); } /* * Get counts for all enabled post types. * * @return array<string, int> Post type counts. / private function get_post_type_counts(): array { $counts = []; $cpts = apply_filters( 'surerank_sitemap_enabled_cpts', Helper::get_public_cpts() ); foreach ( $cpts as $cpt ) { if ( 'attachment' === $cpt->name ) { continue; } $counts[ $cpt->name ] = $this->get_total_count( $cpt->name ); } return $counts; } /* * Get counts for all enabled taxonomies. * * @return array<string, int> Taxonomy counts. / private function get_taxonomy_counts() { $counts = []; $custom_taxonomies = apply_filters( 'surerank_sitemap_enabled_taxonomies', Schema_Helper::get_instance()->get_taxonomies( [ 'public' => true ] ) ); foreach ( $custom_taxonomies as $custom_taxonomy ) { $counts[ $custom_taxonomy['slug'] ] = $this->get_total_count( $custom_taxonomy['slug'] ); } return $counts; } /* * Check if a type should be included in the sitemap. * * @param string $type Content type. * @param int $total Total count. * @return bool True if should include. / private function should_include_type( string $type, int $total ) { return ! $this->check_noindex( $type, 'check' ) && $total > 0; } /* * Get last modified date for a content type. * * @param string $type Content type. * @return string\|null Last modified date or null. / private function get_type_last_modified( string $type ) { if ( post_type_exists( $type ) ) { return $this->get_post_type_last_modified( $type ); } if ( taxonomy_exists( $type ) ) { return $this->get_taxonomy_last_modified( $type ); } return null; } /* * Get last modified date for a post type. * * @param string $type Post type. * @return string\|null Last modified date or null. / private function get_post_type_last_modified( string $type ) { $args = [ 'post_type' => $type, 'post_status' => 'publish', 'posts_per_page' => 1, 'orderby' => 'modified', 'order' => 'DESC', ]; return $this->query_last_modified( $args ); } /* * Get last modified date for a taxonomy. * * @param string $type Taxonomy. * @return string\|null Last modified date or null. / private function get_taxonomy_last_modified( string $type ) { $args = [ 'post_type' => 'any', 'post_status' => 'publish', 'posts_per_page' => 1, 'orderby' => 'modified', 'order' => 'DESC', 'tax_query' => [ //phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query [ 'taxonomy' => $type, 'operator' => 'EXISTS', ], ], ]; return $this->query_last_modified( $args ); } /* * Query for last modified date. * * @param array<string, mixed> $args Query arguments. * @return string\|null Last modified date or null. / private function query_last_modified( array $args ): ?string { $query = new WP_Query( $args ); $last_modified = null; if ( $query->have_posts() && $query->posts[0] instanceof \WP_Post ) { $modified_time = get_post_modified_time( 'c', false, $query->posts[0]->ID ); if ( false !== $modified_time ) { $last_modified = (string) $modified_time; } } wp_reset_postdata(); return $last_modified; } /* * Build sitemap entries for a type. * * @param string $type Content type. * @param int $total Total count. * @param int $threshold Threshold for splitting. * @param string\|null $last_modified Last modified date. * @return array<int, array{link: string, updated: string}> Sitemap entries. / private function build_sitemap_entries( string $type, int $total, int $threshold, ?string $last_modified ) { $entries = []; $updated = $last_modified ? esc_html( (string) $last_modified ) : current_time( 'c' ); // Default handling for standard sitemaps. if ( $total >= $threshold ) { $total_sitemaps = ceil( $total / $threshold ); for ( $i = 1; $i <= $total_sitemaps; $i++ ) { $entries[] = [ 'link' => home_url( "{$type}-sitemap-{$i}.xml" ), 'updated' => $updated, ]; } } else { $entries[] = [ 'link' => home_url( "{$type}-sitemap.xml" ), 'updated' => $updated, ]; } return apply_filters( 'surerank_build_sitemap_entries', $entries, $type, $total, $threshold, $updated ); } /* * Get sitemap from cache * * @param string $type Sitemap type. * @param int $page Page number. * @param string $prefix_param Prefix name. * @return array<string, mixed>\|array<int, string> / private function get_sitemap_from_cache( string $type, int $page, string $prefix_param ) { // Calculate which chunks belong to this page based on threshold and chunk size. $sitemap_threshold = apply_filters( 'surerank_sitemap_threshold', 200 ); $chunk_size = apply_filters( 'surerank_sitemap_json_chunk_size', 20 ); $chunks_per_sitemap = (int) ceil( $sitemap_threshold / $chunk_size ); $start_chunk = ( $page - 1 ) $chunks_per_sitemap + 1; $end_chunk = $page * $chunks_per_sitemap; $combined_sitemap = []; for ( $chunk_number = $start_chunk; $chunk_number <= $end_chunk; $chunk_number++ ) { $chunk_file = $prefix_param . '-' . $type . '-chunk-' . $chunk_number . '.json'; $cache_file_data = Cache::get_file( $chunk_file ); if ( ! $cache_file_data ) { continue; } $chunk_data = json_decode( $cache_file_data, true ); if ( is_array( $chunk_data ) ) { $combined_sitemap = array_merge( $combined_sitemap, $chunk_data ); } } return $combined_sitemap; } /** * Generates the author sitemap. * * @param int $page Page number. * @param int $offset Number of authors to retrieve. * @return array<string, mixed>\|array<int, string> / private function generate_author_sitemap( int $page, int $offset ) { // Author-based sitemap logic. $args = [ 'role__in' => [ 'Administrator', 'Editor', 'Author' ], 'number' => $offset, 'paged' => $page, ]; $authors = get_users( $args ); $sitemap = []; if ( is_array( $authors ) ) { foreach ( $authors as $author ) { $sitemap[] = [ 'link' => get_author_posts_url( $author->ID ), 'updated' => gmdate( 'Y-m-d\TH:i:sP', strtotime( $author->user_registered ) ), ]; } } return $sitemap; } /* * Generates the category sitemap. * * @param int $page Page number. * @param int $offset Number of categories to retrieve. * @return array<string, mixed>\|array<int, string> / private function generate_category_sitemap( int $page, int $offset ) { return $this->generate_taxonomy_sitemap( 'category', $page, $offset ); } /* * Generates the post-tag sitemap. * * @param int $page Page number. * @param int $offset Number of tags to retrieve. * @return array<string, mixed>\|array<int, string> / private function generate_post_tag_sitemap( int $page, int $offset ) { return $this->generate_taxonomy_sitemap( 'post_tag', $page, $offset ); } /* * Generates the product-category sitemap. * * @param int $page Page number. * @param int $offset Number of product categories to retrieve. * @return array<string, mixed>\|array<int, string> / private function generate_product_category_sitemap( int $page, int $offset ) { return $this->generate_taxonomy_sitemap( 'product_cat', $page, $offset ); } /* * Generates the sitemap for a specific taxonomy. * * @param string $taxonomy Taxonomy name. * @param int $page Page number. * @param int $offset Number of terms to retrieve. * @return array<string, mixed>\|array<int, string> / private function generate_taxonomy_sitemap( string $taxonomy, int $page, int $offset ) { $terms = $this->get_terms_query( $taxonomy, $page, $offset ); if ( ! $terms ) { return []; } if ( ! is_array( $terms ) ) { return []; } $modif = new WP_Query( [ 'taxonomy' => $taxonomy, 'showposts' => 1, ] ); $last_modified = isset( $modif->posts[0] ) && $modif->posts[0] instanceof \WP_Post ? $modif->posts[0]->post_modified : null; $last_modified_timestamp = is_string( $last_modified ) ? strtotime( $last_modified ) : null; $sitemap = []; foreach ( $terms as $term ) { $term_id = $term->term_id ?? null; if ( ! $term_id ) { continue; } if ( $this->is_noindex_term( $term_id, $taxonomy ) ) { continue; } $sitemap[] = [ 'link' => get_term_link( $term_id ), 'updated' => $last_modified_timestamp ? gmdate( 'Y-m-d\TH:i:sP', $last_modified_timestamp ) : null, ]; } return $sitemap; } /* * Generates the post sitemap, including images if enabled. * * @param string $type Post type. * @param int $page Page number. * @param int $offset Number of posts to retrieve. * @return array<string, mixed>\|array<int, string> */ private function generate_post_sitemap( string $type, int $page, int $offset ) { $query = $this->get_posts_query( $type, $page, $offset ); if ( ! $query ) { return []; } $sitemap = []; if ( $query->have_posts() ) { while ( $query->have_posts() ) { $query->the_post(); if ( $this->is_noindex( (int) get_the_ID(), $type ) ) { continue; } $url_data = [ 'link' => esc_url( (string) get_permalink() ), 'updated' => esc_html( (string) get_the_modified_date( 'c' ) ), 'images' => 0, 'images_data' => [], ]; if ( empty( Settings::get( 'enable_xml_image_sitemap' ) ) ) { $sitemap[] = $url_data; continue; } $images = Utils::get_images_from_post( (int) get_the_ID() ); if ( is_array( $images ) && ! empty( $images ) ) { $url_data['images'] = count( $images ); $url_data['images_data'] = array_map( static function ( $image_url ) { return [ 'link' => esc_url( $image_url ), 'updated' => esc_html( (string) get_the_modified_date( 'c' ) ), ]; }, $images ); } $sitemap[] = $url_data; } wp_reset_postdata(); } return $sitemap; } }	18.12 KB	2025-10-27 18:36

Terminal