mirror of
https://github.com/10h30/display-featured-image-genesis.git
synced 2026-06-05 15:08:20 +09:00
Robin Cornett
328 lines
10 KiB
PHP
328 lines
10 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Common functions for plugin
|
|
*
|
|
* @package DisplayFeaturedImageGenesis
|
|
* @since 1.2.1
|
|
*/
|
|
class Display_Featured_Image_Genesis_Common {
|
|
|
|
/**
|
|
* current plugin version
|
|
* @var string
|
|
* @since 1.4.3
|
|
*/
|
|
public $version = '2.3.3';
|
|
|
|
/**
|
|
* set and retreive variables for the featured image.
|
|
* @return $item
|
|
*
|
|
* @since 1.1.0
|
|
*/
|
|
public static function get_image_variables() {
|
|
|
|
$item = new stdClass();
|
|
|
|
// variables internal to this function
|
|
$displaysetting = get_option( 'displayfeaturedimagegenesis' );
|
|
$fallback = $displaysetting['default']; // url only
|
|
|
|
// sitewide variables used outside this function
|
|
$item->backstretch = '';
|
|
|
|
add_filter( 'jetpack_photon_override_image_downsize', '__return_true' ); // turn Photon off so we can get the correct image
|
|
|
|
/**
|
|
* create a filter for user to optionally force post types to use the large image instead of backstretch
|
|
* @var filter
|
|
*
|
|
* @since 2.0.0
|
|
*/
|
|
$use_large_image = apply_filters( 'display_featured_image_genesis_use_large_image', array() );
|
|
$image_size = 'displayfeaturedimage_backstretch';
|
|
if ( in_array( get_post_type(), $use_large_image ) ) {
|
|
$image_size = 'large';
|
|
}
|
|
|
|
$image_id = self::set_image_id();
|
|
|
|
$item->backstretch = wp_get_attachment_image_src( $image_id, $image_size );
|
|
|
|
// set a content variable so backstretch doesn't show if full size image exists in post.
|
|
$item->content = '';
|
|
// declare this last so that $item->backstretch is set.
|
|
if ( ! is_admin() && is_singular() ) {
|
|
$fullsize = wp_get_attachment_image_src( $image_id, 'full' );
|
|
$post = get_post();
|
|
$item->content = strpos( $post->post_content, 'src="' . $fullsize[0] );
|
|
|
|
if ( false !== $item->content ) {
|
|
$source_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 ( ! empty( $term_image ) ) {
|
|
$source_id = $term_image;
|
|
} elseif ( ! empty( $fallback ) ) {
|
|
// else, reset backstretch image source to fallback.
|
|
$source_id = $default_image;
|
|
}
|
|
$item->backstretch = wp_get_attachment_image_src( $source_id, $image_size );
|
|
$item->content = strpos( $post->post_content, 'src="' . $item->backstretch[0] );
|
|
}
|
|
}
|
|
|
|
add_filter( 'jetpack_photon_override_image_downsize', '__return_false' ); // re-enable photon
|
|
|
|
// $title is set by new title function
|
|
$title = self::set_item_title();
|
|
|
|
/**
|
|
* Optional filter to change the title text
|
|
* @since 2.2.0
|
|
*/
|
|
$item->title = apply_filters( 'display_featured_image_genesis_title', $title );
|
|
|
|
return $item;
|
|
|
|
}
|
|
|
|
/**
|
|
* retrieve image ID for output
|
|
* @param string $image_id variable, ID of featured image
|
|
*
|
|
* @since 2.2.1
|
|
*/
|
|
public static function set_image_id( $image_id = '' ) {
|
|
|
|
$frontpage = get_option( 'show_on_front' ); // either 'posts' or 'page'
|
|
$postspage = get_option( 'page_for_posts' );
|
|
$displaysetting = get_option( 'displayfeaturedimagegenesis' );
|
|
$postspage_image = get_post_thumbnail_id( $postspage );
|
|
$fallback = $displaysetting['default'];
|
|
$medium = (int) get_option( 'medium_size_w' );
|
|
$fallback_id = displayfeaturedimagegenesis_check_image_id( $fallback );
|
|
|
|
/**
|
|
* create a filter to use the fallback image
|
|
* @var filter
|
|
* @since 2.0.0 (deprecated old use_fallback_image function from 1.2.2)
|
|
*/
|
|
$use_fallback = apply_filters( 'display_featured_image_genesis_use_default', array() );
|
|
|
|
// set here with fallback preemptively, if it exists
|
|
if ( ! empty( $fallback ) ) {
|
|
$image_id = $fallback_id;
|
|
|
|
if ( in_array( get_post_type(), $use_fallback ) ) {
|
|
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
|
|
if ( ( is_home() && 'page' === $frontpage && ! empty( $postspage_image ) ) || 'post' === get_post_type() ) {
|
|
$image_id = $postspage_image ? $postspage_image : $image_id;
|
|
}
|
|
|
|
$object = get_queried_object();
|
|
// singular or archive CPT
|
|
if ( $object && is_main_query() && ! is_admin() ) {
|
|
$post_type = '';
|
|
if ( $object->name ) { // results in post type on cpt archive
|
|
$post_type = $object->name;
|
|
} elseif ( $object->taxonomy ) { // on a tax/term/category
|
|
$tax_object = get_taxonomy( $object->taxonomy );
|
|
$post_type = $tax_object->object_type[0];
|
|
} elseif ( $object->post_type ) { // on singular
|
|
$post_type = $object->post_type;
|
|
}
|
|
if ( ! empty( $displaysetting['post_type'][ $post_type ] ) ) {
|
|
$image_id = displayfeaturedimagegenesis_check_image_id( $displaysetting['post_type'][ $post_type ] );
|
|
|
|
/**
|
|
* use the custom post type featured image
|
|
*
|
|
* @since 2.2.1
|
|
*/
|
|
$use_cpt = apply_filters( 'displayfeaturedimagegenesis_use_post_type_image', array() );
|
|
if ( in_array( get_post_type(), $use_cpt ) ) {
|
|
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() ) {
|
|
$t_id = $object->term_id;
|
|
$term_meta = get_option( "displayfeaturedimagegenesis_$t_id" );
|
|
// if there is a term image
|
|
if ( ! empty( $term_meta['term_image'] ) ) {
|
|
$image_id = displayfeaturedimagegenesis_check_image_id( $term_meta['term_image'] );
|
|
}
|
|
}
|
|
|
|
// any singular post/page/CPT
|
|
if ( is_singular() ) {
|
|
|
|
$term_image = display_featured_image_genesis_get_term_image_id();
|
|
if ( ! empty( $term_image ) ) {
|
|
$image_id = $term_image;
|
|
|
|
/**
|
|
* create filter to use taxonomy image if single post doesn't have a thumbnail, but one of its terms does.
|
|
* @var filter
|
|
*/
|
|
$use_tax_image = apply_filters( 'display_featured_image_genesis_use_taxonomy', array() );
|
|
|
|
if ( in_array( get_post_type(), $use_tax_image ) ) {
|
|
return (int) $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'] : '';
|
|
if ( has_post_thumbnail() && $width >= $medium ) {
|
|
$image_id = get_post_thumbnail_id( get_the_ID() );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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;
|
|
|
|
}
|
|
|
|
protected static function set_item_title( $title = '' ) {
|
|
|
|
$frontpage = get_option( 'show_on_front' ); // either 'posts' or 'page'
|
|
$postspage = get_option( 'page_for_posts' );
|
|
$a11ycheck = current_theme_supports( 'genesis-accessibility', array( 'headings' ) );
|
|
|
|
if ( is_singular() ) {
|
|
$title = get_the_title();
|
|
} elseif ( is_home() && 'page' === $frontpage ) {
|
|
$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 || ! isset( $term->meta ) ) {
|
|
return;
|
|
}
|
|
$title = $term->meta['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 $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/
|
|
*/
|
|
public static function get_image_id( $attachment_url = '' ) {
|
|
|
|
$attachment_id = false;
|
|
|
|
// as of 2.2.0, if a (new) image id is passed to the function, return it as is.
|
|
if ( is_numeric( $attachment_url ) ) {
|
|
return $attachment_url;
|
|
}
|
|
|
|
// If there is no url, return.
|
|
if ( '' === $attachment_url ) {
|
|
return;
|
|
}
|
|
|
|
// Get the upload directory paths
|
|
$upload_dir_paths = wp_upload_dir();
|
|
|
|
// 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, $upload_dir_paths['baseurl'] ) ) {
|
|
|
|
// Remove the upload path base directory from the attachment URL
|
|
$attachment_url = str_replace( trailingslashit( $upload_dir_paths['baseurl'] ), '', $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 var $url_stripped image url without WP resize string (eg 150x150)
|
|
* @param var $attachment_url image 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] );
|
|
}
|
|
|
|
/**
|
|
* 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 ) );
|
|
}
|
|
|
|
}
|