format( $number ); } else { if ( $number % 100 >= 11 && $number % 100 <= 13 ) { $ordinal = $number . 'th'; } else { switch ( $number % 10 ) { case 1: $ordinal = $number . 'st'; break; case 2: $ordinal = $number . 'nd'; break; case 3: $ordinal = $number . 'rd'; break; default: $ordinal = $number . 'th'; break; } } return $ordinal; } } /** * Remove element from multi-dimensional array * * @param array $items The multi-dimensional array. * @param string $key The key of the element. * @param string $value The value of the element. * @return array */ function edac_remove_element_with_value( $items, $key, $value ) { foreach ( $items as $sub_key => $sub_array ) { if ( $sub_array[ $key ] === $value ) { unset( $items[ $sub_key ] ); } } return $items; } /** * Filter a multi-dimensional array * * @param array $items The multi-dimensional array. * @param string $index The index of the element. * @param string $value The element value to match. * @return array */ function edac_filter_by_value( $items, $index, $value ) { if ( is_array( $items ) && count( $items ) > 0 ) { foreach ( array_keys( $items ) as $key ) { $temp[ $key ] = $items[ $key ][ $index ]; if ( $temp[ $key ] === $value ) { $newarray[ $key ] = $items[ $key ]; } } } if ( isset( $newarray ) && is_array( $newarray ) && count( $newarray ) ) { return array_values( $newarray ); } return []; } /** * Get days plugin has been active * * @return int */ function edac_days_active() { $activation_date = get_option( 'edac_activation_date' ); if ( $activation_date ) { $diff = strtotime( $activation_date ) - strtotime( gmdate( 'Y-m-d H:i:s' ) ); return abs( round( $diff / 86400 ) ); } return 0; } /** * Custom Post Types * * Returns only non-built-in post types that are publicly viewable, meaning * both public and publicly_queryable are true. Post types that redirect * frontend requests (publicly_queryable = false) are excluded so they do * not appear as scan targets in settings. * * @return array */ function edac_custom_post_types() { $args = [ 'public' => true, 'publicly_queryable' => true, '_builtin' => false, ]; $output = 'names'; // names or objects, note names is the default. $operator = 'and'; // Options 'and' or 'or'. return get_post_types( $args, $output, $operator ); } /** * Available Post Types * * @return array */ function edac_post_types() { /** * Filter the post types that the plugin will check. * * @since 1.4.0 * * @param array $post_types post types. */ $post_types = apply_filters( 'edac_filter_post_types', [ 'post', 'page' ] ); if ( ! is_array( $post_types ) ) { $post_types = [ $post_types ]; } // remove duplicates. $post_types = array_unique( $post_types ); // validate post types. foreach ( $post_types as $key => $post_type ) { if ( ! post_type_exists( $post_type ) ) { unset( $post_types[ $key ] ); } } return $post_types; } /** * Retrieve a human readable post type label. * * @param string $post_type Post type slug. * @return string */ function edac_get_post_type_label( string $post_type ): string { $post_type = sanitize_key( (string) $post_type ); if ( '' === $post_type ) { return ''; } $post_type_object = get_post_type_object( $post_type ); if ( $post_type_object instanceof \WP_Post_Type && ! empty( $post_type_object->labels->name ) ) { return $post_type_object->labels->name; } return ucfirst( $post_type ); } /** * This function validates a table name against WordPress naming conventions and checks its existence in the database. * * The function first checks if the provided table name only contains alphanumeric characters, underscores, or hyphens. * If not, it returns null. * * After that, it checks if a table with that name actually exists in the database using the SHOW TABLES LIKE query. * If the table doesn't exist, it also returns null. * * If both checks are passed, it returns the valid table name. * * @param string $table_name The name of the table to be validated. * * @return string|null The validated table name, or null if the table name is invalid or the table does not exist. */ function edac_get_valid_table_name( $table_name ) { global $wpdb; static $found_table_name; if ( isset( $found_table_name ) ) { return $found_table_name; } // Check if table name only contains alphanumeric characters, underscores, or hyphens. if ( ! preg_match( '/^[a-zA-Z0-9_\-]+$/', $table_name ) ) { // Invalid table name. return null; } // Verify that the table actually exists in the database. // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching if ( $wpdb->get_var( $wpdb->prepare( 'SHOW TABLES LIKE %s', $table_name ) ) !== $table_name ) { // Table does not exist. return null; } $found_table_name = $table_name; return $found_table_name; } /** * Upcoming meetups in json format * * @param string $meetup meetup name. * @param integer $count number of meetups to return. * @return array */ function edac_get_upcoming_meetups_json( $meetup, $count = 5 ) { if ( empty( $meetup ) || ! is_string( $meetup ) ) { return []; } // Min of 1 and max of 25. $count = absint( max( 1, min( 25, $count ) ) ); // Sanitize meetup name for both cache key and GraphQL query to prevent injection. $sanitized_meetup = sanitize_title( $meetup ); $key = '_upcoming_meetups__' . $sanitized_meetup . '__' . (int) $count; $stale_key = $key . '__stale'; $cached_value = get_transient( $key ); if ( false !== $cached_value ) { return is_array( $cached_value ) ? $cached_value : []; } $output = []; $request_uri = 'https://api.meetup.com/gql-ext'; $query = ' query Group { groupByUrlname(urlname: "' . $sanitized_meetup . '") { events(first: ' . (int) $count . ') { totalCount edges { node { dateTime eventUrl id title } } } } }'; $request = wp_remote_post( $request_uri, [ 'headers' => [ 'Content-Type' => 'application/json', ], 'timeout' => 10, // phpcs:ignore WordPressVIPMinimum.Performance.RemoteRequestTimeout.timeout_timeout -- Timeout set for external request. 'body' => wp_json_encode( [ 'query' => $query, ] ), ] ); if ( ! is_wp_error( $request ) && 200 === (int) wp_remote_retrieve_response_code( $request ) ) { $response_body = json_decode( wp_remote_retrieve_body( $request ) ); $edges = null; if ( is_object( $response_body ) && isset( $response_body->data->groupByUrlname->events->edges ) ) { $edges = $response_body->data->groupByUrlname->events->edges; } if ( is_array( $edges ) ) { foreach ( $edges as $edge ) { if ( ! isset( $edge->node ) ) { continue; } $event = $edge->node; // phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL response uses camelCase. if ( empty( $event->title ) || empty( $event->dateTime ) || empty( $event->eventUrl ) || empty( $event->id ) ) { continue; } $timestamp = strtotime( (string) $event->dateTime ); if ( false === $timestamp ) { continue; } $event_data = new stdClass(); $event_data->name = (string) $event->title; $event_data->time = $timestamp * 1000; // Convert to milliseconds to match old format. $event_data->link = (string) $event->eventUrl; $event_data->id = (string) $event->id; // phpcs:enable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase. $output[] = $event_data; } } } if ( ! empty( $output ) ) { set_transient( $key, $output, DAY_IN_SECONDS ); update_option( $stale_key, $output, false ); return $output; } $stale_value = get_option( $stale_key ); if ( is_array( $stale_value ) && ! empty( $stale_value ) ) { // Serve stale data for a short window while retrying upstream requests periodically. set_transient( $key, $stale_value, HOUR_IN_SECONDS ); return $stale_value; } return []; } /** * Upcoming meetups in html * * @param string $meetup meetup name. * @param integer $count number of meetups to return. * @param string $heading heading level. * @return string */ function edac_get_upcoming_meetups_html( $meetup, $count = 5, $heading = '3' ) { $json = edac_get_upcoming_meetups_json( $meetup, $count ); if ( empty( $json ) ) { return ''; } $html = ''; return $html; } /** * Calculate the issue density * * @param int $issue_count number of issues. * @param int $element_count number of elements. * @param int $content_length length of content. * @return int */ function edac_get_issue_density( $issue_count, $element_count, $content_length ) { if ( $element_count < 1 || $content_length < 1 ) { return 0; } $element_weight = .8; $content_weight = .2; $error_elements_percentage = $issue_count / $element_count; $error_content_percentage = $issue_count / $content_length; $score = ( ( $error_elements_percentage * $element_weight ) + ( $error_content_percentage * $content_weight ) ); return round( $score * 100, 2 ); } /** * Get simplified summary * * @param integer $post Post ID. * @return void */ function edac_get_simplified_summary( $post = null ) { if ( null === $post ) { $post = get_the_ID(); } if ( null === $post ) { return; } echo wp_kses_post( ( new \EDAC\Inc\Simplified_Summary() )->simplified_summary_markup( $post ) ); } /** * Get Post Count by available custom post types * * @return mixed */ function edac_get_posts_count() { $output = []; $post_types = Settings::get_scannable_post_types(); if ( $post_types ) { foreach ( $post_types as $post_type ) { $counts = wp_count_posts( $post_type ); if ( $counts ) { foreach ( $counts as $key => $value ) { // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual if ( 0 == $value ) { unset( $counts->{$key} ); } } } if ( $counts ) { $array = []; foreach ( $counts as $key => $value ) { $array[] = $key . ' = ' . $value; } if ( $array ) { $output[] = $post_type . ': ' . implode( ', ', $array ); } } } } if ( $output ) { return implode( ', ', $output ); } return false; } /** * Get Raw Global Error Count * * @return array */ function edac_get_error_count() { global $wpdb; // Define a unique cache key for our data. $cache_key = 'edac_errors_' . get_current_blog_id(); $stored_errors = wp_cache_get( $cache_key ); // Check if the result exists in the cache. if ( false === $stored_errors ) { // If not, perform the database query. $table_name = $wpdb->prefix . 'accessibility_checker'; // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery $stored_errors = (int) $wpdb->get_var( $wpdb->prepare( 'SELECT count(*) FROM %i WHERE siteid = %d AND ruletype = %s', $table_name, get_current_blog_id(), 'error' ) ); // Save the result in the cache for future use. wp_cache_set( $cache_key, $stored_errors ); } return $stored_errors; } /** * Get Raw Global Warning Count * * @return array Array of. */ function edac_get_warning_count() { global $wpdb; // Define a unique cache key for our data. $cache_key = 'edac_warnings_' . get_current_blog_id(); $stored_warnings = wp_cache_get( $cache_key ); // Check if the result exists in the cache. if ( false === $stored_warnings ) { // If not, perform the database query. $table_name = $wpdb->prefix . 'accessibility_checker'; // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery $stored_warnings = (int) $wpdb->get_var( $wpdb->prepare( 'SELECT count(*) FROM %i WHERE siteid = %d AND ruletype = %s', $table_name, get_current_blog_id(), 'warning' ) ); // Save the result in the cache for future use. wp_cache_set( $cache_key, $stored_warnings ); } return $stored_warnings; } /** * Get Database Table Count * * @param string $table Database table. * @return int */ function edac_database_table_count( $table ) { global $wpdb; // Create a unique cache key based on the table's name. $cache_key = 'edac_table_count_' . $table; // Try to get the count from the cache first. $count = wp_cache_get( $cache_key ); if ( false === $count ) { // If the count is not in the cache, perform the database query. // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery $count = $wpdb->get_var( $wpdb->prepare( 'SELECT count(*) FROM %i', $wpdb->prefix . $table ) ); // Save the count to the cache for future use. wp_cache_set( $cache_key, $count ); } return $count; } /** * Generate a summary statistic list item. * * @since 1.14.0 * * @param string $item_class The base CSS class for the list item. * @param int $count The count of items to display. * @param string $label The translated label with count included. * @param string $icon_name Icon name passed to edac_icon(). Default 'error'. * * @return string The generated HTML list item. */ function edac_generate_summary_stat( string $item_class, int $count, string $label, string $icon_name = 'error' ): string { $has_error_class = ( $count > 0 ) ? ' has-errors' : ''; return '
  • ' . $count . ' ' . $label . ' ' . edac_icon( $icon_name ) . '
    • '; } /** * Generate links to pro page with some params. * * @param array $query_args A list of key value pairs to add as query vars to the link. * @param string $type The type of link to generate. Default is 'pro'. * @param array $args Additional arguments to pass on the link. * @return string */ function edac_generate_link_type( $query_args = [], $type = 'pro', $args = [] ): string { if ( ! is_array( $query_args ) ) { $query_args = []; } if ( ! is_array( $args ) ) { $args = []; } $date_now = new DateTime( gmdate( 'Y-m-d H:i:s' ) ); $activation_date = new DateTime( get_option( 'edac_activation_date', gmdate( 'Y-m-d H:i:s' ) ) ); $interval = $date_now->diff( $activation_date ); $days_active = $interval->days; $query_defaults = [ 'utm_source' => 'accessibility-checker', 'utm_medium' => 'software', 'utm_campaign' => 'wordpress-general', 'php_version' => PHP_VERSION, 'platform' => 'wordpress', 'platform_version' => $GLOBALS['wp_version'], 'software' => edac_is_pro() ? 'pro' : 'free', 'software_version' => defined( 'EDACP_VERSION' ) ? EDACP_VERSION : EDAC_VERSION, 'days_active' => $days_active, ]; // Add the ref parameter if one is set via filter. $ref = apply_filters( 'edac_filter_generate_link_type_ref', '' ); if ( ! empty( $ref ) && is_string( $ref ) ) { $query_args['ref'] = $ref; } $query_args = array_merge( $query_defaults, $query_args ); switch ( $type ) { case 'help': $base_link = trailingslashit( 'https://a11ychecker.com/help' . ( $args['help_id'] ?? '' ) ); break; case 'custom': // phpcs:ignore -- intentially only breaking inside the condition because if it's not set we want to hit default. if ( ! empty( $args['base_link'] ) ) { $base_link = $args['base_link']; break; } case 'pro': default: $base_link = 'https://equalizedigital.com/accessibility-checker/pricing/'; break; } return add_query_arg( $query_args, $base_link ); } /** * Echo or return a link with some utms. * * This is just a simplified wrapper around `edac_generate_link_type` to generate a link with UTM parameters. * * @param string $base_url the base URL to which UTM parameters will be added. * @param string $campaign the UTM campaign name, optional. * @param string $content the UTM content name, optional. * @param bool $directly_echo whether to echo the link or return it. Default is true. * * @return void|string */ function edac_link_wrapper( $base_url, $campaign = '', $content = '', $directly_echo = true ) { if ( empty( $base_url ) || ! is_string( $base_url ) ) { return; } $params = []; if ( ! empty( $campaign ) ) { $params['utm_campaign'] = $campaign; } if ( ! empty( $content ) ) { $params['utm_content'] = $content; } $link = edac_generate_link_type( $params, 'custom', [ 'base_link' => $base_url ] ); if ( ! $directly_echo ) { return $link; } echo esc_url( $link ); } /** * Check if WooCommerce is enabled. * * This just checks for existence of the main WooCommerce function and class. * * @return bool */ function edac_is_woocommerce_enabled() { return function_exists( 'WC' ) && class_exists( 'WooCommerce' ); } /** * Check if a given post id is the WooCommerce checkout page. * * @param int $post_id The post ID to check. * @return bool */ function edac_check_if_post_id_is_woocommerce_checkout_page( $post_id ) { if ( ! edac_is_woocommerce_enabled() ) { return false; } return wc_get_page_id( 'checkout' ) === $post_id; } /** * Parse HTML content to extract image or SVG elements * * @param string $html The HTML content to parse. * @return array Array containing 'img' (string) and 'svg' (string) keys. */ function edac_parse_html_for_media( $html ) { if ( empty( $html ) ) { return [ 'img' => null, 'svg' => null, ]; } // Decode HTML entities before processing. $decoded_html = html_entity_decode( $html, ENT_QUOTES | ENT_HTML5 ); // Early return if no media tags found. if ( stripos( $decoded_html, ' null, 'svg' => null, ]; } // More specific img tag regex pattern. if ( preg_match( '/]+src=([\'"])(.*?)\1[^>]*>/i', $decoded_html, $matches ) ) { return [ 'img' => $matches[2] ?? null, 'svg' => null, ]; } // SVG pattern remains the same. if ( preg_match( '/]*>.*?<\/svg>/is', $decoded_html, $matches ) ) { return [ 'img' => null, 'svg' => $matches[0], ]; } return [ 'img' => null, 'svg' => null, ]; } /** * Remove corrected posts * * @param int $post_ID The ID of the post. * @param string $type The type of the post. * @param int $pre The flag indicating the removal stage (1 for before validation php based rules, 2 for after validation). * @param string $ruleset The type of the ruleset to correct (php or js). For backwards compatibility, defaults to 'php'. * * @return void */ function edac_remove_corrected_posts( $post_ID, $type, $pre = 1, $ruleset = 'php' ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed, VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- $ruleset is for backwards compatibility. global $wpdb; $rules = edac_register_rules(); if ( 0 === count( $rules ) ) { return; } $sql = 1 === $pre ? "UPDATE {$wpdb->prefix}accessibility_checker SET recordcheck = %d WHERE siteid = %d AND postid = %d AND type = %s" : "DELETE FROM {$wpdb->prefix}accessibility_checker WHERE recordcheck = %d AND siteid = %d AND postid = %d AND type = %s"; // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Using direct query for adding data to database, caching not required for one time operation. $wpdb->query( $wpdb->prepare( $sql, // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQL.NotPrepared 0, get_current_blog_id(), $post_ID, $type ) ); } /** * Get the canonical landmark detection rules the scanner uses to populate the * `landmark` database column. * * This is the single source of truth mirrored by `LANDMARK_TAGS`, * `LANDMARK_ROLES`, `CONDITIONAL_LANDMARK_TAGS`, and * `CONDITIONAL_LANDMARK_ROLES` in `src/pageScanner/index.js`. Tag names stay * uppercase to match `Element.tagName`; role names stay lowercase to match * the already-lowercased `role` attribute the scanner compares against. * * Tag-detected and role-detected landmarks are NOT normalized to a shared * value even when conceptually the same landmark — e.g. a `