forked from Automattic/jetpack
-
Notifications
You must be signed in to change notification settings - Fork 0
/
functions.opengraph.php
395 lines (350 loc) · 13.6 KB
/
functions.opengraph.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
<?php
/**
* Open Graph Tags
*
* Add Open Graph tags so that Facebook (and any other service that supports them)
* can crawl the site better and we provide a better sharing experience.
*
* @link http://ogp.me/
* @link http://developers.facebook.com/docs/opengraph/
*/
add_action( 'wp_head', 'jetpack_og_tags' );
function jetpack_og_tags() {
/**
* Allow Jetpack to output Open Graph Meta Tags.
*
* @module sharedaddy, publicize
*
* @since 2.0.0
* @deprecated 2.0.3 Duplicative filter. Use `jetpack_enable_open_graph`.
*
* @param bool true Should Jetpack's Open Graph Meta Tags be enabled. Default to true.
*/
if ( false === apply_filters( 'jetpack_enable_opengraph', true ) ) {
_deprecated_function( 'jetpack_enable_opengraph', '2.0.3', 'jetpack_enable_open_graph' );
return;
}
// Disable the widont filter on WP.com to avoid stray  s
$disable_widont = remove_filter( 'the_title', 'widont' );
$og_output = "\n<!-- Jetpack Open Graph Tags -->\n";
$tags = array();
/**
* Filter the minimum width of the images used in Jetpack Open Graph Meta Tags.
*
* @module sharedaddy, publicize
*
* @since 2.0.0
*
* @param int 200 Minimum image width used in Jetpack Open Graph Meta Tags.
*/
$image_width = absint( apply_filters( 'jetpack_open_graph_image_width', 200 ) );
/**
* Filter the minimum height of the images used in Jetpack Open Graph Meta Tags.
*
* @module sharedaddy, publicize
*
* @since 2.0.0
*
* @param int 200 Minimum image height used in Jetpack Open Graph Meta Tags.
*/
$image_height = absint( apply_filters( 'jetpack_open_graph_image_height', 200 ) );
$description_length = 197;
if ( is_home() || is_front_page() ) {
$site_type = get_option( 'open_graph_protocol_site_type' );
$tags['og:type'] = ! empty( $site_type ) ? $site_type : 'website';
$tags['og:title'] = get_bloginfo( 'name' );
$tags['og:description'] = get_bloginfo( 'description' );
$front_page_id = get_option( 'page_for_posts' );
if ( $front_page_id && is_home() )
$tags['og:url'] = get_permalink( $front_page_id );
else
$tags['og:url'] = home_url( '/' );
// Associate a blog's root path with one or more Facebook accounts
$facebook_admins = get_option( 'facebook_admins' );
if ( ! empty( $facebook_admins ) )
$tags['fb:admins'] = $facebook_admins;
} else if ( is_author() ) {
$tags['og:type'] = 'profile';
$author = get_queried_object();
$tags['og:title'] = $author->display_name;
if ( ! empty( $author->user_url ) ) {
$tags['og:url'] = $author->user_url;
} else {
$tags['og:url'] = get_author_posts_url( $author->ID );
}
$tags['og:description'] = $author->description;
$tags['profile:first_name'] = get_the_author_meta( 'first_name', $author->ID );
$tags['profile:last_name'] = get_the_author_meta( 'last_name', $author->ID );
} else if ( is_singular() ) {
global $post;
$data = $post; // so that we don't accidentally explode the global
$tags['og:type'] = 'article';
if ( empty( $data->post_title ) ) {
$tags['og:title'] = ' ';
} else {
/** This filter is documented in core/src/wp-includes/post-template.php */
$tags['og:title'] = wp_kses( apply_filters( 'the_title', $data->post_title, $data->ID ), array() );
}
$tags['og:url'] = get_permalink( $data->ID );
if ( ! post_password_required() ) {
if ( ! empty( $data->post_excerpt ) ) {
$tags['og:description'] = preg_replace( '@https?://[\S]+@', '', strip_shortcodes( wp_kses( $data->post_excerpt, array() ) ) );
} else {
$exploded_content_on_more_tag = explode( '<!--more-->', $data->post_content );
$tags['og:description'] = wp_trim_words( preg_replace( '@https?://[\S]+@', '', strip_shortcodes( wp_kses( $exploded_content_on_more_tag[0], array() ) ) ) );
}
}
if ( empty( $tags['og:description'] ) ) {
/**
* Filter the fallback `og:description` used when no excerpt information is provided.
*
* @module sharedaddy, publicize
*
* @since 3.9.0
*
* @param string $var Fallback og:description. Default is translated `Visit the post for more'.
* @param object $data Post object for the current post.
*/
$tags['og:description'] = apply_filters( 'jetpack_open_graph_fallback_description', __( 'Visit the post for more.', 'jetpack' ), $data );
} else {
// Intentionally not using a filter to prevent pollution. @see https://github.com/Automattic/jetpack/pull/2899#issuecomment-151957382
$tags['og:description'] = wp_kses( trim( convert_chars( wptexturize( $tags['og:description'] ) ) ), array() );
}
$tags['article:published_time'] = date( 'c', strtotime( $data->post_date_gmt ) );
$tags['article:modified_time'] = date( 'c', strtotime( $data->post_modified_gmt ) );
if ( post_type_supports( get_post_type( $data ), 'author' ) && isset( $data->post_author ) ) {
$publicize_facebook_user = get_post_meta( $data->ID, '_publicize_facebook_user', true );
if ( ! empty( $publicize_facebook_user ) ) {
$tags['article:author'] = esc_url( $publicize_facebook_user );
}
}
}
/**
* Allow plugins to inject additional template-specific Open Graph tags.
*
* @module sharedaddy, publicize
*
* @since 3.0.0
*
* @param array $tags Array of Open Graph Meta tags.
* @param array $args Array of image size parameters.
*/
$tags = apply_filters( 'jetpack_open_graph_base_tags', $tags, compact( 'image_width', 'image_height' ) );
// Re-enable widont if we had disabled it
if ( $disable_widont )
add_filter( 'the_title', 'widont' );
/**
* Do not return any Open Graph Meta tags if we don't have any info about a post.
*
* @module sharedaddy, publicize
*
* @since 3.0.0
*
* @param bool true Do not return any Open Graph Meta tags if we don't have any info about a post.
*/
if ( empty( $tags ) && apply_filters( 'jetpack_open_graph_return_if_empty', true ) )
return;
$tags['og:site_name'] = get_bloginfo( 'name' );
// Get image info and build tags
if ( ! post_password_required() ) {
$image_info = jetpack_og_get_image( $image_width, $image_height );
$tags['og:image'] = $image_info['src'];
if ( ! empty( $image_info['width'] ) ) {
$tags['og:image:width'] = $image_info['width'];
}
if ( ! empty( $image_info['height'] ) ) {
$tags['og:image:height'] = $image_info['height'];
}
}
// Facebook whines if you give it an empty title
if ( empty( $tags['og:title'] ) )
$tags['og:title'] = __( '(no title)', 'jetpack' );
// Shorten the description if it's too long
if ( isset( $tags['og:description'] ) ) {
$tags['og:description'] = strlen( $tags['og:description'] ) > $description_length ? mb_substr( $tags['og:description'], 0, $description_length ) . '…' : $tags['og:description'];
}
// Try to add OG locale tag if the WP->FB data mapping exists
if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
require_once JETPACK__GLOTPRESS_LOCALES_PATH;
$_locale = get_locale();
// We have to account for w.org vs WP.com locale divergence
if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
$gp_locale = GP_Locales::by_field( 'slug', $_locale );
} else {
$gp_locale = GP_Locales::by_field( 'wp_locale', $_locale );
}
}
if ( isset( $gp_locale->facebook_locale ) && ! empty( $gp_locale->facebook_locale ) ) {
$tags['og:locale'] = $gp_locale->facebook_locale;
}
/**
* Allow the addition of additional Open Graph Meta tags, or modify the existing tags.
*
* @module sharedaddy, publicize
*
* @since 2.0.0
*
* @param array $tags Array of Open Graph Meta tags.
* @param array $args Array of image size parameters.
*/
$tags = apply_filters( 'jetpack_open_graph_tags', $tags, compact( 'image_width', 'image_height' ) );
// secure_urls need to go right after each og:image to work properly so we will abstract them here
$secure = $tags['og:image:secure_url'] = ( empty( $tags['og:image:secure_url'] ) ) ? '' : $tags['og:image:secure_url'];
unset( $tags['og:image:secure_url'] );
$secure_image_num = 0;
foreach ( (array) $tags as $tag_property => $tag_content ) {
// to accommodate multiple images
$tag_content = (array) $tag_content;
$tag_content = array_unique( $tag_content );
foreach ( $tag_content as $tag_content_single ) {
if ( empty( $tag_content_single ) )
continue; // Don't ever output empty tags
$og_tag = sprintf( '<meta property="%s" content="%s" />', esc_attr( $tag_property ), esc_attr( $tag_content_single ) );
/**
* Filter the HTML Output of each Open Graph Meta tag.
*
* @module sharedaddy, publicize
*
* @since 2.0.0
*
* @param string $og_tag HTML HTML Output of each Open Graph Meta tag.
*/
$og_output .= apply_filters( 'jetpack_open_graph_output', $og_tag );
$og_output .= "\n";
if ( 'og:image' == $tag_property ) {
if ( is_array( $secure ) && !empty( $secure[$secure_image_num] ) ) {
$og_tag = sprintf( '<meta property="og:image:secure_url" content="%s" />', esc_url( $secure[ $secure_image_num ] ) );
/** This filter is documented in functions.opengraph.php */
$og_output .= apply_filters( 'jetpack_open_graph_output', $og_tag );
$og_output .= "\n";
} else if ( !is_array( $secure ) && !empty( $secure ) ) {
$og_tag = sprintf( '<meta property="og:image:secure_url" content="%s" />', esc_url( $secure ) );
/** This filter is documented in functions.opengraph.php */
$og_output .= apply_filters( 'jetpack_open_graph_output', $og_tag );
$og_output .= "\n";
}
$secure_image_num++;
}
}
}
echo $og_output;
}
function jetpack_og_get_image( $width = 200, $height = 200, $max_images = 4 ) { // Facebook requires thumbnails to be a minimum of 200x200
$image = '';
if ( is_singular() && ! is_home() ) {
global $post;
$image = '';
// Grab obvious image if $post is an attachment page for an image
if ( is_attachment( $post->ID ) && 'image' == substr( $post->post_mime_type, 0, 5 ) ) {
$image = wp_get_attachment_url( $post->ID );
}
// Attempt to find something good for this post using our generalized PostImages code
if ( ! $image && class_exists( 'Jetpack_PostImages' ) ) {
$post_images = Jetpack_PostImages::get_images( $post->ID, array( 'width' => $width, 'height' => $height ) );
if ( $post_images && ! is_wp_error( $post_images ) ) {
$image = array();
foreach ( (array) $post_images as $post_image ) {
$image['src'] = $post_image['src'];
if ( isset( $post_image['src_width'], $post_image['src_height'] ) ) {
$image['width'] = $post_image['src_width'];
$image['height'] = $post_image['src_height'];
}
}
}
}
} else if ( is_author() ) {
$author = get_queried_object();
if ( function_exists( 'get_avatar_url' ) ) {
// Prefer the core function get_avatar_url() if available, WP 4.2+
$image['src'] = get_avatar_url( $author->user_email, array( 'size' => $width ) );
}
else {
$has_filter = has_filter( 'pre_option_show_avatars', '__return_true' );
if ( ! $has_filter ) {
add_filter( 'pre_option_show_avatars', '__return_true' );
}
$avatar = get_avatar( $author->user_email, $width );
if ( ! $has_filter ) {
remove_filter( 'pre_option_show_avatars', '__return_true' );
}
if ( ! empty( $avatar ) && ! is_wp_error( $avatar ) ) {
if ( preg_match( '/src=["\']([^"\']+)["\']/', $avatar, $matches ) );
$image['src'] = wp_specialchars_decode( $matches[1], ENT_QUOTES );
}
}
}
if ( empty( $image ) ) {
$image = array();
} else if ( ! is_array( $image ) ) {
$image = array(
'src' => $image
);
}
// First fall back, blavatar
if ( empty( $image ) && function_exists( 'blavatar_domain' ) ) {
$blavatar_domain = blavatar_domain( site_url() );
if ( blavatar_exists( $blavatar_domain ) ) {
$image['src'] = blavatar_url( $blavatar_domain, 'img', $width, false, true );
$image['width'] = $width;
$image['height'] = $height;
}
}
// Second fall back, Site Logo
if ( empty( $image ) && ( function_exists( 'jetpack_has_site_logo' ) && jetpack_has_site_logo() ) ) {
$image['src'] = jetpack_get_site_logo( 'url' );
$image_dimensions = jetpack_get_site_logo_dimensions();
if ( ! empty( $image_dimensions ) ) {
$image['width'] = $image_dimensions['width'];
$image['height'] = $image_dimensions['height'];
}
}
// Third fall back, Core Site Icon. Added in WP 4.3.
if ( empty( $image ) && ( function_exists( 'has_site_icon') && has_site_icon() ) ) {
$image['src'] = get_site_icon_url( 512 );
$image['width'] = '512';
$image['height'] = '512';
}
// Finally fall back, blank image
if ( empty( $image ) ) {
/**
* Filter the default Open Graph Image tag, used when no Image can be found in a post.
*
* @since 3.0.0
*
* @param string $str Default Image URL.
*/
$image['src'] = apply_filters( 'jetpack_open_graph_image_default', 'https://s0.wp.com/i/blank.jpg' );
}
return $image;
}
/**
* @param $email
* @param $width
* @return array|bool|mixed|string
*/
function jetpack_og_get_image_gravatar( $email, $width ) {
$image = '';
if ( function_exists( 'get_avatar_url' ) ) {
$avatar = get_avatar_url( $email, $width );
if ( ! empty( $avatar ) ) {
if ( is_array( $avatar ) )
$image = $avatar[0];
else
$image = $avatar;
}
} else {
$has_filter = has_filter( 'pre_option_show_avatars', '__return_true' );
if ( !$has_filter ) {
add_filter( 'pre_option_show_avatars', '__return_true' );
}
$avatar = get_avatar( $email, $width );
if ( !$has_filter ) {
remove_filter( 'pre_option_show_avatars', '__return_true' );
}
if ( !empty( $avatar ) && !is_wp_error( $avatar ) ) {
if ( preg_match( '/src=["\']([^"\']+)["\']/', $avatar, $matches ) )
$image = wp_specialchars_decode($matches[1], ENT_QUOTES);
}
}
return $image;
}