avatar_url: The URL to the image
show_image_dim: 1 indicates to show image dimensions, 0 to hide them
image_height: integer value of image height or null if image dimensions is turned off
image_width: integer value of image width or null if image dimensions is turned off
post_id: ID of current post
post_title: Post title for the image attribute
image_name: Image file name

Example: Display a default image if no avatar is selected

This example makes use of the HTML/CSS settings defined by the site admin.

If you want to change the HTML completely or override the option to display avatars automatically, use the remove_filter() like so:
remove_filter(‘the_content’, ‘gkl_postavatar_filter’, 99 );
remove_filter(‘the_excerpt’, ‘gkl_postavatar_filter’, 99 );

You can then define your own the_content filter function that makes use of the gkl_postavatar() or gkl_get_postavatar() functions

You will need to use the function gkl_get_postavatar() which takes the post object and returns the array of post avatar information.

$post_avatar_array – Post Avatar data in array format. The keys are:

avatar_url: The URL to the image
show_image_dim: 1 indicates to show image dimensions, 0 to hide them
image_height: integer value of image height or null if image dimensions is turned off
image_width: integer value of image width or null if image dimensions is turned off
post_id: ID of current post
post_title: Post title for the image attribute
image_name: Image file name

If you want the post avatar to appear outside of the content, e.g. with the entry’s meta information, make use of the gkl_postavatar() template tag.

It takes four paramters:

class: CSS class to use in the `<img>` tag.
before: HTML to appear before the image.
after: HTML to appear after the image.
do_what: Use `echo` to display the post avatar, `return` to pass it to a variable. Defaults to `echo`.

Or you can make your own template tag function like in the example for “Override HTML display with custom content hook”, except you call the function directly in your template instead of hooking into the_content().

For Administration Screens

Add Post Avatar to Pages and Custom Post Types

Use the filter hook gklpa_allowed_post_types to add further post types that you want the Post Avatar selection to appear on.

By default, Post Avatar looks for your images folder in relation to your WordPress installation. If you want to move your folder elsewhere, use these pair of filter hooks: gklpa_image_url and gklpa_image_dir. They take a single parameter: Image folder url and absolute path to the image folder, respectively.

Show avatar in post? Disable to use template tag. – Tick this so that the chosen post avatar will be automatically displayed in your post, just prior to your post content. Enabled by default.

Scan the images directory and its sub-directories – Tick this to include images stored in sub-directories of the images folder during the avatar selection. Enabled by default.

Get image dimensions? Disable this feature if you encounter getimagesize errors – Turned on by default, a tick mark here will determine the image’s width and height. If you encounter any getimagesize errors, turn this feature off.

Show post avatars in RSS feeds? – Turned off by default, place a tick mark here to include avatars in your RSS feeds.

Customize HTML/CSS – These options help you further customize how post avatars will look.

A. Use this HTML before/after the post avatar image – Enter the HTML code that will wrap around the image. Can be left blank. The plugin defaults to <div class="postavatar"></div>.

Go to the Post Editor screen. Below the content text area you will find the Post Avater section.

Select the image name from the dropdown list. You can also use the next and previous arrow buttons on either side of the dropdown to scroll through images.

Once you’ve made your selection, click Publish for a new post or Update for a previously saved one.

FAQ

Can I upload images with the Post Avatar plugin?

No. Post Avatar does not support image uploads. It simply looks up the list of images that you’ve defined in the plugin settings. Images will need to be transferred via FTP or a file manager.
However, there are a few workarounds:
1. Make your image folder the same as your WordPress uploads folder to include images from the Media Library in the Post Avatar list. Or,
2. Install a plugin that will let you upload images to a folder other than the WordPress uploads folder.

How is Post Avatar different from Featured Images?

Post Avatar pre-dates Featured Images by 3 years and while both attach an image to a post, Post Avatar makes use of the same images while Featured Images is more for a unique image.

I designed Post Avatar so I can selec images right from the Post Editor screen.
Also, I prefer to use images with smaller dimensions (usually 250px by 250px and lower).
Post Avatar is more efficient when used with a relatively short list of images (anything in the range of more thousands of images and I suggest you stay with Featured Images).

I’m new to WordPress. How can I change the styling of the image I’ve chosen?

You can make use of the HTML/CSS options in the Post Avatar settings page to make sure that the image’s look is in line with your theme. See Configuration options.

Can I have multiple Post Avatar boxes for different folder locations in the Editor screen?

No. Post Avatar only displays a single list of images scanned from the folder you specified in the Post Avatar settings screen.

Can I use Post Avatar with custom post types?

Not by default. If you’re comfortable with editing your theme’s function.php file you can use the custom filter ‘gklpa_allowed_post_types’ to enable the Post Avatar functionality on custom post types and pages. Please see the Developer section for more details

Contributors & Developers

“Post Avatar” is open source software. The following people have contributed to this plugin.