mirror of
https://github.com/10h30/display-featured-image-genesis.git
synced 2026-06-05 15:08:20 +09:00
Robin Cornett
b4628b3e36
WordPress is adding new image sizes in version 5.3, so our custom image size is redundant. Keeping it in for back compat, plus older images will still need to be retrieved using the old image size name, or else the original size will be used in lieu of a correctly sized option.
480 lines
15 KiB
PHP
480 lines
15 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Common functions for plugin
|
|
* Class Display_Featured_Image_Genesis_Common
|
|
*
|
|
* @package DisplayFeaturedImageGenesis
|
|
* @author Robin Cornett <hello@robincornett.com>
|
|
* @license GPL-2.0+
|
|
* @link https://robincornett.com
|
|
* @copyright 2014-2017 Robin Cornett Creative, LLC
|
|
* @since 1.2.1
|
|
*/
|
|
class Display_Featured_Image_Genesis_Common {
|
|
|
|
/**
|
|
* current plugin version
|
|
* @var string
|
|
* @since 1.4.3
|
|
*/
|
|
public $version = '3.1.2';
|
|
|
|
/**
|
|
* @var $instance
|
|
*/
|
|
private static $instance;
|
|
|
|
/**
|
|
* Class Instance.
|
|
* @return Display_Featured_Image_Genesis_Common
|
|
*/
|
|
public static function instance() {
|
|
if ( ! isset( self::$instance ) && ! ( self::$instance instanceof Display_Featured_Image_Genesis_Common ) ) {
|
|
self::$instance = new Display_Featured_Image_Genesis_Common();
|
|
}
|
|
|
|
return self::$instance;
|
|
}
|
|
|
|
/**
|
|
* set and retrieve variables for the featured image.
|
|
* @return \stdClass $item
|
|
*
|
|
* @since 1.1.0
|
|
*/
|
|
public static function get_image_variables() {
|
|
|
|
$item = new stdClass();
|
|
|
|
$item->backstretch = '';
|
|
|
|
add_filter( 'jetpack_photon_override_image_downsize', '__return_true' ); // turn Photon off so we can get the correct image
|
|
|
|
$image_id = self::set_image_id();
|
|
$image_size = self::image_size();
|
|
$item->backstretch = wp_get_attachment_image_src( $image_id, $image_size );
|
|
if ( empty( $item->backstretch[3] ) ) {
|
|
$item->backstretch = wp_get_attachment_image_src( $image_id, 'displayfeaturedimage_backstretch' );
|
|
}
|
|
|
|
// set a content variable so backstretch doesn't show if full size image exists in post.
|
|
$item->content = false;
|
|
// declare this last so that $item->backstretch is set.
|
|
if ( ! is_admin() && is_singular() ) {
|
|
$post_content = get_post_field( 'post_content' );
|
|
$item->content = strpos( $post_content, 'src="' . $item->backstretch[0] );
|
|
}
|
|
|
|
/**
|
|
* Optional filter to change the title text
|
|
* @since 2.2.0
|
|
*/
|
|
$item->title = apply_filters( 'display_featured_image_genesis_title', self::set_item_title() );
|
|
|
|
return $item;
|
|
}
|
|
|
|
/**
|
|
* retrieve image ID for output
|
|
*
|
|
* @param string $image_id variable, ID of featured image
|
|
*
|
|
* @since 2.2.1
|
|
* @return int|string $image_id
|
|
*/
|
|
public static function set_image_id( $image_id = '' ) {
|
|
|
|
$setting = displayfeaturedimagegenesis_get_setting();
|
|
$fallback_id = $setting['default'];
|
|
|
|
// set here with fallback preemptively, if it exists
|
|
if ( ! empty( $fallback_id ) ) {
|
|
/**
|
|
* Creates display_featured_image_genesis_use_default filter to check
|
|
* whether get_post_type array should use default image.
|
|
* @uses is_in_array()
|
|
*/
|
|
$image_id = $fallback_id;
|
|
if ( self::is_in_array( 'use_default' ) || $setting['always_default'] ) {
|
|
return (int) $image_id;
|
|
}
|
|
}
|
|
|
|
// outlier: if it's a home page with a static front page, and there is a featured image set on the home page
|
|
// also provisionally sets featured image for posts, similar to CPT archives
|
|
$postspage = get_option( 'page_for_posts' );
|
|
if ( self::has_static_front_page() && $postspage ) {
|
|
$postspage_image = get_post_thumbnail_id( $postspage );
|
|
$setting['post_type']['post'] = (int) $postspage_image;
|
|
}
|
|
|
|
// if a post type image exists, it takes priority over the fallback. check that next.
|
|
$post_type = self::get_post_type();
|
|
if ( ! empty( $setting['post_type'][ $post_type ] ) ) {
|
|
/**
|
|
* Creates display_featured_image_genesis_use_post_type_image filter to check
|
|
* whether get_post_type array should use the post type image.
|
|
* @uses is_in_array()
|
|
*/
|
|
$image_id = $setting['post_type'][ $post_type ];
|
|
if ( self::is_in_array( 'use_post_type_image' ) ) {
|
|
return (int) $image_id;
|
|
}
|
|
}
|
|
if ( is_author() ) {
|
|
$image_id = get_the_author_meta( 'displayfeaturedimagegenesis', (int) get_query_var( 'author' ) );
|
|
}
|
|
// taxonomy
|
|
if ( is_category() || is_tag() || is_tax() ) {
|
|
$object = get_queried_object();
|
|
$image = displayfeaturedimagegenesis_get_term_image( $object->term_id );
|
|
if ( $image ) {
|
|
$image_id = $image;
|
|
}
|
|
}
|
|
|
|
// search page
|
|
if ( is_search() && ! empty( $setting['post_type']['search'] ) ) {
|
|
$image_id = $setting['post_type']['search'];
|
|
}
|
|
|
|
// 404
|
|
if ( is_404() && ! empty( $setting['post_type']['fourohfour'] ) ) {
|
|
$image_id = $setting['post_type']['fourohfour'];
|
|
}
|
|
|
|
// any singular post/page/CPT
|
|
if ( is_singular() ) {
|
|
$image_id = self::get_singular_post_image( $image_id, $setting, $post_type );
|
|
}
|
|
|
|
/**
|
|
* filter to use a different image id
|
|
* @var $image_id
|
|
*
|
|
* @since 2.2.0
|
|
*/
|
|
$image_id = apply_filters( 'display_featured_image_genesis_image_id', $image_id );
|
|
|
|
// make sure the image id is an integer
|
|
$image_id = is_numeric( $image_id ) ? (int) $image_id : '';
|
|
|
|
return $image_id;
|
|
}
|
|
|
|
/**
|
|
* Get the current post type.
|
|
* @return false|object|string
|
|
*/
|
|
private static function get_post_type() {
|
|
$post_type = get_post_type();
|
|
if ( ! is_post_type_archive() ) {
|
|
return $post_type;
|
|
}
|
|
$post_type = get_queried_object();
|
|
|
|
return $post_type->name;
|
|
}
|
|
|
|
/**
|
|
* Get the featured image for the singular post
|
|
* @param $image_id int|string
|
|
* @param $setting array
|
|
* @param $post_type
|
|
*
|
|
* @return string
|
|
*
|
|
* @since 2.5.0
|
|
*/
|
|
protected static function get_singular_post_image( $image_id, $setting, $post_type ) {
|
|
$term_image = display_featured_image_genesis_get_term_image_id();
|
|
if ( ! empty( $term_image ) ) {
|
|
/**
|
|
* Creates display_featured_image_genesis_use_taxonomy filter to check
|
|
* whether get_post_type array should use the term image.
|
|
* @uses is_in_array()
|
|
*/
|
|
$image_id = $term_image;
|
|
if ( self::is_in_array( 'use_taxonomy' ) ) {
|
|
return $image_id;
|
|
}
|
|
}
|
|
|
|
// If this post type is set to always use a fallback image, stop here and use it.
|
|
if ( isset( $setting['fallback'][ $post_type ] ) && $setting['fallback'][ $post_type ] ) {
|
|
return $image_id;
|
|
}
|
|
$thumb_metadata = wp_get_attachment_metadata( get_post_thumbnail_id( get_the_ID() ) ); // needed only for the next line
|
|
$width = $thumb_metadata ? $thumb_metadata['width'] : '';
|
|
$medium = (int) apply_filters( 'displayfeaturedimagegenesis_set_medium_width', get_option( 'medium_size_w' ) );
|
|
if ( has_post_thumbnail() && $width > $medium ) {
|
|
$image_id = get_post_thumbnail_id( get_the_ID() );
|
|
$image_id = self::singular_reset_image( $image_id );
|
|
}
|
|
return $image_id;
|
|
}
|
|
|
|
/**
|
|
* Check the post content for the featured image. If it's there (full size), reset the featured image to a fallback.
|
|
* @param $image_id
|
|
*
|
|
* @return string
|
|
* @since 2.5.0
|
|
*/
|
|
public static function singular_reset_image( $image_id ) {
|
|
$fullsize = wp_get_attachment_image_src( $image_id, 'full' );
|
|
$post = get_post( get_the_ID() );
|
|
$item_content = strpos( $post->post_content, 'src="' . $fullsize[0] );
|
|
|
|
if ( false === $item_content ) {
|
|
return $image_id;
|
|
}
|
|
$term_image = display_featured_image_genesis_get_term_image_id();
|
|
$default_image = display_featured_image_genesis_get_default_image_id();
|
|
// reset backstretch image source to term image if it exists and the featured image is being used in content.
|
|
if ( $term_image ) {
|
|
$image_id = $term_image;
|
|
} elseif ( $default_image ) {
|
|
// else, reset backstretch image source to fallback.
|
|
$image_id = $default_image;
|
|
}
|
|
|
|
return $image_id;
|
|
}
|
|
|
|
/**
|
|
* @param string $title
|
|
*
|
|
* @return string
|
|
*/
|
|
protected static function set_item_title( $title = '' ) {
|
|
|
|
$postspage = get_option( 'page_for_posts' );
|
|
$a11ycheck = current_theme_supports( 'genesis-accessibility', array( 'headings' ) );
|
|
|
|
if ( is_singular() ) {
|
|
$title = get_the_title();
|
|
} elseif ( is_home() && self::has_static_front_page() ) {
|
|
$title = get_post( $postspage )->post_title;
|
|
} elseif ( is_category() || is_tag() || is_tax() ) {
|
|
$term = is_tax() ? get_term_by( 'slug', get_query_var( 'term' ), get_query_var( 'taxonomy' ) ) : get_queried_object();
|
|
if ( ! $term ) {
|
|
return '';
|
|
}
|
|
$title = displayfeaturedimagegenesis_get_term_meta( $term, 'headline' );
|
|
if ( empty( $title ) && $a11ycheck ) {
|
|
$title = $term->name;
|
|
}
|
|
} elseif ( is_author() ) {
|
|
$title = get_the_author_meta( 'headline', (int) get_query_var( 'author' ) );
|
|
if ( empty( $title ) && $a11ycheck ) {
|
|
$title = get_the_author_meta( 'display_name', (int) get_query_var( 'author' ) );
|
|
}
|
|
} elseif ( is_post_type_archive() && genesis_has_post_type_archive_support() ) {
|
|
$title = genesis_get_cpt_option( 'headline' );
|
|
if ( empty( $title ) && $a11ycheck ) {
|
|
$title = post_type_archive_title( '', false );
|
|
}
|
|
}
|
|
|
|
return apply_filters( 'display_featured_image_genesis_title_text', $title );
|
|
}
|
|
|
|
/**
|
|
* Get the ID of each image dynamically.
|
|
*
|
|
* @since 1.2.0
|
|
*
|
|
* @author Philip Newcomer
|
|
* @link http://philipnewcomer.net/2012/11/get-the-attachment-id-from-an-image-url-in-wordpress/
|
|
*
|
|
* @param string $attachment_url
|
|
*
|
|
* @return bool|int|mixed|string
|
|
*/
|
|
public static function get_image_id( $attachment_url = '' ) {
|
|
|
|
_deprecated_function( __FUNCTION__, '3.1.0' );
|
|
// as of 2.2.0, if a (new) image id is passed to the function, or if it's empty, return it as is.
|
|
if ( is_numeric( $attachment_url ) || '' === $attachment_url ) {
|
|
return $attachment_url;
|
|
}
|
|
|
|
$attachment_id = false;
|
|
|
|
// if we're running 4.0 or later, we can do this all using a new core function.
|
|
if ( function_exists( 'attachment_url_to_postid' ) ) {
|
|
$url_stripped = preg_replace( '/-\d+x\d+(?=\.(jpg|jpeg|png|gif)$)/i', '', $attachment_url );
|
|
$attachment_id = attachment_url_to_postid( $url_stripped );
|
|
return $attachment_id > 0 ? $attachment_id : false;
|
|
}
|
|
|
|
// Get the upload directory paths
|
|
$upload_dir_paths = wp_upload_dir();
|
|
$base_url = wp_make_link_relative( $upload_dir_paths['baseurl'] );
|
|
$attachment_url = wp_make_link_relative( $attachment_url );
|
|
|
|
// Make sure the upload path base directory exists in the attachment URL, to verify that we're working with a media library image
|
|
if ( false !== strpos( $attachment_url, $base_url ) ) {
|
|
|
|
// Remove the upload path base directory from the attachment URL
|
|
$attachment_url = str_replace( $base_url . '/', '', $attachment_url );
|
|
|
|
// If this is the URL of an auto-generated thumbnail, get the URL of the original image
|
|
$url_stripped = preg_replace( '/-\d+x\d+(?=\.(jpg|jpeg|png|gif)$)/i', '', $attachment_url );
|
|
|
|
// Finally, run a custom database query to get the attachment ID from the modified attachment URL
|
|
$attachment_id = self::fetch_image_id_query( $url_stripped, $attachment_url );
|
|
|
|
}
|
|
|
|
return $attachment_id;
|
|
}
|
|
|
|
/**
|
|
* Fetch image ID from database
|
|
* @param $url_stripped string url without WP resize (eg 150x150)
|
|
* @param $attachment_url string url
|
|
* @return int (image id) image ID, or false
|
|
*
|
|
* @since 2.2.0
|
|
*
|
|
* @author hellofromtonya
|
|
*/
|
|
protected static function fetch_image_id_query( $url_stripped, $attachment_url ) {
|
|
|
|
global $wpdb;
|
|
|
|
$query_sql = $wpdb->prepare(
|
|
"
|
|
SELECT wposts.ID
|
|
FROM {$wpdb->posts} wposts, {$wpdb->postmeta} wpostmeta
|
|
WHERE wposts.ID = wpostmeta.post_id AND wpostmeta.meta_key = '_wp_attached_file' AND wpostmeta.meta_value IN ( %s, %s ) AND wposts.post_type = 'attachment'
|
|
",
|
|
$url_stripped, $attachment_url
|
|
);
|
|
|
|
$result = $wpdb->get_col( $query_sql );
|
|
|
|
return empty( $result ) || ! is_numeric( $result[0] ) ? false : intval( $result[0] );
|
|
}
|
|
|
|
/**
|
|
* Set up filter to check for post type rules. Variable, based on $value passed in.
|
|
* @param $value string for filter name
|
|
* @param array $post_types affected post types (empty array by default)
|
|
* @return bool
|
|
*
|
|
* @since 2.5.0
|
|
*/
|
|
public static function is_in_array( $value, $post_types = array() ) {
|
|
$post_types = apply_filters( "display_featured_image_genesis_{$value}", $post_types );
|
|
|
|
// phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict
|
|
return in_array( get_post_type(), $post_types );
|
|
}
|
|
|
|
/**
|
|
* add a filter to change the minimum width required for backstretch image
|
|
* @return integer sets the minimum width for backstretch effect
|
|
*
|
|
* @since 2.2.0
|
|
*/
|
|
public function minimum_backstretch_width() {
|
|
$large = apply_filters( 'display_featured_image_genesis_set_minimum_backstretch_width', get_option( 'large_size_w' ) );
|
|
if ( ! is_numeric( $large ) ) {
|
|
$large = get_option( 'large_size_w' );
|
|
}
|
|
return absint( intval( $large ) );
|
|
}
|
|
|
|
/**
|
|
* Select which image size to use. Can be filtered to use a custom size.
|
|
* @return string
|
|
* @since 2.5.0
|
|
*/
|
|
public static function image_size() {
|
|
$setting = displayfeaturedimagegenesis_get_setting();
|
|
$registered_size = self::banner_image_size();
|
|
$image_size = 'large' !== $setting['image_size'] ? $registered_size : $setting['image_size'];
|
|
$post_id = self::get_post_id();
|
|
$post_meta = get_post_meta( $post_id, '_displayfeaturedimagegenesis_disable', true );
|
|
if ( $post_meta && ! is_numeric( $post_meta ) ) {
|
|
return $post_meta;
|
|
}
|
|
/**
|
|
* Creates display_featured_image_genesis_use_large_image filter to check
|
|
* whether get_post_type array should use large image instead of backstretch.
|
|
* @uses is_in_array()
|
|
*/
|
|
if ( self::is_in_array( 'use_large_image' ) || self::use_large_image_singular( $setting ) ) {
|
|
return 'large';
|
|
}
|
|
|
|
return apply_filters( 'displayfeaturedimagegenesis_image_size', $image_size );
|
|
}
|
|
|
|
/**
|
|
* If the new WordPress image sizes have been registered, use them instead of the old one.
|
|
*
|
|
* @return string
|
|
* @since 3.2.0
|
|
*/
|
|
public static function banner_image_size() {
|
|
return has_image_size( '2048x2048' ) ? '2048x2048' : 'displayfeaturedimage_backstretch';
|
|
}
|
|
|
|
/**
|
|
* Determine if a singular post/page should use a large image instead of backstretch.
|
|
*
|
|
* @param $setting
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected static function use_large_image_singular( $setting ) {
|
|
if ( ! is_singular() ) {
|
|
return false;
|
|
}
|
|
$post_type = get_post_type();
|
|
return ( isset( $setting['large'][ $post_type ] ) && $setting['large'][ $post_type ] );
|
|
}
|
|
|
|
/**
|
|
* Does the site have a static front page?
|
|
* @return bool
|
|
* @since 3.1.0
|
|
*/
|
|
private static function has_static_front_page() {
|
|
$frontpage = get_option( 'show_on_front' );
|
|
|
|
return (bool) ( 'page' === $frontpage );
|
|
}
|
|
|
|
/**
|
|
* Get the current post ID.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public static function get_post_id() {
|
|
if ( is_singular() ) {
|
|
return get_the_ID();
|
|
}
|
|
if ( is_home() && self::has_static_front_page() ) {
|
|
return get_option( 'page_for_posts' );
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper function to return an instance of the common class.
|
|
* @return \Display_Featured_Image_Genesis_Common
|
|
* @since 3.1.0
|
|
*/
|
|
function displayfeaturedimagegenesis_get() {
|
|
return Display_Featured_Image_Genesis_Common::instance();
|
|
}
|
|
|
|
displayfeaturedimagegenesis_get();
|