File "class-dfi.php"
Full Path: /home/vantageo/public_html/cache/.wp-cli/wp-content/plugins/default-featured-image/app/class-dfi.php
File size: 7.99 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/**
* Class DFI
*/
final class DFI {
/**
* Holds the instance.
*
* @var self
*/
protected static $inst = null;
/**
* Create instance of this class.
*
* @return self
*/
public static function instance() {
if ( null === static::$inst ) {
static::$inst = new self();
}
return static::$inst;
}
/**
* The constructor
*/
private function __construct() {
}
/**
* Uninstall
*
* @return void
*/
public static function uninstall() {
delete_option( 'dfi_image_id' );
}
/**
* L10n
*
* @return void
*/
public function load_plugin_textdomain() {
load_plugin_textdomain( 'default-featured-image', false, plugin_basename( DFI_DIR ) . '/languages/' );
}
/**
* Add the dfi_id to the meta data if needed.
*
* @param null|mixed $null Should be null, we don't use it because we update the meta cache.
* @param int $object_id ID of the object metadata is for.
* @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for
* the specified object.
* @param bool $single Optional, default is false. If true, return only the first value of the
* specified meta_key. This parameter has no effect if meta_key is not specified.
*
* @return string|string[] Single metadata value, or array of values
*/
public function set_dfi_meta_key( $null, $object_id, $meta_key, $single ) {
// Only affect thumbnails on the frontend, do allow ajax calls.
if ( ( is_admin() && ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX ) ) ) {
return $null;
}
// Check only empty meta_key and '_thumbnail_id'.
if ( ! empty( $meta_key ) && '_thumbnail_id' !== $meta_key ) {
return $null;
}
$post_type = get_post_type( $object_id );
// Check if this post type supports featured images.
if ( false !== $post_type && ! post_type_supports( $post_type, 'thumbnail' ) ) {
return $null; // post type does not support featured images.
}
// Get current Cache.
$meta_cache = wp_cache_get( $object_id, 'post_meta' );
/**
* Empty objects probably need to be initiated.
*
* @see get_metadata() in /wp-includes/meta.php
*/
if ( ! $meta_cache ) {
$meta_cache = update_meta_cache( 'post', array( $object_id ) );
if ( ! empty( $meta_cache[ $object_id ] ) ) {
$meta_cache = $meta_cache[ $object_id ];
} else {
$meta_cache = array();
}
}
// Is the _thumbnail_id present in cache?
if ( ! empty( $meta_cache['_thumbnail_id'][0] ) ) {
return $null; // it is present, don't check anymore.
}
// Get the Default Featured Image ID.
$dfi_id = get_option( 'dfi_image_id' );
// Set the dfi in cache.
$meta_cache['_thumbnail_id'][0] = apply_filters( 'dfi_thumbnail_id', $dfi_id, $object_id );
wp_cache_set( $object_id, $meta_cache, 'post_meta' );
return $null;
}
/**
* Register the setting on the media settings page.
*
* @return void
*/
public function media_setting() {
register_setting(
'media', // settings page.
'dfi_image_id', // option name.
array( &$this, 'input_validation' ) // validation callback.
);
add_settings_field(
'dfi', // id.
_x( 'Default featured image', 'Label on the settings page.', 'default-featured-image' ), // setting title.
array( &$this, 'settings_html' ), // display callback.
'media', // settings page.
'default' // settings section.
);
}
/**
* Display the buttons and a preview on the media settings page.
*
* @return void
*/
public function settings_html() {
$value = get_option( 'dfi_image_id' );
$rm_btn_class = 'button button-disabled';
if ( ! empty( $value ) ) {
echo $this->preview_image( $value ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
$rm_btn_class = 'button';
}
?>
<input id="dfi_id" type="hidden" value="<?php echo esc_attr( $value ); ?>" name="dfi_image_id"/>
<a id="dfi-set-dfi" class="button" title="<?php esc_attr_e( 'Select default featured image', 'default-featured-image' ); ?>" href="#">
<span style="margin-top: 3px;" class="dashicons dashicons-format-image"></span>
<?php esc_html_e( 'Select default featured image', 'default-featured-image' ); ?>
</a>
<div style="margin-top:5px;">
<a id="dfi-no-fdi" class="<?php echo esc_attr( $rm_btn_class ); ?>"
title="<?php esc_attr_e( 'Don\'t use a default featured image', 'default-featured-image' ); ?>" href="#">
<?php esc_html_e( 'Don\'t use a default featured image', 'default-featured-image' ); ?>
</a>
</div>
<?php
}
/**
* Is the given input a valid image.
*
* @param string|int $thumbnail_id The saving thumbnail.
*
* @return int|false
*/
public function input_validation( $thumbnail_id ) {
if ( wp_attachment_is_image( absint( $thumbnail_id ) ) ) {
return absint( $thumbnail_id );
}
return false;
}
/**
* Register the javascript
*
* @return void
*/
public function admin_scripts() {
wp_enqueue_media(); // scripts used for uploader.
wp_enqueue_script( 'dfi-script', DFI_URL . 'set-default-featured-image.js', array(), DFI_VERSION, true );
wp_localize_script(
'dfi-script',
'dfi_L10n',
array(
'manager_title' => __( 'Select default featured image', 'default-featured-image' ),
'manager_button' => __( 'Set default featured image', 'default-featured-image' ),
)
);
}
/**
* Get an image and wrap it in a div
*
* @param int $image_id A valid attachment image ID.
*
* @return string
*/
public function preview_image( $image_id ) {
$output = '<div id="preview-image" style="float:left; padding: 0 5px 0 0;">';
$output .= wp_get_attachment_image( $image_id, array( 80, 60 ), true );
$output .= '</div>';
return $output;
}
/**
* The callback for the ajax call when the DFI changes
*
* @return void It's an ajax call.
*/
public function ajax_wrapper() {
//phpcs:disable WordPress.Security.NonceVerification.Missing
// This is only a preview, don't bother verifying.
if ( ! empty( $_POST['image_id'] ) && absint( $_POST['image_id'] ) ) {
$img_id = absint( $_POST['image_id'] );
echo $this->preview_image( $img_id ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
die(); // ajax call..
}
/**
* Add a settings link to the the plugin on the plugin page
*
* @param string[] $links An array of plugin action links.
*
* @return string[]
*/
public function add_settings_link( $links ) {
$href = admin_url( 'options-media.php#dfi-set-dfi' );
$settings_link = '<a href="' . $href . '">' . __( 'Settings' ) . '</a>'; // phpcs:ignore WordPress.WP.I18n.MissingArgDomain
array_unshift( $links, $settings_link );
return $links;
}
/**
* Set a default featured image if it is missing
*
* @param string $html The post thumbnail HTML.
* @param int $post_id The post ID.
* @param int $post_thumbnail_id The post thumbnail ID.
* @param string|int[] $size The post thumbnail size. Image size or array of width and height.
* @param string|mixed[] $attr values (in that order). Default 'post-thumbnail'.
*
* @return string
*/
public function show_dfi( $html, $post_id, $post_thumbnail_id, $size, $attr ) {
$default_thumbnail_id = get_option( 'dfi_image_id' ); // select the default thumb.
// if an image is set return that image.
if ( (int) $default_thumbnail_id !== (int) $post_thumbnail_id ) {
return $html;
}
if ( isset( $attr['class'] ) ) {
$attr['class'] .= ' default-featured-img';
} else {
$size_class = $size;
if ( is_array( $size_class ) ) {
$size_class = 'size-' . implode( 'x', $size_class );
}
// attachment-$size is a default class `wp_get_attachment_image` would otherwise add. It won't add it if there are classes already there.
$attr = array( 'class' => "attachment-{$size_class} default-featured-img" );
}
$html = wp_get_attachment_image( $default_thumbnail_id, $size, false, $attr );
$html = apply_filters( 'dfi_thumbnail_html', $html, $post_id, $default_thumbnail_id, $size, $attr );
return $html;
}
}