You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

246 lines
6.4 KiB
PHTML

<?php
/**
* Global functionality of the plugin.
*
* Defines the functionality loaded both on admin and frontend.
*
* @since 0.9.0
* @package RankMath
* @subpackage RankMath\Core
* @author Rank Math <support@rankmath.com>
*/
namespace RankMath;
use RankMath\Traits\Ajax;
use RankMath\Traits\Meta;
use RankMath\Traits\Hooker;
use RankMath\Helpers\Str;
defined( 'ABSPATH' ) || exit;
/**
* Common class.
*/
class Common {
use Hooker, Ajax, Meta;
/**
* Constructor method.
*/
public function __construct() {
$this->action( 'loginout', 'nofollow_link' );
$this->filter( 'register', 'nofollow_link' );
// Change Permalink for primary term.
$this->filter( 'post_type_link', 'post_type_link', 9, 2 );
$this->filter( 'post_link_category', 'post_link_category', 10, 3 );
// Reorder categories listing: put primary at the beginning.
$this->filter( 'get_the_terms', 'reorder_the_terms', 10, 3 );
$this->filter( 'is_protected_meta', 'hide_rank_math_meta', 10, 2 );
$this->action( 'rank_math/admin/before_editor_scripts', 'editor_script' );
new Auto_Updater();
new Update_Email();
new Defaults();
new Admin_Bar_Menu();
new Dashboard_Widget();
new Thumbnail_Overlay();
}
/**
* Enqueue common editor script to use in all editors.
*/
public function editor_script() {
wp_register_script(
'rank-math-app',
rank_math()->plugin_url() . 'assets/admin/js/rank-math-app.js',
[],
rank_math()->version,
true
);
}
/**
* Add rel="nofollow" to a link.
*
* @param string $link Link.
*
* @return string
*/
public function nofollow_link( $link ) {
// Check if link is nofollow already.
if ( strpos( $link, ' rel="nofollow"' ) || strpos( $link, " rel='nofollow'" ) ) {
return $link;
}
return str_replace( '<a ', '<a rel="nofollow" ', $link );
}
/**
* Filters the category that gets used in the %category% permalink token.
*
* @param WP_Term $term The category to use in the permalink.
* @param array $terms Array of all categories (WP_Term objects) associated with the post.
* @param WP_Post $post The post in question.
*
* @return WP_Term
*/
public function post_link_category( $term, $terms, $post ) {
$primary_term = $this->get_primary_term( $term->taxonomy, $post->ID );
if ( false === $primary_term ) {
return $term;
}
$term_ids = array_column( $terms, 'term_id' );
if ( ! is_object( $primary_term ) || ! in_array( $primary_term->term_id, $term_ids, true ) ) {
return $term;
}
return $primary_term;
}
/**
* Filters the permalink for a post of a custom post type.
*
* @param string $post_link The post's permalink.
* @param WP_Post $post The post in question.
*
* @return string
*/
public function post_type_link( $post_link, $post ) {
$taxonomies = Helper::get_object_taxonomies( $post->post_type, 'objects' );
$taxonomies = wp_filter_object_list( $taxonomies, [ 'hierarchical' => true ], 'and', 'name' );
foreach ( $taxonomies as $taxonomy ) {
$this->sanitize_post_type_link( $post_link, $post, $taxonomy );
}
return $post_link;
}
/**
* Reorder terms for a post to put primary category to the beginning.
*
* @param array|WP_Error $terms List of attached terms, or WP_Error on failure.
* @param int $post_id Post ID.
* @param string $taxonomy Name of the taxonomy.
*
* @return array
*/
public function reorder_the_terms( $terms, $post_id, $taxonomy ) {
if ( empty( $terms ) || is_wp_error( $terms ) ) {
return $terms;
}
/**
* Filter: Allow disabling the primary term feature.
* 'rank_math/primary_term' is deprecated,
* use 'rank_math/admin/disable_primary_term' instead.
*
* @param bool $return True to disable.
*/
if ( true === apply_filters_deprecated( 'rank_math/primary_term', [ false ], '1.0.43', 'rank_math/admin/disable_primary_term' )
|| true === $this->do_filter( 'admin/disable_primary_term', false ) ) {
return $terms;
}
$post_id = empty( $post_id ) ? $GLOBALS['post']->ID : $post_id;
// Get Primary Term.
$primary = absint( Helper::get_post_meta( "primary_{$taxonomy}", $post_id ) );
if ( ! $primary ) {
return $terms;
}
$primary_term = null;
foreach ( $terms as $index => $term ) {
if ( $primary === $term->term_id ) {
$primary_term = $term;
unset( $terms[ $index ] );
array_unshift( $terms, $primary_term );
break;
}
}
return $terms;
}
/**
* Hide rank math meta keys
*
* @param bool $protected Whether the key is considered protected.
* @param string $meta_key Meta key.
*
* @return bool
*/
public function hide_rank_math_meta( $protected, $meta_key ) {
return Str::starts_with( 'rank_math_', $meta_key ) ? true : $protected;
}
/**
* Filters the permalink for a post of a custom post type.
*
* @param string $post_link The post's permalink.
* @param WP_Post $post The post in question.
* @param object $taxonomy The post taxonomy.
*/
private function sanitize_post_type_link( &$post_link, $post, $taxonomy ) {
$find = "%{$taxonomy}%";
if ( ! Str::contains( $find, $post_link ) ) {
return;
}
$primary_term = $this->get_primary_term( $taxonomy, $post->ID );
if ( false !== $primary_term ) {
// Get the hierachical terms.
$parents = $this->get_hierarchical_link( $primary_term );
// Replace the placeholder rewrite tag with hierachical terms.
$post_link = str_replace( $find, $parents, $post_link );
}
}
/**
* Get chain of hierarchical links.
*
* @param WP_Term $term The term in question.
*
* @return string
*/
private function get_hierarchical_link( $term ) {
if ( is_wp_error( $term ) ) {
return $term->slug;
}
$chain = [];
$name = $term->slug;
if ( $term->parent && ( $term->parent !== $term->term_id ) ) {
$chain[] = $this->get_hierarchical_link( get_term( $term->parent, $term->taxonomy ) );
}
$chain[] = $name;
return implode( '/', $chain );
}
/**
* Get primary term of the post.
*
* @param string $taxonomy Taxonomy name.
* @param int $post_id Post ID.
*
* @return object|false Primary term on success, false if there are no terms, WP_Error on failure.
*/
private function get_primary_term( $taxonomy, $post_id ) {
$primary = Helper::get_post_meta( "primary_{$taxonomy}", $post_id );
if ( ! $primary ) {
return false;
}
$primary = get_term( $primary, $taxonomy );
return is_wp_error( $primary ) || empty( $primary ) ? false : $primary;
}
}