File "class-thumbnail-overlays.php"
Full Path: /home/diablzlo/glucosebalnce.com/wp-content/plugins/seo-by-rank-math-pro/includes/class-thumbnail-overlays.php
File size: 16.35 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/**
* Social thumbnail overlays.
*
* @since 1.0
* @package RankMathPro
* @subpackage RankMathPro\Admin
* @author Rank Math <support@rankmath.com>
*/
namespace RankMathPro;
use RankMath\Helper;
use RankMath\Helpers\Str;
use RankMath\Helpers\Param;
use RankMath\Traits\Hooker;
defined( 'ABSPATH' ) || exit;
/**
* Admin class.
*
* @method get_pt_default()
* @codeCoverageIgnore
*/
class Thumbnail_Overlays {
use Hooker;
/**
* Register hooks.
*/
public function __construct() {
$this->filter( 'rank_math/social/overlay_images', 'add_custom_overlays' );
$this->filter( 'rank_math/settings/sanitize_fields', 'sanitize_fields', 10, 3 );
$this->filter( 'rank_math/social/overlay_image_position', 'apply_overlay_position', 20, 2 );
$this->filter( 'rank_math/social/overlay_image_positions', 'get_position_margins', 20, 4 );
$this->action( 'cmb2_admin_init', 'cmb_init' );
$this->filter( 'cmb2_default_filter', 'get_cmb_default', 20, 2 );
$this->filter( 'default_post_metadata', 'get_postmeta_default', 10, 3 );
$this->filter( 'default_term_metadata', 'get_termmeta_default', 10, 3 );
$this->filter( 'default_user_metadata', 'get_usermeta_default', 10, 3 );
$this->action( 'admin_init', 'enqueue', 20 );
}
/**
* Apply position for custom overlays.
*
* @param string $position Original position.
* @param string $type Overlay type.
*
* @return string New position.
*/
public function apply_overlay_position( $position, $type ) {
$custom_overlays = $this->get_custom_overlays();
if ( empty( $custom_overlays ) ) {
return $position;
}
foreach ( $custom_overlays as $overlay ) {
$id = sanitize_title( $overlay['name'], md5( $overlay['name'] ) );
if ( $id === $type ) {
return $overlay['position'];
}
}
return $position;
}
/**
* Calculate margins for new position values.
*
* @param array $margins Original margins array.
* @param resource $image GD image resource identifier.
* @param resource $stamp GD image resource identifier.
* @param string $module PHP module used for the image manipulation ('gd' or 'imagick').
*
* @return array
*/
public function get_position_margins( $margins, $image, $stamp, $module ) {
$method = 'get_positions_' . $module;
if ( ! method_exists( $this, $method ) ) {
return $margins;
}
$positions = $this->$method( $margins, $image, $stamp );
if ( empty( $positions ) ) {
return $margins;
}
$new_margins = [
'top_left' => [],
'top_center' => [],
'top_right' => [],
'middle_left' => [],
'middle_right' => [],
'bottom_left' => [],
'bottom_center' => [],
'bottom_right' => [],
];
$new_margins['top_left']['top'] = $positions['top'];
$new_margins['top_left']['left'] = $positions['left'];
$new_margins['top_center']['top'] = $positions['top'];
$new_margins['top_center']['left'] = $positions['center'];
$new_margins['top_right']['top'] = $positions['top'];
$new_margins['top_right']['left'] = $positions['right'];
$new_margins['middle_left']['top'] = $positions['middle'];
$new_margins['middle_left']['left'] = $positions['left'];
$new_margins['middle_right']['top'] = $positions['middle'];
$new_margins['middle_right']['left'] = $positions['right'];
$new_margins['bottom_left']['top'] = $positions['bottom'];
$new_margins['bottom_left']['left'] = $positions['left'];
$new_margins['bottom_center']['top'] = $positions['bottom'];
$new_margins['bottom_center']['left'] = $positions['center'];
$new_margins['bottom_right']['top'] = $positions['bottom'];
$new_margins['bottom_right']['left'] = $positions['right'];
return $margins + $new_margins;
}
/**
* Sanitize the Image SEO options.
*
* @param string $sanitized_value The sanitized value.
* @param string $value Original field value.
* @param string $field_id Field ID.
*
* @return string
*/
public function sanitize_fields( $sanitized_value, $value, $field_id ) {
if ( $field_id !== 'custom_image_overlays' || ! is_array( $value ) ) {
return $sanitized_value;
}
foreach ( $value as $key => $overlay ) {
if ( empty( $overlay['image'] ) ) {
unset( $value[ $key ] );
} elseif ( empty( $overlay['name'] ) ) {
Helper::add_notification( esc_html__( 'A Custom Watermark item could not be saved because the name field is empty.', 'rank-math-pro' ), [ 'type' => 'error' ] );
unset( $value[ $key ] );
} elseif ( empty( $overlay['position'] ) ) {
$value[ $key ]['position'] = 'bottom_right';
}
}
return $value;
}
/**
* Get margins for GD image manipulation.
*
* @param array $margins Original margins array.
* @param resource $image GD image resource identifier.
* @param resource $stamp GD image resource identifier.
*
* @return array
*/
private function get_positions_gd( $margins, $image, $stamp ) {
$left = 0;
$top = 0;
$right = abs( imagesx( $image ) - imagesx( $stamp ) );
$bottom = abs( imagesy( $image ) - imagesy( $stamp ) );
$center = round( $right / 2 );
$middle = round( $bottom / 2 );
return compact( 'left', 'top', 'right', 'bottom', 'center', 'middle' );
}
/**
* Get margins for Imagick image manipulation.
*
* @param array $margins Original margins array.
* @param object $image Imagick image object.
* @param object $stamp Imagick image object.
*
* @return array
*/
private function get_positions_imagick( $margins, $image, $stamp ) {
$left = 0;
$top = 0;
$right = abs( $image->getImageWidth() - $stamp->getImageWidth() );
$bottom = abs( $image->getImageHeight() - $stamp->getImageHeight() );
$center = round( $right / 2 );
$middle = round( $bottom / 2 );
return compact( 'left', 'top', 'right', 'bottom', 'center', 'middle' );
}
/**
* Set default value for overlay meta options.
*
* @param mixed $value The value to return, either a single metadata value or an array
* of values depending on the value of `$single`.
* @param int $object_id ID of the object metadata is for.
* @param string $meta_key Metadata key.
* @return mixed
*/
public function get_postmeta_default( $value, $object_id, $meta_key ) {
if ( ! $this->is_overlay_field( $meta_key ) ) {
return $value;
}
return $this->get_meta_default( $meta_key, get_post_type( $object_id ), $value );
}
/**
* Set default value for overlay meta options.
*
* @param mixed $value The value to return, either a single metadata value or an array
* of values depending on the value of `$single`.
* @param int $object_id ID of the object metadata is for.
* @param string $meta_key Metadata key.
* @return mixed
*/
public function get_termmeta_default( $value, $object_id, $meta_key ) {
if ( ! $this->is_overlay_field( $meta_key ) ) {
return $value;
}
return $this->get_meta_default( $meta_key, '', $value );
}
/**
* Set default value for overlay meta options.
*
* @param mixed $value The value to return, either a single metadata value or an array
* of values depending on the value of `$single`.
* @param int $object_id ID of the object metadata is for.
* @param string $meta_key Metadata key.
* @return mixed
*/
public function get_usermeta_default( $value, $object_id, $meta_key ) {
if ( ! $this->is_overlay_field( $meta_key ) ) {
return $value;
}
return $this->get_meta_default( $meta_key, '', $value );
}
/**
* Set default value for overlay CMB options.
*
* @param mixed $defaults Original default value.
* @param object $field CMB Field object.
* @return mixed
*/
public function get_cmb_default( $defaults, $field ) {
$meta_key = $field->id();
if ( ! $this->is_overlay_field( $meta_key ) ) {
return $defaults;
}
return $this->get_pt_default( $meta_key, get_post_type(), $defaults );
}
/**
* Check if a field ID is for an overlay related field.
*
* @param string $field Field ID.
* @return boolean
*/
public function is_overlay_field( $field ) {
$overlay_fields = [ 'rank_math_facebook_enable_image_overlay', 'rank_math_twitter_enable_image_overlay', 'rank_math_facebook_image_overlay', 'rank_math_twitter_image_overlay' ];
return in_array( $field, $overlay_fields, true );
}
/**
* Get default overlay as set in the plugin settings, or return $default.
*
* @param string $key Field ID (custom field name).
* @param string $post_type Post type.
* @param string $defaults Default value.
* @return mixed
*/
public function get_meta_default( $key, $post_type, $defaults = false ) {
if ( $post_type ) {
$pt_default = Helper::get_settings( 'titles.pt_' . $post_type . '_image_overlay' );
if ( $pt_default ) {
if ( strpos( $key, '_enable_image_overlay' ) !== false ) {
return 'on';
}
return $pt_default;
}
}
$global_default = Helper::get_settings( 'titles.default_image_overlay' );
if ( $global_default ) {
if ( strpos( $key, '_enable_image_overlay' ) !== false ) {
return 'on';
}
return $global_default;
}
return $defaults;
}
/**
* Add custom overlays to the list.
*
* @param array $overlays Original overlays.
*
* @return array New overlays.
*/
public function add_custom_overlays( $overlays ) {
$custom_overlays = $this->get_custom_overlays();
if ( empty( $custom_overlays ) ) {
return $overlays;
}
foreach ( $custom_overlays as $custom_overlay ) {
$new_id = sanitize_title( $custom_overlay['name'], md5( $custom_overlay['name'] ) );
$upload_dir = wp_upload_dir();
$image_path = str_replace( $upload_dir['baseurl'], $upload_dir['basedir'], $custom_overlay['image'] );
$overlays[ $new_id ] = [
'name' => $custom_overlay['name'],
'url' => $custom_overlay['image'],
'path' => $image_path,
];
}
return $overlays;
}
/**
* Hook CMB2 init process.
*/
public function cmb_init() {
$this->action( 'rank_math/admin/settings/global', 'add_thumbnail_watermark_options', 10, 2 );
foreach ( Helper::get_accessible_post_types() as $post_type ) {
if ( 'attachment' === $post_type && Helper::get_settings( 'general.attachment_redirect_urls', true ) ) {
continue;
}
$this->action( "rank_math/admin/settings/post-type-{$post_type}", 'add_thumbnail_watermark_options', 10, 2 );
}
foreach ( Helper::get_accessible_taxonomies() as $slug => $taxonomy ) {
if ( ! $this->is_taxonomy_allowed( $taxonomy->name ) ) {
continue;
}
$this->action( "rank_math/admin/settings/taxonomy-{$slug}", 'add_thumbnail_watermark_options', 10, 2 );
}
}
/**
* Add Custom Image Overlay option in Titles & Meta settings.
*
* @param object $cmb CMB2 instance.
* @param array $tab Current settings tab.
*/
public function add_thumbnail_watermark_options( $cmb, $tab ) {
$overlays = array_merge( [ '' => __( 'Off', 'rank-math-pro' ) ], Helper::choices_overlay_images( 'names' ) );
$field_ids = wp_list_pluck( $cmb->prop( 'fields' ), 'id' );
if ( isset( $tab['post_type'] ) || isset( $tab['taxonomy'] ) ) {
$id = isset( $tab['taxonomy'] ) ? "tax_{$tab['taxonomy']}_image_overlay" : "pt_{$tab['post_type']}_image_overlay";
$position = isset( $tab['taxonomy'] ) ? array_search( "remove_{$tab['taxonomy']}_snippet_data", array_keys( $field_ids ), true ) + 1 : $this->get_field_position( $tab['post_type'], $field_ids );
$cmb->add_field(
[
'id' => $id,
'type' => 'radio_inline',
'name' => esc_html__( 'Default Thumbnail Watermark', 'rank-math-pro' ),
'desc' => esc_html__( 'Select the default watermark that will be applied if no specific watermark is selected.', 'rank-math-pro' ),
'options' => $overlays,
'default' => '',
'classes' => 'default-overlay-field',
],
++$position
);
return;
}
$fields_position = array_search( 'twitter_card_type', array_keys( $field_ids ), true ) + 1;
$overlays_fields = $cmb->add_field(
[
'id' => 'custom_image_overlays',
'type' => 'group',
'name' => esc_html__( 'Custom Image Watermarks', 'rank-math-pro' ),
'desc' => esc_html__( 'Add more image watermarks to choose from for the social thumbnails.', 'rank-math-pro' ),
'options' => [
'add_button' => esc_html__( 'Add Watermark', 'rank-math-pro' ),
'remove_button' => esc_html__( 'Remove', 'rank-math-pro' ),
],
'classes' => 'cmb-group-text-only',
'sanitization_cb' => [ $this, 'sanitize_overlays' ],
],
++$fields_position
);
$cmb->add_group_field(
$overlays_fields,
[
'id' => 'image',
'type' => 'file',
'options' => [
'url' => false,
],
'text' => [ 'add_upload_file_text' => esc_html__( 'Add Image', 'rank-math-pro' ) ],
]
);
$cmb->add_group_field(
$overlays_fields,
[
'id' => 'name',
'type' => 'text',
'attributes' => [
'placeholder' => esc_attr__( 'Name*', 'rank-math-pro' ),
],
]
);
$cmb->add_group_field(
$overlays_fields,
[
'id' => 'position',
'type' => 'select',
'options' => $this->get_position_choices(),
'default' => 'bottom_right',
]
);
$cmb->add_field(
[
'id' => 'default_image_overlay',
'type' => 'radio_inline',
'name' => esc_html__( 'Default Thumbnail Watermark', 'rank-math-pro' ),
'desc' => esc_html__( 'Select the default watermark that will be applied if no specific watermark is selected.', 'rank-math-pro' ),
'options' => $overlays,
'default' => '',
'classes' => 'default-overlay-field',
],
++$fields_position
);
}
/**
* Enqueue assets.
*
* @return void
*/
public function enqueue() {
if ( Param::get( 'page' ) !== 'rank-math-options-titles' ) {
return;
}
wp_enqueue_style(
'rank-math-pro-title-options',
RANK_MATH_PRO_URL . 'assets/admin/css/title-options.css',
null,
rank_math_pro()->version
);
wp_enqueue_script( 'rank-math-pro-redirections', RANK_MATH_PRO_URL . 'assets/admin/js/title-options.js', [], RANK_MATH_PRO_VERSION, true );
}
/**
* Get custom overlays.
*
* @return array
*/
private function get_custom_overlays() {
return array_filter(
array_map(
function ( $overlay ) {
return empty( $overlay['name'] ) || empty( $overlay['image'] ) ? false : $overlay;
},
(array) Helper::get_settings( 'titles.custom_image_overlays' )
)
);
}
/**
* Get field position by post type.
*
* @param string $post_type Post type.
* @param array $field_ids All field ids.
*
* @return bool
*/
private function get_field_position( $post_type, $field_ids ) {
$field = "pt_{$post_type}_analyze_fields";
if ( 'attachment' === $post_type ) {
$field = 'pt_attachment_bulk_editing';
}
if ( 'web-story' === $post_type ) {
$field = 'pt_web-story_slack_enhanced_sharing';
}
return array_search( $field, array_keys( $field_ids ), true ) + 1;
}
/**
* Is taxonomy allowed
*
* @param string $taxonomy Taxonomy to check.
*
* @return bool
*/
private function is_taxonomy_allowed( $taxonomy ) {
$exclude_taxonomies = [ 'post_format', 'product_shipping_class' ];
if ( Str::starts_with( 'pa_', $taxonomy ) || in_array( $taxonomy, $exclude_taxonomies, true ) ) {
return false;
}
return true;
}
/**
* Do not save if name or image is empty.
*
* @param array $value Field value to save.
* @return array
*/
private function sanitize_overlays( $value ) {
if ( ! is_array( $value ) ) {
return [];
}
foreach ( $value as $key => $overlay ) {
if ( empty( $overlay['image'] ) ) {
unset( $value[ $key ] );
} elseif ( empty( $overlay['name'] ) ) {
Helper::add_notification( esc_html__( 'A Custom Watermark item could not be saved because the name field is empty.', 'rank-math-pro' ), [ 'type' => 'error' ] );
unset( $value[ $key ] );
}
}
return $value;
}
/**
* Get position options.
*
* @return array
*/
private function get_position_choices() {
return [
'top_left' => __( 'Top Left', 'rank-math-pro' ),
'top_center' => __( 'Top Center', 'rank-math-pro' ),
'top_right' => __( 'Top Right', 'rank-math-pro' ),
'middle_left' => __( 'Middle Left', 'rank-math-pro' ),
'middle_center' => __( 'Middle Center', 'rank-math-pro' ),
'middle_right' => __( 'Middle Right', 'rank-math-pro' ),
'bottom_left' => __( 'Bottom Left', 'rank-math-pro' ),
'bottom_center' => __( 'Bottom Center', 'rank-math-pro' ),
'bottom_right' => __( 'Bottom Right', 'rank-math-pro' ),
];
}
}