File "class-common.php"

Full Path: /home/diablzlo/glucosebalnce.com/wp-content/plugins/seo-by-rank-math-pro/includes/class-common.php
File size: 9.03 KB
MIME-type: text/x-php
Charset: utf-8

<?php
/**
 * Miscellaneous functions.
 *
 * @since      1.0
 * @package    RankMathPro
 * @subpackage RankMathPro\Admin
 * @author     Rank Math <support@rankmath.com>
 */

namespace RankMathPro;

use RankMath\Traits\Hooker;
use RankMath\Helper;
use RankMath\Helpers\Url;
use RankMath\Helpers\Str;
use RankMath\Helpers\Arr;
use RankMath\Helpers\Param;
use RankMath\Admin\Admin_Helper;
use RankMath\Schema\DB;
use RankMathPro\Admin\Admin_Helper as PROAdminHelper;


defined( 'ABSPATH' ) || exit;

/**
 * Admin class.
 *
 * @codeCoverageIgnore
 */
class Common {

	use Hooker;

	/**
	 * Register hooks.
	 */
	public function __construct() {
		$this->action( 'rank_math/admin_bar/items', 'add_admin_bar_items' );
		$this->filter( 'rank_math/focus_keyword/maxtags', 'limit_maxtags', 5 );
		$this->filter( 'rank_math/metabox/values', 'add_json_data' );
		$this->filter( 'wp_helpers_is_affiliate_link', 'is_affiliate_link', 10, 2 );
		$this->filter( 'rank_math/link/add_attributes', 'can_add_attributes' );

		$this->filter( 'rank_math/researches/tests', 'add_product_tests', 10, 2 );
		$this->filter( 'rank_math/recalculate_score/data', 'seo_score_tool_values', 10, 2 );
		$this->action( 'rank_math/admin/editor_scripts', 'enqueue' );
		$this->filter( 'rank_math/determine_search_intent', 'determine_search_intent', 9 );
	}

	/**
	 * Increase the focus keyword max tags.
	 */
	public function limit_maxtags() {
		return 100;
	}

	/**
	 * Add Pinterest Rich Pins Validator to the top admin bar.
	 *
	 * @param object $menu_object The Admin_Bar_Menu object.
	 */
	public function add_admin_bar_items( $menu_object ) {
		$url = rawurlencode( Url::get_current_url() );
		$menu_object->add_sub_menu(
			'rich-pins',
			[
				'title' => esc_html__( 'Rich Pins Validator', 'rank-math-pro' ),
				'href'  => 'https://developers.pinterest.com/tools/url-debugger/?link=' . $url,
				'meta'  => [
					'title'  => esc_html__( 'Pinterest Debugger', 'rank-math-pro' ),
					'target' => '_blank',
				],
			],
			'third-party'
		);
	}

	/**
	 * Add settings in the Advanced tab of the metabox.
	 *
	 * @param array $values Localized data.
	 */
	public function add_json_data( $values ) {

		if ( ! Helper::is_site_connected() ) {
			$values['trendsIcon']         = $this->get_icon_svg();
			$values['trendsUpgradeLink']  = esc_url_raw( admin_url( 'admin.php?page=rank-math&view=help' ) );
			$values['trendsUpgradeLabel'] = esc_html__( 'Activate now', 'rank-math-pro' );
		}

		if (
			Helper::is_woocommerce_active() &&
			( 'product' === PROAdminHelper::get_current_post_type() || Param::get( 'page' ) === 'rank-math-status' )
		) {
			$values['assessor']['isReviewEnabled'] = 'yes' === get_option( 'woocommerce_enable_reviews', 'yes' );
		}

		$values['searchIntents'] = PROAdminHelper::get_search_intent();

		return $values;
	}

	/**
	 * Checks whether a link is an affiliate link.
	 *
	 * @param string $is_affiliate Is affiliate link.
	 * @param string $url          Anchor link.
	 *
	 * @return string
	 */
	public function is_affiliate_link( $is_affiliate, $url ) {
		$url      = str_replace( home_url(), '', $url );
		$prefixes = Arr::from_string( Helper::get_settings( 'general.affiliate_link_prefixes' ), "\n" );

		if ( empty( $url ) || empty( $prefixes ) ) {
			return $is_affiliate;
		}

		foreach ( $prefixes as $prefix ) {
			if ( Str::starts_with( $prefix, trim( $url ) ) ) {
				$is_affiliate = true;
				break;
			}
		}

		return $is_affiliate;
	}

	/**
	 * Run a fucntion to add sponsored rel tag to the affiliate links.
	 *
	 * @param bool $value Whether to run the function to add link attributes.
	 */
	public function can_add_attributes( $value ) {
		$prefixes = Arr::from_string( Helper::get_settings( 'general.affiliate_link_prefixes' ), "\n" );
		return ! empty( $prefixes ) ? true : $value;
	}

	/**
	 * Remove few tests on static Homepage.
	 *
	 * @since 3.0.7
	 *
	 * @param array  $tests Array of tests with score.
	 * @param string $type  Object type. Can be post, user or term.
	 */
	public function add_product_tests( $tests, $type ) {
		if ( 'post' !== $type ) {
			return $tests;
		}

		$post_type      = PROAdminHelper::get_current_post_type();
		$is_woocommerce = Helper::is_woocommerce_active() && 'product' === $post_type;
		$is_edd         = Helper::is_edd_active() && 'download' === $post_type;

		if ( ! $is_woocommerce && ! $is_edd ) {
			return $tests;
		}

		$exclude_tests = [
			'keywordInSubheadings' => true,
			'linksHasExternals'    => true,
			'linksNotAllExternals' => true,
			'linksHasInternal'     => true,
			'titleSentiment'       => true,
			'titleHasNumber'       => true,
			'contentHasTOC'        => true,
		];

		$tests = array_diff_assoc( $tests, $exclude_tests );

		$tests['hasProductSchema'] = true;
		if ( $is_woocommerce ) {
			$tests['isReviewEnabled'] = true;
		}

		return $tests;
	}

