forked from peterhudec/image-metadata-cruncher
/
README.txt
139 lines (93 loc) · 4.39 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
=== Image Metadata Cruncher ===
Contributors: PeterHudec
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RJYHYJJD2VKAN
Tags: image, metadata, EXIF, IPTC, lightroom, photoshop, photomechanic, photostation, meta
Requires at least: 2.7
Tested up to: 3.5
Stable tag: 1.8
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
A versatile Swiss Army Knife for extraction and processing of IPTC, EXIF and other image metadata.
== Description ==
A must have tool for photographers who edit their images in **Lightroom** or **Photomechanic** and
don't want to waste their precious time by writing all the **keywords** and **categories**
once again by hand.
WordPress by default extracts the **EXIF ImageDescription** of an uploaded image to
the **Description** field and the **IPTC Headline** to the **Title** field of
the **Edit Media** form.
**Image Metadata Cruncher** gives you ultimate controll over this behaviour.
You decide what metadata gets where and in what form.
Moreover, the plugin's simple but powerfull templating system allows you to
convert the extracted metadata into complex strings like:
> Image was taken with Canon 7D, exposure was 1/125s and aperture was f/2.8.
You can even extract metadata to unlimited custom **post meta** that will be saved
with the image to the database.
The plugin also has some usefull public methods which you can use in your code:
This will return the complete metadata of the image in a stuctured array same as {ALL:PHP}.
$metadata = $image_metadata_cruncher->get_meta_by_path( '/path/to/your/image.jpg' );
The same but by attachment post ID.
$metadata = $image_metadata_cruncher->get_meta_by_id( $attachment_ID );
You can crunch an already uploaded attachment with the `crunch()` method.
The template and its indexes are optional. If missing, templates from plugin's settings will be used.
$template = array(
'title' => '{IPTC:Title}',
'caption' => '{IPTC:Caption}',
'description' => '{IPTC:Headline}',
'alt' => '{IPTC:Caption}',
'custom_meta' => array(
'camera-make' => '{EXIF:Make}',
'camera-model' => '{EXIF:Model}',
),
)
$image_metadata_cruncher->crunch( $attachment_ID, $template )
== Installation ==
Copy the **image-metadata-cruncher** folder into the plugins directory and activate.
== Screenshots ==
1. Plugin Settings
2. Available Metadata
3. How to Use Template tags
== Frequently Asked Questions ==
= Is it possible to extract metadata from already uploaded images? =
You can use the plugin's methods like this:
This will return the complete metadata of the image in a stuctured array same as {ALL:PHP}.
$metadata = $image_metadata_cruncher->get_meta_by_path( '/path/to/your/image.jpg' );
The same but by attachment post ID.
$metadata = $image_metadata_cruncher->get_meta_by_id( $attachment_ID );
You can crunch an already uploaded attachment with the `crunch()` method:
Which will extract metadata from the attachment image file and
update the attachment post according to the optional template array.
Templates from plugin settings will be used for missing indexes.
$template = array(
'title' => '{IPTC:Title}',
'caption' => '{IPTC:Caption}',
'description' => '{IPTC:Headline}',
'alt' => '{IPTC:Caption}',
'custom_meta' => array(
'camera-make' => '{EXIF:Make}',
'camera-model' => '{EXIF:Model}',
),
)
$image_metadata_cruncher->crunch( $attachment_ID, $template )
== Changelog ==
= 1.8 =
* Fixed a bug causing the `Invalid argument supplied for foreach()` warning.
= 1.7 =
* Now you can also use the plugin in your code to extract and crunch metadata of an attachment post.
* The syntax highlighting should now work on every browser.
* Fixed a bug when text inserted after the syntax highlighting has been disabled didn't get saved.
= 1.6 =
* Fixed a bug when the **enable highlighting** option didn't get saved.
* Fixed some potential security issues.
= 1.5 =
* Fixed a bug which threw an exif_read_data() warning introduced by previous update.
= 1.4 =
* Added keys **Image:basename**, **Image:filename** and **Image:extension**.
= 1.3 =
* Fixed broken links to plugin settings in the plugins page.
= 1.2 =
* Fixed a bug when the plugin extracted only the first item of an IPTC metadata of type array like IPTC:Keywords and IPTC:SupplementalCategories
= 1.1 =
* Fixed several bugs
* Added an option to disable syntax highlighting of template tags
= 1.0 =
* Initial version