Image Widget vs Photogallery

Image Widget is a simple plugin that uses the native WordPress media manager to add image widgets to your site. Image Widget Features Responsive MU Compatible Handles image resizing and alignment Link the image Add title and description Versatile – all fields are optional Upload, link to external image, or select an image from your media collection Customize the look & feel with filter hooks or theme overrides Quality You Can Trust Image Widget is developed and maintained by The Events Calendar, the same folks behind The Events Calendar, Event Tickets, and a full suite of premium plugins. This plugin is actively supported by our team and contributions from community members. If you see a question in the forum you can help with or have a great idea and want to code it up or submit a patch, that would be awesome! Not only will we shower you with praise and thanks, it’s also a good way to get to know us and lead into options for paid work if you freelance. Pull Requests & Translations Check us out on GitHub to pull request changes. Translations can be submitted here on WordPress.org. Documentation The built in template can be overridden by files within your template. Default vs. Custom Templates The Image Widget comes with a default template for the widget output. If you would like to alter the widget display code, create a new folder called “image-widget” in your template directory and copy over the “views/widget.php” file. Edit the new file to your hearts content. Please do not edit the one in the plugin folder as that will cause conflicts when you update the plugin to the latest release. New in 3.2: You may now also use the “sp_template_image-widget_widget.php” filter to override the default template behavior for .php template files. Eg: if you wanted widget.php to reside in a folder called my-custom-templates/ and wanted it to be called my-custom-name.php: add_filter('sp_template_image-widget_widget.php', 'my_template_filter'); function my_template_filter($template) { return get_template_directory() . '/my-custom-templates/my-custom-name.php'; } Filters There are a number of filters in the code that will allow you to override data as you see fit. The best way to learn what filters are available is always by simply searching the code for ‘apply_filters’. But all the same, here are a few of the more essential filters: widget_title This is actually a pretty typical filter in widgets and is applied to the widget title. widget_text Another very typical widget filter that is applied to the description body text. This filter also takes 2 additional arguments for $args and $instance so that you can learn more about the specific widget instance in the process of filtering the content. image_widget_image_attachment_id Filters the attachment id of the image. Accepts additional $args and $instance arguments. image_widget_image_url Filters the url of the image displayed in the widget. Accepts additional $args and $instance arguments. THIS IS DEPRECATED AND WILL EVENTUALLY BE DELETED image_widget_image_width Filters the display width of the image. Accepts additional $args and $instance arguments. image_widget_image_height Filters the display height of the image. Accepts additional $args and $instance arguments. image_widget_image_maxwidth Filters the inline max-width style of the image. Hint: override this to use this in responsive designs 🙂 Accepts additional $args and $instance arguments. Return null to remove this css from the image output (defaults to ‘100%’). image_widget_image_maxheight Filters the inline max-height style of the image. Accepts additional $args and $instance arguments. Return null to remove this css from the image output (defaults to null) image_widget_image_size Filters the selected image ‘size’ corresponding to WordPress registered sizes. If this is set to ‘tribe_image_widget_custom’ then the width and height are used instead. Accepts additional $args and $instance arguments. image_widget_image_align Filters the display alignment of the image. Accepts additional $args and $instance arguments. image_widget_image_alt Filters the alt text of the image. Accepts additional $args and $instance arguments. image_widget_image_link Filters the url that the image links to. Accepts additional $args and $instance arguments. image_widget_image_link_target Filters the link target of the image link. Accepts additional $args and $instance arguments. image_widget_image_attributes Filters a list of image attributes used in the image output. Similar to ‘wp_get_attachment_image_attributes’ Accepts $instance arguments image_widget_link_attributes Filters a list of attributes used in the image link. Similar to ‘wp_get_attachment_image_attributes’ Accepts $instance arguments Have You Supported the Image Widget? If so, then THANK YOU! Also, feel free to add this line to your wp-config.php file to prevent the image widget from displaying a message after upgrades. define( ‘I_HAVE_SUPPORTED_THE_IMAGE_WIDGET’, true ); For more info on the philosophy here, check out our blog post

