forked from Labs64/credit-tracker
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcredit-tracker-shortcodes.php
423 lines (408 loc) · 15.5 KB
/
credit-tracker-shortcodes.php
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
<?php
/**
* Plugin shortcodes.
*
* @package Credit_Tracker
* @author Labs64 <[email protected]>
* @license GPL-2.0+
* @link http://www.labs64.com
* @copyright 2013 Labs64
*/
// add shortcodes
add_shortcode('credit_tracker_table', 'credit_tracker_table_shortcode');
add_filter('img_caption_shortcode', 'credit_tracker_caption_shortcode_filter', 10, 3);
add_filter('post_gallery', 'credit_tracker_gallery_caption_shortcode_filter', 10, 3);
add_filter('post_thumbnail_html', 'credit_tracker_thumbnail', 99, 3);
function credit_tracker_table_shortcode($atts)
{
$columns_set_default = array(
'ident_nr' => __('Ident-Nr.', CREDITTRACKER_SLUG),
'author' => __('Author', CREDITTRACKER_SLUG),
'publisher' => __('Publisher', CREDITTRACKER_SLUG),
'copyright' => __('Copyright', CREDITTRACKER_SLUG),
'license' => __('License', CREDITTRACKER_SLUG),
);
$columns_set_optional = array(
'source' => __('Source', CREDITTRACKER_SLUG),
'title' => __('Title', CREDITTRACKER_SLUG),
'caption' => __('Caption', CREDITTRACKER_SLUG),
'link' => __('Link', CREDITTRACKER_SLUG)
);
$columns_set_i18n = array_merge($columns_set_default, $columns_set_optional);
$columns_set = implode(",", array_keys($columns_set_default));
extract(shortcode_atts(
array(
'id' => '',
'size' => 'thumbnail',
'style' => 'default',
'include_columns' => $columns_set,
'only_current_post' => false,
), $atts)
);
if (empty($include_columns)) {
$include_columns = $columns_set;
}
$columns = explode(",", $include_columns);
foreach ($columns as $key => $value) {
$columns[$key] = trim($columns[$key]);
}
if (is_numeric($size)) {
$size = array($size, $size);
} else if (stripos($size, 'x') !== false) {
$size = explode('x', $size);
}
$request = array(
'size' => $size,
'include' => $id,
);
$request['only_current_post'] = isset( $atts['only_current_post'] ) ? boolval( $atts['only_current_post'] ) : false;
$images = credittracker_get_images($request);
$ret = '<table id="credit-tracker-table" class="credit-tracker-' . $style . '"><thead>';
if ($size !== 'hidden') {
$ret .= '<th>' . ' ' . '</th>';
}
foreach ($columns as $column) {
if (!empty($column)) {
$column_name = $columns_set_i18n[$column];
if (empty($column_name)) {
$column_name = $column;
}
$ret .= '<th>' . $column_name . '</th>';
}
}
$ret .= '</thead><tbody>';
if (empty($images)) {
$ret .= '<tr class="credit-tracker-row"><td colspan="6" class="credit-tracker-column-empty">' . __('No images found', CREDITTRACKER_SLUG) . '</td></tr>';
}
foreach ($images as $image) {
if (!empty($image['author']) or !empty($image['publisher'])) {
$ct_copyright_format = credittracker_get_source_copyright($image['source']);
if (empty($ct_copyright_format)) {
$ct_copyright_format = credittracker_get_single_option('ct_copyright_format');
}
$ret .= '<tr>';
if ($size == 'linkonly') {
$imageName = $image['caption'];
if (empty($imageName)) {
$imageName = $image['title'];
}
$ret .= '<td>' . '<a href="' . $image['url'] . '" class="attachment-linkonly" alt="' . $image['alt'] . '">' . $imageName . '</a>' . '</td>';
} elseif ($size !== 'hidden') {
$ret .= '<td>' . '<img width="' . $image['width'] . '" height="' . $image['height'] . '" src="' . $image['url'] . '" class="attachment-thumbnail" alt="' . $image['alt'] . '">' . '</td>';
}
foreach ($columns as $column) {
if (!empty($column)) {
if ($column == 'copyright') {
$ret .= '<td>' . credittracker_process_item_copyright($image, $ct_copyright_format) . '</td>';
} else if ($column == 'source') {
$ret .= '<td>' . credittracker_get_source_caption($image[(string)$column], false) . '</td>';
} else {
$ret .= '<td>' . $image[(string)$column] . '</td>';
}
}
}
$ret .= '</tr>';
}
}
$ret .= '</tbody></table>';
return $ret;
}
function credit_tracker_caption_shortcode_filter($val, $attr, $content = null)
{
extract(shortcode_atts(
array(
'id' => '',
'align' => 'aligncenter',
'width' => '',
'caption' => '',
'text' => '',
'type' => 'caption'
), $attr)
);
$ct_override_caption_shortcode = credittracker_get_single_option('ct_override_caption_shortcode');
if ((bool)$ct_override_caption_shortcode) {
$id_orig = $id;
if ($id) {
$id = esc_attr($id);
}
// extract attachment id
preg_match("/\d+/", $id, $matches);
if (!empty($matches)) {
$id = $matches[0];
}
// find attachment
$request = array(
'size' => 'thumbnail',
'include' => $id
);
$images = credittracker_get_images($request);
if (empty($images)) {
return $val;
}
$image = reset($images);
$ct_copyright_format = credittracker_get_source_copyright($image['source']);
if (empty($ct_copyright_format)) {
$ct_copyright_format = credittracker_get_single_option('ct_copyright_format');
}
// override image caption via 'text' attribute
if (!empty($text)) {
$image['caption'] = $text;
}
$ct_copyright = htmlspecialchars_decode(credittracker_process_item_copyright($image, $ct_copyright_format));
$content = str_replace('<img', '<img itemprop="contentUrl"', $content);
$content = str_replace("%copyright%", $ct_copyright, $content);
$content = credittracker_process_item_copyright($image, $content);
$style = '';
if ((int)$width > 0) {
$style = 'style="width: ' . (int)$width . 'px"';
}
$ret = '<div id="' . $id_orig . '" class="wp-caption credit-tracker-caption ' . esc_attr($align) . '" itemscope itemtype="http://schema.org/ImageObject" ' . $style . '>';
$ret .= do_shortcode($content);
$ret .= '<p class="wp-caption-text" itemprop="copyrightHolder">' . $ct_copyright . '</p>';
$ret .= '<meta itemprop="name" content="' . $image['title'] . '">';
$ret .= '<meta itemprop="caption" content="' . $image['caption'] . '">';
$ret .= '<meta itemprop="author" content="' . $image['author'] . '">';
$ret .= '<meta itemprop="publisher" content="' . $image['publisher'] . '">';
$ret .= '</div>';
return $ret;
} else {
return $val;
}
}
/**
* Filters the post thumbnail markup to add the 'credit' information as figure/ficaption markup.
*
* @param string $html The post thumbnail HTML
* @param $post_id The post ID, currently unused.
* @param $post_thumbnail_id The post thumbnail ID, used to get the attachment meta fields.
*
* @return string The modified markup for post thumbnail, if it contains an author for crediting.
*/
function credit_tracker_thumbnail( $html, $post_id, $post_thumbnail_id )
{
$ct_override_featured_image_caption = credittracker_get_single_option('ct_override_featured_image_caption');
if ($ct_override_featured_image_caption==1) {
$trigger = false;
}
else if ($ct_override_featured_image_caption==2 && !is_front_page()) {
$trigger = true;
}
else if ($ct_override_featured_image_caption==3) {
$trigger = true;
}
if ($trigger and !empty($post_thumbnail_id)) {
// Get the post_meta for the attachment post.
$image_post_meta = get_post_meta( $post_thumbnail_id );
// Get the attachment meta for the attachment post.
$attachment_meta = wp_get_attachment_metadata( $post_thumbnail_id );
// Add title and caption to processed_meta array.
$processed_meta = array(
'title' => $attachment_meta['image_meta']['title'],
'caption' => $attachment_meta['image_meta']['caption'],
);
// Modify the meta so that it matches what is expected in the `credittracker_process_item_copyright`
foreach ( $image_post_meta as $key => $meta ) {
$new_key = substr( $key, 15 );
$processed_meta[ $new_key ] = $meta[0];
}
// Get the correct copyright text, as set by user in site option, for this thumbnail.
$ct_copyright_format = credittracker_get_single_option('ct_copyright_format' );
$ct_copyright = htmlspecialchars_decode( credittracker_process_item_copyright( $processed_meta, $ct_copyright_format ) );
if ( ! empty( $ct_copyright ) ) {
$html = sprintf(
'<figure>
%1$s
<figcaption class="credit-tracker-thumbnail">%2$s</figcaption>
</figure>',
$html,
esc_html( $ct_copyright )
);
}
return $html;
} else {
return $html;
}
}
/*MOD
This function generates the captions for all the images in a gallery.
Major part of the code is simply a slightly modified copy of gallery_shortcode function in WP media.php (lines 1665-1795 and 1801-1815)
Its modified lines are marked in the code*/
function credit_tracker_gallery_caption_shortcode_filter($output, $attr, $instance)
{
$ct_override_caption_shortcode = credittracker_get_single_option('ct_override_caption_shortcode');
if ((bool)$ct_override_caption_shortcode) {
static $instance = 0;
$instance++;
if ( ! empty( $attr['ids'] ) ) {
// 'ids' is explicitly ordered, unless you specify otherwise.
if ( empty( $attr['orderby'] ) ) {
$attr['orderby'] = 'post__in';
}
$attr['include'] = $attr['ids'];
}
$html5 = current_theme_supports( 'html5', 'gallery' );
$atts = shortcode_atts( array(
'order' => 'ASC',
'orderby' => 'menu_order ID',
'id' => $post ? $post->ID : 0,
'itemtag' => $html5 ? 'figure' : 'dl',
'icontag' => $html5 ? 'div' : 'dt',
'captiontag' => $html5 ? 'figcaption' : 'dd',
'columns' => 3,
'size' => 'thumbnail',
'include' => '',
'exclude' => '',
'link' => ''
), $attr, 'gallery' );
$id = intval( $atts['id'] );
if ( ! empty( $atts['include'] ) ) {
$_attachments = get_posts( array( 'include' => $atts['include'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
$attachments = array();
foreach ( $_attachments as $key => $val ) {
$attachments[$val->ID] = $_attachments[$key];
}
} elseif ( ! empty( $atts['exclude'] ) ) {
$attachments = get_children( array( 'post_parent' => $id, 'exclude' => $atts['exclude'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
} else {
$attachments = get_children( array( 'post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
}
if ( empty( $attachments ) ) {
return '';
}
if ( is_feed() ) {
$ret = "\n";
foreach ( $attachments as $att_id => $attachment ) {
$ret .= wp_get_attachment_link( $att_id, $atts['size'], true ) . "\n";
}
return $ret;
}
$itemtag = tag_escape( $atts['itemtag'] );
$captiontag = tag_escape( $atts['captiontag'] );
$icontag = tag_escape( $atts['icontag'] );
$valid_tags = wp_kses_allowed_html( 'post' );
if ( ! isset( $valid_tags[ $itemtag ] ) ) {
$itemtag = 'dl';
}
if ( ! isset( $valid_tags[ $captiontag ] ) ) {
$captiontag = 'dd';
}
if ( ! isset( $valid_tags[ $icontag ] ) ) {
$icontag = 'dt';
}
$columns = intval( $atts['columns'] );
$itemwidth = $columns > 0 ? floor(100/$columns) : 100;
$float = is_rtl() ? 'right' : 'left';
$selector = "gallery-{$instance}";
$gallery_style = '';
/**
* Filters whether to print default gallery styles.
*
* @since 3.1.0
*
* @param bool $print Whether to print default gallery styles.
* Defaults to false if the theme supports HTML5 galleries.
* Otherwise, defaults to true.
*/
$gallery_style = "
<style type='text/css'>
#{$selector} {
margin: auto;
}
#{$selector} .gallery-item {
float: {$float};
margin-top: 10px;
text-align: center;
width: {$itemwidth}%;
}
#{$selector} img {
border: 2px solid #cfcfcf;
}
#{$selector} .gallery-caption {
margin-left: 0;
}
/* see gallery_shortcode() in wp-includes/media.php */
</style>\n\t\t";
$size_class = sanitize_html_class( $atts['size'] );
$gallery_div = "<div id='$selector' class='gallery galleryid-{$id} gallery-columns-{$columns} gallery-size-{$size_class}'>";
/**
* Filters the default gallery shortcode CSS styles.
*
* @since 2.5.0
*
* @param string $gallery_style Default CSS styles and opening HTML div container
* for the gallery shortcode output.
*/
$ret = apply_filters( 'gallery_style', $gallery_style . $gallery_div );
$i = 0;
foreach ( $attachments as $id => $attachment ) {
$attr = ( trim( $attachment->post_excerpt ) ) ? array( 'aria-describedby' => "$selector-$id" ) : '';
if ( ! empty( $atts['link'] ) && 'file' === $atts['link'] ) {
$image_output = wp_get_attachment_link( $id, $atts['size'], false, false, false, $attr );
} elseif ( ! empty( $atts['link'] ) && 'none' === $atts['link'] ) {
$image_output = wp_get_attachment_image( $id, $atts['size'], false, $attr );
} else {
$image_output = wp_get_attachment_link( $id, $atts['size'], true, false, false, $attr );
}
$image_meta = wp_get_attachment_metadata( $id );
$orientation = '';
if ( isset( $image_meta['height'], $image_meta['width'] ) ) {
$orientation = ( $image_meta['height'] > $image_meta['width'] ) ? 'portrait' : 'landscape';
}
$ret .= "<{$itemtag} class='gallery-item'>";
$ret .= "
<{$icontag} class='gallery-icon {$orientation}'>
$image_output
</{$icontag}>";
if ( $captiontag && trim($attachment->post_excerpt) ) {
/*Modified part that outputs the caption text itself*/
$id_orig = $id;
if ($id) {
$id = esc_attr($id);
}
// extract attachment id
preg_match("/\d+/", $id, $matches);
if (!empty($matches)) {
$id = $matches[0];
}
// find attachment
$request = array(
'size' => 'thumbnail',
'include' => $id
);
$images = credittracker_get_images($request);
if (empty($images)) {
return $val;
}
$image = reset($images);
// override image caption via 'text' attribute
if (!empty($text)) {
$image['caption'] = $text;
}
$ct_copyright_format = credittracker_get_source_copyright($image['source']);
if (empty($ct_copyright_format)) {
$ct_copyright_format = credittracker_get_single_option('ct_copyright_format');
}
$ct_copyright = htmlspecialchars_decode(credittracker_process_item_copyright($image, $ct_copyright_format));
$ret .= "
<{$captiontag} class='wp-caption-text gallery-caption' id='$selector-$id'>
" . $ct_copyright . "
</{$captiontag}>";
}
/*identical to media.php of WP*/
$ret .= "</{$itemtag}>";
if ( ! $html5 && $columns > 0 && ++$i % $columns == 0 ) {
$ret .= '<br style="clear: both" />';
}
}
if ( ! $html5 && $columns > 0 && $i % $columns !== 0 ) {
$ret .= "
<br style='clear: both' />";
}
$ret .= "</div>\n";
return $ret;
/**/
} else {
return $output;
}
}
?>