	/**
	 * Update the values used in the Update SEO Score Database Tools.
	 *
	 * @since 3.0.81
	 *
	 * @param array  $values  Values used in Content analysis.
	 * @param string $post_id Post ID.
	 */
	public function seo_score_tool_values( $values, $post_id ) {
		$post_type      = get_post_type( $post_id );
		$is_woocommerce = Helper::is_woocommerce_active() && 'product' === $post_type;
		$is_edd         = Helper::is_edd_active() && 'download' === $post_type;
		if ( ! $is_woocommerce && ! $is_edd ) {
			return $values;
		}

		$values['isProduct'] = true;
		$schemas             = DB::get_schemas( $post_id );
		if ( empty( $schemas ) && Helper::get_default_schema_type( $post_id ) ) {
			$schemas = [
				[ '@type' => Helper::get_default_schema_type( $post_id ) ],
			];
		}

		$schemas = array_filter(
			$schemas,
			function ( $schema ) {
				return in_array( $schema['@type'], [ 'WooCommerceProduct', 'EDDProduct', 'Product' ], true );
			}
		);

		$values['schemas'] = $schemas;
		$values['content'] = $is_woocommerce ? $this->add_product_gallery_images( $post_id, $values['content'] ) : $values['content'];

		return $values;
	}

	/**
	 * Enqueue script to analyze product data.
	 *
	 * @since 3.0.7
	 */
	public function enqueue() {
		if ( ! Admin_Helper::is_post_edit() ) {
			return;
		}

		$post_type      = PROAdminHelper::get_current_post_type();
		$is_woocommerce = Helper::is_woocommerce_active() && 'product' === $post_type;
		$is_edd         = Helper::is_edd_active() && 'download' === $post_type;

		if ( ! $is_woocommerce && ! $is_edd ) {
			return;
		}

		wp_enqueue_script( 'rank-math-gallery-analysis', RANK_MATH_PRO_URL . 'assets/admin/js/product-analysis.js', [ 'rank-math-editor' ], rank_math_pro()->version, true );
	}

	/**
	 * Whether to add the Keyword Intent.
	 */
	public function determine_search_intent() {
		return Helper::get_settings( 'general.determine_search_intent', true );
	}

	/**
	 * Pass Product gallery images to the Update SEO Score tool.
	 *
	 * @param int    $post_id    Post ID.
	 * @param string $content Post content.
	 *
	 * @since 3.0.81
	 */
	private function add_product_gallery_images( $post_id, $content ) {
		$product = wc_get_product( $post_id );
		if ( empty( $product ) ) {
			return $content;
		}

		$attachment_ids = $product->get_gallery_image_ids();
		if ( empty( $attachment_ids ) ) {
			return $content;
		}

		foreach ( $attachment_ids as $attachment_id ) {
			$content .= wp_get_attachment_image( $attachment_id );
		}

		return $content;
	}

	/**
	 * Get Trends icon <svg> element.
	 *
	 * @return string
	 */
	private function get_icon_svg() {
		return '<svg width="100%" height="100%" viewBox="0 0 36 36" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" fit="" preserveAspectRatio="xMidYMid meet" focusable="false">
		<g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
			<g id="Trends-Arrow">
				<g id="TrendsArrow">
					<path d="M1.11227159,26.3181534 L10.2875029,17.1429221 L13.7152617,20.5706809 L4.5400304,29.7459122 C4.20518633,30.0807563 3.66229681,30.0807562 3.32745277,29.7459122 L1.11136262,27.529822 C0.776518575,27.194978 0.776518548,26.6520885 1.11136262,26.3172444 L1.11227159,26.3181534 Z" id="Shape" fill="#4285F4" fill-rule="nonzero"></path>
					<path d="M14.3201543,14.3211528 L22.283717,22.2847155 L19.4658829,25.1025495 C19.1310388,25.4373936 18.5881494,25.4373937 18.2533053,25.1025495 L10.2906516,17.1398959 L13.1084857,14.3220618 C13.4429747,13.987572 13.9851638,13.9871653 14.3201543,14.3211528 Z" id="Shape" fill="#EA4335" fill-rule="nonzero"></path>
					<polygon id="Rectangle-path" fill="#FABB05" fill-rule="nonzero" points="18.8573051 18.8577571 28.2843236 9.43073862 31.7120824 12.8584974 22.2850639 22.2855159"></polygon>
					<path d="M35.0711567,15.5054713 L35.0711567,7 L35.0711567,7 C35.0711567,6.44771525 34.6234415,6 34.0711567,6 L25.5656854,6 L25.5656854,6 C25.0134007,6 24.5656854,6.44771525 24.5656854,7 C24.5656854,7.26521649 24.6710423,7.5195704 24.8585786,7.70710678 L33.3640499,16.2125781 L33.3640499,16.2125781 C33.7545742,16.6031024 34.3877392,16.6031024 34.7782635,16.2125781 C34.9657999,16.0250417 35.0711567,15.7706878 35.0711567,15.5054713 Z" id="Shape" fill="#34A853" fill-rule="nonzero"></path>
					<rect id="Rectangle-path" x="0" y="0" width="36" height="36"></rect>
				</g>
			</g>
		</g>
	</svg>';
	}
}