Wala shell

Advanced PHP File Manager

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

Name	Size	Last Modified
📁 ..	-	2025-10-27 18:36
📄 archives.php <?php /** * Archives Meta Data * * This file will handle functionality to print meta data for archives in frontend. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Settings; use SureRank\Inc\Functions\Validate; use SureRank\Inc\Traits\Get_Instance; /* * Archives Meta Data * This class will handle functionality to print meta data for archives in frontend. * * @since 1.0.0 / class Archives { use Get_Instance; /* * Constructor. * * @since 1.0.0 / public function __construct() { add_action( 'template_redirect', [ $this, 'redirect_to_home' ], 1, 1 ); add_action( 'surerank_print_meta', [ $this, 'paginated_link_relationships' ], 1, 1 ); add_filter( 'surerank_robots_meta_array', [ $this, 'noindex_paginated_pages' ], 1, 1 ); add_filter( 'surerank_is_singular_archive', [ $this, 'set_singular_archive' ], 10, 2 ); } /* * Determine if the current page is a singular archive using the filter. * * @param mixed $post Optional. Post object or ID. Defaults to null for the current post. * * @return bool True if it's a singular archive, false otherwise. / public static function is_singular_archive( $post = null ) { $id = $post ? ( is_int( $post ) ? $post : ( get_post( $post )->ID ?? 0 ) ) : null; // Apply filter to determine singular archive status. return (bool) apply_filters( 'surerank_is_singular_archive', static::is_static_front_page_as_blog( $id ), $id ); } /* * Set Singular Archive using the filter. * * @param bool $is_singular_archive Current singular archive state. * @param int\|null $id The ID of the post or page being checked. * * @return bool Updated singular archive state. / public function set_singular_archive( $is_singular_archive, $id ) { $shop_page_id = $this->get_shop_page_id(); return $is_singular_archive \|\| ( $shop_page_id && $this->is_shop_page( $id ) ); } /* * Check if the front page is configured to display blog posts. * * @param int\|null $id Optional. Post ID to check. Defaults to null. * * @return bool True if the front page is set as the blog, false otherwise. / public static function is_static_front_page_as_blog( $id ) { if ( self::check_front_page_condition() && \is_home() ) { return true; } if ( 'page' !== get_option( 'show_on_front' ) ) { return false; } $posts_page_id = get_option( 'page_for_posts' ); return $posts_page_id && ( $id ? $posts_page_id === $id : is_page( $posts_page_id ) ); } /* * Paginated Link Relationships. * * Helps search engines locate the correct page in paginated archives. * * @since 0.0.1 * * @return void / public function paginated_link_relationships() { if ( ! ( is_paged() \|\| is_archive() \|\| is_home() ) ) { return; } $settings = Settings::get(); if ( empty( $settings['paginated_link_relationships'] ) ) { return; } $single_archive = $this->is_singular_archive(); $screen_types = [ 'homepage' => is_home() && ! $single_archive, 'archives' => is_archive() && ! $single_archive, 'pages' => $single_archive, ]; $relationship_settings = Validate::array( $settings['paginated_link_relationships'], array_keys( $screen_types ) ); foreach ( $screen_types as $type => $is_type ) { if ( $is_type && in_array( $type, $relationship_settings ) ) { $this->print_rel_links(); break; } } } /* * Set Noindex for paginated archive pages beyond the first. * * @param array<string, mixed>\|array<int, array<string, mixed>> $robots_meta Robots meta array. * * @since 0.0.1 * * @return array<string, mixed>\|array<int, array<string, mixed>> / public function noindex_paginated_pages( $robots_meta ) { if ( ! is_paged() ) { return $robots_meta; } $settings = Settings::get(); if ( ! empty( $settings['noindex_paginated_pages'] ) \|\| apply_filters( 'surerank_noindex_paginated_pages', false ) ) { $robots_meta = array_map( static function ( $value ) { return 'index' === $value ? 'noindex' : $value; }, $robots_meta ); } return $robots_meta; } /* * Redirect to home if archive or search is disabled. * * @since 0.0.1 * @return void / public function redirect_to_home() { if ( ! is_archive() && ! is_search() ) { return; } $settings = Settings::get(); $archive_types = [ 'author' => 'author_archive', 'date' => 'date_archive', ]; foreach ( $archive_types as $type => $setting_key ) { if ( call_user_func( "is_{$type}" ) && empty( $settings[ $setting_key ] ) ) { wp_safe_redirect( home_url(), 301 ); exit; } } } /* * Check if the current front page is not a static page or if there is a page for posts. * * @return bool True if the condition is met, false otherwise. / public static function check_front_page_condition() { $show_on_front = \get_option( 'show_on_front' ); $page_for_posts = \get_option( 'page_for_posts' ); return 'page' === $show_on_front \|\| $page_for_posts; } /* * Check if the given page ID is the WooCommerce shop page. * * @param int\|null $id Post ID to check. * * @return bool True if it's the WooCommerce shop page, false otherwise. / private function is_shop_page( $id ) { return function_exists( 'is_shop' ) && is_shop(); } /* * Get the ID of the WooCommerce shop page. * * @return int\|null Shop page ID, or null if WooCommerce is not active. / private function get_shop_page_id() { return function_exists( 'wc_get_page_id' ) ? wc_get_page_id( 'shop' ) : null; } /* * Print rel links for next and previous pages. * * @since 0.0.1 * * @return void */ private function print_rel_links() { global $paged; if ( get_next_posts_link() ) { echo '<link rel="next" href="' . esc_url( get_pagenum_link( $paged + 1 ) ) . '">' . PHP_EOL; } if ( get_previous_posts_link() ) { echo '<link rel="prev" href="' . esc_url( get_pagenum_link( $paged - 1 ) ) . '">' . PHP_EOL; } } }	5.99 KB	2025-10-27 18:36
📄 breadcrumbs.php <?php /** * Breadcrumb.php * * This file handles functionality for all Breadcrumbs. * * @package surerank / namespace SureRank\Inc\Frontend; use SureRank\Inc\Traits\Get_Instance; use WP_Post; use WP_Term; use WP_User; defined( 'ABSPATH' ) \|\| exit; /* * Breadcrumbs * * This class handles functionality for all Breadcrumbs. / class Breadcrumbs { use Get_Instance; /* * Breadcrumb trail. * * @var array<array{name: string, link: string}> / private $crumbs = []; /* * Get the breadcrumb trail. * * @return array<array<string, mixed>> / public function get_crumbs() { if ( empty( $this->crumbs ) ) { $this->generate(); } return $this->crumbs; } /* * Generate the breadcrumb trail. * * @return void / private function generate(): void { $this->maybe_add_home_crumb(); $this->add_page_specific_crumbs(); } /* * Add page-specific breadcrumbs based on current page type. * * @return void / private function add_page_specific_crumbs(): void { $crumb_handler = $this->get_crumb_handler(); if ( $crumb_handler ) { $crumb_handler(); } } /* * Get the appropriate crumb handler for the current page. * * @return mixed The crumb handler callback or null. / private function get_crumb_handler() { $handlers = $this->get_crumb_handlers(); foreach ( $handlers as $condition => $handler ) { if ( $this->check_page_condition( $condition ) ) { return $handler; } } return null; } /* * Get all crumb handlers mapped to their conditions. * * @return array<string, array<int, $this\|string>> Map of conditions to handlers. / private function get_crumb_handlers(): array { return [ 'category' => [ $this, 'add_category_crumbs' ], 'tag' => [ $this, 'add_tag_crumbs' ], 'tax' => [ $this, 'add_tax_crumbs' ], 'singular' => [ $this, 'add_singular_crumbs' ], 'author' => [ $this, 'add_author_crumbs' ], 'date' => [ $this, 'add_date_crumbs' ], 'search' => [ $this, 'add_search_crumb' ], 'not_found' => [ $this, 'add_404_crumb' ], ]; } /* * Check if a page condition is met. * * @param string $condition The condition to check. * @return bool True if condition is met. / private function check_page_condition( string $condition ): bool { $checks = [ 'category' => 'is_category', 'tag' => 'is_tag', 'tax' => 'is_tax', 'singular' => 'is_singular', 'author' => 'is_author', 'date' => 'is_date', 'search' => 'is_search', 'not_found' => 'is_404', ]; return isset( $checks[ $condition ] ) && call_user_func( $checks[ $condition ] ); } /* * Add search results breadcrumb. * * @return void / private function add_search_crumb(): void { $this->add_crumb( 'Search results for: ' . get_search_query(), '' ); } /* * Add 404 page breadcrumb. * * @return void / private function add_404_crumb(): void { $this->add_crumb( '404 Not Found', '' ); } /* * Add category breadcrumbs. * * @return void / private function add_category_crumbs() { $category = get_queried_object(); if ( $category instanceof WP_Term ) { $this->add_term_hierarchy_crumbs( $category, 'category' ); } } /* * Add tag breadcrumbs. * * @return void / private function add_tag_crumbs() { $tag = get_queried_object(); if ( $tag instanceof WP_Term ) { $this->add_crumb( $tag->name, get_tag_link( $tag ) ); } } /* * Add taxonomy breadcrumbs. * * @return void / private function add_tax_crumbs() { $term = get_queried_object(); if ( $term instanceof WP_Term ) { $this->add_term_hierarchy_crumbs( $term, $term->taxonomy ); } } /* * Add singular (post or page) breadcrumbs. * * @return void / private function add_singular_crumbs() { global $post; if ( ! ( $post instanceof WP_Post ) \|\| ! $post->post_type ) { return; } $this->add_post_type_breadcrumbs( $post ); $this->add_crumb( get_the_title( $post ), get_permalink( $post ) ); } /* * Add post type specific breadcrumbs. * * @param WP_Post $post Post object. * @return void / private function add_post_type_breadcrumbs( WP_Post $post ): void { if ( 'product' === $post->post_type ) { $this->add_product_breadcrumbs( $post ); return; } $this->add_custom_post_type_archive_crumb( $post ); $this->add_post_hierarchy_or_taxonomy_crumbs( $post ); } /* * Add product specific breadcrumbs. * * @param WP_Post $post Post object. * @return void / private function add_product_breadcrumbs( WP_Post $post ): void { $this->add_shop_crumb(); $this->add_product_terms_crumbs( $post ); } /* * Add shop breadcrumb if WooCommerce is active. * * @return void / private function add_shop_crumb(): void { if ( ! function_exists( 'wc_get_page_id' ) ) { return; } $shop_page_id = wc_get_page_id( 'shop' ); $shop_permalink = get_permalink( $shop_page_id ); if ( $shop_permalink ) { $this->add_crumb( 'Shop', $shop_permalink ); } } /* * Add custom post type archive crumb. * * @param WP_Post $post Post object. * @return void / private function add_custom_post_type_archive_crumb( WP_Post $post ): void { $excluded_types = [ 'post', 'page', 'product' ]; if ( in_array( $post->post_type, $excluded_types, true ) ) { return; } $post_type_obj = get_post_type_object( $post->post_type ); if ( ! $post_type_obj ) { return; } $archive_link = get_post_type_archive_link( $post->post_type ); if ( $archive_link ) { $this->add_crumb( $post_type_obj->labels->singular_name, $archive_link ); } } /* * Add post hierarchy or taxonomy breadcrumbs. * * @param WP_Post $post Post object. * @return void / private function add_post_hierarchy_or_taxonomy_crumbs( WP_Post $post ): void { if ( is_post_type_hierarchical( $post->post_type ) ) { $this->add_post_hierarchy_crumbs( $post ); return; } $this->add_primary_taxonomy_crumbs( $post ); } /* * Add primary taxonomy breadcrumbs. * * @param WP_Post $post Post object. * @return void / private function add_primary_taxonomy_crumbs( WP_Post $post ): void { $taxonomy = $this->get_primary_taxonomy( $post->post_type ); if ( empty( $taxonomy ) ) { return; } $terms = get_the_terms( $post->ID, $taxonomy ); if ( ! is_array( $terms ) \|\| empty( $terms ) ) { return; } $primary_term = $terms[0]; $this->add_term_hierarchy_crumbs( $primary_term, $taxonomy ); } /* * Add breadcrumbs for a term and its ancestors. * * @param WP_Term $term Term object. * @param string $taxonomy Taxonomy slug. * * @return void / private function add_term_hierarchy_crumbs( WP_Term $term, string $taxonomy ) { $ancestors = $this->get_term_ancestors( $term, $taxonomy ); foreach ( $ancestors as $ancestor ) { $link = $this->get_term_link( $ancestor, $taxonomy ); if ( $link ) { $this->add_crumb( $ancestor->name, $link ); } } if ( empty( $ancestors ) \|\| end( $ancestors )->term_id !== $term->term_id ) { $link = $this->get_term_link( $term, $taxonomy ); if ( $link ) { $this->add_crumb( $term->name, $link ); } } } /* * Get a term's ancestors in order from root to direct parent. * * @param WP_Term $term Term object. * @param string $taxonomy Taxonomy slug. * @return array<int, \WP_Term> Array of WP_Term objects. / private function get_term_ancestors( WP_Term $term, string $taxonomy ) { $ancestors = []; $original_term = $term; while ( $term->parent ) { $term = get_term( $term->parent, $taxonomy ); if ( ! ( $term instanceof WP_Term ) ) { break; } array_unshift( $ancestors, $term ); } return $ancestors; } /* * Get term link safely. * * @param WP_Term $term Term object. * @param string $taxonomy Taxonomy slug. * @return string\|null Term link or null if error. / private function get_term_link( WP_Term $term, string $taxonomy ): ?string { $link = get_term_link( $term->term_id, $taxonomy ); return is_wp_error( $link ) ? null : $link; } /* * Get the primary taxonomy for a given post type. * * @param string $post_type The post type slug. * @return string\|null The taxonomy slug or null if not found. / private function get_primary_taxonomy( string $post_type ): ?string { $taxonomies = get_object_taxonomies( $post_type, 'names' ); foreach ( $taxonomies as $taxonomy ) { $taxonomy_obj = get_taxonomy( $taxonomy ); if ( $taxonomy_obj && $taxonomy_obj->hierarchical ) { return $taxonomy; } } return $taxonomies[0] ?? null; } /* * Add breadcrumbs for hierarchical post types like Pages. * * @param WP_Post $post Post object. * @return void / private function add_post_hierarchy_crumbs( WP_Post $post ) { $ancestors = $this->get_post_ancestors( $post ); foreach ( $ancestors as $ancestor ) { if ( get_permalink( $ancestor ) ) { $this->add_crumb( get_the_title( $ancestor ), get_permalink( $ancestor ) ); } } } /* * Get a post's ancestors in order from root to direct parent. * * @param WP_Post $post Post object. * @return array<int, \WP_Post> Array of WP_Post objects. / private function get_post_ancestors( WP_Post $post ) { $parents = []; $original_post = $post; while ( $post->post_parent ) { $post = get_post( $post->post_parent ); if ( $post instanceof WP_Post ) { array_unshift( $parents, $post ); } else { break; } } return $parents; } /* * Add product category breadcrumbs. * * @param WP_Post $post Product post object. * @return void / private function add_product_terms_crumbs( WP_Post $post ) { $term_name = apply_filters( 'surerank_product_breadcrumbs_term_name', 'product_cat' ); $categories = get_the_terms( $post->ID, $term_name ); if ( is_array( $categories ) && ! empty( $categories ) ) { $primary_category = $categories[0]; $this->add_term_hierarchy_crumbs( $primary_category, $term_name ); } } /* * Add author breadcrumbs. * * @return void / private function add_author_crumbs() { $author = get_queried_object(); if ( $author instanceof WP_User ) { $this->add_crumb( 'Author: ' . $author->display_name, get_author_posts_url( $author->ID ) ); } } /* * Add date breadcrumbs. * * @return void / private function add_date_crumbs() { if ( is_year() ) { $year = (string) get_the_date( 'Y' ); $this->add_crumb( $year, (string) get_year_link( intval( $year ) ) ); } if ( is_month() ) { $year = get_the_date( 'Y' ); $month = get_the_date( 'm' ); $this->add_crumb( (string) get_the_date( 'F Y' ), (string) get_month_link( intval( $year ), intval( $month ) ) ); } if ( is_day() ) { $year = get_the_date( 'Y' ); $month = get_the_date( 'm' ); $day = get_the_date( 'd' ); $this->add_crumb( (string) get_the_date( 'j F Y' ), (string) get_day_link( intval( $year ), intval( $month ), intval( $day ) ) ); } } /* * Add an item to the breadcrumb trail. * * @param string $name Name of the breadcrumb. * @param string $link URL for the breadcrumb. * @return void / private function add_crumb( string $name, string $link = '' ) { if ( empty( $name ) ) { return; } $this->crumbs[] = [ 'name' => esc_html( $name ), 'link' => esc_url( $link ), ]; } /* * Add a home breadcrumb. * * @return void */ private function maybe_add_home_crumb() { $home_name = apply_filters( 'surerank_home_breadcrumb_name', 'Home' ); $this->add_crumb( $home_name, home_url() ); } }	11.36 KB	2025-10-27 18:36
📄 canonical.php <?php /** * Canonical Meta Data * * This file will handle functionality to print meta_data in frontend for different requests. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Traits\Get_Instance; use WP_Term; /* * Canonical URL * This class will handle functionality to print meta_data in frontend for different requests. * * @since 1.0.0 / class Canonical { use Get_Instance; /* * Constructor * * @since 1.0.0 / public function __construct() { remove_action( 'wp_head', 'rel_canonical' ); remove_action( 'wp_head', 'index_rel_link' ); add_action( 'surerank_print_meta', [ $this, 'print_canonical_url' ], 1, 1 ); } /* * Add meta data * * @param array<string, mixed> $meta_data Meta Data. * @since 1.0.0 * @return void / public function print_canonical_url( $meta_data ) { $url = ''; if ( is_singular() ) { $url = $meta_data['canonical_url'] ?? get_the_permalink(); } if ( is_archive() ) { $taxonomy = get_queried_object(); if ( $taxonomy instanceof \WP_Term ) { $url = get_term_link( $taxonomy ); } } if ( is_home() \|\| is_front_page() ) { $url = $meta_data['canonical_url'] ?? get_home_url(); } if ( ! is_404() ) { if ( is_search() ) { $url = get_search_link(); } elseif ( is_paged() && is_singular() ) { $url = $meta_data['canonical_url'] ?? get_permalink(); } elseif ( is_paged() ) { $url = $meta_data['canonical_url'] ?? get_pagenum_link( get_query_var( 'paged' ) ); } elseif ( is_tax() \|\| is_category() \|\| is_tag() ) { $queried_object = get_queried_object(); $url = isset( $meta_data['canonical_url'] ) && ! empty( $meta_data['canonical_url'] ) ? $meta_data['canonical_url'] : ( $queried_object instanceof WP_Term ? get_term_link( $queried_object ) : '' ); } else { global $wp; $url = $meta_data['canonical_url'] ?? user_trailingslashit( home_url( add_query_arg( [], $wp->request ) ) ); } } $this->print_canonical( $url ); } /* * Print the canonical url. * * @param string $url Canonical URL. * @return void * @since 1.0.0 */ public function print_canonical( $url ) { echo '<link rel="canonical" href="' . esc_url( $url ) . '">' . PHP_EOL; } }	2.29 KB	2025-10-27 18:36
📄 common.php <?php /** * Common Meta Data * * This file will handle functionality to print meta_data in frontend for different requests. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Validate; use SureRank\Inc\Traits\Get_Instance; /* * Common SEO * This class will handle functionality to print meta_data in frontend for different requests. * * @since 1.0.0 / class Common { use Get_Instance; /* * Constructor * * @since 1.0.0 / public function __construct() { add_action( 'surerank_print_meta', [ $this, 'common_meta' ], 1, 1 ); add_filter( 'pre_get_document_title', [ $this, 'get_document_title' ], 1, 1 ); } /* * Add meta data * * @param array<string, mixed> $meta_data Meta Data. * @since 1.0.0 * @return void / public function common_meta( $meta_data ) { $this->print_page_description( $meta_data ); } /* * Print the Page Description meta * * @param array<string, mixed> $meta_data Meta Data. * @since 1.0.0 * @return void / public function print_page_description( $meta_data ) { $description = $meta_data['page_description'] ?? ''; if ( ! empty( $description ) && Validate::string( $description ) ) { Meta_Data::get_instance()->meta_html_template( 'description', $description ); } } /* * Get the document title * * @param string $title Document Title. * @since 1.0.0 * @return string $title */ public function get_document_title( $title ) { $meta_data = Meta_Data::get_instance()->get_meta_data(); if ( ! empty( $meta_data['page_title'] ) && Validate::string( $meta_data['page_title'] ) ) { $title = esc_html( $meta_data['page_title'] ); } return $title; } }	1.75 KB	2025-10-27 18:36
📄 crawl-optimization.php <?php /** * Crawl Optimization Class * This class is responsible for optimizing crawl settings by removing category bases in URLs * and managing rewrite rules for categories and product categories in WooCommerce. * * @since 1.0.0 * @package surerank / namespace SureRank\Inc\Frontend; use SureRank\Inc\Crawl_Optimization\Utils; use SureRank\Inc\Functions\Helper; use SureRank\Inc\Traits\Get_Instance; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Crawl_Optimization * This class will handle functionality to crawl optimization settings. * * @since 1.0.0 / class Crawl_Optimization { use Get_Instance; /* * Constructor * Initializes the crawl optimization based on settings and adds necessary actions. * * @since 1.0.0 / protected function __construct() { /* * Filter to remove category base * We need to flush settings while using this filter * * @since 1.0.0 / if ( apply_filters( 'surerank_remove_category_base', false ) ) { add_filter( 'query_vars', [ $this, 'add_custom_redirect_query_var' ] ); add_filter( 'request', [ $this, 'handle_redirect_for_old_category' ] ); add_filter( 'category_rewrite_rules', [ $this, 'add_rewrite_rules_for_categories' ] ); add_filter( 'term_link', [ $this, 'remove_category_base_from_links' ], 10, 3 ); } else { remove_filter( 'query_vars', [ $this, 'add_custom_redirect_query_var' ] ); remove_filter( 'request', [ $this, 'handle_redirect_for_old_category' ] ); remove_filter( 'category_rewrite_rules', [ $this, 'add_rewrite_rules_for_categories' ] ); remove_filter( 'term_link', [ $this, 'remove_category_base_from_links' ], 10 ); } /* * Filter to remove product category base * We need to flush settings while using this filter * * @since 1.0.0 / if ( Helper::wc_status() && apply_filters( 'surerank_remove_product_category_base', false ) ) { add_action( 'created_product_cat', 'flush_rewrite_rules' ); add_action( 'delete_product_cat', 'flush_rewrite_rules' ); add_action( 'edited_product_cat', 'flush_rewrite_rules' ); add_filter( 'product_cat_rewrite_rules', [ $this, 'surerank_filter_product_category_rewrite_rules' ] ); add_filter( 'term_link', [ $this, 'surerank_remove_product_category_base' ], 10, 3 ); add_action( 'template_redirect', [ $this, 'surerank_product_category_redirect' ], 1 ); } else { remove_action( 'created_product_cat', 'flush_rewrite_rules' ); remove_action( 'delete_product_cat', 'flush_rewrite_rules' ); remove_action( 'edited_product_cat', 'flush_rewrite_rules' ); remove_filter( 'product_cat_rewrite_rules', [ $this, 'surerank_filter_product_category_rewrite_rules' ] ); remove_filter( 'term_link', [ $this, 'surerank_remove_product_category_base' ], 10 ); remove_action( 'template_redirect', [ $this, 'surerank_product_category_redirect' ], 1 ); } } /* * Remove Category Base from Links * Removes the base from category links to create cleaner URLs. * * @param string $termlink Original term link. * @param object $term Term object. * @param string $taxonomy Taxonomy name. * @return string Modified term link. * @since 1.0.0 / public function remove_category_base_from_links( $termlink, $term, $taxonomy ) { if ( 'category' !== $taxonomy ) { return $termlink; } $category_base = get_option( 'category_base' ) ? get_option( 'category_base' ) : 'category'; if ( strpos( $termlink, '/' . $category_base . '/' ) !== false ) { $termlink = str_replace( '/' . $category_base . '/', '/', $termlink ); } return $termlink; } /* * Add Custom Redirect Query Var * Adds a custom query variable to handle category redirects. * * @param array<string, mixed> $query_vars Array of query variables. * @return array<string, mixed>\|array<int, string> Modified query variables. * @since 1.0.0 / public function add_custom_redirect_query_var( $query_vars ) { $query_vars[] = 'custom_category_redirect'; return $query_vars; } /* * Handle Redirect for Old Category * Redirects users from old category URLs to new URLs without category bases. * * @param array<string, mixed> $query_vars Array of query variables. * @return array<string, mixed>\|array<int, string> Modified query variables. * @since 1.0.0 / public function handle_redirect_for_old_category( $query_vars ) { if ( isset( $query_vars['custom_category_redirect'] ) ) { $redirect_url = home_url( trailingslashit( $query_vars['custom_category_redirect'] ) ); wp_safe_redirect( $redirect_url, 301 ); exit; } return $query_vars; } /* * Add Rewrite Rules for Categories * Generates rewrite rules to handle clean category URLs. * * @param array<string, mixed> $rules Existing rewrite rules. * @return array<string, mixed> Modified rewrite rules. * @since 1.0.0 / public function add_rewrite_rules_for_categories( $rules ) { $base = get_option( 'category_base' ); $category_base = $base ? $base : 'category'; $custom_rule = [ "^{$category_base}/(.+)/?$" => 'index.php?custom_category_redirect=$matches[1]' ]; $clean_category_rules = $this->generate_clean_category_rules(); return array_merge( $custom_rule, $clean_category_rules, $rules ); } /* * Filter Product Category Rewrite Rules * Modifies rewrite rules for product categories in WooCommerce. * * @param array<string, mixed> $rules Existing product category rewrite rules. * @return array<string, mixed> Modified rewrite rules. / public function surerank_filter_product_category_rewrite_rules( $rules ) { $categories = get_terms( [ 'taxonomy' => 'product_cat', 'hide_empty' => false, ] ); if ( is_array( $categories ) && ! empty( $categories ) ) { $slugs = []; foreach ( $categories as $category ) { $slugs[] = Utils::get_full_category_slug_path( $category ); } $rules = []; foreach ( $slugs as $slug ) { $rules[ '(' . $slug . ')(/page/(\d+))?/?$' ] = 'index.php?product_cat=$matches[1]&paged=$matches[3]'; $rules[ $slug . '/(.+?)/page/?([0-9]{1,})/?$' ] = 'index.php?product_cat=$matches[1]&paged=$matches[2]'; $rules[ $slug . '/(.+?)/?$' ] = 'index.php?product_cat=$matches[1]'; } } return apply_filters( 'surerank_product_category_rewrite_rules', $rules ); } /* * Remove Product Category Base * Removes the product category base from product category links. * * @param string $termlink Original term link. * @param object $term Term object. * @param string $taxonomy Taxonomy name. * @return string Modified term link. * @since 1.0.0 / public function surerank_remove_product_category_base( $termlink, $term, $taxonomy ) { if ( 'product_cat' === $taxonomy ) { $category_base = get_option( 'woocommerce_permalinks' )['category_base'] ? get_option( 'woocommerce_permalinks' )['category_base'] : 'product-category'; $termlink = str_replace( '/' . $category_base, '', $termlink ); } return $termlink; } /* * Product Category Redirect * Redirects URLs containing the product category base to clean URLs. * * @since 1.0.0 * @return void / public function surerank_product_category_redirect() { if ( ! is_404() ) { return; } $category_base = get_option( 'woocommerce_permalinks' )['category_base'] ? get_option( 'woocommerce_permalinks' )['category_base'] : 'product-category'; global $wp; $current_url = user_trailingslashit( home_url( add_query_arg( [], $wp->request ) ) ); $regex = sprintf( '/\/%s\//', str_replace( '/', '\/', $category_base ) ); if ( preg_match( $regex, $current_url ) ) { $new_url = str_replace( '/' . $category_base, '', $current_url ); wp_safe_redirect( $new_url, 301 ); exit; } } /* * Generate Clean Category Rules * Generates rewrite rules for each category to allow cleaner URLs. * * @return array<string, mixed> Generated rewrite rules for categories. * @since 1.0.0 / private function generate_clean_category_rules() { $rewrite_rules = []; $categories = Utils::get_all_categories(); $prefix = Utils::get_blog_prefix(); foreach ( $categories as $category ) { $path = Utils::get_category_path( $category ) . $category->slug; $rewrite_rules = $this->append_category_rewrite( $rewrite_rules, $path, $prefix ); } return $rewrite_rules; } /* * Append Category Rewrite * Adds a specific category's rewrite rule to the rules array. * * @param array<string, mixed> $rules Existing rewrite rules. * @param string $path Category path. * @param string $prefix Blog prefix if applicable. * @return array<string, mixed> Modified rewrite rules. * @since 1.0.0 */ private function append_category_rewrite( $rules, $path, $prefix ) { $rules[ "^{$prefix}({$path})/page/([0-9]{1,})/?$" ] = 'index.php?category_name=$matches[1]&paged=$matches[2]'; $rules[ "^{$prefix}({$path})/?$" ] = 'index.php?category_name=$matches[1]'; return $rules; } }	8.84 KB	2025-10-27 18:36
📄 description.php <?php /** * Description * * This file handles the functionality to generate a description automatically for post/page/taxonomy. * * @package SureRank * @since 1.0.0 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Get; use SureRank\Inc\Functions\Sanitize; use SureRank\Inc\Meta_Variables\Post; use SureRank\Inc\Traits\Get_Instance; /* * Class Description * Handles functionality to auto-generate Open Graph description based on post content, post excerpt, or archive description. * * @since 1.0.0 / class Description { use Get_Instance; /* * Get the generated Open Graph description. * * @param int $post_id Optional post ID. If not provided, it will be determined automatically. * @param string $post_type Post type (default empty string). * @return string Generated description. / public function get( int $post_id = 0, string $post_type = '' ): string { if ( 0 === $post_id ) { $post_id = (int) $this->get_id(); } if ( 0 === $post_id ) { return ''; } $description = $this->get_description( $post_id ); return self::sanitize_description( $description ); } /* * Get the post description. * * @param int $post_id Post ID. * @return string Description. / public function post( int $post_id ): string { $content = $this->get_post_description( $post_id ); if ( empty( $content ) ) { return ''; } return self::sanitize_description( $content ); } /* * Get the taxonomy description. * * @param int $term_id Term ID. * @return string Description. / public function taxonomy( int $term_id ): string { $content = $this->get_archive_description( $term_id ); if ( empty( $content ) ) { return ''; } return self::sanitize_description( $content ); } /* * Get the current post ID based on the context. * * @return int\|null Post ID or null if not found. / public function get_id(): ?int { if ( is_admin() ) { $admin_id = $this->get_admin_id(); return is_int( $admin_id ) ? $admin_id : null; } if ( is_feed() ) { return absint( get_the_ID() ); } return get_queried_object_id(); } /* * Sanitize and limit description length. * * @param string $description Description text. * @return string Sanitized description. / public static function sanitize_description( string $description ): string { if ( empty( $description ) ) { return ''; } $remove_tags = apply_filters( 'surerank_description_remove_tags', [ 'script', 'style', 'iframe', 'noscript', 'form', 'input', 'select', 'button', 'textarea', 'svg', 'canvas', 'video', 'audio', 'embed', 'object', 'li', 'ul', 'ol', 'table', 'img', ] ); $replace_tags = apply_filters( 'surerank_description_replace_tags', [ 'address', 'article', 'aside', 'blockquote', 'details', 'div', 'footer', 'header', 'hgroup', 'hr', 'nav', 'ol', 'p', 'section', ] ); // This sanitize all the shortcodes. $description = Sanitize::sanitize_shortcode( $description ); // This will remove all the tags and replace them with a space. $description = preg_replace( '#<(' . implode( '\|', $remove_tags ) . ')[^>]>.?</\1>#si', ' ', (string) $description ); // This will replace the tags with a space. $description = preg_replace( '#</?(' . implode( '\|', $replace_tags ) . ')[^>]>#si', ' ', (string) $description ); $description = wp_strip_all_tags( (string) $description ); $description = html_entity_decode( $description, ENT_QUOTES \| ENT_HTML5, 'UTF-8' ); // Decode HTML entities. $description = trim( (string) preg_replace( '/\s+/', ' ', $description ) ); $description = str_replace( '[…]', '', $description ); return trim( Get::formatted_description( $description ) ); } /** * Get the appropriate description based on context. * * @param int $post_id Optional post ID. * @return string Description. / private function get_description( int $post_id ): string { $show_on_front = get_option( 'show_on_front' ); $front_page_id = get_option( 'page_on_front' ); $posts_page_id = get_option( 'page_for_posts' ); if ( 'page' === $show_on_front && is_front_page() ) { return esc_html__( 'Welcome to ', 'surerank' ) . get_bloginfo( 'name' ); } if ( 'posts' === $show_on_front && is_home() ) { return esc_html__( 'Latest posts from ', 'surerank' ) . get_bloginfo( 'name' ); } if ( 'page' === $show_on_front && is_home() && $posts_page_id === $post_id ) { return $this->get_archive_description(); } if ( is_archive() ) { return $this->get_archive_description(); } return $this->get_post_description( $post_id ); } /* * Get the post ID when inside the admin panel. * * @return int\|null Admin post ID or null if not applicable. / private function get_admin_id(): ?int { $screen = function_exists( 'get_current_screen' ) ? get_current_screen() : null; if ( $screen && 'post' === $screen->base ) { return absint( get_the_ID() ); } if ( $screen && 'edit-tags' === $screen->base ) { $term_id = filter_input( INPUT_GET, 'tag_ID', FILTER_VALIDATE_INT ); return is_int( $term_id ) ? $term_id : null; } return null; } /* * Get post/page description. * * @param int $post_id Post ID. * @return string Description. / private function get_post_description( int $post_id ): string { $post_instance = Post::get_instance(); $post_instance->set_post( $post_id ); return $post_instance->get_content(); } /* * Get archive description. * * @param int\|null $term_id Term ID. * @return string Archive description. */ private function get_archive_description( ?int $term_id = null ): string { if ( $term_id ) { return (string) term_description( $term_id ); } if ( is_category() \|\| is_tag() \|\| is_tax() ) { return (string) term_description(); } if ( is_author() ) { return (string) get_the_author_meta( 'description' ); } if ( is_post_type_archive() ) { $post_type = get_queried_object(); return isset( $post_type->description ) ? (string) $post_type->description : ''; } return ''; } }	6.13 KB	2025-10-27 18:36
📄 facebook.php <?php /** * Common Meta Data * * This file will handle functionality to print meta_data in frontend for different requests. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Helper; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Functions\Validate; use SureRank\Inc\Meta_Variables\Post; use SureRank\Inc\Meta_Variables\Site; use SureRank\Inc\Meta_Variables\Term; use SureRank\Inc\Traits\Get_Instance; /* * Facebook SEO * This class will handle functionality to print meta_data in frontend for different requests. * * @since 1.0.0 / class Facebook { use Get_Instance; public const FACEBOOK_LOCALES = [ 'af_ZA', // Afrikaans. 'ak_GH', // Akan. 'am_ET', // Amharic. 'ar_AR', // Arabic. 'as_IN', // Assamese. 'ay_BO', // Aymara. 'az_AZ', // Azerbaijani. 'be_BY', // Belarusian. 'bg_BG', // Bulgarian. 'bp_IN', // Bhojpuri. 'bn_IN', // Bengali. 'br_FR', // Breton. 'bs_BA', // Bosnian. 'ca_ES', // Catalan. 'cb_IQ', // Sorani Kurdish. 'ck_US', // Cherokee. 'co_FR', // Corsican. 'cs_CZ', // Czech. 'cx_PH', // Cebuano. 'cy_GB', // Welsh. 'da_DK', // Danish. 'de_DE', // German. 'el_GR', // Greek. 'en_GB', // English (UK). 'en_PI', // English (Pirate). 'en_UD', // English (Upside Down). 'en_US', // English (US). 'em_ZM', 'eo_EO', // Esperanto. 'es_ES', // Spanish (Spain). 'es_LA', // Spanish. 'es_MX', // Spanish (Mexico). 'et_EE', // Estonian. 'eu_ES', // Basque. 'fa_IR', // Persian. 'fb_LT', // Leet Speak. 'ff_NG', // Fulah. 'fi_FI', // Finnish. 'fo_FO', // Faroese. 'fr_CA', // French (Canada). 'fr_FR', // French (France). 'fy_NL', // Frisian. 'ga_IE', // Irish. 'gl_ES', // Galician. 'gn_PY', // Guarani. 'gu_IN', // Gujarati. 'gx_GR', // Classical Greek. 'ha_NG', // Hausa. 'he_IL', // Hebrew. 'hi_IN', // Hindi. 'hr_HR', // Croatian. 'hu_HU', // Hungarian. 'ht_HT', // Haitian Creole. 'hy_AM', // Armenian. 'id_ID', // Indonesian. 'ig_NG', // Igbo. 'is_IS', // Icelandic. 'it_IT', // Italian. 'ik_US', 'iu_CA', 'ja_JP', // Japanese. 'ja_KS', // Japanese (Kansai). 'jv_ID', // Javanese. 'ka_GE', // Georgian. 'kk_KZ', // Kazakh. 'km_KH', // Khmer. 'kn_IN', // Kannada. 'ko_KR', // Korean. 'ks_IN', // Kashmiri. 'ku_TR', // Kurdish (Kurmanji). 'ky_KG', // Kyrgyz. 'la_VA', // Latin. 'lg_UG', // Ganda. 'li_NL', // Limburgish. 'ln_CD', // Lingala. 'lo_LA', // Lao. 'lt_LT', // Lithuanian. 'lv_LV', // Latvian. 'mg_MG', // Malagasy. 'mi_NZ', // Maori. 'mk_MK', // Macedonian. 'ml_IN', // Malayalam. 'mn_MN', // Mongolian. 'mr_IN', // Marathi. 'ms_MY', // Malay. 'mt_MT', // Maltese. 'my_MM', // Burmese. 'nb_NO', // Norwegian (bokmal). 'nd_ZW', // Ndebele. 'ne_NP', // Nepali. 'nl_BE', // Dutch (Belgie). 'nl_NL', // Dutch. 'nn_NO', // Norwegian (nynorsk). 'nr_ZA', // Southern Ndebele. 'ns_ZA', // Northern Sotho. 'ny_MW', // Chewa. 'om_ET', // Oromo. 'or_IN', // Oriya. 'pa_IN', // Punjabi. 'pl_PL', // Polish. 'ps_AF', // Pashto. 'pt_BR', // Portuguese (Brazil). 'pt_PT', // Portuguese (Portugal). 'qc_GT', // Quiché. 'qu_PE', // Quechua. 'qr_GR', 'qz_MM', // Burmese (Zawgyi). 'rm_CH', // Romansh. 'ro_RO', // Romanian. 'ru_RU', // Russian. 'rw_RW', // Kinyarwanda. 'sa_IN', // Sanskrit. 'sc_IT', // Sardinian. 'se_NO', // Northern Sami. 'si_LK', // Sinhala. 'su_ID', // Sundanese. 'sk_SK', // Slovak. 'sl_SI', // Slovenian. 'sn_ZW', // Shona. 'so_SO', // Somali. 'sq_AL', // Albanian. 'sr_RS', // Serbian. 'ss_SZ', // Swazi. 'st_ZA', // Southern Sotho. 'sv_SE', // Swedish. 'sw_KE', // Swahili. 'sy_SY', // Syriac. 'sz_PL', // Silesian. 'ta_IN', // Tamil. 'te_IN', // Telugu. 'tg_TJ', // Tajik. 'th_TH', // Thai. 'tk_TM', // Turkmen. 'tl_PH', // Filipino. 'tl_ST', // Klingon. 'tn_BW', // Tswana. 'tr_TR', // Turkish. 'ts_ZA', // Tsonga. 'tt_RU', // Tatar. 'tz_MA', // Tamazight. 'uk_UA', // Ukrainian. 'ur_PK', // Urdu. 'uz_UZ', // Uzbek. 've_ZA', // Venda. 'vi_VN', // Vietnamese. 'wo_SN', // Wolof. 'xh_ZA', // Xhosa. 'yi_DE', // Yiddish. 'yo_NG', // Yoruba. 'zh_CN', // Simplified Chinese (China). 'zh_HK', // Traditional Chinese (Hong Kong). 'zh_TW', // Traditional Chinese (Taiwan). 'zu_ZA', // Zulu. 'zz_TR', // Zazaki. ]; /* * Constructor * * @since 1.0.0 / public function __construct() { add_action( 'surerank_print_meta', [ $this, 'open_graph_tags' ], 1, 1 ); add_action( 'surerank_print_meta', [ $this, 'facebook_tags' ], 1, 1 ); } /* * Catch some weird locales served out by WP that are not easily doubled up. * * @param string $locale Current site locale. * * @return string / public static function sanitize( $locale ) { $fix_locales = [ 'ca' => 'ca_ES', 'en' => 'en_US', 'el' => 'el_GR', 'et' => 'et_EE', 'ja' => 'ja_JP', 'sq' => 'sq_AL', 'uk' => 'uk_UA', 'vi' => 'vi_VN', 'zh' => 'zh_CN', 'te' => 'te_IN', 'ur' => 'ur_PK', 'cy' => 'cy_GB', 'eu' => 'eu_ES', 'th' => 'th_TH', 'af' => 'af_ZA', 'hy' => 'hy_AM', 'gu' => 'gu_IN', 'kn' => 'kn_IN', 'mr' => 'mr_IN', 'kk' => 'kk_KZ', 'lv' => 'lv_LV', 'sw' => 'sw_KE', 'tl' => 'tl_PH', 'ps' => 'ps_AF', 'as' => 'as_IN', ]; if ( isset( $fix_locales[ $locale ] ) ) { $locale = $fix_locales[ $locale ]; } // Convert locales like "es" to "es_ES", in case that works for the given locale (sometimes it does). if ( 2 === strlen( $locale ) ) { $locale = self::join( $locale ); } return $locale; } /* * Validate with locales FB supports. * * Check to see if the locale is a valid FB one, if not, use en_US as a fallback. * * @param string $locale Current site locale. * * @return string / public static function validate( $locale ) { if ( in_array( $locale, self::FACEBOOK_LOCALES, true ) ) { return $locale; } $locale = self::join( substr( $locale, 0, 2 ) ); return in_array( $locale, self::FACEBOOK_LOCALES, true ) ? $locale : 'en_US'; } /* * Add meta data * * @param array<string, mixed> $meta_data Meta Data. * @since 1.0.0 * @return void / public function facebook_tags( $meta_data ) { if ( apply_filters( 'surerank_disable_facebook_tags', false ) ) { return; } $global_meta = Settings::get(); $global_meta = $this->add_times( $global_meta ); $facebook_meta_keys = [ 'facebook_page_url' => 'publisher', 'facebook_author_fallback' => 'author', 'facebook_published_time' => 'published_time', 'facebook_modified_time' => 'modified_time', ]; // Loop through facebook_meta_keys and add to meta_data_array if valid. foreach ( $facebook_meta_keys as $key => $value ) { if ( ! empty( $global_meta[ $key ] ) && Validate::not_empty( $global_meta[ $key ] ) ) { Meta_Data::get_instance()->meta_html_template( 'article:' . $value, $global_meta[ $key ], 'property' ); } } } /* * Prepare facebook meta data. * * @param array<string, mixed> $meta_data facebook meta data will be array and will contain image, title and description. * @since 1.0.0 * @return void / public function open_graph_tags( $meta_data ) { if ( apply_filters( 'surerank_disable_open_graph_tags', false ) ) { return; } $image = Image::get_instance(); $image->get( $meta_data, 'facebook_image_url' ); $this->add_common_tags( $meta_data ); // Add product-specific Open Graph tags if applicable. if ( Helper::is_product() ) { $this->add_product_tags( $meta_data ); } } /* * Get URL. * If it is not home page then get the post URL else get the site URL. * * @return string\|false * @since 1.0.0 / public function get_url() { if ( is_home() ) { return Site::get_instance()->get_site_url(); } if ( is_singular() ) { return Post::get_instance()->get_permalink(); } if ( is_category() \|\| is_tax() \|\| is_tag() ) { return Term::get_instance()->get_permalink(); } return Site::get_instance()->get_site_url(); } /* * Output the locale, doing some conversions to make sure the proper Facebook locale is outputted. * * @see http://www.facebook.com/translations/FacebookLocales.xml for the list of supported locales * @link https://developers.facebook.com/docs/reference/opengraph/object-type/article/ * * @return string / public function get_locale() { $locale = get_locale(); $locale = self::sanitize( $locale ); return self::validate( $locale ); } /* * Add published and modified times to the global meta data. * * @param array<string, mixed> $global_meta Global Meta Data. * @since 1.0.0 * @return array<string, mixed> / private function add_times( $global_meta ) { if ( ! is_array( $global_meta ) ) { return $global_meta; // bailed. } global $post; if ( empty( $post ) \|\| ! is_a( $post, 'WP_Post' ) ) { return $global_meta; } if ( empty( $global_meta['facebook_published_time'] ) ) { $global_meta['facebook_published_time'] = get_the_date( 'c', $post ); } if ( empty( $global_meta['facebook_modified_time'] ) ) { $global_meta['facebook_modified_time'] = get_post_modified_time( 'c', true, $post ); } return $global_meta; } /* * Join locale to make full locale. * * @param string $locale Locale to join. * * @return string / private static function join( $locale ) { return strtolower( $locale ) . '_' . strtoupper( $locale ); } /* * Add common tags. * * @param array<string, mixed> $meta_data Meta Data. * @since 1.0.0 * @return void / private function add_common_tags( $meta_data ) { $common_tags = [ 'og:url' => $this->get_url(), 'og:site_name' => Site::get_instance()->get_site_name(), 'og:locale' => $this->get_locale(), 'og:type' => $this->get_type(), ]; foreach ( $common_tags as $key => $value ) { Meta_Data::get_instance()->meta_html_template( $key, $value, 'property' ); } $this->add_dynamic_tags( $meta_data ); } /* * Add dynamic tags. * * @param array<string, mixed> $meta_data Meta Data. * @since 1.0.0 * @return void / private function add_dynamic_tags( $meta_data ) { $facebook_meta_keys = [ 'facebook_title' => 'title', 'facebook_description' => 'description', 'facebook_image_url' => 'image', 'facebook_image_width' => 'image:width', 'facebook_image_height' => 'image:height', ]; foreach ( $facebook_meta_keys as $key => $value ) { if ( ! empty( $meta_data[ $key ] ) && Validate::not_empty( $meta_data[ $key ] ) ) { Meta_Data::get_instance()->meta_html_template( 'og:' . $value, $meta_data[ $key ], 'property' ); } } } /* * Add product tags. * * @param array<string, mixed> $meta_data Meta Data. * @since 1.0.0 * @return void / private function add_product_tags( $meta_data ) { $product_tags = [ 'product:price:amount' => $meta_data['product_price'] ?? null, 'product:price:currency' => $meta_data['product_currency'] ?? null, 'product:availability' => $meta_data['product_availability'] ?? null, ]; foreach ( $product_tags as $key => $value ) { if ( Validate::not_empty( $value ) ) { Meta_Data::get_instance()->meta_html_template( $key, $value, 'property' ); } } } /* * Get type. * * @return string */ private function get_type() { if ( is_front_page() \|\| is_home() ) { return 'website'; } if ( is_author() ) { return 'profile'; } return Helper::is_product() ? 'product' : 'article'; } }	11.43 KB	2025-10-27 18:36
📄 feed.php <?php /** * Custom Feed * * This file handles the functionality to print a custom feed on the frontend. * * @package SureRank * @since 1.0.0 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Settings; use SureRank\Inc\Traits\Get_Instance; /* * Class Feed * Handles functionality to print the custom feed in the frontend. * * @since 1.0.0 / class Feed { use Get_Instance; /* * Constructor * * @since 1.0.0 / public function __construct() { add_filter( 'the_excerpt_rss', [ $this, 'custom_feed_content' ] ); add_filter( 'the_content_feed', [ $this, 'custom_feed_content' ] ); add_action( 'template_redirect', [ $this, 'disable_feed_indexing' ] ); add_action( 'init', [ $this, 'additional_settings' ] ); } /* * Custom Feed Content * * @param string $content The content of the feed. * @since 1.0.0 * @return string / public function custom_feed_content( $content ) { // apply filter to add permalink to the content or not. if ( apply_filters( 'surerank_disable_permalink_in_feed', false ) ) { return $content; } $permalink = get_permalink(); if ( ! $permalink ) { return $content; } // Append site name and link to the content. $content_after = sprintf( '<p>%s <a href="%s">%s</a></p>', esc_html__( 'Read more at', 'surerank' ), esc_url( $permalink ), esc_html( get_bloginfo( 'name' ) ) ); return $content . $content_after; } /* * Disable Feed Indexing * * @since 1.0.0 * @return void / public function disable_feed_indexing() { // apply filter to disable feed indexing or not. if ( apply_filters( 'surerank_disable_feed_indexing', false ) \|\| ! is_feed() ) { return; } // Disable indexing of feed entries. header( 'X-Robots-Tag: noindex', true ); } /* * Additional Settings * * @since 1.0.0 * @return void / public function additional_settings() { $global_meta = Settings::get(); $meta_keys = [ 'remove_global_comments_feed' => 'feed_links_show_comments_feed', 'remove_post_authors_feed' => 'feed_links_extra_show_author_feed', 'remove_post_types_feed' => 'feed_links_extra_show_post_feed', 'remove_category_feed' => 'feed_links_extra_show_category_feed', 'remove_tag_feeds' => 'feed_links_extra_show_tag_feed', 'remove_custom_taxonomy_feeds' => 'feed_links_extra_show_tax_feed', 'remove_search_results_feed' => 'feed_links_extra_show_search_feed', ]; // Remove feed links based on settings. foreach ( $meta_keys as $meta_key => $filter ) { if ( ! empty( $global_meta[ $meta_key ] ) ) { add_filter( $filter, '__return_false' ); } } // Disable Atom and RDF feeds. if ( ! empty( $global_meta['remove_atom_rdf_feeds'] ) ) { add_action( 'do_feed_atom', [ $this, 'disable_feed_and_redirect' ], 1 ); add_action( 'do_feed_rdf', [ $this, 'disable_feed_and_redirect' ], 1 ); } // Disable various feeds. $feed_actions = [ 'remove_global_comments_feed' => 'do_feed_rss2_comments', 'remove_post_authors_feed' => 'do_feed_rss', 'remove_post_types_feed' => 'do_feed_rss2', 'remove_category_feed' => 'do_feed_category', 'remove_tag_feeds' => 'do_feed_tag', 'remove_custom_taxonomy_feeds' => 'do_feed_custom_taxonomy', 'remove_search_results_feed' => 'do_feed_search', ]; foreach ( $feed_actions as $meta_key => $action ) { if ( ! empty( $global_meta[ $meta_key ] ) ) { add_action( $action, [ $this, 'disable_feed_and_redirect' ], 1 ); } } } /* * Disable Feed and Redirect * * @since 1.0.0 * @return void */ public function disable_feed_and_redirect() { wp_safe_redirect( esc_url( home_url() ), 301 ); exit; } }	3.72 KB	2025-10-27 18:36
📄 image-seo.php <?php /** * Image SEO Enhancement Module * * Automatically enhances images with missing accessibility attributes. * * @package surerank * @since 1.4.0 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; } use SureRank\Inc\Traits\Get_Instance; /* * Image SEO enhancement handler * * @since 1.4.0 / class Image_Seo { use Get_Instance; /* * Initialize image enhancement * * @since 1.4.0 / public function __construct() { if ( $this->status() ) { $this->register_enhancement_hooks(); } } /* * Check if image enhancement is active * * @return bool * @since 1.4.0 / public function status(): bool { return apply_filters( 'surerank_auto_set_image_title_and_alt', true ); } /* * Enhance content with missing image attributes * * @param string $content Content to enhance. * @param int\|null $post_id Post ID context. * @return string Enhanced content * @since 1.4.0 / public function enhance_content( $content, $post_id = null ) { if ( empty( $content ) \|\| strpos( $content, '<img' ) === false ) { return $content; } return $this->process_content_images( $content, $post_id ); } /* * Register WordPress content enhancement hooks * * @since 1.4.0 * @return void / private function register_enhancement_hooks(): void { $filters = [ 'the_content' => 11, 'post_thumbnail_html' => 11, 'woocommerce_single_product_image_thumbnail_html' => 11, ]; foreach ( $filters as $hook => $priority ) { add_filter( $hook, [ $this, 'enhance_content' ], $priority, 2 ); } } /* * Process all images in content * * @param string $content Content with images. * @param int\|null $post_id Post context. * @return string Processed content * @since 1.4.0 / private function process_content_images( $content, $post_id ): string { $clean_content = $this->remove_script_style_tags( $content ); $image_tags = $this->extract_image_tags( $clean_content ); if ( empty( $image_tags ) ) { return $content; } $context = $this->build_processing_context( $post_id ); return $this->enhance_image_tags( $content, $image_tags, $context ); } /* * Remove script and style tags from content * * @param string $content Raw content. * @return string Cleaned content * @since 1.4.0 / private function remove_script_style_tags( $content ): string { /* * Using regex to remove script and style tags * * Regex pattern breakdown: * * < matches the start of a tag * (script\|style) matches either script or style * [^>]? matches any character except > (using lazy quantifier) .? matches any character any number of times (using lazy quantifier) <\/\1> matches the closing tag of the same type as the opening tag * s single line mode * i matches case insensitive / $result = preg_replace( '/<(script\|style)[^>]?>.?<\/\1>/si', '', $content ); return $result !== null ? $result : $content; } /* * Extract image tags from content that need enhancement * * @param string $content Clean content. * @return array<string> Image tag matches that need enhancement * @since 1.4.0 / private function extract_image_tags( $content ): array { $missing_alt_images = $this->extract_images_missing_alt( $content ); $missing_title_images = $this->extract_images_missing_title( $content ); if ( empty( $missing_alt_images ) && empty( $missing_title_images ) ) { return []; } return array_unique( array_merge( $missing_alt_images, $missing_title_images ) ); } /* * Extract images missing alt attributes * * @param string $content Content to search. * @return array<string> Image tags missing alt * @since 1.4.0 / private function extract_images_missing_alt( $content ): array { /* * Finds all <img> tags that are missing proper alt attributes for accessibility compliance. * * Regex breakdown: * <img : Matches literal "<img" * (?! : Start negative lookahead (ensure pattern does NOT exist) * [^>]* : Match any chars except ">" (stay within tag) * alt\s=\s : Match "alt" + optional whitespace + "=" + optional whitespace * ["\'] : Match opening quote (single or double) * [^"\'\s] : Match at least one non-quote, non-whitespace character * [^"\']* : Match remaining non-quote characters * ["\'] : Match closing quote * ) : End negative lookahead * [^>]> : Match remaining tag content until closing ">" i : Case-insensitive flag * * Examples of what this WILL match (accessibility violations): * - <img src="photo.jpg"> (no alt attribute) * - <img src="photo.jpg" alt=""> (empty alt) * - <img src="photo.jpg" alt=" "> (whitespace-only alt) * - <IMG SRC="photo.jpg" ALT=""> (case variations) * * Examples of what this will NOT match (valid alt attributes): * - <img src="photo.jpg" alt="A photo"> (valid alt text) * - <img src="photo.jpg" alt="User avatar"> (descriptive alt text) * * @param string $content The HTML content to search for non-compliant img tags * @param array $matches Output array that will contain all matched img tags * @return int Number of matches found * * @see https://www.php.net/manual/en/reference.pcre.pattern.syntax.php * @since 1.0.0 / preg_match_all( '/<img(?![^>]alt\s=\s["\'][^"\'\s][^"\']["\'])[^>]>/i', $content, $matches ); return $matches[0]; } /** * Extract images missing title attributes * * @param string $content Content to search. * @return array<string> Image tags missing title * @since 1.4.0 / private function extract_images_missing_title( $content ): array { /* * Finds all <img> tags that are missing proper title attributes for accessibility compliance. * * Regex breakdown: * <img : Matches literal "<img" * (?! : Start negative lookahead (ensure pattern does NOT exist) * [^>]* : Match any chars except ">" (stay within tag) * title\s=\s : Match "title" + optional whitespace + "=" + optional whitespace * ["\'] : Match opening quote (single or double) * [^"\'\s] : Match at least one non-quote, non-whitespace character * [^"\']* : Match remaining non-quote characters * ["\'] : Match closing quote * ) : End negative lookahead * [^>]> : Match remaining tag content until closing ">" i : Case-insensitive flag * * Examples of what this WILL match (accessibility violations): * - <img src="photo.jpg"> (no title attribute) * - <img src="photo.jpg" title=""> (empty title) * - <img src="photo.jpg" title=" "> (whitespace-only title) * - <IMG SRC="photo.jpg" TITLE=""> (case variations) * * Examples of what this will NOT match (valid title attributes): * - <img src="photo.jpg" title="A photo"> (valid title text) * - <img src="photo.jpg" title="User avatar"> (descriptive title text) * * @param string $content The HTML content to search for non-compliant img tags * @param array $matches Output array that will contain all matched img tags * @return int Number of matches found * * @see https://www.php.net/manual/en/reference.pcre.pattern.syntax.php * @since 1.0.0 / preg_match_all( '/<img(?![^>]title\s=\s["\'][^"\'\s][^"\']["\'])[^>]>/i', $content, $matches ); return $matches[0]; } /** * Build processing context object * * @param int\|null $post_id Post ID. * @return object{title: string, slug: string, site_name: string} Context data * @since 1.4.0 / private function build_processing_context( $post_id ): object { $post = get_post( $post_id ); return (object) [ 'title' => $post->post_title ?? '', 'slug' => $post->post_name ?? '', 'site_name' => get_bloginfo( 'name' ), ]; } /* * Enhance individual image tags * * @param string $content Original content. * @param array<string> $images Image tag array. * @param object{title: string, slug: string, site_name: string} $context Processing context. * @return string Enhanced content * @since 1.4.0 / private function enhance_image_tags( $content, $images, $context ): string { foreach ( $images as $original_tag ) { $enhanced_tag = $this->enhance_single_image( $original_tag, $context ); if ( $enhanced_tag !== $original_tag ) { $content = str_replace( $original_tag, $enhanced_tag, $content ); } } return $content; } /* * Enhance single image tag * * @param string $tag Original image tag. * @param object{title: string, slug: string, site_name: string} $context Processing context. * @return string Enhanced tag * @since 1.4.0 / private function enhance_single_image( $tag, $context ): string { $attributes = $this->parse_image_attributes( $tag ); if ( empty( $attributes ) ) { return $tag; } $image_src = $this->resolve_image_source( $attributes ); if ( empty( $image_src ) ) { return $tag; } $enhancements = $this->calculate_needed_enhancements( $attributes ); $enhancements = apply_filters( 'surerank_image_seo_enhancements', $enhancements, $attributes, $image_src, $context ); if ( empty( $enhancements ) ) { return $tag; } return $this->apply_enhancements( $attributes, $enhancements, $image_src, $context ); } /* * Parse attributes from image tag * * @param string $tag Image tag. * @return array<string, string> Parsed attributes * @since 1.4.0 / private function parse_image_attributes( $tag ): array { $attributes = []; /* * Using regex to parse image attributes * * Regex pattern breakdown: * ([a-zA-Z_:][a-zA-Z0-9\-_.:]) : Check for the attribute name. [a-zA-Z_:] : First char: letter, underscore, or colon * [a-zA-Z0-9\-_.]* : Remaining chars: alphanumeric, hyphen, dot, underscore, colon * = : Literal equals sign * ["\'] : Opening quote (single or double) * ([^"\']) : Capture group 2 - Attribute value (any chars except quotes) ["\'] : Closing quote (single or double) * i : Case-insensitive flag * * Examples of what this WILL match (accessibility violations): * - <img src="photo.jpg"> (no alt attribute) * - <img src="photo.jpg" alt=""> (empty alt) * - <img src="photo.jpg" alt=" "> (whitespace-only alt) * - <IMG SRC="photo.jpg" ALT=""> (case variations) * * Examples of what this will NOT match (valid alt attributes): * - <img src="photo.jpg" alt="A photo"> (valid alt text) * - <img src="photo.jpg" alt="User avatar"> (descriptive alt text) / if ( preg_match_all( '/([a-zA-Z_:][a-zA-Z0-9\-_.:])=["\']([^"\'])["\']/', $tag, $matches, PREG_SET_ORDER ) ) { /* * [0] => src="photo.jpg" // Full match * [1] => src // Attribute name * [2] => photo.jpg // Attribute value / foreach ( $matches as $match ) { $attributes[ $match[1] ] = $match[2]; } } return $attributes; } /* * Resolve image source URL (supports lazy loading) * * @param array<string, string> $attributes Image attributes. * @return string Image source * @since 1.4.0 / private function resolve_image_source( $attributes ): string { $lazy_attrs = [ 'data-src', 'data-lazy-src', 'data-layzr' ]; foreach ( $lazy_attrs as $attr ) { if ( ! empty( $attributes[ $attr ] ) ) { return $attributes[ $attr ]; } } return $attributes['src'] ?? ''; } /* * Calculate which enhancements are needed * * @param array<string, string> $attributes Current attributes. * @return array<string, string> Needed enhancements * @since 1.4.0 / private function calculate_needed_enhancements( $attributes ): array { $needed = []; if ( apply_filters( 'surerank_image_seo_enable_alt', true ) && empty( $attributes['alt'] ) ) { $needed['alt'] = apply_filters( 'surerank_image_seo_alt_template', '%filename%' ); } if ( apply_filters( 'surerank_image_seo_enable_title', true ) && empty( $attributes['title'] ) ) { $needed['title'] = apply_filters( 'surerank_image_seo_title_template', '%title%' ); } return $needed; } /* * Apply enhancements to image attributes * * @param array<string, string> $attributes Original attributes. * @param array<string, string> $enhancements Needed enhancements. * @param string $src Image source. * @param object{title: string, slug: string, site_name: string} $context Processing context. * @return string Enhanced image tag * @since 1.4.0 / private function apply_enhancements( $attributes, $enhancements, $src, $context ): string { $filename = $this->extract_clean_filename( $src ); foreach ( $enhancements as $attr => $template ) { $attributes[ $attr ] = $this->resolve_template( $template, $context, $filename ); } return $this->build_image_tag( $attributes ); } /* * Extract and clean filename from URL * * @param string $url Image URL. * @return string Clean filename * @since 1.4.0 / private function extract_clean_filename( $url ): string { if ( empty( $url ) ) { return ''; } return $this->sanitize_filename( $this->get_basename_without_extension( $url ) ); } /* * Get filename without extension * * @param string $url URL. * @return string Basename * @since 1.4.0 / private function get_basename_without_extension( $url ): string { $filename = basename( $url ); /* * Using regex to get the basename without the extension * Regex pattern breakdown: * * \. matches a literal dot * [^.]+ matches one or more characters that are not a dot * $ matches the end of the string / $result = preg_replace( '/\.[^.]+$/', '', $filename ); return $result !== null ? $result : $filename; } /* * Sanitize filename for readability * * @param string $filename Raw filename. * @return string Sanitized filename * @since 1.4.0 / private function sanitize_filename( $filename ): string { /* * Using regex to sanitize the filename * Regex pattern breakdown: * * [-_] matches a hyphen or underscore * + matches one or more of the preceding element * $ matches the end of the string / $cleaned = preg_replace( '/[-_]+/', ' ', $filename ); $safe_cleaned = $cleaned !== null ? $cleaned : $filename; return ucwords( trim( $safe_cleaned ) ); } /* * Resolve template variables * * @param string $template Template string. * @param object{title: string, slug: string, site_name: string} $context Context data. * @param string $filename Clean filename. * @return string Resolved string * @since 1.4.0 / private function resolve_template( $template, $context, $filename ): string { if ( empty( $template ) ) { return ''; } $variables = $this->build_variable_map( $context, $filename ); $resolved = trim( strtr( $template, $variables ) ); return apply_filters( 'surerank_image_seo_resolved_text', $resolved, $template, $context, $filename ); } /* * Build variable replacement map * * @param object{title: string, slug: string, site_name: string} $context Context data. * @param string $filename Filename. * @return array<string, string> Variable mappings * @since 1.4.0 / private function build_variable_map( $context, $filename ): array { $default_vars = [ '%title%' => $context->title, '%filename%' => $filename, '%site_name%' => $context->site_name, '%slug%' => $context->slug, ]; return apply_filters( 'surerank_image_seo_variable_map', $default_vars, $context, $filename ); } /* * Build complete image tag from attributes * * @param array<string, string> $attributes Attribute pairs. * @return string Complete image tag * @since 1.4.0 / private function build_image_tag( $attributes ): string { $attr_pairs = []; foreach ( $attributes as $name => $value ) { $attr_pairs[] = $this->format_attribute_pair( $name, $value ); } return sprintf( '<img %s>', implode( ' ', $attr_pairs ) ); } /* * Format single attribute pair * * @param string $name Attribute name. * @param string $value Attribute value. * @return string Formatted pair * @since 1.4.0 */ private function format_attribute_pair( $name, $value ): string { return sprintf( '%s="%s"', esc_attr( $name ), esc_attr( $value ) ); } }	17.32 KB	2025-10-27 18:36
📄 image.php <?php /** * Image Meta Data * * Handles functionality to retrieve and manage image metadata for frontend requests, * particularly for Open Graph image tags. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Settings; use SureRank\Inc\Meta_Variables\Post; use SureRank\Inc\Traits\Get_Instance; /* * Image Meta Data Handler * * Manages image metadata retrieval for frontend requests, optimized for Open Graph tags. * * @since 0.0.1 / class Image { use Get_Instance; /* * Cache for image data * * @var array<string, string\|null> / private $image_cache = []; /* * Retrieves Open Graph image URL based on page type * * @return string\|null OG image URL or null if none found * @since 1.0.0 / public function get_og_image() { if ( post_password_required() ) { return null; } if ( ! get_queried_object_id() ) { return null; } $cache_key = md5( (string) wp_json_encode( get_queried_object_id() ) ); if ( isset( $this->image_cache[ $cache_key ] ) ) { return $this->image_cache[ $cache_key ]; } $image_url = null; if ( is_singular() ) { $image_url = $this->get_singular_page_image(); } elseif ( is_tax() \|\| is_category() \|\| is_tag() ) { $image_url = $this->get_taxonomy_image(); } $this->image_cache[ $cache_key ] = $image_url; return $image_url; } /* * Get attachment ID by URL * * @param string $url Image URL. * @return int Attachment ID or 0 if not found * @since 1.0.0 / public function attachment_by_url( $url ) { $attachment_id = attachment_url_to_postid( $url ); return (int) $attachment_id; } /* * Prepare fallback image * * @param array<string, mixed> $meta_data Meta Data. * @param string $key Meta key to populate. * @since 1.0.0 * @return void / public function get( &$meta_data, $key ) { $fallback_image = Settings::get( 'fallback_image' ); if ( ! empty( $meta_data[ $key ] ) ) { return; } if ( $this->get_og_image() ) { $meta_data[ $key ] = $this->get_og_image(); } else { $meta_data[ $key ] = $fallback_image; } } /* * Retrieves taxonomy page image * * @param int\|null $term_id The term ID. * @return string\|null Taxonomy image URL or null if none found * @since 1.0.0 / public function get_taxonomy_image( $term_id = null ) { $term_description = ''; if ( ! $term_id ) { $term_description = term_description(); } else { $term_data = get_term( $term_id ); if ( $term_data ) { $term_description = $term_data->description ?? ''; } } if ( ! $term_description ) { return null; } return $this->get_first_content_image( $term_description ); } /* * Retrieves singular page image * * @param int\|null $post_id The post ID. * @return string\|null Singular page image URL or null if none found * @since 1.0.0 / public function get_singular_page_image( $post_id = null ) { if ( ! $post_id ) { $post_id = get_queried_object_id(); } if ( ! $post_id ) { return null; } $post_instance = Post::get_instance(); $post_instance->set_post( $post_id ); $content = $post_instance->get_content(); return $content ? $this->get_first_content_image( $content ) : null; } /* * Extracts first valid image from content * * @param string $content The content to search. * @return string\|null Image URL or null if none found * @since 1.0.0 / private function get_first_content_image( string $content ) { if ( empty( $content ) \|\| strpos( $content, '<img' ) === false ) { return null; } if ( ! preg_match( '/<img\s+[^>]?src=["\']([^"\']+)["\']/i', $content, $match ) ) { return null; } $src = trim( $match[1] ); if ( empty( $src ) ) { return null; } $absolute_url = $this->ensure_absolute_url( $src ); $image_data = $this->get_image_data_by_url( $absolute_url ); return $image_data && $this->is_valid_og_image( $image_data ) ? $image_data['url'] : null; } /** * Gets image data by attachment ID * * @param int $attachment_id The attachment ID. * @return array<string, mixed>\|null Image data array or null if invalid * @since 1.0.0 / private function get_image_data_by_id( int $attachment_id ) { if ( ! wp_attachment_is_image( $attachment_id ) ) { return null; } $image = wp_get_attachment_image_src( $attachment_id, 'large' ); if ( ! $image ) { return null; } [$url, $width, $height] = $image; return [ 'id' => $attachment_id, 'url' => $url, 'width' => $width, 'height' => $height, 'type' => get_post_mime_type( $attachment_id ), 'alt' => get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ) ?? '', ]; } /* * Gets image data by URL * * @param string $url Image URL. * @return array<string, mixed>\|null Image data array or null if invalid * @since 1.0.0 / private function get_image_data_by_url( string $url ) { $url = filter_var( $url, FILTER_VALIDATE_URL ) ? $url : null; if ( ! $url ) { return null; } $attachment_id = $this->attachment_by_url( $url ); if ( $attachment_id > 0 ) { return $this->get_image_data_by_id( $attachment_id ); } if ( ! $this->is_valid_image_extension( $url ) ) { return null; } return [ 'url' => $url ]; } /* * Validates image for Open Graph use * * @param array<string, mixed> $image_data Image data to validate. * @return bool Whether image meets OG requirements * @since 1.0.0 / private function is_valid_og_image( array $image_data ) { if ( empty( $image_data['url'] ) \|\| ! $this->is_valid_image_extension( $image_data['url'] ) ) { return false; } if ( isset( $image_data['width'] ) && isset( $image_data['height'] ) ) { return $image_data['width'] >= apply_filters( 'surerank_og_dimensions_min_width', 200 ) && $image_data['height'] >= apply_filters( 'surerank_og_dimensions_min_height', 200 ) && $image_data['width'] <= apply_filters( 'surerank_og_dimensions_max_width', 2000 ) && $image_data['height'] <= apply_filters( 'surerank_og_dimensions_max_height', 2000 ); } return true; } /* * Validates image file extension * * @param string $url Image URL. * @return bool Whether extension is valid * @since 1.0.0 / private function is_valid_image_extension( string $url ) { $valid_extensions = [ 'jpg', 'jpeg', 'png', 'gif', 'webp' ]; $extension = strtolower( pathinfo( $url, PATHINFO_EXTENSION ) ); return ! empty( $extension ) && in_array( $extension, $valid_extensions, true ); } /* * Ensures URL is absolute * * @param string $url Input URL. * @return string Absolute URL * @since 1.0.0 */ private function ensure_absolute_url( string $url ): string { if ( empty( $url ) ) { return ''; } $sanitized_url = filter_var( $url, FILTER_SANITIZE_URL ); if ( ! $sanitized_url ) { return ''; } return filter_var( $sanitized_url, FILTER_VALIDATE_URL ) ? $sanitized_url : home_url( $sanitized_url ); } }	6.93 KB	2025-10-27 18:36
📄 meta-data.php <?php /** * Meta Data * * This file will handle functionality to print meta_data in frontend for different requests. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Meta_Variables\Post; use SureRank\Inc\Meta_Variables\Site; use SureRank\Inc\Meta_Variables\Term; use SureRank\Inc\Traits\Get_Instance; use WP_Post; use WP_Term; /* * Meta Data * This class will handle functionality to print meta_data in frontend for different requests. * * @since 1.0.0 / class Meta_Data { use Get_Instance; /* * Meta Data * * @var array<string, mixed>\|null $meta_data Post meta data. * @since 1.0.0 / private $meta_data = null; /* * Constructor * * @since 1.0.0 / public function __construct() { /* * If it's a ajax request, we don't need to call wp_head or wp hook here. * * @since 1.3.0 / if ( \wp_doing_ajax() ) { return; } add_action( 'wp_head', [ $this, 'print_meta_data' ], 2 ); add_action( 'wp', [ $this, 'set_meta_data' ], 1 ); } /* * Add meta data * * @since 1.0.0 * @return void / public function print_meta_data() { $this->print_meta(); } /* * Add meta data * * @since 1.0.0 * @return void / public function set_meta_data() { $this->set_meta(); } /* * Meta HTML Template * * @param string $attr_key meta attribute key. * @param string\|false $attr_value meta attribute value. * @param string $attr_type meta attribute type. * @since 1.0.0 * @return void / public function meta_html_template( $attr_key, $attr_value, $attr_type = 'name' ) { if ( empty( $attr_value ) ) { return; } if ( 'property' === $attr_type ) { echo '<meta property="' . esc_attr( $attr_key ) . '" content="' . esc_attr( $attr_value ) . '">' . PHP_EOL; } else { echo '<meta name="' . esc_attr( $attr_key ) . '" content="' . esc_attr( $attr_value ) . '">' . PHP_EOL; } } /* * Get Meta Data * * @since 1.0.0 * @return array<string, mixed>\|null / public function get_meta_data() { return $this->meta_data; } /* * Set meta data * * @since 1.0.0 * @return void / private function set_meta() { $queried_object = get_queried_object(); if ( is_singular() && $queried_object instanceof WP_Post ) { Post::get_instance()->set_post( intval( $queried_object->ID ) ); } elseif ( ( is_tax() \|\| is_category() \|\| is_tag() ) && $queried_object instanceof WP_Term ) { Term::get_instance()->set_term( intval( $queried_object->term_id ) ); } elseif ( is_front_page() \|\| is_home() ) { Site::get_instance(); } elseif ( is_author() \|\| is_date() ) { // For archive pages, we don't need to initialize any specific meta variable instance. // But we still need to apply the filter to allow archive meta to be added. $this->initialize_archive_variables(); } else { return; } $this->meta_data = apply_filters( 'surerank_set_meta', $this->meta_data ); } /* * This function prints available meta on current page. * * @since 0.0.1 * @return void / private function print_meta() { echo '<!-- SureRank Meta Data -->' . PHP_EOL; do_action( 'surerank_print_meta', $this->meta_data ); echo PHP_EOL . '<!-- /SureRank Meta Data -->' . PHP_EOL; } /* * Initialize archive variables - intentionally empty. * This method exists to avoid empty elseif statement coding standard violation. * * @since 1.2.0 * @return void */ private function initialize_archive_variables() { // Intentionally empty - archive pages don't need specific meta variable initialization. // The filter application happens after this method call. } }	3.65 KB	2025-10-27 18:36
📄 meta-tag-injection.php <?php /** * Meta Tag Injection Class * * Responsible for injecting Google Search Console verification meta tags. * * @since 1.4.0 * @package SureRank / namespace SureRank\Inc\Frontend; use SureRank\Inc\Traits\Get_Instance; use SureRank\Inc\Functions\Settings; /* * Meta Tag Injection Class * * Handles the injection of Google verification meta tags into the site head. * * @since 1.4.0 / class Meta_Tag_Injection { use Get_Instance; /* * Constructor * * @since 1.4.0 * @return void / public function __construct() { $enabled = Settings::get( 'enable_google_console' ) ?? false; if ( $enabled ) { add_action( 'surerank_print_meta', [ $this, 'output_verification_meta_tag' ] ); return; } } /* * Output Verification Meta Tag * * Outputs the Google Search Console verification meta tag if one exists * * @since 1.4.0 * @return void */ public function output_verification_meta_tag() { $verification_token = get_option( 'surerank_gsc_verification_token', false ); if ( ! empty( $verification_token ) ) { echo "\n" . '<meta name="google-site-verification" content="' . esc_attr( $verification_token ) . '" />' . "\n"; } } }	1.17 KB	2025-10-27 18:36
📄 product.php <?php /** * Product Meta Data * * This file will handle functionality to print product-specific meta_data in the frontend for WooCommerce product pages. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Helper; use SureRank\Inc\Traits\Get_Instance; /* * Product SEO * This class will handle functionality to print product-specific meta_data in the frontend. * * @since 1.0.0 / class Product { use Get_Instance; /* * Meta Data * * @var array<string, mixed>\|null $meta_data Product meta data. * @since 1.0.0 / private $meta_data = null; /* * Constructor * * @since 1.0.0 / public function __construct() { // Check if WooCommerce is active. if ( ! Helper::wc_status() ) { return; } // Set product-specific meta data. add_filter( 'surerank_set_meta', [ $this, 'get_meta_data' ], 1 ); } /* * Get and set product-specific meta data * * @param array<string, mixed> $meta_data Meta Data. * @since 1.0.0 * @return array<string, mixed> / public function get_meta_data( $meta_data ) { if ( ! Helper::is_product() && ! Helper::wc_status() ) { return $meta_data; } $product_id = get_the_ID(); if ( empty( $product_id ) ) { return $meta_data; } if ( null !== $this->meta_data ) { return $meta_data; } $this->meta_data = $this->prepare_product_meta( $product_id ); if ( empty( $this->meta_data ) ) { return $meta_data; } if ( ! $meta_data ) { return $this->meta_data; } return array_merge( $meta_data, $this->meta_data ); } /* * Prepare product-specific meta data * * @param int $product_id Product ID. * @since 1.0.0 * @return array<string, mixed> */ private function prepare_product_meta( $product_id ) { $product = \wc_get_product( $product_id ); if ( ! $product ) { return []; } return [ 'product_price' => $product->get_price(), 'product_currency' => get_woocommerce_currency(), 'product_availability' => $product->is_in_stock() ? 'instock' : 'outofstock', ]; } }	2.1 KB	2025-10-27 18:36
📄 robots.php <?php /** * Meta Data * * This file will handle functionality to print meta_data in frontend for different requests. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Get; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Sitemap\Xml_Sitemap; use SureRank\Inc\Traits\Get_Instance; /* * Home Page SEO * This class will handle functionality to print meta_data in frontend for different requests. * * @since 1.0.0 / class Robots { use Get_Instance; /* * Constructor * * @since 1.0.0 / public function __construct() { add_action( 'surerank_print_meta', [ $this, 'print_meta' ], 1 ); remove_all_filters( 'wp_robots' ); add_filter( 'robots_txt', [ $this, 'generate_custom_robots_txt' ], 10, 2 ); //phpcs:ignore WordPressVIPMinimum.Hooks.RestrictedHooks.robots_txt } /* * Add meta data * * @since 1.0.0 * @param array<string, mixed> $robots_meta meta data. * @return void / public function print_meta( $robots_meta ) { $noindex = $robots_meta['post_no_index'] ?? false; $nofollow = $robots_meta['post_no_follow'] ?? false; $noarchive = $robots_meta['post_no_archive'] ?? false; /* * Example of robots meta array: * [ "general" => [ "noindex", "nofollow", "noarchive" ] ] / $robots_meta_keys = [ 'noindex', 'nofollow', 'noarchive' ]; $robots_meta_array = []; // If robots_meta general exists, use it. if ( ! empty( $noindex ) \|\| ! empty( $nofollow ) \|\| ! empty( $noarchive ) ) { if ( $noindex === 'yes' ) { $robots_meta_array[] = 'noindex'; } if ( $nofollow === 'yes' ) { $robots_meta_array[] = 'nofollow'; } if ( $noarchive === 'yes' ) { $robots_meta_array[] = 'noarchive'; } } else { // Otherwise, fallback to Settings-based values. if ( $this->is_specified_page_type( Settings::get( 'no_index' ) ) ) { $robots_meta_array[] = 'noindex'; } if ( $this->is_specified_page_type( Settings::get( 'no_follow' ) ) ) { $robots_meta_array[] = 'nofollow'; } if ( $this->is_specified_page_type( Settings::get( 'no_archive' ) ) ) { $robots_meta_array[] = 'noarchive'; } } // Default to 'index' and 'follow' if not already set. if ( ! in_array( 'noindex', $robots_meta_array, true ) ) { $robots_meta_array[] = 'index'; } if ( ! in_array( 'nofollow', $robots_meta_array, true ) ) { $robots_meta_array[] = 'follow'; } if ( ! Get::option( 'blog_public' ) ) { $robots_meta_array = array_diff( $robots_meta_array, [ 'index', 'follow' ] ); $robots_meta_array[] = 'noindex'; $robots_meta_array[] = 'nofollow'; } // Prepare the final meta tag value. $robots_meta_value = implode( ', ', apply_filters( 'surerank_robots_meta_array', array_unique( $robots_meta_array ) ) ); // Call the meta_html_template method with the prepared value. Meta_Data::get_instance()->meta_html_template( 'robots', $robots_meta_value ); } /* * Generates a custom robots.txt content with an updated Sitemap directive. * * @since 0.0.1 * @since 1.2.0 * @param string $output The current robots.txt output. * @param bool $public Whether the site is public and should be indexed. * @return string Updated robots.txt content with the Sitemap directive added or modified. / public function generate_custom_robots_txt( $output, $public ) { if ( ! $public ) { return $output; } $custom_content = Get::option( SURERANK_ROBOTS_TXT_CONTENT, '' ); if ( ! empty( $custom_content ) ) { return $custom_content; } if ( ! empty( Settings::get( 'enable_xml_sitemap' ) ) ) { $sitemap_url = home_url( Xml_Sitemap::get_slug() ); $sitemap_directive = "Sitemap: {$sitemap_url}" . PHP_EOL; if ( preg_match( '/^sitemap:\s.$/im', $output ) ) { $output = preg_replace( '/^sitemap:\s.$/im', $sitemap_directive, $output ); } else { // Append the Sitemap directive to the output if none exists. $output .= PHP_EOL . $sitemap_directive; } return (string) $output; } return $output; } /* * Check of specified page type exists * * @since 1.0.0 * @param array<int, string> $types page types. * @return bool / public function is_specified_page_type( $types = [] ): bool { foreach ( $types as $type ) { if ( $this->is_empty_taxonomy() ) { return true; } if ( $this->matches_page_type( $type ) ) { return true; } } return false; } /* * Check if current page is an empty taxonomy archive. * * @since 1.0.0 * @return bool / private function is_empty_taxonomy() { if ( ! is_archive() ) { return false; } $taxonomy = get_queried_object(); if ( ! $taxonomy instanceof \WP_Term ) { return false; } return $taxonomy->count === 0; } /* * Check if the current page matches the specified type. * * @since 1.0.0 * @param string $type The page type to check. * @return bool */ private function matches_page_type( string $type ) { $type_checks = [ 'post_tag' => 'is_tag', 'author' => 'is_author', 'date' => 'is_date', 'category' => 'is_category', 'search' => 'is_search', 'archive' => 'is_archive', ]; // Check standard page types. if ( isset( $type_checks[ $type ] ) && call_user_func( $type_checks[ $type ] ) ) { return true; } // Check post format. if ( 'post_format' === $type && is_tax( 'post_format' ) ) { return true; } // Check custom post types. if ( post_type_exists( $type ) && is_singular( $type ) ) { return true; } // Check custom taxonomies. if ( taxonomy_exists( $type ) && is_tax( $type ) ) { return true; } return false; } }	5.6 KB	2025-10-27 18:36
📄 seo-popup.php <?php /** * Seo Popup. * * @since 1.0.0 * @package surerank / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Traits\Enqueue; use SureRank\Inc\Traits\Get_Instance; /* * Seo Popup frontend. * * @method void admin_enqueue_scripts() * @since 1.0.0 / class Seo_Popup { use Enqueue; use Get_Instance; /* * Constructor * * @since 0.0.1 * @return void / public function __construct() { $this->enqueue_scripts(); } /* * Enqueue scripts * * @since 0.0.1 * @return void */ public function wp_enqueue_scripts() { if ( ! is_admin_bar_showing() ) { return; } if ( ! is_admin() ) { return; // Exit if not admin, this will avoid js on frontend pages. } $this->build_assets_operations( 'seo-popup', [ 'hook' => 'seo-popup', 'object_name' => 'seo_popup', 'data' => [ 'post_id' => get_the_ID(), 'site_icon_url' => get_site_icon_url( 16 ), 'editor_type' => 'frontend', ], ] ); } }	1.04 KB	2025-10-27 18:36
📄 single.php <?php /** * Common Meta Data * * This file will handle functionality to print meta_data in frontend for different requests. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Settings; use SureRank\Inc\Functions\Validate; use SureRank\Inc\Functions\Variables; use SureRank\Inc\Traits\Get_Instance; /* * Single Page SEO * This class will handle functionality to print meta_data in frontend for different requests. * * @since 1.0.0 / class Single { use Get_Instance; /* * Meta Data * * @var array<string, mixed>\|null $meta_data Post meta data. * @since 1.0.0 / private $meta_data = null; /* * Constructor * * @since 1.0.0 / public function __construct() { add_filter( 'surerank_set_meta', [ $this, 'get_meta_data' ], 1 ); } /* * Add meta data * * @param array<string, mixed> $meta_data Meta Data. * @since 1.0.0 * @return array<string, mixed> $meta_data */ public function get_meta_data( $meta_data ) { if ( ! is_singular() ) { return $meta_data; } $post_id = get_the_ID(); if ( empty( $post_id ) ) { return $meta_data; } if ( null !== $this->meta_data ) { return $meta_data; } $post_type = get_post_type( $post_id ) ? get_post_type( $post_id ) : ''; $this->meta_data = Variables::replace( Validate::array( Settings::prep_post_meta( intval( $post_id ), $post_type, false ) ), intval( $post_id ) ); return $this->meta_data; } }	1.52 KB	2025-10-27 18:36
📄 special-page.php <?php /** * Meta Data * * This file will handle functionality to print meta_data in frontend for different requests. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Get; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Functions\Validate; use SureRank\Inc\Functions\Variables; use SureRank\Inc\Traits\Get_Instance; /* * Home Page SEO * This class will handle functionality to print meta_data in frontend for different requests. * * @since 1.0.0 / class Special_Page { use Get_Instance; /* * Constructor * * @since 1.0.0 / public function __construct() { add_filter( 'surerank_set_meta', [ $this, 'add_meta_data' ], 1, 1 ); } /* * Add meta data * * @param array<string, mixed> $meta Meta Data. * @since 1.0.0 * @return array<string, mixed> / public function add_meta_data( $meta ) { if ( ! is_home() && ! is_front_page() ) { return $meta; } $meta = get_option( 'show_on_front' ) === 'page' ? $this->get_meta_for_static_homepage( $meta ) : self::get_meta_for_dynamic_homepage(); return Get::fb_image_size( $meta ); } /* * Get the meta data for the homepage. * * @return array<string, mixed> Meta data for the homepage. * @since 1.0.0 / public static function get_meta_for_dynamic_homepage() { $page_meta = Settings::get(); $robots = isset( $page_meta['home_page_robots'] ) && is_array( $page_meta['home_page_robots'] ) && isset( $page_meta['home_page_robots']['general'] ) ? $page_meta['home_page_robots']['general'] : []; if ( ! isset( $page_meta['home_page_facebook_title'] ) \|\| $page_meta['home_page_facebook_title'] === '' ) { $page_meta['home_page_facebook_title'] = $page_meta['home_page_title'] ?? ''; } if ( ! isset( $page_meta['home_page_facebook_description'] ) \|\| $page_meta['home_page_facebook_description'] === '' ) { $page_meta['home_page_facebook_description'] = $page_meta['home_page_description'] ?? ''; } if ( ! isset( $page_meta['home_page_twitter_title'] ) \|\| $page_meta['home_page_twitter_title'] === '' ) { $page_meta['home_page_twitter_title'] = $page_meta['home_page_title'] ?? ''; } if ( ! isset( $page_meta['home_page_twitter_description'] ) \|\| $page_meta['home_page_twitter_description'] === '' ) { $page_meta['home_page_twitter_description'] = $page_meta['home_page_description'] ?? ''; } $page_meta = [ 'page_title' => $page_meta['home_page_title'], 'page_description' => $page_meta['home_page_description'], 'facebook_title' => $page_meta['home_page_facebook_title'], 'facebook_description' => $page_meta['home_page_facebook_description'], 'facebook_image_url' => $page_meta['home_page_facebook_image_url'] ?? $page_meta['fallback_image'] ?? '', 'twitter_title' => $page_meta['home_page_twitter_title'], 'twitter_description' => $page_meta['home_page_twitter_description'], 'twitter_image_url' => $page_meta['home_page_twitter_image_url'] ?? $page_meta['fallback_image'] ?? '', 'post_no_index' => in_array( 'noindex', $robots ) ? 'yes' : 'no', 'post_no_follow' => in_array( 'nofollow', $robots ) ? 'yes' : 'no', 'post_no_archive' => in_array( 'noarchive', $robots ) ? 'yes' : 'no', 'canonical_url' => self::get_canonical_url( $page_meta ), ]; return Variables::replace( $page_meta, (int) get_the_ID() ); } /* * Get the page id. * * @return int Page id. * @since 1.3.0 / public static function get_page_id() { if ( is_home() && ! is_front_page() && Get::option( 'page_for_posts' ) ) { return Get::option( 'page_for_posts' ); } return (int) get_the_ID(); } /* * Get the canonical url. * * @param array<string, mixed> $meta Meta data. * @return string Canonical url. * @since 1.3.0 / public static function get_canonical_url( $meta ) { if ( is_home() && is_front_page() ) { return get_home_url(); } return $meta['canonical_url'] ?? ''; } /* * Get meta for static homepage. * * @param array<string, mixed> $meta Meta Data. * @return array<string, mixed> Meta data for static homepage. * @since 1.0.0 */ private function get_meta_for_static_homepage( $meta ) { $auto_generated_og_image = $meta['auto_generated_og_image'] ?? ''; $meta = [ 'page_title' => $meta['page_title'] ?? '', 'page_description' => $meta['page_description'] ?? '', 'facebook_title' => $meta['facebook_title'] ?? '', 'facebook_description' => $meta['facebook_description'] ?? '', 'facebook_image_url' => $meta['facebook_image_url'] ?? $auto_generated_og_image, 'twitter_title' => $meta['twitter_title'] ?? '', 'twitter_description' => $meta['twitter_description'] ?? '', 'twitter_image_url' => $meta['twitter_image_url'] ?? $auto_generated_og_image, 'post_no_index' => $meta['post_no_index'] ?? 'no', 'post_no_follow' => $meta['post_no_follow'] ?? 'no', 'post_no_archive' => $meta['post_no_archive'] ?? 'no', 'canonical_url' => self::get_canonical_url( $meta ), ]; $post_meta = Variables::replace( Validate::array( Settings::prep_post_meta( intval( self::get_page_id() ) ) ), intval( self::get_page_id() ) ); return array_merge( $meta, $post_meta ); } }	5.28 KB	2025-10-27 18:36
📄 taxonomy.php <?php /** * Taxonomy Meta Data * * This file will handle functionality to print meta_data in frontend for taxonomy requests. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Settings; use SureRank\Inc\Functions\Validate; use SureRank\Inc\Functions\Variables; use SureRank\Inc\Traits\Get_Instance; /* * Taxonomy SEO * This class will handle functionality to print meta_data in frontend for taxonomy requests. * * @since 1.0.0 / class Taxonomy { use Get_Instance; /* * Meta Data * * @var array<string, mixed>\|null $meta_data Term meta data. * @since 1.0.0 / private $meta_data = null; /* * Constructor * * @since 1.0.0 / public function __construct() { add_filter( 'surerank_set_meta', [ $this, 'get_meta_data' ], 1 ); } /* * Add meta data * * @param array<string, mixed> $meta_data Meta Data. * @since 1.0.0 * @return array<string, mixed> */ public function get_meta_data( $meta_data ) { if ( ! is_tax() && ! is_category() && ! is_tag() ) { return $meta_data; } $term = get_queried_object(); if ( empty( $term ) \|\| ! isset( $term->term_id ) ) { return $meta_data; } if ( null !== $this->meta_data ) { return $meta_data; } $term_id = intval( $term->term_id ); $taxonomy = $term->taxonomy ?? ''; $this->meta_data = Variables::replace( Validate::array( Settings::prep_term_meta( $term_id, $taxonomy, true ) ), $term_id ); return $this->meta_data; } }	1.55 KB	2025-10-27 18:36
📄 title.php <?php /** * Title Meta Data * * Handles functionality to print titles in the frontend for different requests. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Helper; use SureRank\Inc\Traits\Get_Instance; use WP_Term; /* * Title * Manages title generation for various WordPress frontend requests. * * @since 0.0.1 / class Title { use Get_Instance; /* * Post meta data. * * @var array<string, mixed>\|null * @since 0.0.1 / private $meta_data = null; /* * Default separator for title parts. * * @var string * @since 0.0.1 / private $default_separator = ' - '; /* * Cached site name. * * @var string\|null * @since 0.0.1 / private $site_name = null; /* * Constructor * * @since 0.0.1 / public function __construct() { // Bail early if automatic titles are disabled. if ( apply_filters( 'surerank_disable_automatic_titles', false ) ) { return; } add_filter( 'surerank_set_meta', [ $this, 'get_meta_data' ], 10, 1 ); add_filter( 'pre_get_document_title', [ $this, 'replace_title' ], 20, 1 ); add_filter( 'wp_title', [ $this, 'replace_title' ], 20, 1 ); } /* * Store meta data. * * @param array<string, mixed> $meta_data Meta data to store. * @return array<string, mixed> Modified meta data. * @since 0.0.1 / public function get_meta_data( $meta_data ) { $this->meta_data = $meta_data; return $meta_data; // Return to maintain filter chain. } /* * Replace title based on request type. * * @param string $title Original title. * @return string Modified title. * @since 0.0.1 / public function replace_title( $title ) { $meta_title = $this->meta_data['page_title'] ?? $title; if ( is_post_type_archive() ) { $title = $this->post_type_archive_title( $meta_title ); } elseif ( is_archive() ) { $title = $this->archive_title( $meta_title ); } elseif ( is_search() ) { $title = $this->search_title( $meta_title ); } elseif ( is_404() ) { $title = $this->not_found_title( $meta_title ); } elseif ( is_singular() \|\| is_home() \|\| is_front_page() ) { $title = $meta_title; $title = $this->add_pagination_title( $title ); } // Apply global title filter. return apply_filters( 'surerank_final_title', $title, $meta_title ); } /* * Generate post type archive title. * * @param string $title Original title. * @return string Modified title. * @since 0.0.1 / public function post_type_archive_title( $title ) { if ( function_exists( 'is_shop' ) && is_shop() ) { $title = get_the_title( get_option( 'woocommerce_shop_page_id', '' ) ); } else { $object = get_queried_object(); $title = $object && isset( $object->label ) ? __( 'Archives: ', 'surerank' ) . $object->label : $title; } $title = $this->add_pagination_title( $title ); $title = $this->add_site_name( $title ); return apply_filters( 'surerank_post_type_archive_title', $title ); } /* * Generate archive title. * * @param string $title Original title. * @return string Modified title. * @since 0.0.1 / public function archive_title( $title ) { if ( is_category() ) { $title = __( 'Category: ', 'surerank' ) . $title; } elseif ( is_tag() ) { $title = __( 'Tag: ', 'surerank' ) . $title; } elseif ( is_author() ) { if ( empty( $title ) ) { // Use default format. $title = __( 'Author: ', 'surerank' ) . get_the_author(); } if ( empty( $this->meta_data['page_title'] ) ) { $title = $this->add_site_name( $title ); } } elseif ( is_date() ) { if ( empty( $title ) ) { // Use default format. if ( is_day() ) { $title = __( 'Day Archives: ', 'surerank' ) . get_the_date(); } elseif ( is_month() ) { $title = __( 'Month Archives: ', 'surerank' ) . get_the_date( 'F Y' ); } elseif ( is_year() ) { $title = __( 'Year Archives: ', 'surerank' ) . get_the_date( 'Y' ); } } if ( empty( $this->meta_data['page_title'] ) ) { $title = $this->add_site_name( $title ); } } elseif ( is_tax() ) { $term = \get_queried_object(); if ( $term instanceof WP_Term ) { $title = $this->get_taxonomy_title( $term ); } $title = $this->add_site_name( $title ); } return apply_filters( 'surerank_archive_title', $title ); } /* * Generate search title. * * @param string $title Original title. * @return string Modified title. * @since 0.0.1 / public function search_title( $title ) { $search_query = get_search_query(); / translators: %s: Search query / $title = sprintf( __( 'Search Results for: %s', 'surerank' ), $search_query ? $search_query : __( 'No query', 'surerank' ) ); $title = $this->add_pagination_title( $title ); $title = $this->add_site_name( $title ); return apply_filters( 'surerank_search_title', $title, $search_query ); } /* * Generate 404 title. * * @param string $title Original title. * @return string Modified title. * @since 0.0.1 / public function not_found_title( $title ) { $title = __( '404: Page not found', 'surerank' ); $title = $this->add_site_name( $title ); return apply_filters( 'surerank_not_found_title', $title ); } /* * Add site name to title. * * @param string $title Original title. * @return string Modified title. * @since 0.0.1 / public function add_site_name( $title ) { if ( empty( $title ) \|\| ! apply_filters( 'surerank_show_site_name', true ) ) { return $title; } if ( $this->site_name === null ) { $this->site_name = get_bloginfo( 'name', 'display' ); } $separator = apply_filters( 'surerank_title_separator', $this->default_separator ); return $title . $separator . $this->site_name; } /* * Add pagination to title. * * @param string $title Original title. * @return string Modified title. * @since 0.0.1 / public function add_pagination_title( $title ) { if ( empty( $title ) \|\| ! apply_filters( 'surerank_show_pagination', true ) \|\| ! is_paged() ) { return $title; } $paged_info = Helper::get_paged_info(); return $title . $paged_info; } /* * Get taxonomy title. * * @param WP_Term $term Term object. * @return string Taxonomy title. * @since 0.0.1 */ public function get_taxonomy_title( $term ) { $taxonomy = get_taxonomy( $term->taxonomy ); $tax_label = $taxonomy->label ?? ''; $term_title = $term->name; return $tax_label . ': ' . $term_title; } }	6.38 KB	2025-10-27 18:36
📄 twitter.php <?php /** * Common Meta Data * * This file will handle functionality to print Twitter meta_data in the frontend for different requests. * * @package surerank * @since 0.0.1 / namespace SureRank\Inc\Frontend; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } use SureRank\Inc\Functions\Helper; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Functions\Validate; use SureRank\Inc\Traits\Get_Instance; /* * Twitter SEO * This class will handle functionality to print meta_data in the frontend for Twitter. * * @since 1.0.0 / class Twitter { use Get_Instance; /* * Constructor * * @since 1.0.0 / public function __construct() { add_action( 'surerank_print_meta', [ $this, 'twitter_meta' ], 1, 1 ); } /* * Prepare and add Twitter meta data. * * @param array<string, mixed> $meta_data Twitter meta data array. * @since 1.0.0 * @return void / public function twitter_meta( $meta_data ) { if ( apply_filters( 'surerank_disable_twitter_tags', false ) ) { return; } if ( is_home() && is_front_page() ) { $same_as_facebook = null !== Settings::get( 'twitter_same_as_facebook' ) ? Settings::get( 'twitter_same_as_facebook' ) : false; } else { $same_as_facebook = $meta_data['twitter_same_as_facebook'] ?? false; } // Prepare fallback image if not available. $image = Image::get_instance(); $image->get( $meta_data, 'twitter_image_url' ); // Add Twitter-specific meta tags. $this->add_common_tags( $meta_data, $same_as_facebook ); } /* * Add common Twitter tags. * * @param array<string, mixed> $meta_data Meta Data. * @param bool $same_as_facebook Whether to use Facebook meta as fallback. * @since 1.0.0 * @return void / private function add_common_tags( $meta_data, $same_as_facebook ) { $common_tags = [ 'twitter:card' => Settings::get( 'twitter_card_type' ), 'twitter:site' => $this->get_formatted_twitter_site(), 'twitter:title' => $this->get_twitter_value( $meta_data, $same_as_facebook, 'facebook_title', 'twitter_title', 'page_title' ), 'twitter:description' => $this->get_twitter_value( $meta_data, $same_as_facebook, 'facebook_description', 'twitter_description', 'page_description' ), 'twitter:image' => $this->get_twitter_value( $meta_data, $same_as_facebook, 'facebook_image_url', 'twitter_image_url', 'fallback_image' ), 'twitter:creator' => $this->get_formatted_twitter_creator(), ]; foreach ( $common_tags as $key => $value ) { if ( Validate::not_empty( $value ) ) { Meta_Data::get_instance()->meta_html_template( $key, $value, 'name' ); } } if ( Helper::wc_status() && Helper::is_product() ) { $this->add_product_tags( $meta_data ); } } /* * Get Twitter meta value with Facebook fallback logic. * * @param array<string, mixed> $meta_data Meta data array. * @param bool $same_as_facebook Whether to use Facebook meta as fallback. * @param string $facebook_key Facebook meta key. * @param string $twitter_key Twitter meta key. * @param string\|null $fallback_key Optional fallback key. * @since 1.0.0 * @return string / private function get_twitter_value( $meta_data, $same_as_facebook, $facebook_key, $twitter_key, $fallback_key = null ) { if ( $same_as_facebook ) { if ( isset( $meta_data[ $facebook_key ] ) && ! empty( $meta_data[ $facebook_key ] ) ) { return $meta_data[ $facebook_key ]; } if ( $fallback_key && isset( $meta_data[ $fallback_key ] ) ) { return $meta_data[ $fallback_key ]; } } return $meta_data[ $twitter_key ] ?? ''; } /* * Get formatted Twitter creator. * * @since 1.0.0 * @return string / private function get_formatted_twitter_creator() { $twitter_creator = Settings::get( 'twitter_profile_fallback' ); if ( empty( $twitter_creator ) ) { return ''; } $twitter_creator = explode( '/', $twitter_creator ); $twitter_creator = end( $twitter_creator ); return '@' . $twitter_creator; } /* * Get formatted Twitter site. * * @since 1.0.0 * @return string / private function get_formatted_twitter_site() { $twitter_site = Settings::get( 'twitter_profile_username' ); $twitter_site = explode( '/', $twitter_site ); $twitter_site = end( $twitter_site ); if ( empty( $twitter_site ) ) { return ''; } return '@' . $twitter_site; } /* * Add product-specific Twitter tags. * * @param array<string, mixed> $meta_data Meta Data. * @since 1.0.0 * @return void */ private function add_product_tags( $meta_data ) { $price = $meta_data['product_price'] ? $meta_data['product_currency'] . ' ' . $meta_data['product_price'] : ''; $product_tags = [ 'twitter:label1' => 'Price', 'twitter:data1' => $price, 'twitter:label2' => 'Availability', 'twitter:data2' => 'instock' === $meta_data['product_availability'] ? esc_html__( 'In Stock', 'surerank' ) : esc_html__( 'Out of Stock', 'surerank' ), ]; foreach ( $product_tags as $key => $value ) { if ( Validate::not_empty( $value ) ) { Meta_Data::get_instance()->meta_html_template( $key, $value, 'name' ); } } } }	5.1 KB	2025-10-27 18:36

Edit File:

Terminal