This plugin is meant primarily for theme developers. This plugin allows to collect photos from the the Media Manager and arrange them into albums. These albums can be combined into galleries. Both albums and galleries can be added to a theme’s navigation menu. Note that this plugin does not provide any CSS formatting and JavaScript for frontend presentation of galleries and albums. You have to format them yourself and integrate necessary JavaScript libraries, e.g Lightbox, yourself. This plugin merely gives a framework for gallery and album creation via custom post types and registration of designs for a frontend presentation. If you found a bug or have any questions, complains or suggestions please feel free to contact me. Theme Integration You have to write post type template files for your theme in order for an album or gallery to work. This gives Theme developers the most control over a frontend presentation and users a convenient way to create galleries through the WordPress dashboard. If you install this plugin, create albums and galleries and include them into your theme’s menu, you will be disappointed, since nothing will happen. Create two php files inside your theme’s directory: single-photogallery.php and single-photoalbum.php. single-photogallery.php gets called everytime a gallery is about to be viewed single-photoalbum.php gets called everytime a album is about to be viewed Now you have two options. You can register a custom design inside your theme’s function.php via e.g $kt_Photogallery->register_gallery_design() and call $kt_Photogallery->render() at an appropriated place inside your single-photogallery.php to render it depending on the user’s choice. You fetch albums, images and thumbnail details, and render consistent HTML for all albums and galleries. Refere to the PHP API section for further details on how to retrieve album IDs, image IDs and thumbnail details. Example A basic example for a custom gallery design # functions.php $kt_Photogallery->register_gallery_design ('my_gallery_design', array( 'label' => __('My Gallery Design', 'my-textdomain'), 'icon' => 'dashicons-format-gallery', 'title' => __('This is my custom gallery design', 'my-textdomain'), 'render' => 'render_my_gallery_design' )); $kt_Photogallery->register_album_design ('my_album_design', array( 'label' => __('My Album Design', 'my-textdomain'), 'icon' => 'dashicons-format-image', 'title' => __('This is my custom album design', 'my-textdomain'), 'render' => 'render_my_album_design' )); function render_my_gallery_design ($post) { global $kt_Photogallery; $album_IDs = $kt_Photogallery->get_albums($post); if ($album_IDs) { foreach ($album_IDs as $album_ID) { $album_thumbnail = $kt_Photogallery->get_thumbnail_src($album_ID); echo ' '; if ($album_thumbnail) { echo ' '; } echo ' '; } } else { printf(__('The gallery %s does not contain any albums', 'my-textdomain'), esc_html($post->post_title)); } } function render_my_album_design ($post) { global $kt_Photogallery; $image_IDs = $kt_Photogallery->get_images($post); if ($image_IDs) { foreach ($image_IDs as $image_ID) { $image = get_post($image_ID); if ($image) { $image_src = wp_get_attachment_image_src($image_ID, 'medium'); if (!$image_src) { $image_src = wp_get_attachment_image_src($image_ID, 'full'); } echo ' '; } } } else { printf(__('The album %s does not contain any images', 'my-textdomain'), esc_html($post->post_title)); } } Basic integration into Twenty Fifteen: # single-photogallery.php or single-photoalbum.php get_header(); ?> ', ' '); ?> render(); ?> get_album_count ( [$gallery_ID] ) Returns the number of albums associated with a gallery Argument int|null $gallery_ID Optional – ID of a gallery. Defaults to the current ID if used inside the Loop Returns integer|boolean – Returns an integer on success, or false if $gallery_ID yields no gallery $kt_Photogallery->get_albums ( [$gallery_ID] ) Returns an array of album IDs associated with a gallery. Argument int|null $gallery_ID Optional – ID of a gallery. Defaults to the current ID if used inside the Loop Returns array|boolean – Returns an array of IDs on success, false if $gallery_ID yields no gallery $kt_Photogallery->get_image_count ( [$album_ID] ) Returns the number of images associated with an album Argument int|null $album_ID Optional – ID of an album. Defaults to the current ID if used inside the Loop Returns integer|boolean – Returns an integer on success, or false if $album_ID yields no album $kt_Photogallery->get_images ( [$album_ID] ) Returns an array of image IDs associated with an album. Argument int|null $album_ID Optional – ID of an album. Defaults to the current ID if used inside the Loop Returns array|boolean – Returns an array of IDs on success, false if $album_ID yields no album $kt_Photogallery->get_thumbnail ( [$album_ID, [$fallback] ] ) Returns the ID of the image (attachment) used as thumbnail for an album Argument int|null $album_ID Optional – ID of an album. Defaults to the current ID if used inside the Loop Argument boolean $fallback Optional – if true and $album_ID yields no album the method returns the ID of the first image associated with the album. Default is true Returns integer|false – Returns an integer on success, false if $album_ID yields no album, no thumbnail is set or a fallback could not been resolved $kt_Photogallery->get_thumbnail_src ( [$album_ID, [$fallback] ] ) Returns an ordered array with values corresponding to the (0) url, (1) width, (2) height and (3) scale of the thumbnail associated with an album. Argument int|null $album_ID Optional – ID of an album. Defaults to the current ID if used inside the Loop Argument boolean $fallback Optional – if true and $album_ID yields no album the method returns the ID of the first image associated with the album. Default is true Returns array|false – Returns an array on success, false if $album_ID yields no album, no thumbnail is set or a fallback could not been resolved $kt_Photogallery->register_album_design ( $key, $options ) $kt_Photogallery->register_gallery_design ( $key, $options ) Registers a custom design for albums and galleries respectively. The design will be available in the Design metabox during editing Returns boolean – returns true if the design was registered successfully, false on failure. Argument string $key Required – A key used as id inside HTML/CSS and for general identification Argument callable|array $options Required – A callback rendering the design on the frontend or an associative array: string label – The text for the label string icon – The image shown next to the label. Can be dashicons-*, an URL to an image or a base 64 encoded image string title – Text used inside the HTML title attribute, usually containing a description callback render ($post, $options) – Callback rendering the design on the frontend. The arguments passed are the current post as a WP_Post instance and an associative array of the options straight from the database callback options ($current_options, $defaults, $post) – Callback for additional form fields, should echo HTML. The arguments passed are an associative array of the options straight from the database, the default options as second argument and the current post as a WP_Post instance as third. array defaults – Associative array containing default values for options. Its keys are used during saving so you should generate HTML form fields using its keys and provide a callback for filtering. callback filter ($current_options, $defaults, $post) – Callback for filtering the options before they are saved. This callback is called every time a post is saved. The arguments passed are the default options merged with the values from the current request, the default options as second argument and the current post as a WP_Post instance as third. The callback must return an associative array otherwise no options are stored. $kt_Photogallery->render( [$auto_design] ) Main output method. Depending on the current post type the method prints out a design for a gallery or an album. Argument boolean auto_design optional – If set true and no design is found, take the first registered one and proceed. Default is true Returns boolean – Returns true on success, false otherwise