5 | Enhanced media library features for WordPress. 6 |
16 | |
4 | Smart Media 5 | Enhanced media library features for WordPress. 6 | |
7 | 8 | | 9 |
| 12 | A Human Made project. Maintained by @roborourke. 13 | | 14 |
15 |
16 | |
17 |
id' ) );
568 | }
569 |
570 | if ( 'attachment' !== $attachment->post_type || ! wp_attachment_is_image( $attachment->ID ) ) {
571 | wp_die( sprintf( esc_html__( 'That is not a valid image attachment.', 'hm-smart-media' ), 'id' ) );
572 | }
573 |
574 | if ( ! current_user_can( get_post_type_object( $attachment->post_type )->cap->edit_post, $attachment->ID ) ) {
575 | wp_die( esc_html__( 'You are not allowed to edit this attachment.', 'hm-smart-media' ) );
576 | }
577 |
578 | return $attachment;
579 | }
580 |
581 | /**
582 | * Returns the width and height of a given thumbnail size.
583 | *
584 | * @param string $size Thumbnail size name.
585 | * @return array|false Associative array of width and height in pixels. False on invalid size.
586 | */
587 | function get_thumbnail_dimensions( $size ) {
588 | global $_wp_additional_image_sizes;
589 |
590 | switch ( $size ) {
591 | case 'thumbnail':
592 | case 'medium':
593 | case 'medium_large':
594 | case 'large':
595 | $width = get_option( $size . '_size_w' );
596 | $height = get_option( $size . '_size_h' );
597 | break;
598 | default:
599 | if ( empty( $_wp_additional_image_sizes[ $size ] ) ) {
600 | return false;
601 | }
602 |
603 | $width = $_wp_additional_image_sizes[ $size ]['width'];
604 | $height = $_wp_additional_image_sizes[ $size ]['height'];
605 | }
606 |
607 | // Just to be safe
608 | $width = (int) $width;
609 | $height = (int) $height;
610 |
611 | return [
612 | 'width' => $width,
613 | 'height' => $height,
614 | ];
615 | }
616 |
617 | /**
618 | * Gets all image sizes as keyed array with width, height and crop values.
619 | *
620 | * @return array
621 | */
622 | function get_image_sizes() {
623 | global $_wp_additional_image_sizes;
624 |
625 | $sizes = \get_intermediate_image_sizes();
626 | $sizes = array_combine( $sizes, $sizes );
627 |
628 | // Extract dimensions and crop setting.
629 | $sizes = array_map(
630 | function ( $size ) use ( $_wp_additional_image_sizes ) {
631 | if ( isset( $_wp_additional_image_sizes[ $size ] ) ) {
632 | $width = intval( $_wp_additional_image_sizes[ $size ]['width'] );
633 | $height = intval( $_wp_additional_image_sizes[ $size ]['height'] );
634 | $crop = (bool) $_wp_additional_image_sizes[ $size ]['crop'];
635 | } else {
636 | $width = intval( get_option( "{$size}_size_w" ) );
637 | $height = intval( get_option( "{$size}_size_h" ) );
638 | $crop = (bool) get_option( "{$size}_crop" );
639 | }
640 |
641 | return [
642 | 'width' => $width,
643 | 'height' => $height,
644 | 'crop' => $crop,
645 | 'orientation' => $width >= $height ? 'landscape' : 'portrait',
646 | ];
647 | }, $sizes
648 | );
649 |
650 | return $sizes;
651 | }
652 |
653 | /**
654 | * Deletes the coordinates for a custom crop for a given attachment ID and thumbnail size.
655 | *
656 | * @param int $attachment_id Attachment ID.
657 | * @param string $size Thumbnail size name.
658 | * @return bool False on failure (probably no such custom crop), true on success.
659 | */
660 | function delete_coordinates( $attachment_id, $size ) {
661 | return delete_post_meta( $attachment_id, "_crop_{$size}" );
662 | }
663 |
664 | /**
665 | * Force 100% quality for image edits as we only allow editing the original.
666 | *
667 | * @param int $quality Percentage quality from 0-100.
668 | * @param string $context The context for the change in jpeg quality.
669 | * @return int
670 | */
671 | function jpeg_quality( $quality, $context = '' ) {
672 | if ( $context === 'edit_image' ) {
673 | return 100;
674 | }
675 |
676 | return $quality;
677 | }
678 |
679 | /**
680 | * Filter the default tachyon URL args.
681 | *
682 | * @param array $args
683 | * @return array
684 | */
685 | function tachyon_args( $args ) {
686 | // Use smart cropping by default for resizes.
687 | if ( isset( $args['resize'] ) && ! isset( $args['crop'] ) ) {
688 | $args['crop_strategy'] = 'smart';
689 | }
690 |
691 | return $args;
692 | }
693 |
694 | /**
695 | * Remove crop data when editing original.
696 | */
697 | function on_edit_image() {
698 | // Get the attachment.
699 | $attachment = validate_parameters( 'postid' );
700 |
701 | check_ajax_referer( 'image_editor-' . $attachment->ID );
702 |
703 | // Only run on a save operation.
704 | if ( isset( $_POST['do'] ) && ! in_array( $_POST['do'], [ 'save', 'restore' ], true ) ) {
705 | return;
706 | }
707 |
708 | // Only run if transformations being applied.
709 | if ( $_POST['do'] === 'save' && ( ! isset( $_POST['history'] ) || empty( json_decode( wp_unslash( $_POST['history'] ), true ) ) ) ) {
710 | return;
711 | }
712 |
713 | // Remove crops as dimensions / orientation may have changed.
714 | foreach ( array_keys( get_image_sizes() ) as $size ) {
715 | delete_coordinates( $attachment->ID, $size );
716 | }
717 |
718 | // Remove focal point.
719 | delete_post_meta( $attachment->ID, '_focal_point' );
720 |
721 | // @todo update crop coordinates according to history steps
722 | // @todo update focal point coordinates according to history steps
723 | }
724 |
725 | /**
726 | * Prevents WordPress generated resized thumbnails for an image.
727 | * We let tachyon handle this.
728 | *
729 | * @param array $sizes
730 | * @return array
731 | */
732 | function prevent_thumbnail_generation( $sizes ) {
733 | if ( ! function_exists( 'tachyon_url' ) ) {
734 | return $sizes;
735 | }
736 |
737 | return [];
738 | }
739 |
740 | /**
741 | * Fake attachment meta data to include all image sizes.
742 | *
743 | * This attempts to fix two issues:
744 | * - "new" image sizes are not included in meta data.
745 | * - when using Tachyon in admin and disabling resizing,
746 | * NO image sizes are included in the meta data.
747 | *
748 | * @TODO Work out how to name files if crop on upload is reintroduced.
749 | *
750 | * @param $data array The original attachment meta data.
751 | * @param $attachment_id int The attachment ID.
752 | *
753 | * @return array The modified attachment data including "new" image sizes.
754 | */
755 | function filter_attachment_meta_data( $data, $attachment_id ) {
756 | // Save time, only calculate once.
757 | static $cache = [];
758 |
759 | if ( ! empty( $cache[ $attachment_id ] ) ) {
760 | return $cache[ $attachment_id ];
761 | }
762 |
763 | // Only modify if valid format and for images.
764 | if ( ! is_array( $data ) || ! wp_attachment_is_image( $attachment_id ) ) {
765 | return $data;
766 | }
767 |
768 | if ( empty( $data['file'] ) ) {
769 | return $data;
770 | }
771 |
772 | if ( skip_attachment( $attachment_id ) ) {
773 | return $data;
774 | }
775 |
776 | $data = massage_meta_data_for_orientation( $data );
777 |
778 | // Full size image info.
779 | $image_sizes = get_image_sizes();
780 | $mime_type = get_post_mime_type( $attachment_id );
781 | $filename = pathinfo( $data['file'], PATHINFO_FILENAME );
782 | $ext = pathinfo( $data['file'], PATHINFO_EXTENSION );
783 | $orig_w = $data['width'];
784 | $orig_h = $data['height'];
785 |
786 | foreach ( $image_sizes as $size => $crop ) {
787 | if ( isset( $data['sizes'][ $size ] ) ) {
788 | // Meta data is set.
789 | continue;
790 | }
791 |
792 | if ( 'full' === $size ) {
793 | // Full is a special case.
794 | continue;
795 | }
796 |
797 | /*
798 | * $new_dims = [
799 | * 0 => 0
800 | * 1 => 0
801 | * 2 => // Crop start X axis
802 | * 3 => // Crop start Y axis
803 | * 4 => // New width
804 | * 5 => // New height
805 | * 6 => // Crop width on source image
806 | * 7 => // Crop height on source image
807 | * ];
808 | */
809 | $new_dims = image_resize_dimensions( $orig_w, $orig_h, $crop['width'], $crop['height'], $crop['crop'] );
810 |
811 | if ( ! $new_dims ) {
812 | continue;
813 | }
814 |
815 | $w = (int) $new_dims[4];
816 | $h = (int) $new_dims[5];
817 |
818 | // Set crop hash if source crop isn't 0,0,orig_width,orig_height
819 | $crop_details = "{$orig_w},{$orig_h},{$new_dims[2]},{$new_dims[3]},{$new_dims[6]},{$new_dims[7]}";
820 | $crop_hash = '';
821 |
822 | if ( $crop_details !== "{$orig_w},{$orig_h},0,0,{$orig_w},{$orig_h}" ) {
823 | /*
824 | * NOTE: Custom file name data.
825 | *
826 | * The crop hash is used to help determine the correct crop to use for identically
827 | * sized images.
828 | */
829 | $crop_hash = '-c' . substr( strtolower( sha1( $crop_details ) ), 0, 8 );
830 | }
831 |
832 | // Add meta data with fake WP style file name.
833 | $data['sizes'][ $size ] = [
834 | '_tachyon_dynamic' => true,
835 | 'width' => $w,
836 | 'height' => $h,
837 | 'file' => "{$filename}{$crop_hash}-{$w}x{$h}.{$ext}",
838 | 'mime-type' => $mime_type,
839 | ];
840 | }
841 |
842 | $cache[ $attachment_id ] = $data;
843 | return $data;
844 | }
845 |
846 | /**
847 | * When saving the attachment metadata remove the dynamic sizes added
848 | * by the above filter.
849 | *
850 | * @param array $data The image metadata array.
851 | * @return array
852 | */
853 | function filter_update_attachment_meta_data( array $data ) : array {
854 | if ( ! isset( $data['sizes'] ) ) {
855 | return $data;
856 | }
857 | foreach ( $data['sizes'] as $size => $size_data ) {
858 | if ( isset( $size_data['_tachyon_dynamic'] ) ) {
859 | unset( $data['sizes'][ $size ] );
860 | }
861 | }
862 | return $data;
863 | }
864 |
865 | /**
866 | * Swap width and height if required.
867 | *
868 | * The Tachyon service/sharp library will automatically fix
869 | * the orientation but as a result, the width and height will
870 | * be the reverse of that calculated on upload.
871 | *
872 | * This swaps the width and height if needed but it does not
873 | * fix the image on upload as we have Tachy for that.
874 | *
875 | * @param array $meta_data Meta data stored in the database.
876 | *
877 | * @return array Meta data with correct width and height.
878 | */
879 | function massage_meta_data_for_orientation( array $meta_data ) {
880 | if ( empty( $meta_data['image_meta']['orientation'] ) ) {
881 | // No orientation data to fix.
882 | return $meta_data;
883 | }
884 |
885 | $fix_width_height = false;
886 |
887 | switch ( $meta_data['image_meta']['orientation'] ) {
888 | case 5:
889 | case 6:
890 | case 7:
891 | case 8:
892 | case 9:
893 | $fix_width_height = true;
894 | break;
895 | }
896 |
897 | if ( ! $fix_width_height ) {
898 | return $meta_data;
899 | }
900 |
901 | $width = $meta_data['height'];
902 | $meta_data['height'] = $meta_data['width'];
903 | $meta_data['width'] = $width;
904 | unset( $meta_data['image_meta']['orientation'] );
905 | return $meta_data;
906 | }
907 |
908 | /**
909 | * Check if this image matches the tachyon host and path. Allows subdomains.
910 | *
911 | * @param string $image Image HTML or URL.
912 | * @return boolean
913 | */
914 | function is_tachyon_url( string $image ) : bool {
915 | if ( ! defined( 'TACHYON_URL' ) ) {
916 | return false;
917 | }
918 |
919 | // TACHYON_URL can be filtered on output so this is the only reliable method to
920 | // check an image is handled by Tachyon.
921 | $uploads_dir = wp_upload_dir();
922 | $tachyon_base_url = dirname( tachyon_url( $uploads_dir['baseurl'] . '/image.jpg' ) );
923 |
924 | return strpos( $image, $tachyon_base_url ) !== false;
925 | }
926 |
927 | /**
928 | * Add our special handlers for width & height attrs and srcset attributes.
929 | *
930 | * @param string $filtered_image Full img tag with attributes that will replace the source img tag.
931 | * @param string $context Additional context, like the current filter name or the function name from where this was called.
932 | * @param int $attachment_id The image attachment ID. May be 0 in case the image is not an attachment.
933 | * @return string Full img tag with attributes that will replace the source img tag.
934 | */
935 | function content_img_tag( string $filtered_image, string $context, int $attachment_id ) : string {
936 | if ( ! is_tachyon_url( $filtered_image ) ) {
937 | return $filtered_image;
938 | }
939 |
940 | if ( $attachment_id === 0 ) {
941 | return $filtered_image;
942 | }
943 |
944 | $image_meta = wp_get_attachment_metadata( $attachment_id );
945 |
946 | // Add 'width' and 'height' attributes if applicable.
947 | if ( ! str_contains( $filtered_image, ' width=' ) && ! str_contains( $filtered_image, ' height=' ) ) {
948 | $filtered_image = add_width_and_height_attr( $filtered_image, $image_meta );
949 | }
950 |
951 | // Add 'srcset' and 'sizes' attributes if applicable.
952 | if ( ! str_contains( $filtered_image, ' srcset=' ) ) {
953 | $filtered_image = add_srcset_and_sizes_attr( $filtered_image, $image_meta, $attachment_id );
954 | }
955 |
956 | // Call core function to add loading optimization attributes again.
957 | // These rely on width/heights being set correctly which is not set at the point core calls them.
958 | // See wp_img_tag_add_auto_sizes
959 | $filtered_image = wp_img_tag_add_loading_optimization_attrs( $filtered_image, $context );
960 |
961 | // Availabile in WP 6.7 only.
962 | if ( function_exists( 'wp_img_tag_add_auto_sizes' ) ) {
963 | $filtered_image = wp_img_tag_add_auto_sizes( $filtered_image );
964 | }
965 |
966 | return $filtered_image;
967 | }
968 |
969 | /**
970 | * Filters whether to add various attributes to the img tag markup.
971 | *
972 | * We override this to ensure compatibility with Tachyon & smart media.
973 | *
974 | * @param bool $value The filtered value, defaults to true.
975 | * @param string $image The HTML img tag where the attribute should be added.
976 | * @param string $context Additional context about how the function was called or where the img tag is.
977 | * @param int $attachment_id The image attachment ID.
978 | * @return bool The filtered value, defaults to true.
979 | */
980 | function img_tag_add_attr( bool $value, string $image ) : bool {
981 | return ! is_tachyon_url( $image ) ? $value : false;
982 | }
983 |
984 | /**
985 | * Get the image dimensions from the img src attribute.
986 | *
987 | * @TODO Deal with edit hashes by getting the previous version of the meta
988 | * data if required for calculating the srcset using the meta value of
989 | * `_wp_attachment_backup_sizes`. To get the edit hash, refer to
990 | * wp/wp-includes/media.php:1380
991 | *
992 | * @param string $image_src The extracted image src.
993 | * @param array $image_meta The attachment meta data.
994 | * @return false|array Returns an array of [width, height] on success, false on failure.
995 | */
996 | function get_img_src_dimensions( $image_src, $image_meta ) {
997 | if ( empty( $image_meta ) || empty( $image_meta['file'] ) ) {
998 | return false;
999 | }
1000 |
1001 | // Bail early if an image has been inserted and later edited.
1002 | list( $image_path ) = explode( '?', $image_src );
1003 | if ( preg_match( '/-e[0-9]{13}/', $image_meta['file'], $img_edit_hash ) &&
1004 | strpos( wp_basename( $image_path ), $img_edit_hash[0] ) === false ) {
1005 | return false;
1006 | }
1007 |
1008 | $width = false;
1009 | $height = false;
1010 |
1011 | parse_str( html_entity_decode( wp_parse_url( $image_src, PHP_URL_QUERY ) ?? '' ), $tachyon_args );
1012 |
1013 | // Need to work back width and height from various Tachyon options.
1014 | if ( isset( $tachyon_args['resize'] ) ) {
1015 | // Image is cropped.
1016 | list( $width, $height ) = explode( ',', $tachyon_args['resize'] );
1017 | } elseif ( isset( $tachyon_args['fit'] ) ) {
1018 | // Image is uncropped.
1019 | list( $width, $height ) = explode( ',', $tachyon_args['fit'] );
1020 | list( $width, $height ) = wp_constrain_dimensions( $image_meta['width'], $image_meta['height'], $width, $height ?? 0 );
1021 | } else {
1022 | if ( isset( $tachyon_args['w'] ) ) {
1023 | $width = (int) $tachyon_args['w'];
1024 | }
1025 | if ( isset( $tachyon_args['h'] ) ) {
1026 | $height = (int) $tachyon_args['h'];
1027 | }
1028 | if ( ! $width && ! $height ) {
1029 | $width = $image_meta['width'] ?: false;
1030 | $height = $image_meta['height'] ?: false;
1031 | }
1032 | if ( $width && ! $height ) {
1033 | list( $width, $height ) = wp_constrain_dimensions( $image_meta['width'], $image_meta['height'], $width );
1034 | } elseif ( ! $width && $height ) {
1035 | list( $width, $height ) = wp_constrain_dimensions( $image_meta['width'], $image_meta['height'], 0, $height );
1036 | }
1037 | }
1038 |
1039 | // Still stumped?
1040 | if ( ! $width || ! $height ) {
1041 | return false;
1042 | }
1043 |
1044 | return [ $width, $height ];
1045 | }
1046 |
1047 | /**
1048 | * Filters the default method for getting image dimensions.
1049 | *
1050 | * @param array $dimensions List of width and height dimensions.
1051 | * @param string $image_src The current image src URL.
1052 | * @param array $image_meta Attachment metadata.
1053 | * @return void
1054 | */
1055 | function src_get_dimensions( $dimensions, $image_src, $image_meta ) {
1056 | return get_img_src_dimensions( $image_src, $image_meta ) ?: $dimensions;
1057 | }
1058 |
1059 | /**
1060 | * Adds 'width' and 'height' attributes to an existing 'img' element.
1061 | *
1062 | * @param string $image The extracted image tag.
1063 | * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'.
1064 | *
1065 | * @return string Converted 'img' element with 'srcset' and 'sizes' attributes added.
1066 | */
1067 | function add_width_and_height_attr( $image, $image_meta ) : string {
1068 | if ( empty( $image_meta ) ) {
1069 | return $image;
1070 | }
1071 |
1072 | $image_src = preg_match( '/src="([^"]+)"/', $image, $match_src ) ? $match_src[1] : '';
1073 |
1074 | // Return early if we couldn't get the image source.
1075 | if ( ! $image_src ) {
1076 | return $image;
1077 | }
1078 |
1079 | // Calculate width & height.
1080 | $size_array = get_img_src_dimensions( $image_src, $image_meta );
1081 | if ( ! $size_array ) {
1082 | return $image;
1083 | }
1084 |
1085 | // Make absolutely sure that height and width attributes are accurate.
1086 | list( $width, $height ) = wp_constrain_dimensions( $image_meta['width'], $image_meta['height'], $size_array[0], $size_array[1] );
1087 |
1088 | $hw = trim( image_hwstring( $width, $height ) );
1089 | return str_replace( '