Wala shell

Advanced PHP File Manager

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

Name	Size	Last Modified	Actions
📁 ..	-	2025-10-27 18:36
📄 base.php <?php /** * Base Schema Type * * This file provides a base class for schema types. * * @package SureRank * @since 1.0.0 / namespace SureRank\Inc\Schema; /* * Base Schema Type * * Provides a base class for defining schema types. * Child classes must implement the `get` and `schema_data` methods. * * @package SureRank * @since 1.0.0 / abstract class Base { /* * Get schema variables. * * This method should be implemented by child classes to define schema fields. * * @return array<int, array<string, mixed>> / abstract public function get(); /* * Get schema data. * * @return array<string, mixed> * @since 1.0.0 / abstract public function schema_data(); /* * Render schema data with dynamic content * * @param array<string, mixed> $schema Schema configuration. * @param Render $renderer Variable renderer instance. * @return array<string, mixed> Rendered schema data. * @since 1.2.0 / public function render_schema( $schema, $renderer ) { $fields = Data::get_schema_type( $schema ); $type = $schema['fields']['@type'] ?? $schema['type'] ?? 'Thing'; $schema_render = new Schema_Render( $type, $fields, $renderer ); return $schema_render->render(); } /* * Get schema type options. * * @return array<string, mixed> / public function get_schema_type_options() { return []; } /* * Add a helper property to the schema. * * @param string $id The property ID. * @param array<string, mixed> $args Arguments for the property. * * @return array<string, mixed> / protected function add_helper_property( $id, $args = [] ) { return Helper::get_instance()->get_property( $id, $args ); } /* * Parse Schema Fields * * Parses schema fields recursively to include only required data. * * @param array<int, array<string, mixed>> $fields Schema fields. * @return array<string, mixed> Parsed fields. / protected function parse_fields( $fields ) { $parsed = []; foreach ( $fields as $field ) { if ( empty( $field['id'] ) \|\| ( empty( $field['required'] ) && empty( $field['show'] ) ) ) { continue; } $type = $field['type'] ?? 'Text'; $value = 'Group' === $type ? $this->parse_group( $field ) : ( $field['std'] ?? '' ); $parsed[ $field['id'] ] = $value; } return $parsed; } /* * Parse Group Fields * * Parses group fields recursively. * * @param array<string, mixed> $field Group field data. * @return array<string, mixed>\|array<int, array<string, mixed>> Parsed group fields. */ protected function parse_group( $field ) { $group_fields = $this->parse_fields( $field['fields'] ); if ( 1 === count( $group_fields ) && isset( $group_fields['@type'] ) ) { // Yoda condition. return []; } if ( ! empty( $field['cloneable'] ) ) { return [ $group_fields ]; } return $group_fields; } }	2.86 KB	2025-10-27 18:36
📄 data.php <?php /** * Data Class * * Responsible for collecting and processing data for schemas. * * @since 1.0.0 * @package SureRank / namespace SureRank\Inc\Schema; use SureRank\Inc\Frontend\Breadcrumbs; use SureRank\Inc\Frontend\Description; use SureRank\Inc\Traits\Get_Instance; use WP_Post; use WP_Term; use WP_User; /* * Data Class * * Responsible for collecting and processing data for schemas. * * @since 1.0.0 / class Data { use Get_Instance; /* * Holds the collected schema data. * * @var array<string, mixed> / private $data = []; /* * Holds the queried object. * * @var mixed / private $queried_object = null; /* * Collects all data for schema rendering. * * @return array<string, mixed>Collected schema data. / public function collect() { $this->data = [ 'post' => $this->get_post_data(), 'term' => $this->get_term_data(), 'author' => $this->get_author_data(), 'user' => $this->get_user_data(), 'site' => $this->get_site_data(), 'current' => $this->get_current_data(), 'schemas' => $this->get_schema_links(), ]; $this->data = apply_filters( 'surerank_schema_data', $this->data ); // Normalize post content and calculate word count. if ( isset( $this->data['post']['content'] ) ) { $post_content = esc_html( (string) $this->data['post']['content'] ); $this->data['post']['content'] = $post_content; $this->data['post']['word_count'] = str_word_count( $post_content ); } return $this->data; } /* * Retrieves schema links. * * @return array<string, mixed>The schema links data. / public function get_schema_links() { $schemas = Schemas::get_instance()->get_active_schemas(); $data = []; return $this->get_schema_links_data( $schemas ); } /* * Retrieves schema links data. * * @param array<string, mixed> $schemas The schema data. * @return array<string, mixed>The schema links data. / public function get_schema_links_data( array $schemas ) { $data = []; foreach ( $schemas as $schema ) { $id = $this->get_id( $schema ); if ( $this->add_breadcrumb( $schema ) ) { continue; } $data[ $id ] = [ '@id' => $this->get_id_value( $schema ), ]; } return $data; } /* * Adds a breadcrumb to a schema. * * @param array<string, mixed> $schema The schema data. * @return bool True if the breadcrumb should be added, false otherwise. / public function add_breadcrumb( array $schema ): bool { $rules = $schema['not_show_on']['rules'] ?? []; if ( is_front_page() && in_array( 'special-front', $rules ) && 'BreadcrumbList' === $schema['type'] ) { return true; } return false; } /* * Retrieves the ID for a schema. * * @param array<string, mixed> $schema The schema array. * @return string The sanitized schema ID. / public function get_id( array $schema ): string { $label = $this->get( $schema, 'fields._label', $schema['type'] ); return $this->sanitize_id( $label ); } /* * Retrieves the ID value for a schema. * * @param array<string, mixed> $schema The schema array. * @return string The ID value. / public function get_id_value( array $schema ): string { $id = $this->get( $schema, 'fields.@id', '%current.url%#%id%' ); return str_replace( '%id%', $this->get_id( $schema ), $id ); } /* * Retrieves a value from an array using dot notation. * * @param array<string, mixed> $array The array to search. * @param string $key The dot-notated key. * @param mixed $default The default value if the key is not found. * @return mixed The value from the array or the default value. / public function get( $array, $key, $default = null ) { if ( ! $key ) { return $array; } $keys = explode( '.', $key ); foreach ( $keys as $key ) { if ( isset( $array[ $key ] ) ) { $array = $array[ $key ]; } else { return $default; } } return $array; } /* * Retrieves the schema data. * * @param array<string, mixed> $schema The schema data. * @return array<string, mixed>The schema data. / public static function get_schema_type( $schema ) { $fields = $schema['fields'] ?? []; $label = self::get_instance()->get_id( $schema ); if ( isset( $fields['@id'] ) ) { $fields['@id'] = str_replace( '%id%', $label, $fields['@id'] ); } return $fields; } /* * Retrieves the queried object and caches it. * * @return mixed The queried object. / private function get_queried_object() { if ( null === $this->queried_object ) { $this->queried_object = \get_queried_object(); } return $this->queried_object; } /* * Retrieves post data. * * @return array<string, mixed>The post data. / private function get_post_data() { $post = $this->get_queried_object(); if ( ! $post instanceof WP_Post ) { return []; } if ( ! $post->ID ) { return []; } $taxonomies = Helper::get_instance()->get_taxonomies(); $taxonomies_data = []; foreach ( $taxonomies as $taxonomy ) { $taxonomies_data[ $taxonomy['slug'] ] = $this->get_terms( $post->ID, $taxonomy['slug'] ); } return [ 'ID' => (int) $post->ID, 'title' => sanitize_text_field( $post->post_title ), 'excerpt' => Description::get_instance()->post( $post->ID ), 'content' => sanitize_text_field( $post->post_content ), 'url' => get_permalink( $post ), 'slug' => sanitize_title( $post->post_name ), 'date' => get_the_date( 'c', $post ), 'modified_date' => get_the_modified_date( 'c', $post ), 'created_date' => get_the_date( 'c', $post ), 'thumbnail' => get_the_post_thumbnail_url( $post->ID, 'full' ), 'comment_count' => (int) $post->comment_count, 'tags' => sanitize_text_field( $this->get_terms( $post->ID, 'post_tag' ) ), 'categories' => sanitize_text_field( $this->get_terms( $post->ID, 'category' ) ), 'custom_field' => array_map( 'sanitize_text_field', $this->get_custom_field_data( $post->ID ) ), 'taxonomies' => array_map( 'sanitize_text_field', $this->get_taxonomies_for_post( $post->ID ) ), 'tax' => $taxonomies_data, ]; } /* * Retrieves term data. * * @return array<string, mixed>The term data. / private function get_term_data() { $term = $this->get_queried_object(); if ( ! $term instanceof WP_Term ) { return []; } if ( ! $term->term_id ) { return []; } return [ 'ID' => (int) $term->term_id, 'name' => sanitize_text_field( $term->name ), 'slug' => sanitize_title( $term->slug ), 'taxonomy' => sanitize_text_field( $term->taxonomy ), 'description' => Description::get_instance()->taxonomy( $term->term_id ), 'url' => get_term_link( $term->term_id ), ]; } /* * Retrieves author data for the current post. * * @return array<string, mixed>The author data. / private function get_author_data() { $post_id = get_the_ID(); if ( ! $post_id ) { return []; } $author_id = (int) get_post_field( 'post_author', $post_id ); return $this->get_user( $author_id ); } /* * Retrieves current user data. * * @return array<string, mixed>The current user data. / private function get_user_data() { return $this->get_user( get_current_user_id() ); } /* * Retrieves user data by ID. * * @param int $user_id The user ID. * @return array<string, mixed>The user data. / private function get_user( int $user_id ) { $user = get_userdata( $user_id ); if ( ! $user instanceof WP_User ) { return []; } return [ 'ID' => (int) $user->ID, 'first_name' => sanitize_text_field( $user->first_name ), 'last_name' => sanitize_text_field( $user->last_name ), 'username' => sanitize_text_field( $user->user_login ), 'display_name' => sanitize_text_field( $user->display_name ), 'nickname' => sanitize_text_field( $user->nickname ), 'email' => sanitize_email( $user->user_email ), 'website_url' => esc_url( $user->user_url ), 'nicename' => sanitize_title( $user->user_nicename ), 'description' => esc_html( $user->description ), 'posts_url' => get_author_posts_url( $user->ID ), 'avatar' => get_avatar_url( $user->ID ), ]; } /* * Retrieves site data. * * @return array<string, mixed>The site data. / private function get_site_data() { return [ 'title' => get_bloginfo( 'name' ), 'description' => get_bloginfo( 'description' ), 'url' => home_url( '/' ), 'language' => get_locale(), 'icon' => get_site_icon_url(), ]; } /* * Retrieves current page data. * * @return array<string, mixed>The current page data. / private function get_current_data() { global $wp; $bread = Breadcrumbs::get_instance()->get_crumbs(); $breadcrumbs = []; foreach ( $bread as $index => $crumb ) { $breadcrumbs[] = [ '@type' => 'ListItem', 'position' => $index + 1, 'item' => [ '@id' => $crumb['link'], 'name' => $crumb['name'], ], ]; } return [ 'url' => home_url( $wp->request ), 'breadcrumbs' => $breadcrumbs, 'title' => $this->get_title(), ]; } /* * Retrieves the title. * * @return string The title. / private function get_title(): string { $post = ! is_singular() ? $this->get_queried_object() : get_post(); if ( $post instanceof WP_Post ) { return $post->post_title; } if ( $post instanceof WP_Term ) { return $post->name; } if ( $post instanceof WP_User ) { return $post->display_name; } return get_the_title(); } /* * Retrieves terms for a post by taxonomy. * * @param int $post_id The post ID. * @param string $taxonomy The taxonomy slug. * @return string The terms as a comma-separated string. / private function get_terms( int $post_id, string $taxonomy ): string { $terms = get_the_terms( $post_id, $taxonomy ); return is_array( $terms ) ? implode( ', ', wp_list_pluck( $terms, 'name' ) ) : ''; } /* * Retrieves taxonomies for a post. * * @param int $post_id The post ID. * @return array<string, mixed>The taxonomies data. / private function get_taxonomies_for_post( int $post_id ) { $taxonomies = get_object_taxonomies( 'post', 'objects' ); $data = []; foreach ( $taxonomies as $taxonomy ) { $terms = get_the_terms( $post_id, $taxonomy->name ); if ( $terms && ! is_wp_error( $terms ) ) { $data[ $taxonomy->name ] = wp_list_pluck( $terms, 'name' ); } } return $data; } /* * Retrieves custom field data for a post. * * @param int $post_id The post ID. * @return array<string, mixed>The custom field data. / private function get_custom_field_data( int $post_id ) { $meta_values = get_post_meta( $post_id ); if ( empty( $meta_values ) \|\| ! is_array( $meta_values ) ) { return []; } // Filter out meta values that are not arrays or are empty. return array_map( static function ( $value ) { return reset( $value ); }, $meta_values ); } /* * Sanitizes a string for use as an ID. * * @param string $text The input text. * @return string The sanitized ID. */ private function sanitize_id( $text ) { if ( ! $text \|\| ! is_string( $text ) ) { return ''; } $id = sanitize_title( $text ); $id = preg_replace( '/[^a-z0-9_]/', '_', (string) $id ); // Only accepts alphanumeric and underscores. $id = preg_replace( '/[ _]{2,}/', '_', (string) $id ); // Remove duplicated `_`. $id = trim( (string) $id, '_' ); // Trim `_`. $id = preg_replace( '/^\d+/', '', (string) $id ); // Don't start with numbers. $id = trim( (string) $id, '_' ); // Trim `_` again. return esc_attr( $id ); } }	11.6 KB	2025-10-27 18:36
📄 helper.php <?php /** * Helper * * This file will handle functionality for all Helper. * * @package surerank * @since 1.0.0 / namespace SureRank\Inc\Schema; use SureRank\Inc\Traits\Get_Instance; /* * Helper * This class will handle functionality for all Helper. * * @since 1.0.0 / class Helper { use Get_Instance; public const UNSUPPORTED_TAXONOMIES = [ 'wp_theme', 'wp_template_part_area', 'link_category', 'nav_menu', 'post_format', 'mb-views-category', ]; /* * Constructor * * @since 1.0.0 / public function __construct() { } /* * Get Taxonomies * * @param array<string, mixed> $args Arguments. * @return array<string, mixed>\|array<int, array<string, string>> * @since 1.0.0 / public function get_taxonomies( $args = [] ) { $unsupported = self::UNSUPPORTED_TAXONOMIES; $taxonomies = get_taxonomies( $args, 'objects' ); if ( empty( $taxonomies ) ) { return []; } $taxonomies = array_diff_key( $taxonomies, array_flip( $unsupported ) ); $taxonomies = array_map( static function( $taxonomy ) { return [ 'slug' => esc_attr( $taxonomy->name ), 'name' => esc_html( $taxonomy->label ), ]; }, $taxonomies ); return array_values( $taxonomies ); } /* * Normalize * * @param string $key key. * @return string * @since 1.0.0 / public function normalize( $key ) { return str_replace( '-', '_', $key ); } /* * Get property * * Retrieves a specific property based on the provided name and arguments. * * @param string $name The name of the property to retrieve. * @param array<string, mixed> $args Optional. Additional arguments to customize the property retrieval. Default is an empty array. * @return array<string, mixed> The retrieved property. * @since 1.0.0 */ public function get_property( $name, $args = [] ) { $properties = []; $properties['type'] = [ 'id' => '@type', 'type' => 'Hidden', 'required' => true, ]; $properties['image'] = [ 'id' => 'image', 'label' => __( 'Image', 'surerank' ), 'std' => [ '%post.thumbnail%' ], 'type' => 'Image', 'cloneable' => true, ]; $properties['product_image'] = [ 'id' => 'image', 'label' => __( 'Product Image', 'surerank' ), 'std' => [ '%product.image%' ], 'type' => 'Image', 'cloneable' => true, ]; $properties['name'] = [ 'label' => __( 'Name', 'surerank' ), 'id' => 'name', 'std' => '%post.title%', ]; $properties['Answer'] = [ 'type' => 'Group', 'fields' => [ [ 'id' => '@type', 'std' => 'Answer', 'type' => 'Hidden', 'required' => true, ], [ 'id' => 'text', 'label' => __( 'Text', 'surerank' ), 'type' => 'Textarea', 'tooltip' => __( 'The full instruction text of this step', 'surerank' ), 'required' => true, ], [ 'id' => 'upvoteCount', 'label' => __( 'Upvote count', 'surerank' ), 'tooltip' => __( 'The total number of votes that this question has received. If the page supports upvotes and downvotes, then set the upvoteCount value to a single aggregate value that represents both upvotes and downvotes.', 'surerank' ), ], [ 'id' => 'url', 'label' => __( 'URL', 'surerank' ), 'tooltip' => __( 'A URL that links directly to this answer.', 'surerank' ), ], ], ]; $properties['dateCreated'] = [ 'id' => 'dateCreated', 'label' => __( 'Created date', 'surerank' ), 'type' => 'Date', ]; $properties['datePublished'] = [ 'id' => 'datePublished', 'label' => __( 'Published date', 'surerank' ), 'type' => 'Date', ]; $properties['dateModified'] = [ 'id' => 'dateModified', 'label' => __( 'Modified date', 'surerank' ), 'type' => 'Date', ]; $properties['description'] = [ 'id' => 'description', 'label' => __( 'Description', 'surerank' ), 'type' => 'Textarea', 'std' => '%post.excerpt%', 'show' => true, ]; $properties['url'] = [ 'id' => 'url', 'label' => __( 'URL', 'surerank' ), ]; $properties['aggregateRating'] = [ 'id' => 'aggregateRating', 'label' => __( 'Aggregate rating', 'surerank' ), 'type' => 'Group', 'propertyType' => 'AggregateRating', 'tooltip' => __( 'Include an overall rating based on customer reviews. This rating is used in structured data to reflect the product’s average performance or satisfaction level.', 'surerank' ), 'fields' => [ [ 'id' => 'ratingValue', 'label' => __( 'Value', 'surerank' ), 'std' => '%product.rating%', 'tooltip' => __( 'Specify the actual score given to the product, such as ‘4’, ‘60%’, or ‘6/10’. This numeric value contributes to the aggregate rating in structured data.', 'surerank' ), 'required' => true, ], [ 'id' => 'reviewCount', 'label' => __( 'Review count', 'surerank' ), 'std' => '%product.review_count%', 'tooltip' => __( 'Enter the total number of reviews the product has received. This helps search engines understand the product’s popularity and display review count in rich results.', 'surerank' ), 'required' => true, ], ], ]; // https://schema.org/VideoObject. $properties['VideoObject'] = [ 'id' => 'video', 'label' => __( 'Video', 'surerank' ), 'type' => 'Group', 'fields' => [ [ 'id' => '@type', 'std' => 'VideoObject', 'type' => 'Hidden', 'required' => true, ], [ 'label' => __( 'Name', 'surerank' ), 'id' => 'name', 'std' => '%post.title%', 'required' => true, ], [ 'id' => 'description', 'label' => __( 'Description', 'surerank' ), 'type' => 'Textarea', 'std' => '%post.content%', 'required' => true, ], [ 'id' => 'thumbnailUrl', 'label' => __( 'Thumbnail URL', 'surerank' ), 'tooltip' => __( 'A URL pointing to the video thumbnail image file', 'surerank' ), 'std' => '%post.thumbnail%', 'required' => true, ], [ 'id' => 'uploadDate', 'label' => __( 'Upload Date', 'surerank' ), 'tooltip' => __( 'The date the video was first published, in ISO 8601 format.', 'surerank' ), 'type' => 'Date', 'std' => '%post.date%', 'required' => true, ], [ 'id' => 'contentURL', 'label' => __( 'Content URL', 'surerank' ), 'tooltip' => __( 'A URL pointing to the actual video media file', 'surerank' ), 'show' => true, ], [ 'id' => 'embedURL', 'label' => __( 'Embed URL', 'surerank' ), 'tooltip' => __( 'A URL pointing to a player for the specific video. Don\'t link to the page where the video lives; this must be the URL of the video player itself. Usually this is the information in the src element of an <embed> tag.', 'surerank' ), ], [ 'id' => 'duration', 'label' => __( 'Duration (min)', 'surerank' ), 'tooltip' => __( 'The duration of the video in ISO 8601 format. For example, PT00H30M5S represents a duration of "thirty minutes and five seconds".', 'surerank' ), ], [ 'id' => 'expires', 'label' => __( 'Expires', 'surerank' ), 'tooltip' => __( 'If applicable, the date after which the video will no longer be available, in ISO 8601 format. Don\'t supply this information if your video does not expire.', 'surerank' ), ], [ 'id' => 'hasPart', 'label' => __( 'Has part', 'surerank' ), 'tooltip' => __( 'If your video has important segments, specify them here', 'surerank' ), 'type' => 'Group', 'cloneable' => true, 'cloneItemHeading' => __( 'Part', 'surerank' ), 'fields' => [ [ 'id' => '@type', 'std' => 'Clip', 'type' => 'Hidden', 'required' => true, ], [ 'label' => __( 'Name', 'surerank' ), 'id' => 'name', 'show' => true, ], [ 'id' => 'startOffset', 'label' => __( 'Start offset', 'surerank' ), 'show' => true, ], [ 'label' => __( 'URL', 'surerank' ), 'id' => 'url', 'show' => true, ], ], ], [ 'id' => 'interactionStatistic', 'type' => 'Group', 'fields' => [ [ 'id' => '@type', 'type' => 'Hidden', 'std' => 'InteractionCounter', 'required' => true, ], [ 'id' => 'interactionType', 'type' => 'Group', 'required' => true, 'fields' => [ [ 'id' => '@type', 'type' => 'Hidden', 'std' => 'WatchAction', 'required' => true, ], ], ], [ 'id' => 'userInteractionCount', 'label' => __( 'Interaction statistic', 'surerank' ), 'tooltip' => __( 'The number of times the video has been watched', 'surerank' ), 'required' => true, ], ], ], ], ]; $properties['address'] = [ 'id' => 'address', 'label' => __( 'Address', 'surerank' ), 'type' => 'Group', 'fields' => [ [ 'id' => '@type', 'std' => 'PostalAddress', 'type' => 'Hidden', 'show' => true, ], [ 'id' => 'streetAddress', 'label' => __( 'Street address', 'surerank' ), 'tooltip' => __( 'The detailed street address.', 'surerank' ), 'show' => true, ], [ 'id' => 'addressLocality', 'label' => __( 'Locality', 'surerank' ), 'tooltip' => __( 'The locality in which the street address is, and which is in the region.', 'surerank' ), 'show' => true, ], [ 'id' => 'addressRegion', 'label' => __( 'Region', 'surerank' ), 'tooltip' => __( 'The region in which the locality is, and which is in the country.', 'surerank' ), 'show' => true, ], [ 'id' => 'addressCountry', 'label' => __( 'Country', 'surerank' ), 'tooltip' => __( 'The country. You can also provide the two-letter ISO 3166-1 alpha-2 country code.', 'surerank' ), 'std' => 'US', 'show' => true, ], [ 'id' => 'postalCode', 'label' => __( 'Postal code', 'surerank' ), 'show' => true, ], ], ]; // https://schema.org/Person. $properties['Person'] = [ 'type' => 'Group', 'fields' => [ [ 'id' => '@type', 'std' => 'Person', 'type' => 'Hidden', 'required' => true, ], [ 'id' => 'name', 'required' => true, 'std' => '%author.display_name%', ], ], ]; // https://schema.org/OpeningHoursSpecification. $properties['OpeningHoursSpecification'] = [ 'type' => 'Group', 'cloneable' => true, 'fields' => [ [ 'id' => 'dayOfWeek', 'label' => __( 'Day of week', 'surerank' ), 'tooltip' => __( 'The day of the week for which these opening hours are valid', 'surerank' ), 'show' => true, 'type' => 'Select', 'options' => [ 'https://schema.org/Monday' => __( 'Monday', 'surerank' ), 'https://schema.org/Tuesday' => __( 'Tuesday', 'surerank' ), 'https://schema.org/Wednesday' => __( 'Wednesday', 'surerank' ), 'https://schema.org/Thursday' => __( 'Thursday', 'surerank' ), 'https://schema.org/Friday' => __( 'Friday', 'surerank' ), 'https://schema.org/Saturday' => __( 'Saturday', 'surerank' ), 'https://schema.org/Sunday' => __( 'Sunday', 'surerank' ), ], ], [ 'id' => 'opens', 'label' => __( 'Opens', 'surerank' ), 'tooltip' => __( 'The opening hour of the place or service on the given day(s) of the week, in hh:mm:ss format', 'surerank' ), 'show' => true, ], [ 'id' => 'closes', 'label' => __( 'Closes', 'surerank' ), 'tooltip' => __( 'The closing hour of the place or service on the given day(s) of the week, in hh:mm:ss format', 'surerank' ), 'show' => true, ], [ 'id' => 'validFrom', 'label' => __( 'Valid from', 'surerank' ), 'tooltip' => __( 'The date when the item becomes valid, in YYYY-MM-DD format', 'surerank' ), ], [ 'id' => 'validThrough', 'label' => __( 'Valid through', 'surerank' ), 'tooltip' => __( 'The date after when the item is not valid, in YYYY-MM-DD format', 'surerank' ), ], ], ]; // https://schema.org/Review. $properties['Review'] = [ 'id' => 'review', 'type' => 'Group', 'label' => __( 'Reviews', 'surerank' ), 'cloneable' => true, 'cloneItemHeading' => __( 'Review', 'surerank' ), 'tooltip' => __( 'Reviews of the item', 'surerank' ), 'fields' => [ [ 'id' => '@type', 'std' => 'Review', 'type' => 'Hidden', 'required' => true, ], [ 'id' => 'author', 'type' => 'Group', 'show' => true, 'fields' => [ [ 'id' => '@type', 'std' => 'Person', 'type' => 'Hidden', 'required' => true, ], [ 'id' => 'name', 'label' => __( 'Author', 'surerank' ), 'required' => true, 'std' => '%author.display_name%', ], ], ], [ 'id' => 'reviewRating', 'type' => 'Group', 'label' => __( 'Rating', 'surerank' ), 'show' => true, 'fields' => [ [ 'id' => '@type', 'std' => 'Rating', 'type' => 'Hidden', 'required' => true, ], [ 'id' => 'ratingValue', 'label' => __( 'Rating value', 'surerank' ), 'required' => true, 'type' => 'DataList', 'std' => '5', 'options' => [ 1 => 1, 2 => 2, 3 => 3, 4 => 4, 5 => 5, ], ], [ 'id' => 'bestRating', 'label' => __( 'Best rating', 'surerank' ), 'type' => 'DataList', 'std' => '5', 'options' => [ 1 => 1, 2 => 2, 3 => 3, 4 => 4, 5 => 5, ], ], [ 'id' => 'worstRating', 'label' => __( 'Worst rating', 'surerank' ), 'type' => 'DataList', 'std' => '1', 'options' => [ 1 => 1, 2 => 2, 3 => 3, 4 => 4, 5 => 5, ], ], ], ], [ 'id' => 'datePublished', 'label' => __( 'Date published', 'surerank' ), 'type' => 'Date', ], ], ]; $properties['duration'] = [ 'fields' => [ [ 'id' => '@type', 'std' => 'QuantitativeValue', 'type' => 'Hidden', 'required' => true, ], [ 'id' => 'value', 'label' => __( 'Value', 'surerank' ), 'show' => true, ], [ 'id' => 'minValue', 'label' => __( 'Min value', 'surerank' ), ], [ 'id' => 'maxValue', 'label' => __( 'Max value', 'surerank' ), ], [ 'id' => 'unitText', 'label' => __( 'Unit text', 'surerank' ), 'type' => 'Select', 'std' => 'MONTH', 'tooltip' => __( 'A string or text indicating the unit of measurement.', 'surerank' ), 'options' => [ 'HOUR' => __( 'Hour', 'surerank' ), 'DAY' => __( 'Day', 'surerank' ), 'WEEK' => __( 'Week', 'surerank' ), 'MONTH' => __( 'Month', 'surerank' ), 'YEAR' => __( 'Year', 'surerank' ), ], ], ], ]; $properties['QuantitativeValue'] = [ 'fields' => [ [ 'id' => '@type', 'std' => 'QuantitativeValue', 'type' => 'Hidden', 'required' => true, ], [ 'id' => 'value', 'label' => __( 'Value', 'surerank' ), 'show' => true, ], [ 'id' => 'minValue', 'label' => __( 'Min value', 'surerank' ), ], [ 'id' => 'maxValue', 'label' => __( 'Max value', 'surerank' ), ], [ 'id' => 'unitText', 'label' => __( 'Unit text', 'surerank' ), 'tooltip' => __( 'A string or text indicating the unit of measurement.', 'surerank' ), 'show' => true, ], ], ]; $properties['mainEntity'] = [ 'id' => 'mainEntity', 'label' => __( 'Main entity', 'surerank' ), 'tooltip' => __( 'Indicates the primary entity described in some page or other CreativeWork.', 'surerank' ), 'description' => __( 'Please create a schema and link to this property via a dynamic variable', 'surerank' ), ]; $properties['mainEntityOfPage'] = [ 'id' => 'mainEntityOfPage', 'label' => __( 'Main entity of page', 'surerank' ), 'tooltip' => __( 'Identify the main entity being described on the page, such as an article, product, or event. This helps search engines understand the primary focus of the page through structured data.', 'surerank' ), 'std' => '%schemas.webpage%', 'show' => true, ]; $property = $properties[ $name ] ?? []; return array_replace_recursive( $property, $args ); } }	17.06 KB	2025-10-27 18:36
📄 options.php <?php /** * Options * * This file will handle functionality for all Options. * * @package surerank * @since 1.0.0 / namespace SureRank\Inc\Schema; use SureRank\Inc\Traits\Get_Instance; /* * Options * This class will handle functionality for all Options. * * @since 1.0.0 / class Options { use Get_Instance; /* * Constructor * * @since 1.0.0 */ public function __construct() { } }	414 B	2025-10-27 18:36
📄 products.php <?php /** * Products * * This file handles functionality for all Products. * * @package SureRank * @since 1.0.0 / namespace SureRank\Inc\Schema; use SureRank\Inc\Functions\Helper; use SureRank\Inc\Schema\Types\Product; use SureRank\Inc\Traits\Get_Instance; /* * Products * This class handles functionality for all Products. * * @since 1.0.0 / class Products { use Get_Instance; /* * Constructor. / public function __construct() { if ( ! Helper::wc_status() && ! Helper::sc_status() ) { return; } $this->init(); } /* * Initialize the class functionality. * * @return void / public function init() { add_filter( 'surerank_schema_types', [ $this, 'add_product_schema_type' ] ); add_filter( 'surerank_default_schemas', [ $this, 'add_product_schema' ] ); add_filter( 'surerank_schema_data', [ $this, 'add_schema_data' ] ); add_action( 'wp_footer', [ $this, 'remove_wc_schema' ], 0 ); add_filter( 'surerank_default_schema_variables', [ $this, 'add_variables' ] ); add_filter( 'surerank_schema_type_data', [ $this, 'schema_type_data' ] ); } /* * Add Product schema type to available schema types. * * @param array<string, mixed> $schema_types Existing schema types. * @return array<string, mixed> Modified schema types. / public function add_product_schema_type( $schema_types ) { if ( Helper::wc_status() \|\| Helper::sc_status() ) { $schema_types['Product'] = Product::class; } return $schema_types; } /* * Add schema data for products. * * @param array<string, mixed> $data Existing schema data. * @return array<string, mixed> Modified schema data. / public function add_schema_data( $data ) { $post = is_singular() ? get_post( get_queried_object_id() ) : ''; if ( empty( $post ) ) { return $data; } $post_type = get_post_type( $post ); switch ( $post_type ) { case 'product': /* * Get product data from WooCommerce / $product = wc_get_product( $post->ID ) ?? ''; if ( empty( $product ) ) { return $data; } $product_data = $this->get_product_data( $product ); break; case 'sc_product': /* * Get product data from SureCart / $product = get_post_meta( $post->ID, 'product', true ) ?? ''; if ( empty( $product ) ) { return $data; } $product_data = $this->get_surecart_product_data( $product ); /* * Remove WooCommerce schema from SureCart product / add_filter( 'sc_display_product_json_ld_schema', '__return_false', 10 ); break; default: return $data; } // Merge product data into schema. $data['product'] = $product_data; return $data; } /* * Remove WooCommerce schema from footer. * * @return void / public function remove_wc_schema() { if ( ! Helper::wc_status() ) { return; } remove_action( 'wp_footer', [ WC()->structured_data, 'output_structured_data' ], 10 ); } /* * Add variables for product schema. * * @param array<string, mixed> $variables Existing variables. * @return array<string, mixed> Modified variables. / public function add_variables( $variables ) { $wc_variables = [ '%product.price%' => __( 'Product Price', 'surerank' ), '%product.price_with_tax%' => __( 'Product Price Including Tax', 'surerank' ), '%product.low_price%' => __( 'Product Low Price (variable product)', 'surerank' ), '%product.high_price%' => __( 'Product High Price (variable product)', 'surerank' ), '%product.offer_count%' => __( 'Product Offer Count (variable product)', 'surerank' ), '%product.sale_from%' => __( 'Product Sale Price Date "From"', 'surerank' ), '%product.sale_to%' => __( 'Product Sale Price Date "To"', 'surerank' ), '%product.sku%' => __( 'Product SKU', 'surerank' ), '%product.stock%' => __( 'Product Stock Status', 'surerank' ), '%product.currency%' => __( 'Product Currency', 'surerank' ), '%product.rating%' => __( 'Product Rating Value', 'surerank' ), '%product.review_count%' => __( 'Product Review Count', 'surerank' ), '%product.image%' => __( 'Product Image', 'surerank' ), '%product.image_width%' => __( 'Product Image Width', 'surerank' ), '%product.image_height%' => __( 'Product Image Height', 'surerank' ), '%product.description%' => __( 'Product Description', 'surerank' ), '%product.variant_sku%' => __( 'Product Variant SKU', 'surerank' ), '%product.variant_name%' => __( 'Product Variant Name', 'surerank' ), '%product.variant_url%' => __( 'Product Variant URL', 'surerank' ), '%product.variant_image%' => __( 'Product Variant Image', 'surerank' ), '%product.variant_size%' => __( 'Product Variant Size', 'surerank' ), '%product.variant_color%' => __( 'Product Variant Color', 'surerank' ), '%product.variant_description%' => __( 'Product Variant Description', 'surerank' ), '%product.variant_sale_price%' => __( 'Product Variant Sale Price', 'surerank' ), '%product.variant_regular_price%' => __( 'Product Variant Regular Price', 'surerank' ), '%product.variant_stock%' => __( 'Product Variant Stock Status', 'surerank' ), ]; return array_merge( $variables, $wc_variables ); } /* * Add product schema. * * @param array<string, mixed> $schemas Existing schemas. * @return array<string, mixed> Modified schemas. / public function add_product_schema( $schemas ) { if ( Helper::wc_status() ) { $rule = 'product\|all'; } elseif ( Helper::sc_status() ) { $rule = 'sc_product\|all'; } else { return $schemas; } $schemas['Product'] = [ 'title' => 'Product', 'type' => 'Product', 'show_on' => [ 'rules' => [ $rule, ], 'specific' => [], 'specificText' => [], ], 'fields' => Utils::parse_fields( Product::get_instance()->get() ), ]; return $schemas; } /* * Get schema type data. * * @param array<string, mixed> $data Existing schema type data. * @return array<string, mixed> Modified schema type data. / public function schema_type_data( $data ) { $data['Product'] = Product::get_instance()->get(); return $data; } /* * Get detailed product data for schema. * * @param \WC_Product $product WooCommerce product object. * @return array<string, mixed> Product data for schema. / private function get_product_data( $product ): array { $basic_data = $this->get_basic_product_data( $product ); $sale_dates = $this->calculate_sale_dates( $product ); $variation_data = $this->get_variation_data( $product ); $stock_data = $this->get_stock_data( $product ); $image_data = $this->get_product_image_dimensions( $product ); $product_data = array_merge( $basic_data, $sale_dates, $variation_data['pricing'], $stock_data, [ 'image' => $image_data['image'], 'image_width' => $image_data['image_width'], 'image_height' => $image_data['image_height'], 'description' => $product->get_description(), 'short_description' => $product->get_short_description(), ] ); return $this->merge_variant_data( $product_data, $variation_data['variant'] ); } /* * Get basic product data. * * @param \WC_Product $product WooCommerce product object. * @return array<string, mixed> Basic product data. / private function get_basic_product_data( \WC_Product $product ): array { $price = $product->get_price(); return [ 'price' => $price, 'price_with_tax' => wc_get_price_including_tax( $product, [ 'price' => $price ] ), 'sku' => $product->get_sku(), 'currency' => get_woocommerce_currency(), 'rating' => $product->get_average_rating(), 'review_count' => $product->get_review_count(), ]; } /* * Calculate sale dates for the product. * * @param \WC_Product $product WooCommerce product object. * @return array<string, string> Sale date information. / private function calculate_sale_dates( \WC_Product $product ): array { $sale_from = $this->get_sale_from_date( $product ); $sale_to = $this->get_sale_to_date( $product, $sale_from ); return [ 'sale_from' => $sale_from, 'sale_to' => $sale_to, ]; } /* * Get sale from date. * * @param \WC_Product $product WooCommerce product object. * @return string Sale from date. / private function get_sale_from_date( \WC_Product $product ): string { $date_on_sale_from = $product->get_date_on_sale_from(); return $date_on_sale_from ? gmdate( 'Y-m-d', $date_on_sale_from->getTimestamp() ) : ''; } /* * Get sale to date. * * @param \WC_Product $product WooCommerce product object. * @param string $sale_from Sale from date. * @return string Sale to date. / private function get_sale_to_date( \WC_Product $product, string $sale_from ): string { $today = gmdate( 'Y-m-d' ); if ( $product->is_on_sale() && $product->get_date_on_sale_to() ) { return gmdate( 'Y-m-d', $product->get_date_on_sale_to()->getTimestamp() ); } if ( $sale_from > $today ) { return gmdate( 'Y-m-d', wc_string_to_timestamp( $sale_from ) - DAY_IN_SECONDS ); } if ( $sale_from === $today ) { return $today; } return gmdate( 'Y-m-d', wc_string_to_timestamp( '+1 month' ) ); } /* * Get variation data for variable products. * * @param \WC_Product $product WooCommerce product object. * @return array{pricing: array<string, mixed>, variant: array<string, mixed>} Variation data. / private function get_variation_data( \WC_Product $product ): array { if ( ! $product->is_type( 'variable' ) \|\| ! $product instanceof \WC_Product_Variable ) { return [ 'pricing' => [ 'low_price' => '', 'high_price' => '', 'offer_count' => 0, ], 'variant' => [], ]; } return $this->process_variable_product( $product ); } /* * Process variable product data. * * @param \WC_Product_Variable $product Variable product. * @return array{pricing: array<string, mixed>, variant: array<string, mixed>} Processed data. / private function process_variable_product( \WC_Product_Variable $product ): array { $pricing_data = $this->get_variable_pricing_data( $product ); $variant_data = $this->get_default_variant_data( $product ); return [ 'pricing' => $pricing_data, 'variant' => $variant_data, ]; } /* * Get variable product pricing data. * * @param \WC_Product_Variable $product Variable product. * @return array<string, mixed> Pricing data. / private function get_variable_pricing_data( \WC_Product_Variable $product ): array { return [ 'low_price' => wc_get_price_including_tax( $product, [ 'price' => $product->get_variation_price( 'min', false ) ] ), 'high_price' => wc_get_price_including_tax( $product, [ 'price' => $product->get_variation_price( 'max', false ) ] ), 'offer_count' => count( $product->get_children() ), ]; } /* * Get default variant data. * * @param \WC_Product_Variable $product Variable product. * @return array<string, mixed> Default variant data. / private function get_default_variant_data( \WC_Product_Variable $product ): array { $variations = $product->get_available_variations(); if ( empty( $variations ) \|\| ! is_array( $variations ) ) { return []; } $default_variation = $variations[0] ?? []; if ( ! is_array( $default_variation ) ) { return []; } $variation_id = $default_variation['variation_id'] ?? null; if ( ! $variation_id ) { return []; } return $this->build_variant_data( $variation_id, $default_variation, $product ); } /* * Build variant data from variation. * * @param int $variation_id Variation ID. * @param array<string, mixed> $default_variation Default variation data. * @param \WC_Product $parent_product Parent product. * @return array<string, mixed> Variant data. / private function build_variant_data( int $variation_id, array $default_variation, \WC_Product $parent_product ): array { $variation_obj = wc_get_product( $variation_id ); if ( ! $variation_obj \|\| ! $variation_obj instanceof \WC_Product_Variation ) { return []; } $attributes = $this->extract_variant_attributes( $variation_obj ); $image_data = $this->get_variant_image( $variation_obj, $parent_product ); $stock_data = $this->get_variant_stock( $variation_obj ); return [ 'sku' => $variation_obj->get_sku(), 'name' => $variation_obj->get_name(), 'url' => $variation_obj->get_permalink(), 'image' => $image_data, 'size' => $attributes['size'], 'color' => $attributes['color'], 'description' => $default_variation['variation_description'] ?? '', 'sale_price' => $this->get_variant_sale_price( $variation_obj ), 'regular_price' => wc_get_price_including_tax( $variation_obj, [ 'price' => $variation_obj->get_regular_price() ] ), 'stock' => $stock_data, ]; } /* * Extract variant attributes. * * @param \WC_Product_Variation $variation Variation object. * @return array{size: string, color: string} Extracted attributes. / private function extract_variant_attributes( \WC_Product_Variation $variation ): array { $attributes = $variation->get_attributes(); $size = ''; $color = ''; foreach ( $attributes as $attribute_name => $attribute_value ) { $taxonomy = str_replace( 'attribute_', '', $attribute_name ); if ( strpos( $taxonomy, 'size' ) !== false ) { $size = $attribute_value; } elseif ( strpos( $taxonomy, 'color' ) !== false \|\| strpos( $taxonomy, 'colour' ) !== false ) { $color = $attribute_value; } } return [ 'size' => $size, 'color' => $color, ]; } /* * Get variant image. * * @param \WC_Product_Variation $variation Variation object. * @param \WC_Product $parent_product Parent product. * @return string Image URL. / private function get_variant_image( \WC_Product_Variation $variation, \WC_Product $parent_product ): string { $image_id = $variation->get_image_id() ? $parent_product->get_image_id() : 0; $image = wp_get_attachment_image_src( (int) $image_id, 'single-post-thumbnail' ); return $image ? $image[0] : ''; } /* * Get variant stock status. * * @param \WC_Product_Variation $variation Variation object. * @return string Stock status URL. / private function get_variant_stock( \WC_Product_Variation $variation ): string { $statuses = $this->get_stock_status_mapping(); $status = strtolower( $variation->get_stock_status() ); return 'https://schema.org/' . ( $statuses[ $status ] ?? 'InStock' ); } /* * Get variant sale price. * * @param \WC_Product_Variation $variation Variation object. * @return string Sale price. / private function get_variant_sale_price( \WC_Product_Variation $variation ): string { $sale_price = $variation->get_sale_price(); return $sale_price ? (string) wc_get_price_including_tax( $variation, [ 'price' => $sale_price ] ) : ''; } /* * Get stock data for product. * * @param \WC_Product $product Product object. * @return array<string, string> Stock data. / private function get_stock_data( \WC_Product $product ): array { $statuses = $this->get_stock_status_mapping(); $status = strtolower( $product->get_stock_status() ); return [ 'stock' => 'https://schema.org/' . ( $statuses[ $status ] ?? 'InStock' ), ]; } /* * Merge variant data into product data. * * @param array<string, mixed> $product_data Base product data. * @param array<string, mixed> $variant_data Variant data. * @return array<string, mixed> Merged data. / private function merge_variant_data( array $product_data, array $variant_data ): array { if ( empty( $variant_data ) ) { return $product_data; } foreach ( $variant_data as $key => $value ) { $product_data[ 'variant_' . $key ] = $value ?? ''; } return $product_data; } /* * Get product image dimensions. * * @param \WC_Product $product WooCommerce product object. * @return array<string, mixed> Product image dimensions. / private function get_product_image_dimensions( $product ) { $image_data = wp_get_attachment_image_src( (int) $product->get_image_id(), 'single-post-thumbnail' ); $product_image_url = $image_data[0] ?? ''; if ( empty( $product_image_url ) ) { $surerank_settings = get_post_meta( $product->get_id(), SURERANK_SETTINGS, true ); $product_image_url = $surerank_settings['facebook_image_url'] ?? ''; } return [ 'image' => $product_image_url ?? '', 'image_width' => $image_data[1] ?? '', 'image_height' => $image_data[2] ?? '', ]; } /* * Get stock status mapping for schema. * * @return array<string, mixed> Stock status mapping. / private function get_stock_status_mapping() { return [ 'instock' => 'InStock', 'outofstock' => 'OutOfStock', 'onbackorder' => 'BackOrder', 'soldout' => 'SoldOut', ]; } /* * Get detailed product data for schema from SureCart data. * * @param array<string, mixed> $post_data SureCart product data array. * @return array<string, mixed> Product data for schema. */ private function get_surecart_product_data( $post_data ) { $price = isset( $post_data['initial_amount'] ) ? $post_data['initial_amount'] / 100 : ''; $price_with_tax = $price; // Sale dates (SureCart doesn't provide sale dates directly in this data, so we'll leave them empty unless you have a custom field). $sale_from = ''; $sale_to = ''; $low_price = isset( $post_data['metrics']['min_price_amount'] ) ? $post_data['metrics']['min_price_amount'] / 100 : $price; $high_price = isset( $post_data['metrics']['max_price_amount'] ) ? $post_data['metrics']['max_price_amount'] / 100 : $price; $offer_count = $post_data['variants']['pagination']['count'] ?? 0; $variant_data = []; if ( $offer_count > 0 && ! empty( $post_data['variants']['data'] ) ) { // Get the first variant as the default. $default_variant = $post_data['variants']['data'][0]; $size = $default_variant['option_1'] ?? ''; $color = $default_variant['option_2'] ?? ''; // Variant image (use product image if variant-specific image is not set). $variant_image_url = $default_variant['image_url'] ?? $post_data['image_url']; // Stock status. $stock_enabled = $post_data['stock_enabled'] ?? false; $stock_status = $stock_enabled && $default_variant['available_stock'] <= 0 ? 'OutOfStock' : 'InStock'; $var_stock = 'https://schema.org/' . $stock_status; // Variant data (SureCart doesn't seem to have variant-specific prices here; use initial price). $variant_data = [ 'sku' => $default_variant['sku'] ?? '', 'name' => $post_data['name'] . ' - ' . $size . ' ' . $color, 'url' => $post_data['checkout_permalink'] ?? '', 'image' => $variant_image_url, 'size' => $size, 'color' => $color, 'description' => $post_data['description'] ?? '', 'sale_price' => '', 'regular_price' => $price, 'stock' => $var_stock, ]; } // Stock status for the main product. $stock_enabled = $post_data['stock_enabled'] ?? false; $stock_status = $stock_enabled && $post_data['available_stock'] <= 0 ? 'OutOfStock' : 'InStock'; $stock = 'https://schema.org/' . $stock_status; // Get product image dimensions from preview image. $preview_image = $post_data['preview_image'] ?? ''; $image_url = $preview_image->src ?? ''; $image_width = $preview_image->width ?? ''; $image_height = $preview_image->height ?? ''; // Currency (from SureCart's initial price or metrics). $currency = $post_data['initial_price']['currency'] ?? 'usd'; // Rating and reviews (not available in SureCart data, so default to empty). $rating = ''; $review_count = ''; // Assemble product data. $product_data = [ 'price' => $price, 'price_with_tax' => $price_with_tax, 'low_price' => $low_price, 'high_price' => $high_price, 'offer_count' => $offer_count, 'sale_from' => $sale_from, 'sale_to' => $sale_to, 'sku' => $post_data['sku'] ?? '', 'stock' => $stock, 'currency' => strtoupper( $currency ), 'rating' => $rating, 'review_count' => $review_count, 'image' => $image_url, 'image_width' => $image_width, 'image_height' => $image_height, 'description' => $post_data['description'] ?? '', 'short_description' => $post_data['meta_description'] ?? '', ]; // Add variant data if available. if ( ! empty( $variant_data ) ) { foreach ( $variant_data as $key => $value ) { $product_data[ 'variant_' . $key ] = $value ?? ''; } } return $product_data; } }	20.68 KB	2025-10-27 18:36
📄 render.php <?php /** * Render * * This file will handle functionality for all Render. * * @package surerank * @since 1.0.0 / namespace SureRank\Inc\Schema; /* * Class Render * * Handles the rendering of dynamic values with placeholders in a structured format. / class Render { /* * Data collected for rendering. * * @var array<string, mixed> / private $data; /* * Render constructor. * * @param Data $data Data instance containing the values to be rendered. / public function __construct( Data $data ) { $this->data = $data->collect(); } /* * Render the value, supporting both strings and arrays. * * @param mixed $value The value to render (string or array). * @return void / public function render( &$value ) { if ( is_array( $value ) ) { foreach ( $value as &$item ) { $this->render( $item ); // Recursively render array items. } return; } if ( ! is_string( $value ) \|\| ! str_contains( $value, '%' ) ) { return; } // Match variables like %post.title% or %schemas.article%. preg_match_all( '/%([^%\s]+)%/', $value, $matches ); foreach ( $matches[1] as $match ) { $keys = explode( '.', $match ); $replacement = $this->resolve_variable( $keys, $this->data ); if ( is_array( $replacement ) ) { $value = $replacement; } else { $value = str_replace( "%{$match}%", $replacement ?? '', $value ); } // Check for additional variables introduced in the replacement and resolve recursively. $this->render( $value ); } } /* * Resolve a variable from a data source using dot notation keys. * * @param array<string, mixed>\|array<int, string> $keys Array of keys to traverse the data structure. * @param array<string, mixed> $data The data array to search within. * @return mixed\|null Resolved value or null if not found. */ private function resolve_variable( array $keys, array $data ) { $current = $data; foreach ( $keys as $key ) { if ( is_array( $current ) && isset( $current[ $key ] ) ) { $current = $current[ $key ]; } elseif ( is_object( $current ) && isset( $current->$key ) ) { $current = $current->$key; } else { return null; // Key not found, return null. } } return $current; } }	2.22 KB	2025-10-27 18:36
📄 rules.php <?php /** * Display Rules * * This file handles functionality for all Rules. * * @package surerank * @since 1.0.0 / namespace SureRank\Inc\Schema; use SureRank\Inc\Traits\Get_Instance; /* * Rules * * This class handles the logic for display rules and location selections. * * @since 1.0.0 / class Rules { use Get_Instance; /* * Get Location Selections * * Retrieves the options for location rules based on post types and taxonomies. * * @param mixed $consider_type Consider type (single or archive) for specific options. * @return array<string, mixed> The array of location selection options. * @since 1.0.0 / public static function get_schema_rules_selections( $consider_type = false ): array { $post_types = self::get_filtered_post_types(); $selection_options = self::initialize_selection_options( $consider_type ); // Add WooCommerce product types if available. self::add_woocommerce_options( $selection_options ); // Add taxonomy-based options. self::add_taxonomy_options( $selection_options, $post_types, $consider_type ); // Add specific target option. $selection_options['specific-target'] = self::get_specific_target_option(); return apply_filters( 'surerank_display_on_list', $selection_options ); } /* * Get target rules for generating the markup for rule selector. * * @since 1.0.0 * * @param object $post_type Post type parameter. * @param object $taxonomy Taxonomy for creating the target rule markup. * @param mixed $consider_type Consider type for dealing with rule options. * @return array<string, mixed> / public static function get_post_target_rule_options( $post_type, $taxonomy, $consider_type = false ) { if ( ! $post_type instanceof \WP_Post_Type \|\| ! $taxonomy instanceof \WP_Taxonomy ) { return []; } $post_key = str_replace( ' ', '-', strtolower( $post_type->label ) ); $post_label = ucwords( $post_type->label ); $post_name = $post_type->name; $post_option = []; if ( 'archive' !== $consider_type ) { / translators: %s: Post type label / $all_posts = sprintf( __( 'All %s', 'surerank' ), $post_label ); $post_option[ $post_name . '\|all' ] = $all_posts; } if ( 'pages' !== $post_key && 'single' !== $consider_type ) { / translators: %s: Post type label / $all_archive = sprintf( __( 'All %s Archive', 'surerank' ), $post_label ); $post_option[ $post_name . '\|all\|archive' ] = $all_archive; } if ( 'single' !== $consider_type ) { if ( in_array( $post_type->name, $taxonomy->object_type, true ) ) { $tax_label = ucwords( $taxonomy->label ); $tax_name = $taxonomy->name; / translators: %s: Taxonomy label / $tax_archive = sprintf( __( 'All %s Archive', 'surerank' ), $tax_label ); $post_option[ $post_name . '\|all\|taxarchive\|' . $tax_name ] = $tax_archive; } } return [ 'post_key' => $post_key, 'label' => $post_label, 'value' => $post_option, ]; } /* * Get filtered post types. * * @return array<string, \WP_Post_Type> Filtered post types. / private static function get_filtered_post_types(): array { // Get built-in post types. $builtin_types = self::get_post_types_by_builtin( true ); unset( $builtin_types['attachment'] ); // Get custom post types. $custom_types = self::get_post_types_by_builtin( false ); // Merge and apply filter. $post_types = array_merge( $builtin_types, $custom_types ); return apply_filters( 'surerank_location_rule_post_types', $post_types ); } /* * Get post types by builtin status. * * @param bool $builtin Whether to get builtin types. * @return array<string, \WP_Post_Type> Post types. / private static function get_post_types_by_builtin( bool $builtin ): array { $args = [ 'public' => true, '_builtin' => $builtin, ]; $post_types = get_post_types( $args, 'objects' ); return array_filter( $post_types, static fn( $pt ) => $pt instanceof \WP_Post_Type ); } /* * Initialize selection options based on consider type. * * @param mixed $consider_type Consider type. * @return array<string, mixed> Initial selection options. / private static function initialize_selection_options( $consider_type ): array { $global_val = self::get_global_values( $consider_type ); $basic_option = [ 'basic' => [ 'label' => __( 'Basic', 'surerank' ), 'value' => $global_val, ], ]; if ( 'single' === $consider_type ) { return $basic_option; } return array_merge( $basic_option, [ 'special-pages' => [ 'label' => __( 'Special Pages', 'surerank' ), 'value' => self::get_special_pages(), ], ] ); } /* * Get global values based on consider type. * * @param mixed $consider_type Consider type. * @return array<string, string> Global values. / private static function get_global_values( $consider_type ): array { $values = [ 'basic-global' => __( 'Entire Website', 'surerank' ), ]; if ( 'single' === $consider_type ) { $values['basic-singulars'] = __( 'All Singulars', 'surerank' ); } elseif ( 'archive' === $consider_type ) { $values['basic-archives'] = __( 'All Archives', 'surerank' ); } else { $values['basic-singulars'] = __( 'All Singulars', 'surerank' ); $values['basic-archives'] = __( 'All Archives', 'surerank' ); } return $values; } /* * Get special pages. * * @return array<string, string> Special pages. / private static function get_special_pages(): array { $special_pages = [ 'special-404' => __( '404 Page', 'surerank' ), 'special-search' => __( 'Search Page', 'surerank' ), 'special-blog' => __( 'Blog / Posts Page', 'surerank' ), 'special-front' => __( 'Front Page', 'surerank' ), 'special-date' => __( 'Date Archive', 'surerank' ), 'special-author' => __( 'Author Archive', 'surerank' ), ]; if ( class_exists( 'WooCommerce' ) ) { $special_pages['special-woo-shop'] = __( 'WooCommerce Shop Page', 'surerank' ); } return $special_pages; } /* * Add WooCommerce options. * * @param array<string, mixed> $selection_options Selection options. * @return void / private static function add_woocommerce_options( array &$selection_options ): void { if ( ! class_exists( 'WooCommerce' ) ) { return; } $product_type_options = self::get_product_type_options(); if ( ! empty( $product_type_options ) ) { $selection_options['product-types'] = [ 'label' => __( 'Product Types', 'surerank' ), 'value' => $product_type_options, ]; } } /* * Get product type options. * * @return array<string, string> Product type options. / private static function get_product_type_options(): array { $product_types = wc_get_product_types(); $options = []; foreach ( $product_types as $type_key => $type_label ) { $options[ 'product-type\|' . $type_key ] = $type_label; } return $options; } /* * Add taxonomy options. * * @param array<string, mixed> $selection_options Selection options. * @param array<string, \WP_Post_Type> $post_types Post types. * @param mixed $consider_type Consider type. * @return void / private static function add_taxonomy_options( array &$selection_options, array $post_types, $consider_type ): void { $taxonomies = self::get_public_taxonomies(); if ( empty( $taxonomies ) ) { return; } foreach ( $taxonomies as $taxonomy ) { self::process_taxonomy_for_post_types( $selection_options, $taxonomy, $post_types, $consider_type ); } } /* * Get public taxonomies. * * @return array<string, \WP_Taxonomy> Public taxonomies. / private static function get_public_taxonomies(): array { $taxonomies = get_taxonomies( [ 'public' => true ], 'objects' ); return array_filter( $taxonomies, static fn( $tax ) => $tax instanceof \WP_Taxonomy ); } /* * Process taxonomy for all post types. * * @param array<string, mixed> $selection_options Selection options. * @param \WP_Taxonomy $taxonomy Taxonomy. * @param array<string, \WP_Post_Type> $post_types Post types. * @param mixed $consider_type Consider type. * @return void / private static function process_taxonomy_for_post_types( array &$selection_options, \WP_Taxonomy $taxonomy, array $post_types, $consider_type ): void { foreach ( $post_types as $post_type ) { $post_opt = self::get_post_target_rule_options( $post_type, $taxonomy, $consider_type ); if ( empty( $post_opt ) ) { continue; } self::merge_post_option( $selection_options, $post_opt ); } } /* * Merge post option into selection options. * * @param array<string, mixed> $selection_options Selection options. * @param array<string, mixed> $post_opt Post option. * @return void / private static function merge_post_option( array &$selection_options, array $post_opt ): void { $key = $post_opt['post_key']; if ( ! isset( $selection_options[ $key ] ) ) { $selection_options[ $key ] = [ 'label' => $post_opt['label'], 'value' => $post_opt['value'], ]; return; } self::merge_option_values( $selection_options[ $key ]['value'], $post_opt['value'] ); } /* * Merge option values. * * @param array<string, mixed> $existing_values Existing values. * @param mixed $new_values New values. * @return void / private static function merge_option_values( array &$existing_values, $new_values ): void { if ( ! is_array( $new_values ) \|\| empty( $new_values ) ) { return; } foreach ( $new_values as $key => $value ) { if ( ! in_array( $value, $existing_values, true ) ) { $existing_values[ $key ] = $value; } } } /* * Get specific target option. * * @return array<string, mixed> Specific target option. */ private static function get_specific_target_option(): array { return [ 'label' => __( 'Specific Target', 'surerank' ), 'value' => [ 'specifics' => __( 'Specific Pages / Posts / Taxonomies, etc.', 'surerank' ), ], ]; } }	9.9 KB	2025-10-27 18:36
📄 schema-render.php <?php /** * Schema_Render * * This file will handle functionality for rendering schema data with placeholders and merging it with a specific schema type. * * @package surerank * @since 1.0.0 / namespace SureRank\Inc\Schema; /* * Class Schema_Render * * Responsible for rendering schema data with placeholders and merging it with a specific schema type. / class Schema_Render { /* * The schema type (e.g., Article, Product, etc.). * * @var string / private $type; /* * The fields or data associated with the schema. * * @var array<string, mixed> / private $fields; /* * The variable renderer for processing dynamic placeholders. * * @var Render / private $variable_renderer; /* * Schema_Render constructor. * * @param string $type The schema type. * @param array<string, mixed> $fields The fields to render. * @param Render $variable_renderer The renderer for processing placeholders. / public function __construct( string $type, array $fields, Render $variable_renderer ) { $this->type = $type; $this->fields = $fields; $this->variable_renderer = $variable_renderer; } /* * Render the schema data with resolved placeholders. * * @return array<string, mixed> The rendered schema data merged with the schema type. / public function render() { foreach ( $this->fields as &$value ) { $this->variable_renderer->render( $value ); } if ( isset( $this->fields['sameAs'] ) && is_array( $this->fields['sameAs'] ) ) { $this->fields['sameAs'] = array_values( $this->fields['sameAs'] ); } $this->flatten_cloneable_fields(); $final_type = $this->type; /* * Combine @type and @sub_type if @sub_type is set. / if ( isset( $this->fields['@sub_type'] ) && is_array( $this->fields['@sub_type'] ) && ! empty( $this->fields['@sub_type'] ) ) { $sub_types = array_filter( $this->fields['@sub_type'] ); if ( ! empty( $sub_types ) ) { $final_type = array_merge( [ $this->type ], $sub_types ); } unset( $this->fields['@sub_type'] ); } $this->fields['@type'] = $final_type; $schema = array_merge( [ '@type' => $final_type ], $this->fields ); return $this->remove_empty( $this->remove_schema_name( $schema ) ); } /* * Remove empty or null values from an array recursively. * * @param array<string, mixed> $data The array to filter. * @return array<string, mixed> Filtered array with non-empty values. / private function remove_empty( array $data ) { foreach ( $data as $key => $value ) { if ( is_array( $value ) ) { $data[ $key ] = $this->remove_empty( $value ); if ( empty( $data[ $key ] ) ) { unset( $data[ $key ] ); } } elseif ( empty( $value ) && 0 !== $value ) { unset( $data[ $key ] ); } } return $data; } /* * Flatten cloneable fields that have flatten=true. * * Converts UUID-based objects to simple arrays for fields marked with flatten=true. * * @return void / private function flatten_cloneable_fields() { $schema_types = Utils::get_schema_types(); $schema_class = $schema_types[ $this->type ] ?? null; if ( ! $schema_class \|\| ! class_exists( $schema_class ) ) { return; } $schema_instance = $schema_class::get_instance(); $field_definitions = $schema_instance->get(); foreach ( $field_definitions as $field ) { if ( ! empty( $field['cloneable'] ) && ! empty( $field['flatten'] ) && isset( $field['id'] ) ) { $field_id = $field['id']; if ( isset( $this->fields[ $field_id ] ) && is_array( $this->fields[ $field_id ] ) ) { $this->fields[ $field_id ] = array_values( $this->fields[ $field_id ] ); } } } } /* * Remove the schema name from the array. * * @param array<string, mixed> $schema The schema to remove the name from. * @return array<string, mixed> The schema with the name removed. */ private function remove_schema_name( array $schema ) { if ( isset( $schema['schema_name'] ) ) { unset( $schema['schema_name'] ); } return $schema; } }	4.02 KB	2025-10-27 18:36
📄 schemas-api.php <?php /** * Schemas class * * Handles schemas related REST API endpoints for the SureRank plugin. * * @package SureRank\Inc\API / namespace SureRank\Inc\Schema; use SureRank\Inc\API\Api_Base; use SureRank\Inc\Functions\Send_Json; use SureRank\Inc\Traits\Get_Instance; use WP_REST_Server; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Class SchemasApi * * Handles schemas related REST API endpoints. / class SchemasApi extends Api_Base { use Get_Instance; /* * Route Get Term Seo Data / protected const GET_POST_BY_QUERY = '/admin/posts'; /* * Route get variables / protected const GET_VARIABLES = '/schemas/variables'; /* * Constructor * * @since 1.0.0 / public function __construct() { } /* * Register API routes. * * @since 1.0.0 * @return void / public function register_routes() { register_rest_route( $this->get_api_namespace(), self::GET_POST_BY_QUERY, [ 'methods' => WP_REST_Server::CREATABLE, // GET Term Seo Data. 'callback' => [ $this, 'get_post_by_query' ], 'permission_callback' => [ $this, 'validate_permission' ], 'args' => [ 'q' => [ 'type' => 'string', 'required' => true, 'sanitize_callback' => 'sanitize_text_field', ], ], ] ); register_rest_route( $this->get_api_namespace(), self::GET_VARIABLES, [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'get_variables' ], 'permission_callback' => [ $this, 'validate_permission' ], ] ); } /* * Get Posts By Query * * Handles the REST API request for posts by query. * * @param \WP_REST_Request<array<string, mixed>> $request REST API Request object. * @since 1.0.0 * @return void / public function get_post_by_query( $request ) { $search_string = sanitize_text_field( $request->get_param( 'q' ) ); $page = intval( $request->get_param( 'page' ) ) ? intval( $request->get_param( 'page' ) ) : 1; $result = []; if ( empty( $search_string ) ) { Send_Json::success( [ 'results' => $result ] ); } try { $post_types = array_merge( [ 'post', 'page' ], array_keys( get_post_types( [ 'public' => true, '_builtin' => false, ], 'names' ) ) ); foreach ( $post_types as $post_type ) { add_filter( 'posts_search', [ $this, 'search_only_titles' ], 10, 2 ); $query = new \WP_Query( [ 's' => $search_string, 'post_type' => $post_type, 'posts_per_page' => 10, 'paged' => $page, 'fields' => 'ids', ] ); $data = []; if ( $query->have_posts() ) { foreach ( $query->posts as $post_id ) { $post_id = intval( is_object( $post_id ) ? $post_id->ID : $post_id ); $data[] = [ 'id' => 'post-' . $post_id, 'text' => get_the_title( $post_id ), ]; } } if ( ! empty( $data ) ) { $result[] = [ 'text' => ucfirst( $post_type ), 'children' => $data, ]; } remove_filter( 'posts_search', [ $this, 'search_only_titles' ] ); } wp_reset_postdata(); $output = 'objects'; // names or objects, note names is the default. $operator = 'and'; // also supports 'or'. $args = [ 'public' => true, ]; $taxonomies = get_taxonomies( $args, $output, $operator ); foreach ( $taxonomies as $taxonomy ) { $terms = get_terms( [ 'taxonomy' => $taxonomy->name, 'orderby' => 'count', 'hide_empty' => 0, 'name__like' => $search_string, ] ); $data = []; $label = ucwords( $taxonomy->label ); if ( ! empty( $terms ) && ! is_wp_error( $terms ) && is_array( $terms ) ) { foreach ( $terms as $term ) { $term_taxonomy_name = ucfirst( str_replace( '_', ' ', $taxonomy->name ) ); // for tax-{id}, and tax-{id}-single-{taxonomy} type rules. $data[] = [ 'id' => 'tax-' . $term->term_id, 'text' => ucwords( $term->name . ' (' . $term_taxonomy_name . ')' ), ]; $data[] = [ 'id' => 'tax-' . $term->term_id . '-single-' . $taxonomy->name, 'text' => 'All singulars from ' . $term->name, ]; } } if ( is_array( $data ) && ! empty( $data ) ) { $result[] = [ 'text' => $label, 'children' => $data, ]; } } Send_Json::success( [ 'results' => $result ] ); } catch ( \Exception $e ) { Send_Json::success( [ 'results' => [] ] ); } } /* * Search Only Titles * * Filters the WP_Query search to look only in post titles. * * @param string $search The search SQL for WHERE clause. * @param \WP_Query $wp_query The current WP_Query object. * @since 1.0.0 * @return string */ public function search_only_titles( $search, $wp_query ) { global $wpdb; if ( ! empty( $search ) && ! empty( $wp_query->query_vars['search_terms'] ) ) { $q = $wp_query->query_vars; $n = ! empty( $q['exact'] ) ? '' : '%'; $search = []; foreach ( (array) $q['search_terms'] as $term ) { $search[] = $wpdb->prepare( "{$wpdb->posts}.post_title LIKE %s", $n . $wpdb->esc_like( $term ) . $n ); } if ( ! is_user_logged_in() ) { $search[] = "{$wpdb->posts}.post_password = ''"; } $search = ' AND ' . implode( ' AND ', $search ); } return $search; } }	5.37 KB	2025-10-27 18:36
📄 schemas.php <?php /** * Schemas * * This file handles functionality for all Schemas. * * @package surerank * @since 1.0.0 / namespace SureRank\Inc\Schema; use SureRank\Inc\Functions\Get; use SureRank\Inc\Functions\Settings; use SureRank\Inc\Traits\Get_Instance; use WP_Post; use WP_Term; use WP_User; /* * Schemas * * This class handles functionality for all Schemas. * * @since 1.0.0 / class Schemas { use Get_Instance; /* * Schema Data * * @var array<int, array<string, mixed>> * @since 1.0.0 / private $schema_data = []; /* * Constructor * * Initializes schema data and sets up hooks for schema handling. * * @since 1.0.0 / public function __construct() { if ( ! Settings::get( 'enable_schemas' ) ) { return; } if ( ! apply_filters( 'surerank_print_schema', true ) ) { return; } add_filter( 'surerank_api_controllers', [ $this, 'add_schemas_apis' ] ); add_filter( 'surerank_common_localization_vars', [ $this, 'add_localization_vars' ] ); add_action( 'surerank_print_meta', [ $this, 'print_schema_data' ], 10 ); add_action( 'wp', [ $this, 'set_schema_data' ], 1 ); Products::get_instance(); } /* * Add GSC APIs to the API controllers. * * @since 1.1.0 * @param array<int,string> $controllers List of API controllers. * @return array<int,string> Updated list of API controllers. / public function add_schemas_apis( $controllers ) { $controllers[] = '\SureRank\Inc\Schema\SchemasApi'; return $controllers; } /* * Add localisation variables * * @since 1.1.0 * @param array<string, mixed> $variables Localisation variables. * @return array<string, mixed> Localisation variables. / public function add_localization_vars( $variables ) { return array_merge( $variables, [ 'schema_rules' => Rules::get_schema_rules_selections(), 'default_schemas' => Utils::get_default_schema_options(), 'schema_type_options' => Utils::get_schema_type_options(), 'schema_type_data' => Utils::get_schema_type_data(), 'schema_variables' => Variables::get_instance()->get_schema_variables(), ] ); } /* * Print Schema Data * * Outputs the schema data in JSON-LD format in the frontend. * * @since 1.0.0 * @return void / public function print_schema_data() { $schemas = $this->get_active_schemas(); $rendered = []; if ( is_admin() && ! defined( 'DOING_AJAX' ) ) { return; } foreach ( $schemas as $schema ) { if ( Validator::validate_schema_rules( $schema ) ) { // Validate schema rules. $type = $schema['fields']['@type'] ?? $schema['type'] ?? 'Thing'; $schema_class = Utils::get_schema_types()[ $schema['type'] ] ?? null; if ( $schema_class && class_exists( $schema_class ) ) { $schema_instance = $schema_class::get_instance(); $rendered[] = $schema_instance->render_schema( $schema, new Render( new Data() ) ); } } } $schema_data = [ '@context' => 'https://schema.org', '@graph' => array_filter( $rendered ), ]; if ( empty( $schema_data['@graph'] ) ) { return; } echo '<script type="application/ld+json" id="surerank-schema">' . wp_json_encode( $schema_data, $this->get_wp_json_encode_flags() ) . '</script>'; } /* * Get wp_json_encode Flags * * Retrieves the wp_json_encode 2nd parameter flag as per debug mode. * * @return int wp_json_encode 2nd parameter flag. * @since 1.0.0 / public function get_wp_json_encode_flags() { if ( defined( 'SURERANK_DEBUG' ) && SURERANK_DEBUG ) { return JSON_PRETTY_PRINT \| JSON_UNESCAPED_UNICODE \| JSON_UNESCAPED_SLASHES; } return JSON_UNESCAPED_UNICODE \| JSON_UNESCAPED_SLASHES; } /* * Get Active Schemas * * Retrieves the active schemas based on settings. * * @return array<mixed> Active schemas. * @since 1.0.0 / public function get_active_schemas() { $post_schema = $this->get_post_schema(); // Get post schema. $global_schema = $this->get_global_schema(); // Get global schema. if ( ! empty( $post_schema ) ) { return $post_schema; } if ( ! empty( $global_schema ) ) { return $global_schema; } return []; } /* * Set Schema Data * * Sets schema data through a WordPress filter. * * @since 1.0.0 * @return void / public function set_schema_data() { $this->schema_data = apply_filters( 'surerank_set_schema', $this->schema_data ); } /* * Get Post Schema * * Retrieves the schema data for a post. * * @return array<string, mixed> Post schema data. * @since 1.0.0 / public function get_post_schema() { $object = get_queried_object(); $schema_data = []; if ( $object instanceof WP_Post ) { $post_id = $object->ID; $schema_data = Get::post_meta( $post_id, 'surerank_settings_schemas', true ); } elseif ( $object instanceof WP_Term ) { $post_id = $object->term_id; $schema_data = Get::term_meta( $post_id, 'surerank_settings_schemas', true ); } elseif ( $object instanceof WP_User ) { $post_id = $object->ID; $schema_data = Get::user_meta( $post_id, 'surerank_settings_schemas', true ); } else { return []; } $post_schema = $schema_data['schemas'] ?? []; return ! empty( $post_schema ) ? $post_schema : []; } /* * Get Global Schema * * Retrieves the global schema data. * * @return array<string, mixed> Global schema data. * @since 1.0.0 */ public function get_global_schema() { $global_schema = Settings::get(); $global_schema = $global_schema['schemas'] ?? Utils::get_default_schemas(); if ( ! empty( $global_schema ) ) { return $global_schema; } return []; } }	5.52 KB	2025-10-27 18:36
📁 types	-	2025-10-27 18:36
📄 utils.php <?php /** * Utils * * This file handles functionality for all Utils. * * @package SureRank * @since 1.0.0 / namespace SureRank\Inc\Schema; use SureRank\Inc\Schema\Types\Article; use SureRank\Inc\Schema\Types\BreadcrumbList; use SureRank\Inc\Schema\Types\Organization; use SureRank\Inc\Schema\Types\Person; use SureRank\Inc\Schema\Types\Search_Action; use SureRank\Inc\Schema\Types\WebPage; use SureRank\Inc\Schema\Types\WebSite; use SureRank\Inc\Traits\Get_Instance; /* * Class Utils * * Provides utility functions for handling schema data. * * @package SureRank\Inc\Schema * @since 1.0.0 / class Utils { use Get_Instance; /* * Get Default Schemas * * Retrieves default schema data with unique IDs as keys. * * @return array<string, mixed> Default schema data with unique IDs as keys. * @since 1.0.0 / public static function get_default_schemas() { return self::build_final_schemas( apply_filters( 'surerank_default_schemas', self::build_schemas_from_types( self::get_default_schema_types() ) ) ); } /* * Get Default Schema Options * * Retrieves all schema data (including Pro schemas) with unique IDs as keys. * * @return array<string, mixed> Schema data with unique IDs as keys. * @since 1.0.0 / public static function get_default_schema_options() { return self::build_final_schemas( self::build_schemas_from_types( self::get_schema_types() ) ); } /* * Build final schemas array with unique IDs as keys. * * Takes an array of schemas and assigns each a unique UUID key for * identification in the frontend and database storage. * * @param array<int\|string, mixed> $schemas Array of schema data. * @return array<string, mixed> Schema data with unique IDs as keys. * @since 1.0.0 / public static function build_final_schemas( $schemas ) { $result = []; foreach ( $schemas as $key => $schema ) { $unique_id = self::generate_unique_id(); $result[ $unique_id ] = $schema; } return $result; } /* * Build schemas array from schema type classes. * * Iterates through schema type class mappings, instantiates each class, * and calls their schema_data() method to generate schema configurations. * * @param array<string, string> $schema_types Schema type class mappings (type => class). * @return array<int, mixed> Array of schema data from each type class. * @since 1.0.0 / public static function build_schemas_from_types( $schema_types ) { $schemas = []; foreach ( $schema_types as $key => $class ) { $instance = $class::get_instance(); $schemas[] = $instance->schema_data(); } return $schemas; } /* * Get Schema Type Data * * Retrieves schema type data. * * @return array<string, mixed> Schema type data. / public static function get_schema_type_data() { $schema_data = []; foreach ( self::get_default_schema_types() as $key => $class ) { $instance = $class::get_instance(); $schema_data[ $key ] = $instance->get(); } return apply_filters( 'surerank_schema_type_data', $schema_data ); } /* * Parse Schema Fields * * Parses schema fields recursively to include only required data. * * @param array<string, mixed>\|array<int, array<string, mixed>> $fields Schema fields. * @return array<string, mixed> Parsed fields. / public static function parse_fields( array $fields ) { $parsed = []; foreach ( $fields as $field ) { if ( empty( $field['id'] ) \|\| ( empty( $field['required'] ) && empty( $field['show'] ) ) ) { continue; } $type = $field['type'] ?? 'Text'; if ( $type === 'Group' && isset( $field['fields'] ) ) { $default_type = null; foreach ( $field['fields'] as $subfield ) { if ( isset( $subfield['id'] ) && $subfield['id'] === '@type' && isset( $subfield['std'] ) ) { $default_type = $subfield['std']; break; } } if ( $default_type ) { $filtered_subfields = []; foreach ( $field['fields'] as $subfield ) { /* * If the field is not a main field, or the main field is the default type, add it to the filtered subfields / if ( ! isset( $subfield['main'] ) \|\| $subfield['main'] === $default_type ) { $filtered_subfields[] = $subfield; } } $field['fields'] = $filtered_subfields; } $value = self::parse_group( $field ); } else { $value = $field['std'] ?? ''; } if ( ! empty( $value ) ) { $parsed[ $field['id'] ] = $value; } } return $parsed; } /* * Get Schema Type Options * * @return array<string, mixed> Schema type options. / public static function get_schema_type_options() { return [ 'WebPage' => WebPage::get_instance()->get_schema_type_options(), 'Article' => Article::get_instance()->get_schema_type_options(), 'Organization' => Organization::get_instance()->get_schema_type_options(), ]; } /* * Schema Types * * List of schema type classes. * * @return array<string, mixed> Schema type class mappings. / public static function get_schema_types() { return apply_filters( 'surerank_schema_types', self::get_default_schema_types() ); } /* * Get Default Schema Types * * @return array<string, mixed> Default schema type class mappings. / public static function get_default_schema_types() { return [ 'WebSite' => WebSite::class, 'WebPage' => WebPage::class, 'Organization' => Organization::class, 'BreadcrumbList' => BreadcrumbList::class, 'Article' => Article::class, 'SearchAction' => Search_Action::class, 'Person' => Person::class, ]; } /* * Generate Unique ID * * Generates a unique ID for a given schema type. * * @return string The unique ID. / private static function generate_unique_id(): string { return sprintf( '%s', wp_generate_uuid4() ); } /* * Parse Group Fields * * Parses group fields recursively. * * @param array<string, mixed>\|array<int, array<string, mixed>> $field Group field data. * @return array<string, mixed>\|array<int, array<string, mixed>> Parsed group fields. */ private static function parse_group( array $field ) { $group_fields = self::parse_fields( $field['fields'] ); if ( 1 === count( $group_fields ) && isset( $group_fields['@type'] ) ) { // Yoda condition. return []; } if ( ! empty( $field['cloneable'] ) ) { return [ $group_fields ]; } return $group_fields; } }	6.32 KB	2025-10-27 18:36
📄 validator.php <?php /** * Validator * * This file handles the validation of schema rules for determining visibility * based on specified conditions. * * @package surerank * @since 1.0.0 / namespace SureRank\Inc\Schema; /* * Validator class * * Handles the validation of schema rules for determining visibility * based on specified conditions. / class Validator { /* * Validate Schema Rules * * Determines if the schema should be displayed based on `show_on` * and `not_show_on` rules. * * @param array<string, mixed> $schema Schema data. * @param string $post_type Post type is the post_type we are getting from API request to show in settings. * @param int $post_id Post ID is from api request. * @param bool $is_taxonomy Whether the post is a taxonomy. * @return bool True if schema should be displayed, false otherwise. / public static function validate_schema_rules( $schema, $post_type = '', $post_id = 0, $is_taxonomy = false ) { // if schema has parent key, and it is true, we will return true, because we are using post meta data for schema now. if ( isset( $schema['parent'] ) && $schema['parent'] ) { return true; } $show_on_rules = $schema['show_on']['rules'] ?? []; $show_on_specific = $schema['show_on']['specific'] ?? []; $not_show_on_rules = $schema['not_show_on']['rules'] ?? []; $not_show_on_specific = $schema['not_show_on']['specific'] ?? []; $show_on_match = false; $not_show_on_match = false; if ( empty( $show_on_rules ) && empty( $show_on_specific ) && empty( $not_show_on_rules ) && empty( $not_show_on_specific ) ) { return false; } if ( ! empty( $show_on_rules ) \|\| ! empty( $show_on_specific ) ) { $show_on_match = self::evaluate_rules( $show_on_rules, $post_type, $is_taxonomy, $post_id ) \|\| self::evaluate_specifics( $show_on_specific, $post_type, $post_id ); } if ( ! empty( $not_show_on_rules ) \|\| ! empty( $not_show_on_specific ) ) { $not_show_on_match = self::evaluate_rules( $not_show_on_rules, $post_type, $is_taxonomy, $post_id ) \|\| self::evaluate_specifics( $not_show_on_specific, $post_type, $post_id ); } // - `show_on` must match (true). // - `not_show_on` must NOT match (false). return $show_on_match && ! $not_show_on_match; } /* * Evaluate Rules * * Evaluates an array of rules to check if any match the current context. * * @param array<string, mixed> $rules Rules to evaluate. * @param string $post_type Post type is the post_type we are getting from API request to show in settings. * @param bool $is_taxonomy Whether the post is a taxonomy. * @param int $post_id Post ID is from api request. * @return bool True if a rule matches, false otherwise. / private static function evaluate_rules( $rules, $post_type, $is_taxonomy = false, $post_id = 0 ) { if ( empty( $rules ) ) { return false; } foreach ( $rules as $rule ) { if ( self::matches_current_context( $rule, $post_type, $is_taxonomy, $post_id ) ) { return true; } } return false; } /* * Evaluate Specifics * * Evaluates specific items to determine if any match the current context. * * @param array<string, mixed> $specifics Specific items to evaluate. * @param string $post_type Post type is the post_type we are getting from API request to show in settings. * @param int $post_id Post ID is from api request. * @return bool True if a specific item matches, false otherwise. / private static function evaluate_specifics( $specifics, $post_type, $post_id ) { if ( empty( $specifics ) ) { return false; } foreach ( $specifics as $specific ) { if ( self::matches_specific_item( $specific, $post_type, $post_id ) ) { return true; } } return false; } /* * Check if Rule Matches Current Context * * Evaluates a single rule to determine if it matches the current WordPress context. * * @param string $rule Rule to check. * @param string $post_type Post type is the post_type we are getting from API request to show in settings. * @param bool $is_taxonomy Whether the post is a taxonomy. * @param int $post_id Post ID is from api request. * @return bool True if the rule matches, false otherwise. / private static function matches_current_context( $rule, $post_type, $is_taxonomy = false, $post_id = 0 ) { $rule_parts = explode( '\|', $rule ); $rule_type = $rule_parts[0]; // Check basic rules first. $basic_result = self::check_basic_rules( $rule_type, $is_taxonomy ); if ( $basic_result !== null ) { return $basic_result; } // Check special page rules. $special_result = self::check_special_rules( $rule_type, $is_taxonomy ); if ( $special_result !== null ) { return $special_result; } // Check post type specific rules. return self::check_post_type_specific_rules( $rule_type, $rule_parts, $post_type, $post_id ); } /* * Check basic rules. * * @param string $rule_type Rule type. * @param bool $is_taxonomy Is taxonomy. * @return bool\|null Result or null if not applicable. / private static function check_basic_rules( string $rule_type, bool $is_taxonomy ) { switch ( $rule_type ) { case 'basic-global': return true; case 'basic-singulars': return is_singular() \|\| ! $is_taxonomy; case 'basic-archives': return is_archive() \|\| $is_taxonomy; } return null; } /* * Check special page rules. * * @param string $rule_type Rule type. * @param bool $is_taxonomy Is taxonomy. * @return bool\|null Result or null if not applicable. / private static function check_special_rules( string $rule_type, bool $is_taxonomy ) { switch ( $rule_type ) { case 'special-404': return is_404(); case 'special-search': return is_search(); case 'special-blog': return is_home(); case 'special-front': return is_front_page() \|\| $is_taxonomy; case 'special-date': return is_date() \|\| $is_taxonomy; case 'special-author': return is_author() \|\| $is_taxonomy; } return null; } /* * Check post type specific rules. * * @param string $rule_type Rule type. * @param array<string, mixed>\|array<int, string> $rule_parts Rule parts. * @param string $post_type Post type. * @param int $post_id Post ID. * @return bool Result. / private static function check_post_type_specific_rules( string $rule_type, array $rule_parts, string $post_type, int $post_id ): bool { switch ( $rule_type ) { case 'post': return self::handle_post_type_rules( $rule_parts, $post_type, 'post' ); case 'page': return self::handle_page_rules( $rule_parts, $post_type ); case 'product-type': return self::handle_product_type_rules( $rule_parts, $post_type, $post_id ); case 'product': return self::handle_product_rules( $rule_parts, $post_type ); default: if ( post_type_exists( $rule_type ) ) { return self::handle_custom_post_type_rules( $rule_parts, $post_type ); } return false; } } /* * Handle Product Type Rules * * Evaluate product type-specific rules. * * @param array<string, mixed>\|array<int, string> $rule_parts Rule parts array. * @param string $post_type Post type is the post_type we are getting from API request to show in settings. * @param int $post_id Post ID is from api request. * @return bool True if matches, false otherwise. / private static function handle_product_type_rules( $rule_parts, $post_type, $post_id ) { if ( ! function_exists( 'wc_get_product' ) ) { return false; } if ( 'product' !== $post_type && ! is_singular( 'product' ) && ! $post_id ) { return false; } $product_type = $rule_parts[1] ?? ''; if ( empty( $product_type ) ) { return false; } $product = null; if ( is_singular( 'product' ) ) { global $post; $product_id = $post->ID; } else { $product_id = get_the_ID(); $product_id = $product_id ? $product_id : $post_id; } $product = $product_id ? wc_get_product( $product_id ) : null; if ( ! $product ) { return false; } $product_type = $product->get_type(); if ( $product_type === $rule_parts[1] ) { return true; } return false; } /* * Handle Custom Post Type Rules * * Evaluate custom post type-specific rules. * * @param array<string, mixed>\|array<int, string> $rule_parts Rule parts array. * @param string $post_type Post type is the post_type we are getting from API request to show in settings. * @return bool True if matches, false otherwise. / private static function handle_custom_post_type_rules( $rule_parts, $post_type ) { return self::handle_post_type_rules( $rule_parts, $post_type, $rule_parts[0] ); } /* * Handle Page Rules * * Evaluate page-specific rules. * * @param array<string, mixed>\|array<int, string> $rule_parts Rule parts array. * @param string $post_type Post type is the post_type we are getting from API request to show in settings. * @return bool True if matches, false otherwise. / private static function handle_page_rules( $rule_parts, $post_type ) { switch ( $rule_parts[1] ?? '' ) { case 'all': return is_page() \|\| 'page' === $post_type; case 'front': return is_front_page(); default: return false; } } /* * Handle Product Rules * * Evaluate product-specific rules. * * @param array<string, mixed>\|array<int, string> $rule_parts Rule parts array. * @param string $post_type Post type is the post_type we are getting from API request to show in settings. * @return bool True if matches, false otherwise. / private static function handle_product_rules( $rule_parts, $post_type ) { return self::handle_post_type_rules( $rule_parts, $post_type, 'product' ); } /* * Handle Post Type Rules * * Evaluate post type-specific rules. * * @param array<string, mixed>\|array<int, string> $rule_parts Rule parts array. * @param string $post_type Post type is the post_type we are getting from API request to show in settings. * @param string $default_type Default post type (e.g., 'product', 'post', 'custom_post'). * @return bool True if matches, false otherwise. / private static function handle_post_type_rules( $rule_parts, $post_type, $default_type ) { switch ( $rule_parts[1] ?? '' ) { case 'all': if ( isset( $rule_parts[2] ) ) { switch ( $rule_parts[2] ) { case 'archive': return is_post_type_archive( $default_type ); case 'taxarchive': $taxonomy = $rule_parts[3] ?? ''; if ( 'category' === $taxonomy && 'post' !== $default_type ) { return is_category(); } if ( 'post_tag' === $taxonomy && 'post' !== $default_type ) { return is_tag(); } if ( is_tax( $taxonomy ) ) { return true; } return $post_type === $taxonomy; } } return is_singular( $default_type ) \|\| $post_type === $default_type; case 'archive': return is_post_type_archive( $default_type ); default: return false; } } /* * Check if Specific Item Matches * * Determines if a specific item (e.g., post ID or product ID) matches the current context. * * @param string $specific Specific item (e.g., post ID). * @param string $post_type Post type is the post_type we are getting from API request to show in settings. * @param int $post_id Post ID is from api request. * @return bool True if the specific item matches, false otherwise. / private static function matches_specific_item( $specific, $post_type, $post_id ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed $parsed_item = self::parse_specific_item( $specific ); if ( ! $parsed_item ) { return false; } $type = $parsed_item['type']; $id = $parsed_item['id']; if ( self::is_post_type( $type ) ) { return self::matches_post_type_item( $id, $post_id ); } if ( 'tax' === $type ) { return self::matches_taxonomy_item( $id, $parsed_item['parts'], $post_id ); } return false; } /* * Parse specific item string into components. * * @param string $specific Specific item string. * @return array{type: string, id: int, parts: array<int, string>}\|false Array with type, id, and parts or false if invalid. / private static function parse_specific_item( string $specific ) { $specific_parts = explode( '-', $specific ); if ( count( $specific_parts ) < 2 ) { return false; } return [ 'type' => $specific_parts[0], 'id' => (int) $specific_parts[1], 'parts' => $specific_parts, ]; } /* * Check if type is a valid post type. * * @param string $type Type to check. * @return bool True if valid post type. / private static function is_post_type( string $type ) { $post_type_array = [ 'post', 'page', 'product' ]; return in_array( $type, $post_type_array, true ); } /* * Check if post type item matches. * * @param int $id Item ID. * @param int $post_id Post ID from request. * @return bool True if matches. / private static function matches_post_type_item( int $id, int $post_id ) { global $post; if ( isset( $post ) ) { return (int) $id === $post->ID; } if ( ! empty( $post_id ) ) { return (int) $id === $post_id; } return false; } /* * Check if taxonomy item matches. * * @param int $id Term ID. * @param array<int, string> $parts Specific parts array. * @param int $post_id Post ID from request. * @return bool True if matches. / private static function matches_taxonomy_item( int $id, array $parts, int $post_id ): bool { // Check if post has the term (single context). if ( isset( $parts[2] ) && 'single' === $parts[2] ) { return self::post_has_term( $id, $post_id ); } // Check if on taxonomy archive page. if ( self::is_taxonomy_archive( $id ) ) { return true; } // Direct ID match. return $id === $post_id; } /* * Check if post has specific term. * * @param int $term_id Term ID. * @param int $post_id Post ID. * @return bool True if post has term. / private static function post_has_term( int $term_id, int $post_id ) { global $post; $term = get_term( $term_id ); if ( ! $term instanceof \WP_Term ) { return false; } $post_check_id = is_singular() ? $post->ID : $post_id; if ( ! $post_check_id ) { return false; } return has_term( $term_id, $term->taxonomy, $post_check_id ) && (int) $term_id === $term->term_id; } /* * Check if current page is taxonomy archive with specific ID. * * @param int $term_id Term ID to check. * @return bool True if on matching taxonomy archive. */ private static function is_taxonomy_archive( int $term_id ) { if ( ! ( is_tax() \|\| is_category() \|\| is_tag() ) ) { return false; } $queried_object = get_queried_object(); return $queried_object instanceof \WP_Term && $term_id === $queried_object->term_id; } }	15.02 KB	2025-10-27 18:36
📄 variables.php <?php /** * Variables * * This file handles functionality for all schema variables. * * @package SureRank * @since 1.0.0 / namespace SureRank\Inc\Schema; use SureRank\Inc\Traits\Get_Instance; use WP_Term; /* * Class Variables * * Handles the functionality for all schema variables. * * @package SureRank\Inc\Schema * @since 1.0.0 / class Variables { use Get_Instance; /* * Schema variables. * * @var mixed * @since 1.0.0 / private $variables = null; /* * Constructor * * Initializes the Variables class and sets up schema variables. * * @since 1.0.0 / public function __construct() { $taxonomies = Helper::get_instance()->get_taxonomies(); $options = []; foreach ( $taxonomies as $taxonomy ) { $key = Helper::get_instance()->normalize( $taxonomy['slug'] ); $options[ "%post.tax.{$key}%" ] = $taxonomy['name']; } $all_variables = array_merge( $options, $this->get_post_variables(), $this->get_term_variables(), $this->get_author_variables(), $this->get_user_variables(), $this->get_site_variables(), $this->get_current_page_variables(), $this->get_schema_links(), ); asort( $all_variables ); $this->variables = $all_variables; } /* * Get Schema Variables * * @return array<int, array<string, mixed>> Schema variables. / public function get_schema_variables() { return apply_filters( 'surerank_default_schema_variables', $this->variables ); } /* * Get Post Variables * * @return array<string, mixed> Post variables. / private function get_post_variables() { return [ '%post.title%' => __( 'Post Title', 'surerank' ), '%post.ID%' => __( 'Post ID', 'surerank' ), '%post.excerpt%' => __( 'Post Excerpt', 'surerank' ), '%post.content%' => __( 'Post Content', 'surerank' ), '%post.url%' => __( 'Post URL', 'surerank' ), '%post.slug%' => __( 'Post Slug', 'surerank' ), '%post.date%' => __( 'Post Date', 'surerank' ), '%post.modified_date%' => __( 'Post Modified Date', 'surerank' ), '%post.thumbnail%' => __( 'Post Thumbnail', 'surerank' ), '%post.comment_count%' => __( 'Post Comment Count', 'surerank' ), '%post.word_count%' => __( 'Post Word Count', 'surerank' ), '%post.tags%' => __( 'Post Tags', 'surerank' ), '%post.categories%' => __( 'Post Categories', 'surerank' ), ]; } /* * Get Term Variables * * @return array<string, mixed> Term variables. / private function get_term_variables() { $term = get_queried_object(); if ( ! $term instanceof WP_Term ) { return []; } return [ '%term.ID%' => __( 'Term ID', 'surerank' ), '%term.name%' => __( 'Term Name', 'surerank' ), '%term.slug%' => __( 'Term Slug', 'surerank' ), '%term.taxonomy%' => __( 'Term Taxonomy', 'surerank' ), '%term.description%' => __( 'Term Description', 'surerank' ), '%term.url%' => __( 'Term URL', 'surerank' ), ]; } /* * Get Author Variables * * @return array<string, mixed> Author variables. / private function get_author_variables() { return [ '%author.ID%' => __( 'Author ID', 'surerank' ), '%author.first_name%' => __( 'Author First Name', 'surerank' ), '%author.last_name%' => __( 'Author Last Name', 'surerank' ), '%author.display_name%' => __( 'Author Display Name', 'surerank' ), '%author.username%' => __( 'Author Username', 'surerank' ), '%author.nickname%' => __( 'Author Nickname', 'surerank' ), '%author.email%' => __( 'Author Email', 'surerank' ), '%author.website_url%' => __( 'Author Website URL', 'surerank' ), '%author.nicename%' => __( 'Author Nicename', 'surerank' ), '%author.description%' => __( 'Author Description', 'surerank' ), '%author.posts_url%' => __( 'Author Posts URL', 'surerank' ), '%author.avatar%' => __( 'Author Avatar', 'surerank' ), ]; } /* * Get User Variables * * @return array<string, mixed> User variables. / private function get_user_variables() { return [ '%user.ID%' => __( 'User ID', 'surerank' ), '%user.first_name%' => __( 'User First Name', 'surerank' ), '%user.last_name%' => __( 'User Last Name', 'surerank' ), '%user.display_name%' => __( 'User Display Name', 'surerank' ), '%user.username%' => __( 'User Username', 'surerank' ), '%user.nickname%' => __( 'User Nickname', 'surerank' ), '%user.email%' => __( 'User Email', 'surerank' ), '%user.website_url%' => __( 'User Website URL', 'surerank' ), '%user.nicename%' => __( 'User Nicename', 'surerank' ), '%user.description%' => __( 'User Description', 'surerank' ), '%user.posts_url%' => __( 'User Posts URL', 'surerank' ), '%user.avatar%' => __( 'User Avatar', 'surerank' ), ]; } /* * Get Site Variables * * @return array<string, mixed> Site variables. / private function get_site_variables() { return [ '%site.title%' => __( 'Site Title', 'surerank' ), '%site.description%' => __( 'Site Description', 'surerank' ), '%site.url%' => __( 'Site URL', 'surerank' ), '%site.language%' => __( 'Site Language', 'surerank' ), '%site.icon%' => __( 'Site Icon', 'surerank' ), ]; } /* * Get Current Page Variables * * @return array<string, mixed> Current page variables. / private function get_current_page_variables() { return [ '%current.title%' => __( 'Current Page Title', 'surerank' ), '%current.url%' => __( 'Current Page URL', 'surerank' ), ]; } /* * Get Schema Variables * * @return array<string, mixed> Schema links. * @since 1.0.0 / private function get_schema_links() { $active_schemas = Schemas::get_instance()->get_active_schemas(); $data = []; foreach ( $active_schemas as $schema ) { $type = strtolower( $schema['type'] ); $data[ "%schemas.{$type}%" ] = sprintf( / translators: %s is replaced with the schema type (e.g., "Product", "Article"). */ __( '%s Schema', 'surerank' ), $schema['type'] ); } return $data; } }	6.07 KB	2025-10-27 18:36

Terminal