Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 107 lines (70 sloc) 4.72 kb
4c2ae75 Importing the files and folders for the Get the Image plugin.
greenshady authored
1 === Get the Image ===
2 Contributors: greenshady
3 Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3687060
4 Tags: image, images, thumbnail
5 Requires at least: 2.9
7d49016 Bringing this up to 0.6.1 standards.
greenshady authored
6 Tested up to: 3.0.1
7 Stable tag: 0.6.1
4c2ae75 Importing the files and folders for the Get the Image plugin.
greenshady authored
8
9 An easy-to-use image script for adding things such as thumbnails and feature images.
10
11 == Description ==
12
13 *Get the Image* is a plugin that grabs images for you. It was designed to make the process of things such as adding thumbnails, feature images, and/or other images to your blog much easier, but it's so much more than that. It is an image-based representation of your WordPress posts.
14
15 This is a highly intuitive script that can grab an image by custom field input, WP's post image feature, post attachment, or extracting it from the post's content.
16
17 == Installation ==
18
19 1. Upload `get-the-image` to the `/wp-content/plugins/` directory.
20 1. Activate the plugin through the 'Plugins' menu in WordPress.
21 1. Add the appropriate code to your template files as outlined in the `readme.html` file.
22
23 More detailed instructions are included in the plugin's `readme.html` file. It is important to read through that file to properly understand all of the options and how the plugin works.
24
25 == Frequently Asked Questions ==
26
27 = Why was this plugin created? =
28
29 Many magazine-type themes require a lot of work when inputting images to make them look good. This plugin was developed to make that process much easier for the end user. But, at the same time, it needed to be flexible enough to handle anything.
30
31 Other scripts are bloated and offer odd solutions. This plugin uses the built-in methods of WordPress to create things such as feature images, thumbnails, galleries, or whatever.
32
33 This plugin was created to be a lightweight solution to handle a very powerful need in the WordPress community.
34
35 = How does it pull images? =
36
37 1. Looks for an image by custom field (one of your choosing).
38 1. If no image is added by custom field, check for an image using `the_post_thumbnail()` (WP 2.9's new image feature).
39 1. If no image is found, it grabs an image attached to your post.
40 1. If no image is attached, it can extract an image from your post content (off by default).
41 1. If no image is found at this point, it will default to an image you set (not set by default).
42
43 = How do I add it to my theme? =
44
45 There are several methods, but in general, you would use this call:
46
47 `
48 <?php if ( function_exists( 'get_the_image' ) ) get_the_image(); ?>
49 `
50
51 To see all methods and options, refer to the `readme.html` file included with the theme download.
52
53 == Screenshots ==
54
55 You can view this plugin in action on my <a href="http://justintadlock.com" title="Justin Tadlock's blog">personal blog</a> (note the thumbnails).
56
57 == Changelog ==
58
7d49016 Bringing this up to 0.6.1 standards.
greenshady authored
59 **Version 0.6.1**
60
61 * Updated inline documentation of the code.
62 * Smarter `meta_key` logic, which allows a single meta key or an array of keys to be used.
63 * Set `custom_key` and `default_size` to `null` by default since they're deprecated.
64
453f159 Updating the documentation for the plugin.
greenshady authored
65 **Version 0.6**
66
67 * Deprecated `custom_key` in favor of `meta_key`.
68 * Added the `meta_key_save` argument to allow users to save the image as a meta key/value pair.
69 * Added a `callback` argument to allow developers to create a custom callback function.
70 * Added a `cache` argument, which allows users to turn off caching.
4c2ae75 Importing the files and folders for the Get the Image plugin.
greenshady authored
71
ca5ff9c Bringing code up to version 0.5.
greenshady authored
72 **Version 0.5**
73
74 * Added support for persistent-caching plugins.
75 * Switched the `default_size` argument to `size` to be more in line with the WordPress post thumbnail arguments, but `default_size` will still work.
76 * Now using `wp_kses_hair()` to extract image attributes when using the `array` value for `format`.
77 * Image `alt` text will now use the attachment description if one has been given rather than the post title.
78 * Updated the `readme.html` instructions for using the plugin.
79
4c2ae75 Importing the files and folders for the Get the Image plugin.
greenshady authored
80 **Version 0.4**
81
82 * Dropped support for older versions of WordPress. Now only compatible with 2.9+.
83 * Added support for `the_post_thumbnail()`, which is WordPress 2.9's new image functionality.
84 * New function: `image_by_the_post_thumbnail()`.
85 * Documented more of the code, so the inline PHP doc is updated.
86 * Cleaned up some of the old legacy code that's no longer needed.
87
88 **Version 0.3.3**
89
90 * General code cleanup
91 * Added the `get_the_image` filter hook.
92
93 **Version 0.3.2**
94
95 * General code cleanup.
96 * More efficient and logical code.
97 * Beefed up the inline documentation so developers can better understand the code.
98 * Added a GPL license.txt file.
99
100 **Version 0.3.1**
101
102 * Fixed the default image and image scan features.
103
104 **Version 0.3**
105
106 * Changed methods of calling the image script.
107 * Added more parameters.
Something went wrong with that request. Please try again.