Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 170 lines (112 sloc) 7.852 kb
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
1 === Get the Image ===
1ca1b9c3 »
2013-09-30 More readme updates.
2
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
3 Contributors: greenshady
6ffdc6f6 »
2012-12-18 Updates for the 0.8.1 version. Includes changelog.
4 Donate link: http://themehybrid.com/donate
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
5 Tags: image, images, thumbnail
1ca1b9c3 »
2013-09-30 More readme updates.
6 Requires at least: 3.5
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
7 Tested up to: 3.7
8 Stable tag: 0.9.0
1ca1b9c3 »
2013-09-30 More readme updates.
9 License: GPLv2 or later
10 License URI: http://www.gnu.org/licenses/gpl-2.0.html
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
11
1ca1b9c3 »
2013-09-30 More readme updates.
12 An easy-to-use image script for adding things such as thumbnail, slider, gallery, and feature images.
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
13
14 == Description ==
15
1ca1b9c3 »
2013-09-30 More readme updates.
16 Get the Image is one of the most advanced thumbnail/image scripts ever created for WordPress.
17
18 It is used everywhere from small blogs to large, enterprise-level solutions like [WordPress.com VIP](http://vip.wordpress.com/). Get the Image offers something for everybody. Much of the reason for its success is because it uses standard WordPress code and methods for doing what it needs to do, which is to simply grab images.
19
20 The plugin was designed to make the process of adding thumbnail, featured, slider, gallery, and 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.
21
22 This is a highly intuitive script that can grab an image by custom field input, WordPress' featured image, post attachment, or extracting it from the post's content. Plus, a lot more!
23
24 ### A little history ###
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
25
1ca1b9c3 »
2013-09-30 More readme updates.
26 The original plugin was in launched 2008, which means it has several years of solid testing and development behind it. It was created at a time when WordPress had very little native media support. At the time, it was mostly used as a "thumbnail" script for magazine-/news-style sites. But, it has grown into a much more flexible script over the years.
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
27
1ca1b9c3 »
2013-09-30 More readme updates.
28 Even with WordPress' more recent advancements in image management, many users still continue using this plugin because it offers a more robust image script than core WordPress.
29
30 The plugin has been downloaded 100,000s of times and is used on millions of sites as part of WordPress theme packages.
31
32 Other image plugins have come and gone, but Get the Image has stood the test of time with several years of successful installs and happy users.
33
34 ### Professional support ###
35
36 If you need professional plugin support from me, the plugin author, you can access the support forums at [Theme Hybrid](http://themehybrid.com/support), which is a professional WordPress help/support site where I handle support for all my plugins and themes for a community of 40,000+ users (and growing).
6ffdc6f6 »
2012-12-18 Updates for the 0.8.1 version. Includes changelog.
37
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
38 == Installation ==
39
40 1. Upload `get-the-image` to the `/wp-content/plugins/` directory.
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
41 2. Activate the plugin through the 'Plugins' menu in WordPress.
42 3. Add the appropriate code to your template files as outlined in the `readme.md` file.
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
43
44 == Frequently Asked Questions ==
45
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
46 ### Why was this plugin created? ###
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
47
1ca1b9c3 »
2013-09-30 More readme updates.
48 It was originally created to work with magazine/news themes. These types of themes typically required 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.
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
49
1ca1b9c3 »
2013-09-30 More readme updates.
50 However, over the years, it has grown to be one of the most robust image scripts for WordPress.
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
51
1ca1b9c3 »
2013-09-30 More readme updates.
52 ### How does it grab images? ###
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
53
54 1. Looks for an image by custom field (one of your choosing).
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
55 2. If no image is added by custom field, check for an image using `the_post_thumbnail()` (WordPress featured image).
56 3. If no image is found, it grabs an image attached to your post.
57 4. If no image is attached, it can extract an image from your post content (off by default).
1ca1b9c3 »
2013-09-30 More readme updates.
58 5. If no image is found at this point, it will fall back to a default image (not set by default).
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
59
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
60 ### How do I add it to my theme? ###
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
61
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
62 There are several methods, but in general, you would use this call within The Loop.
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
63
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
64 <?php if ( function_exists( 'get_the_image' ) ) get_the_image(); ?>
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
65
1ca1b9c3 »
2013-09-30 More readme updates.
66 To see all methods and options, refer to the `readme.md` file included with the plugin download.
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
67
68 == Screenshots ==
69
31a11087 »
2013-09-29 Added some long overdue screenshots for the plugin.
70 1. Slider plus thumbnails.
71 2. Portfolio images.
72 3. Gallery-style thumbnails.
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
73
74 == Changelog ==
75
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
76 ### Version 0.9.0 ###
77
1ca1b9c3 »
2013-09-30 More readme updates.
78 #### Enhancements: ####
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
79
80 * Caption support. FTW!
81 * Multiple image classes now allowed via the `image_class` argument.
1ca1b9c3 »
2013-09-30 More readme updates.
82 * Use current theme's `post-thumbnail` as default image size if set via `set_post_thumbnail_size()`.
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
83
1ca1b9c3 »
2013-09-30 More readme updates.
84 #### Bug fixes: ####
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
85
86 * Use the WordPress-saved attachment alt text for the image.
87 * Only add `$out['src']` if `$out['url']` is set when returning as an array.
88 * Allow `https` when returning as an array.
89 * Use the correct variable (`$attachment_id`) when getting an image via attachment.
90
91 ### Version 0.8.1 ###
6ffdc6f6 »
2012-12-18 Updates for the 0.8.1 version. Includes changelog.
92
93 * Use correct `$attachment_id` variable instead of `$id`.
94 * Pass full `$image` array to the `get_the_image_meta_key_save()` function so that it saves correctly.
95 * Only use `before` and `after` arguments if an image is found.
96 * General code formatting updated.
97
1ca1b9c3 »
2013-09-30 More readme updates.
98 ### Version 0.8 ###
8d6c873a »
2012-06-12 Bringing plugin up to date with version 0.8 of the Get the Image script.
99
100 * Inline docs updates.
101 * Added the `before` argument to output HTML before the image.
102 * Added the `after` argument to output HTML after the image.
103 * Added the `thumbnail_id_save` argument to allow the attached image to be saved as the thumbnail/featured image.
104 * Get the post ID via `get_the_ID()` rather than the global `$post` object.
105 * Fixed debug notice with `$image_html`.
106 * Moved the `*_fetch_post_thumbnail_html` hooks into the main function and only fire them if displaying to the screen.
107 * Simplified the `meta_key` logic.
108 * Completely rewrote the `attachment` logic.
109 * Sanitize classes with `sanitize_html_class()`.
110
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
111 ### Version 0.7 ###
9933b0bd »
2011-09-19 Updating plugin to use version 0.7 of the script.
112
113 * Deprecated and replaced functions that lacked the `get_the_image_` prefix.
114 * New cache delete functions that delete when a post or post meta is updated.
115 * Fixed notice when `image_scan` was used.
116
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
117 ### Version 0.6.2 ###
bd4cc246 »
2011-04-15 Bringing plugin up to version 0.6.2.
118
119 * Updated the cache to save by post ID instead of a single object.
120 * Minor code adjustments.
121
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
122 ### Version 0.6.1 ###
7d490160 »
2010-10-23 Bringing this up to 0.6.1 standards.
123
124 * Updated inline documentation of the code.
125 * Smarter `meta_key` logic, which allows a single meta key or an array of keys to be used.
126 * Set `custom_key` and `default_size` to `null` by default since they're deprecated.
127
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
128 ### Version 0.6 ###
453f159f »
2010-10-23 Updating the documentation for the plugin.
129
130 * Deprecated `custom_key` in favor of `meta_key`.
131 * Added the `meta_key_save` argument to allow users to save the image as a meta key/value pair.
132 * Added a `callback` argument to allow developers to create a custom callback function.
133 * Added a `cache` argument, which allows users to turn off caching.
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
134
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
135 ### Version 0.5 ###
ca5ff9c5 »
2010-07-17 Bringing code up to version 0.5.
136
137 * Added support for persistent-caching plugins.
138 * Switched the `default_size` argument to `size` to be more in line with the WordPress post thumbnail arguments, but `default_size` will still work.
139 * Now using `wp_kses_hair()` to extract image attributes when using the `array` value for `format`.
140 * Image `alt` text will now use the attachment description if one has been given rather than the post title.
141 * Updated the `readme.html` instructions for using the plugin.
142
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
143 ### Version 0.4 ###
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
144
145 * Dropped support for older versions of WordPress. Now only compatible with 2.9+.
146 * Added support for `the_post_thumbnail()`, which is WordPress 2.9's new image functionality.
147 * New function: `image_by_the_post_thumbnail()`.
148 * Documented more of the code, so the inline PHP doc is updated.
149 * Cleaned up some of the old legacy code that's no longer needed.
150
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
151 ### Version 0.3.3 ###
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
152
153 * General code cleanup
154 * Added the `get_the_image` filter hook.
155
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
156 ### Version 0.3.2 ###
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
157
158 * General code cleanup.
159 * More efficient and logical code.
160 * Beefed up the inline documentation so developers can better understand the code.
161 * Added a GPL license.txt file.
162
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
163 ### Version 0.3.1 ###
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
164
165 * Fixed the default image and image scan features.
166
b0015fdf »
2013-09-29 Readme updates. Drop the readme.html file in favor of readme.md.
167 ### Version 0.3 ###
4c2ae75d »
2010-07-17 Importing the files and folders for the Get the Image plugin.
168
169 * Changed methods of calling the image script.
170 * Added more parameters.
Something went wrong with that request. Please try again.