| 1 |
<?php |
| 2 |
/** |
| 3 |
* Social Meta Manager Class |
| 4 |
* |
| 5 |
* Universal social media meta tag generation and optimization for all platforms. |
| 6 |
* Implements 2025 social media SEO best practices with real Open Graph and Twitter Card |
| 7 |
* specifications, social image optimization, and platform-specific handling. |
| 8 |
* |
| 9 |
* @package ThinkRank |
| 10 |
* @subpackage SEO |
| 11 |
* @since 1.0.0 |
| 12 |
*/ |
| 13 |
|
| 14 |
declare(strict_types=1); |
| 15 |
|
| 16 |
namespace ThinkRank\SEO; |
| 17 |
|
| 18 |
// Prevent direct access |
| 19 |
if (!defined('ABSPATH')) { |
| 20 |
exit; |
| 21 |
} |
| 22 |
|
| 23 |
/** |
| 24 |
* Social Meta Manager Class |
| 25 |
* |
| 26 |
* Generates and validates social media meta tags for all supported platforms. |
| 27 |
* Provides context-aware social meta generation with image optimization and |
| 28 |
* platform-specific meta tag handling. |
| 29 |
* |
| 30 |
* @since 1.0.0 |
| 31 |
*/ |
| 32 |
class Social_Meta_Manager extends Abstract_SEO_Manager { |
| 33 |
|
| 34 |
/** |
| 35 |
* Supported social media platforms with their specifications |
| 36 |
* |
| 37 |
* @since 1.0.0 |
| 38 |
* @var array |
| 39 |
*/ |
| 40 |
private array $supported_platforms = [ |
| 41 |
'facebook' => [ |
| 42 |
'og_required' => ['og:title', 'og:type', 'og:image', 'og:url'], |
| 43 |
'og_recommended' => ['og:description', 'og:site_name', 'og:locale'], |
| 44 |
'og_optional' => ['og:updated_time', 'og:see_also', 'og:video', 'og:audio'], |
| 45 |
'image_min_width' => 600, |
| 46 |
'image_min_height' => 315, |
| 47 |
'image_recommended_ratio' => 1.91, |
| 48 |
'title_max_length' => 60, |
| 49 |
'description_max_length' => 160 |
| 50 |
], |
| 51 |
'twitter' => [ |
| 52 |
'card_types' => ['summary', 'summary_large_image', 'app', 'player'], |
| 53 |
'required' => ['twitter:card', 'twitter:title'], |
| 54 |
'recommended' => ['twitter:description', 'twitter:image', 'twitter:site'], |
| 55 |
'optional' => ['twitter:creator', 'twitter:player', 'twitter:app:name'], |
| 56 |
'image_min_width' => 300, |
| 57 |
'image_min_height' => 157, |
| 58 |
'image_max_size' => 5242880, // 5MB |
| 59 |
'title_max_length' => 70, |
| 60 |
'description_max_length' => 200 |
| 61 |
], |
| 62 |
'linkedin' => [ |
| 63 |
'og_required' => ['og:title', 'og:type', 'og:image', 'og:url'], |
| 64 |
'og_recommended' => ['og:description'], |
| 65 |
'image_min_width' => 1200, |
| 66 |
'image_min_height' => 627, |
| 67 |
'image_recommended_ratio' => 1.91, |
| 68 |
'title_max_length' => 70, |
| 69 |
'description_max_length' => 160 |
| 70 |
], |
| 71 |
'pinterest' => [ |
| 72 |
'required' => ['og:title', 'og:type', 'og:image', 'og:url'], |
| 73 |
'recommended' => ['og:description', 'og:site_name'], |
| 74 |
'image_min_width' => 600, |
| 75 |
'image_min_height' => 900, |
| 76 |
'image_recommended_ratio' => 0.67, // 2:3 ratio |
| 77 |
'title_max_length' => 100, |
| 78 |
// Pinterest has no tag of its own: it reads og:description, which |
| 79 |
// the frontend caps at max_description_length. Previewing 500 |
| 80 |
// promised up to 340 characters that are never emitted. |
| 81 |
'description_max_length' => 160 |
| 82 |
], |
| 83 |
'whatsapp' => [ |
| 84 |
'og_required' => ['og:title', 'og:type', 'og:image', 'og:url'], |
| 85 |
'og_recommended' => ['og:description'], |
| 86 |
'image_min_width' => 300, |
| 87 |
'image_min_height' => 200, |
| 88 |
'title_max_length' => 65, |
| 89 |
'description_max_length' => 160 |
| 90 |
] |
| 91 |
]; |
| 92 |
|
| 93 |
/** |
| 94 |
* Open Graph types with their specifications |
| 95 |
* |
| 96 |
* @since 1.0.0 |
| 97 |
* @var array |
| 98 |
*/ |
| 99 |
private array $og_types = [ |
| 100 |
'website' => ['og:title', 'og:type', 'og:image', 'og:url'], |
| 101 |
'article' => ['og:title', 'og:type', 'og:image', 'og:url', 'article:author', 'article:published_time'], |
| 102 |
'product' => ['og:title', 'og:type', 'og:image', 'og:url', 'product:price:amount', 'product:price:currency'], |
| 103 |
'video' => ['og:title', 'og:type', 'og:image', 'og:url', 'og:video', 'video:duration'], |
| 104 |
'music' => ['og:title', 'og:type', 'og:image', 'og:url', 'music:duration', 'music:album'], |
| 105 |
'book' => ['og:title', 'og:type', 'og:image', 'og:url', 'book:author', 'book:isbn'], |
| 106 |
'profile' => ['og:title', 'og:type', 'og:image', 'og:url', 'profile:first_name', 'profile:last_name'] |
| 107 |
]; |
| 108 |
|
| 109 |
/** |
| 110 |
* Constructor |
| 111 |
* |
| 112 |
* @since 1.0.0 |
| 113 |
*/ |
| 114 |
public function __construct() { |
| 115 |
parent::__construct('social_meta'); |
| 116 |
} |
| 117 |
|
| 118 |
/** |
| 119 |
* Generate Open Graph tags for content |
| 120 |
* |
| 121 |
* @since 1.0.0 |
| 122 |
* |
| 123 |
* @param array $data Content data for OG generation |
| 124 |
* @param string $context Context type ('site', 'post', 'page', etc.) |
| 125 |
* @param string $platform Target platform ('facebook', 'linkedin', etc.) |
| 126 |
* @return array Generated Open Graph tags |
| 127 |
*/ |
| 128 |
public function generate_og_tags(array $data, string $context = 'site', string $platform = 'facebook'): array { |
| 129 |
$platform = strtolower($platform); |
| 130 |
if (!isset($this->supported_platforms[$platform])) { |
| 131 |
$platform = 'facebook'; // Default fallback |
| 132 |
} |
| 133 |
|
| 134 |
$platform_spec = $this->supported_platforms[$platform]; |
| 135 |
$og_tags = []; |
| 136 |
|
| 137 |
// OG type: the type the user explicitly chose, otherwise derived from |
| 138 |
// the context. This used to call determine_og_type() unconditionally, |
| 139 |
// overwriting the value extract_social_content_data() had already read |
| 140 |
// from the setting — so the Content Type dropdown, the abilities API |
| 141 |
// and every imported og:type were silently discarded (#398). |
| 142 |
$og_type = ($data['type'] ?? '') !== '' |
| 143 |
? $data['type'] |
| 144 |
: $this->determine_og_type($context, $data); |
| 145 |
$og_tags['og:type'] = $og_type; |
| 146 |
|
| 147 |
// Required OG tags |
| 148 |
// og:title must render the full resolved Open Graph title. The 60-char |
| 149 |
// cap in optimize_title_for_platform() is an SEO-title recommendation for |
| 150 |
// search results and does not apply to the og:title social tag, so use the |
| 151 |
// resolved title verbatim (falling back to the site name when empty). |
| 152 |
// Stripped: a title carrying markup is attribute-escaped into this tag, |
| 153 |
// so the reader sees a literal `<em>` rather than emphasis (#640). |
| 154 |
$og_tags['og:title'] = \ThinkRank\Frontend\SEO_Manager::strip_title_tags( |
| 155 |
($data['title'] ?? '') !== '' ? (string) $data['title'] : (string) get_bloginfo('name') |
| 156 |
); |
| 157 |
// `?:` rather than `??`: the key is always present, seeded as '', so the |
| 158 |
// null-coalesce could never reach the fallback. og:url was emitted empty |
| 159 |
// and then dropped by the !empty() guard in output_social_og_tags(), |
| 160 |
// which is why archives carried no og:url at all (#388). |
| 161 |
// Normalized for the site's scheme preference, so og:url and the |
| 162 |
// canonical can never disagree about http vs https (#638); the same |
| 163 |
// consistency #182 was about. |
| 164 |
$og_tags['og:url'] = \ThinkRank\SEO\Url_Scheme::apply( |
| 165 |
($data['url'] ?? '') !== '' ? $data['url'] : $this->get_current_url() |
| 166 |
); |
| 167 |
|
| 168 |
// Image handling with optimization |
| 169 |
if (!empty($data['image'])) { |
| 170 |
$optimized_image = $this->optimize_image_for_platform($data['image'], $platform); |
| 171 |
$og_tags['og:image'] = $optimized_image['url']; |
| 172 |
// Emit og:image:secure_url for https images (parity with the basic |
| 173 |
// emitter), so crawlers that prefer the secure URL get it. |
| 174 |
if (!empty($optimized_image['url']) && strpos((string) $optimized_image['url'], 'https://') === 0) { |
| 175 |
$og_tags['og:image:secure_url'] = $optimized_image['url']; |
| 176 |
} |
| 177 |
if (!empty($optimized_image['width'])) { |
| 178 |
$og_tags['og:image:width'] = $optimized_image['width']; |
| 179 |
} |
| 180 |
if (!empty($optimized_image['height'])) { |
| 181 |
$og_tags['og:image:height'] = $optimized_image['height']; |
| 182 |
} |
| 183 |
if (!empty($optimized_image['type'])) { |
| 184 |
$og_tags['og:image:type'] = $optimized_image['type']; |
| 185 |
} |
| 186 |
if (!empty($optimized_image['alt'])) { |
| 187 |
$og_tags['og:image:alt'] = $optimized_image['alt']; |
| 188 |
} |
| 189 |
} else { |
| 190 |
// Fallback to site default image |
| 191 |
$default_image = $this->get_default_social_image(); |
| 192 |
if ($default_image) { |
| 193 |
$og_tags['og:image'] = $default_image; |
| 194 |
} |
| 195 |
} |
| 196 |
|
| 197 |
// Recommended OG tags |
| 198 |
if (!empty($data['description'])) { |
| 199 |
$og_tags['og:description'] = $this->optimize_description_for_platform($data['description'], $platform); |
| 200 |
} |
| 201 |
|
| 202 |
$og_tags['og:site_name'] = $data['site_name'] ?? get_bloginfo('name'); |
| 203 |
$og_tags['og:locale'] = $data['locale'] ?? $this->get_og_locale(); |
| 204 |
|
| 205 |
// Context-specific OG tags |
| 206 |
$og_tags = $this->add_context_specific_og_tags($og_tags, $context, $data, $og_type); |
| 207 |
|
| 208 |
// Platform-specific optimizations |
| 209 |
$og_tags = $this->apply_platform_specific_optimizations($og_tags, $platform, $data); |
| 210 |
|
| 211 |
return $og_tags; |
| 212 |
} |
| 213 |
|
| 214 |
/** |
| 215 |
* Generate Twitter Card tags for content |
| 216 |
* |
| 217 |
* @since 1.0.0 |
| 218 |
* |
| 219 |
* @param array $data Content data for Twitter Card generation |
| 220 |
* @param string $context Context type ('site', 'post', 'page', etc.) |
| 221 |
* @return array Generated Twitter Card tags |
| 222 |
*/ |
| 223 |
public function generate_twitter_tags(array $data, string $context = 'site'): array { |
| 224 |
$twitter_tags = []; |
| 225 |
|
| 226 |
// Determine card type based on content |
| 227 |
$card_type = $this->determine_twitter_card_type($data, $context); |
| 228 |
$twitter_tags['twitter:card'] = $card_type; |
| 229 |
|
| 230 |
// Required tags. Prefer a per-post Twitter-specific title, falling back |
| 231 |
// to the resolved og:title/SEO title. Render it in full — the length cap |
| 232 |
// in optimize_title_for_platform() is an SEO-title recommendation for |
| 233 |
// search results, not a rule for the twitter:title social tag. |
| 234 |
$twitter_title = ($data['twitter_title'] ?? '') !== '' ? $data['twitter_title'] : ($data['title'] ?? ''); |
| 235 |
$twitter_tags['twitter:title'] = \ThinkRank\Frontend\SEO_Manager::strip_title_tags( |
| 236 |
$twitter_title !== '' ? (string) $twitter_title : (string) get_bloginfo('name') |
| 237 |
); |
| 238 |
|
| 239 |
// Recommended tags. Prefer a per-object Twitter-specific description, |
| 240 |
// falling back to the resolved OG/meta description — mirroring the |
| 241 |
// twitter:title cascade above. This lookup did not exist, so a Twitter |
| 242 |
// description saved on the Social tab persisted, read back, and was |
| 243 |
// then dropped in favour of the OG description (#406). |
| 244 |
$twitter_description = ($data['twitter_description'] ?? '') !== '' |
| 245 |
? $data['twitter_description'] |
| 246 |
: (string) ($data['description'] ?? ''); |
| 247 |
if ($twitter_description !== '') { |
| 248 |
$twitter_tags['twitter:description'] = $this->optimize_description_for_platform($twitter_description, 'twitter'); |
| 249 |
} |
| 250 |
|
| 251 |
// Image handling - prioritize Twitter-specific image |
| 252 |
$twitter_image = !empty($data['twitter_image']) ? $data['twitter_image'] : ($data['image'] ?? ''); |
| 253 |
if (!empty($twitter_image)) { |
| 254 |
$optimized_image = $this->optimize_image_for_platform($twitter_image, 'twitter'); |
| 255 |
$twitter_tags['twitter:image'] = $optimized_image['url']; |
| 256 |
if (!empty($optimized_image['alt'])) { |
| 257 |
$twitter_tags['twitter:image:alt'] = $optimized_image['alt']; |
| 258 |
} |
| 259 |
} |
| 260 |
|
| 261 |
// Site and creator information |
| 262 |
$twitter_site = $this->get_twitter_site_handle(); |
| 263 |
if ($twitter_site) { |
| 264 |
$twitter_tags['twitter:site'] = $twitter_site; |
| 265 |
} |
| 266 |
|
| 267 |
$twitter_creator = $this->get_twitter_creator_handle(); |
| 268 |
if ($twitter_creator) { |
| 269 |
$twitter_tags['twitter:creator'] = $twitter_creator; |
| 270 |
} elseif (!empty($data['author']['twitter'])) { |
| 271 |
// Fallback to author data if available |
| 272 |
$twitter_tags['twitter:creator'] = $data['author']['twitter']; |
| 273 |
} |
| 274 |
|
| 275 |
// Card-specific tags |
| 276 |
$twitter_tags = $this->add_twitter_card_specific_tags($twitter_tags, $card_type, $data, $context); |
| 277 |
|
| 278 |
return $twitter_tags; |
| 279 |
} |
| 280 |
|
| 281 |
/** |
| 282 |
* Optimize social image for platform requirements |
| 283 |
* |
| 284 |
* @since 1.0.0 |
| 285 |
* |
| 286 |
* @param string $image_url Image URL to optimize |
| 287 |
* @param string $platform Target platform |
| 288 |
* @return array Optimized image data |
| 289 |
*/ |
| 290 |
public function optimize_social_image(string $image_url, string $platform): array { |
| 291 |
return $this->optimize_image_for_platform($image_url, $platform); |
| 292 |
} |
| 293 |
|
| 294 |
/** |
| 295 |
* Generate social media preview data |
| 296 |
* |
| 297 |
* @since 1.0.0 |
| 298 |
* |
| 299 |
* @param array $data Content data |
| 300 |
* @param string $platform Target platform |
| 301 |
* @return array Preview data for the platform |
| 302 |
*/ |
| 303 |
public function preview_social_post(array $data, string $platform): array { |
| 304 |
$preview = [ |
| 305 |
'platform' => $platform, |
| 306 |
'valid' => false, |
| 307 |
'preview_url' => '', |
| 308 |
'title' => '', |
| 309 |
'description' => '', |
| 310 |
'image' => '', |
| 311 |
'warnings' => [], |
| 312 |
'suggestions' => [] |
| 313 |
]; |
| 314 |
|
| 315 |
switch ($platform) { |
| 316 |
case 'facebook': |
| 317 |
case 'linkedin': |
| 318 |
$og_tags = $this->generate_og_tags($data, 'post', $platform); |
| 319 |
$preview = $this->generate_og_preview($og_tags, $platform, $preview); |
| 320 |
break; |
| 321 |
case 'twitter': |
| 322 |
$twitter_tags = $this->generate_twitter_tags($data, 'post'); |
| 323 |
$preview = $this->generate_twitter_preview($twitter_tags, $preview); |
| 324 |
break; |
| 325 |
case 'pinterest': |
| 326 |
$og_tags = $this->generate_og_tags($data, 'post', $platform); |
| 327 |
$preview = $this->generate_pinterest_preview($og_tags, $preview); |
| 328 |
break; |
| 329 |
default: |
| 330 |
$preview['warnings'][] = 'Unsupported platform for preview generation'; |
| 331 |
} |
| 332 |
|
| 333 |
return $preview; |
| 334 |
} |
| 335 |
|
| 336 |
/** |
| 337 |
* Validate SEO settings (implements interface) |
| 338 |
* |
| 339 |
* @since 1.0.0 |
| 340 |
* |
| 341 |
* @param array $settings Settings array to validate |
| 342 |
* @param string $context Optional context for focused validation |
| 343 |
* @return array Validation results |
| 344 |
*/ |
| 345 |
public function validate_settings(array $settings, string $context = 'all'): array { |
| 346 |
$validation = [ |
| 347 |
'valid' => true, |
| 348 |
'errors' => [], |
| 349 |
'warnings' => [], |
| 350 |
'suggestions' => [], |
| 351 |
'score' => 100 |
| 352 |
]; |
| 353 |
|
| 354 |
// Add detailed field validation breakdown |
| 355 |
$field_details = $this->get_detailed_field_validation($settings, $context); |
| 356 |
$validation['field_details'] = $field_details; |
| 357 |
|
| 358 |
// Convert field details to validation format |
| 359 |
foreach ($field_details as $field) { |
| 360 |
switch ($field['status']) { |
| 361 |
case 'error': |
| 362 |
$validation['errors'][] = $field['label']; |
| 363 |
$validation['valid'] = false; |
| 364 |
$validation['score'] -= 15; |
| 365 |
break; |
| 366 |
case 'warning': |
| 367 |
$validation['warnings'][] = $field['label']; |
| 368 |
$validation['score'] -= 8; |
| 369 |
break; |
| 370 |
case 'suggestion': |
| 371 |
$validation['suggestions'][] = $field['label']; |
| 372 |
$validation['score'] -= 3; |
| 373 |
break; |
| 374 |
} |
| 375 |
} |
| 376 |
|
| 377 |
// Ensure score doesn't go below 0 |
| 378 |
$validation['score'] = max(0, $validation['score']); |
| 379 |
|
| 380 |
|
| 381 |
// Validate general enabled setting (Social Media tab format) |
| 382 |
if (isset($settings['enabled'])) { |
| 383 |
// Convert string booleans to actual booleans |
| 384 |
if (is_string($settings['enabled'])) { |
| 385 |
$settings['enabled'] = filter_var($settings['enabled'], FILTER_VALIDATE_BOOLEAN); |
| 386 |
} |
| 387 |
if (!is_bool($settings['enabled'])) { |
| 388 |
$validation['errors'][] = 'enabled must be a boolean value'; |
| 389 |
$validation['valid'] = false; |
| 390 |
} |
| 391 |
} |
| 392 |
|
| 393 |
// Validate Open Graph settings (Social Media tab format) |
| 394 |
if (isset($settings['enable_open_graph'])) { |
| 395 |
// Convert string booleans to actual booleans |
| 396 |
if (is_string($settings['enable_open_graph'])) { |
| 397 |
$settings['enable_open_graph'] = filter_var($settings['enable_open_graph'], FILTER_VALIDATE_BOOLEAN); |
| 398 |
} |
| 399 |
if (!is_bool($settings['enable_open_graph'])) { |
| 400 |
$validation['errors'][] = 'enable_open_graph must be a boolean value'; |
| 401 |
$validation['valid'] = false; |
| 402 |
} |
| 403 |
} |
| 404 |
|
| 405 |
// Validate Twitter Cards settings (Social Media tab format) |
| 406 |
if (isset($settings['enable_twitter_cards'])) { |
| 407 |
// Convert string booleans to actual booleans |
| 408 |
if (is_string($settings['enable_twitter_cards'])) { |
| 409 |
$settings['enable_twitter_cards'] = filter_var($settings['enable_twitter_cards'], FILTER_VALIDATE_BOOLEAN); |
| 410 |
} |
| 411 |
if (!is_bool($settings['enable_twitter_cards'])) { |
| 412 |
$validation['errors'][] = 'enable_twitter_cards must be a boolean value'; |
| 413 |
$validation['valid'] = false; |
| 414 |
} |
| 415 |
} |
| 416 |
|
| 417 |
// Validate Twitter settings (only when relevant) |
| 418 |
if ($context === 'all' || $context === 'twitter' || $context === 'twitter-cards') { |
| 419 |
// Validate Twitter username format |
| 420 |
if (isset($settings['twitter_username']) && !empty($settings['twitter_username'])) { |
| 421 |
$username = trim($settings['twitter_username']); |
| 422 |
|
| 423 |
// Remove @ if present (we store without @, add @ in output) |
| 424 |
$clean_username = ltrim($username, '@'); |
| 425 |
|
| 426 |
if (empty($clean_username)) { |
| 427 |
$validation['errors'][] = 'twitter_username cannot be empty'; |
| 428 |
$validation['valid'] = false; |
| 429 |
} elseif (strlen($clean_username) > 15) { |
| 430 |
$validation['errors'][] = 'twitter_username must be 15 characters or less'; |
| 431 |
$validation['valid'] = false; |
| 432 |
} elseif (!preg_match('/^[A-Za-z0-9_]+$/', $clean_username)) { |
| 433 |
$validation['errors'][] = 'twitter_username can only contain letters, numbers, and underscores'; |
| 434 |
$validation['valid'] = false; |
| 435 |
} |
| 436 |
|
| 437 |
// Update the setting to store without @ for consistency |
| 438 |
$settings['twitter_username'] = $clean_username; |
| 439 |
} |
| 440 |
|
| 441 |
// Validate Twitter creator format |
| 442 |
if (isset($settings['twitter_creator']) && !empty($settings['twitter_creator'])) { |
| 443 |
$creator = trim($settings['twitter_creator']); |
| 444 |
|
| 445 |
// Remove @ if present (we store without @, add @ in output) |
| 446 |
$clean_creator = ltrim($creator, '@'); |
| 447 |
|
| 448 |
if (empty($clean_creator)) { |
| 449 |
$validation['errors'][] = 'twitter_creator cannot be empty'; |
| 450 |
$validation['valid'] = false; |
| 451 |
} elseif (strlen($clean_creator) > 15) { |
| 452 |
$validation['errors'][] = 'twitter_creator must be 15 characters or less'; |
| 453 |
$validation['valid'] = false; |
| 454 |
} elseif (!preg_match('/^[A-Za-z0-9_]+$/', $clean_creator)) { |
| 455 |
$validation['errors'][] = 'twitter_creator can only contain letters, numbers, and underscores'; |
| 456 |
$validation['valid'] = false; |
| 457 |
} |
| 458 |
|
| 459 |
// Update the setting to store without @ for consistency |
| 460 |
$settings['twitter_creator'] = $clean_creator; |
| 461 |
} |
| 462 |
|
| 463 |
// Validate Twitter card type |
| 464 |
if (isset($settings['twitter_card_type'])) { |
| 465 |
$valid_types = ['summary', 'summary_large_image', 'app', 'player']; |
| 466 |
if (!in_array($settings['twitter_card_type'], $valid_types, true)) { |
| 467 |
$validation['errors'][] = 'twitter_card_type must be one of: ' . implode(', ', $valid_types); |
| 468 |
$validation['valid'] = false; |
| 469 |
} |
| 470 |
} |
| 471 |
} |
| 472 |
|
| 473 |
// Validate OG type |
| 474 |
if (isset($settings['og_type'])) { |
| 475 |
$valid_types = ['website', 'article', 'book', 'profile', 'music.song', 'music.album', 'video.movie', 'video.episode']; |
| 476 |
if (!in_array($settings['og_type'], $valid_types, true)) { |
| 477 |
$validation['warnings'][] = 'og_type should be one of the standard Open Graph types for best compatibility'; |
| 478 |
} |
| 479 |
} |
| 480 |
|
| 481 |
// Validate image dimensions |
| 482 |
if (isset($settings['og_image_width']) && (!is_numeric($settings['og_image_width']) || $settings['og_image_width'] < 200)) { |
| 483 |
$validation['warnings'][] = 'og_image_width should be at least 200 pixels for optimal social sharing'; |
| 484 |
} |
| 485 |
|
| 486 |
if (isset($settings['og_image_height']) && (!is_numeric($settings['og_image_height']) || $settings['og_image_height'] < 200)) { |
| 487 |
$validation['warnings'][] = 'og_image_height should be at least 200 pixels for optimal social sharing'; |
| 488 |
} |
| 489 |
|
| 490 |
// Validate description length |
| 491 |
if (isset($settings['max_description_length']) && (!is_numeric($settings['max_description_length']) || $settings['max_description_length'] < 50 || $settings['max_description_length'] > 300)) { |
| 492 |
$validation['warnings'][] = 'max_description_length should be between 50 and 300 characters'; |
| 493 |
} |
| 494 |
|
| 495 |
// Legacy validation for backward compatibility (only when legacy fields are actually present) |
| 496 |
if (isset($settings['og_enabled'])) { |
| 497 |
// Convert string booleans to actual booleans |
| 498 |
if (is_string($settings['og_enabled'])) { |
| 499 |
$settings['og_enabled'] = filter_var($settings['og_enabled'], FILTER_VALIDATE_BOOLEAN); |
| 500 |
} |
| 501 |
if (!is_bool($settings['og_enabled'])) { |
| 502 |
$validation['errors'][] = 'og_enabled must be a boolean value'; |
| 503 |
$validation['valid'] = false; |
| 504 |
} |
| 505 |
} |
| 506 |
|
| 507 |
if (isset($settings['twitter_enabled'])) { |
| 508 |
// Convert string booleans to actual booleans |
| 509 |
if (is_string($settings['twitter_enabled'])) { |
| 510 |
$settings['twitter_enabled'] = filter_var($settings['twitter_enabled'], FILTER_VALIDATE_BOOLEAN); |
| 511 |
} |
| 512 |
if (!is_bool($settings['twitter_enabled'])) { |
| 513 |
$validation['errors'][] = 'twitter_enabled must be a boolean value'; |
| 514 |
$validation['valid'] = false; |
| 515 |
} |
| 516 |
} |
| 517 |
|
| 518 |
// Validate Twitter card type |
| 519 |
if (isset($settings['twitter_card_type'])) { |
| 520 |
$valid_card_types = $this->supported_platforms['twitter']['card_types']; |
| 521 |
if (!in_array($settings['twitter_card_type'], $valid_card_types, true)) { |
| 522 |
$validation['errors'][] = 'Invalid Twitter card type. Must be one of: ' . implode(', ', $valid_card_types); |
| 523 |
$validation['valid'] = false; |
| 524 |
} |
| 525 |
} |
| 526 |
|
| 527 |
// Validate default image |
| 528 |
if (isset($settings['default_image']) && !empty($settings['default_image'])) { |
| 529 |
if (!filter_var($settings['default_image'], FILTER_VALIDATE_URL)) { |
| 530 |
$validation['errors'][] = 'default_image must be a valid URL'; |
| 531 |
$validation['valid'] = false; |
| 532 |
} else { |
| 533 |
// Check image dimensions and format |
| 534 |
$image_validation = $this->validate_social_image($settings['default_image']); |
| 535 |
if (!$image_validation['valid']) { |
| 536 |
$validation['warnings'] = array_merge($validation['warnings'], $image_validation['warnings']); |
| 537 |
} |
| 538 |
} |
| 539 |
} |
| 540 |
|
| 541 |
// Validate Twitter site handle |
| 542 |
if (isset($settings['twitter_site']) && !empty($settings['twitter_site'])) { |
| 543 |
if (!preg_match('/^@[a-zA-Z0-9_]{1,15}$/', $settings['twitter_site'])) { |
| 544 |
$validation['errors'][] = 'twitter_site must be a valid Twitter handle (e.g., @username)'; |
| 545 |
$validation['valid'] = false; |
| 546 |
} |
| 547 |
} |
| 548 |
|
| 549 |
// Validate custom OG tags |
| 550 |
if (isset($settings['custom_og_tags']) && !empty($settings['custom_og_tags'])) { |
| 551 |
if (!is_array($settings['custom_og_tags'])) { |
| 552 |
$validation['errors'][] = 'custom_og_tags must be an array'; |
| 553 |
$validation['valid'] = false; |
| 554 |
} else { |
| 555 |
foreach ($settings['custom_og_tags'] as $property => $content) { |
| 556 |
if (!is_string($property) || !is_string($content)) { |
| 557 |
$validation['errors'][] = 'Custom OG tags must have string property names and content'; |
| 558 |
$validation['valid'] = false; |
| 559 |
break; |
| 560 |
} |
| 561 |
} |
| 562 |
} |
| 563 |
} |
| 564 |
|
| 565 |
// Validate platform verification codes / IDs (Instagram, TikTok, YouTube, |
| 566 |
// WhatsApp, Facebook App ID, Pinterest) against the shared format rules. |
| 567 |
// Single source of truth — also enforced on the Social Platforms REST save |
| 568 |
// path via self::validate_platform_field(). See get_platform_field_validation_rules(). |
| 569 |
foreach (self::get_platform_field_validation_rules() as $field_key => $rule) { |
| 570 |
if (isset($settings[$field_key]) && $settings[$field_key] !== '') { |
| 571 |
$error = self::validate_platform_field($field_key, $settings[$field_key]); |
| 572 |
if ($error !== null) { |
| 573 |
$validation['errors'][] = $error; |
| 574 |
$validation['valid'] = false; |
| 575 |
} |
| 576 |
} |
| 577 |
} |
| 578 |
|
| 579 |
return $validation; |
| 580 |
} |
| 581 |
|
| 582 |
/** |
| 583 |
* Format-validation rules for social platform verification codes / IDs. |
| 584 |
* |
| 585 |
* Single source of truth for the per-field format constraints, shared by |
| 586 |
* validate_settings() and the Social Platforms REST endpoint |
| 587 |
* (ThinkRank\API\Social_Platforms_Endpoint) so a value that is accepted on |
| 588 |
* one path is accepted on the other. These mirror the `pattern` entries in |
| 589 |
* get_settings_schema(); sanitization strips unsafe characters but does not |
| 590 |
* enforce shape, so these rules back it with real validation. |
| 591 |
* |
| 592 |
* @since 1.14.0 |
| 593 |
* |
| 594 |
* @return array<string, array{pattern: string, message: string}> Map of field key => rule. |
| 595 |
*/ |
| 596 |
public static function get_platform_field_validation_rules(): array { |
| 597 |
return [ |
| 598 |
'facebook_app_id' => [ |
| 599 |
'pattern' => '/^[0-9]+$/', |
| 600 |
'message' => 'Facebook App ID must contain digits only.', |
| 601 |
], |
| 602 |
'pinterest_site_verification' => [ |
| 603 |
'pattern' => '/^[a-f0-9]{32}$/', |
| 604 |
'message' => 'Pinterest site verification must be a 32-character hexadecimal string.', |
| 605 |
], |
| 606 |
'instagram_verification' => [ |
| 607 |
'pattern' => '/^[a-zA-Z0-9_-]{20,}$/', |
| 608 |
'message' => 'Instagram verification must be at least 20 characters (letters, numbers, underscore, dash).', |
| 609 |
], |
| 610 |
'tiktok_verification' => [ |
| 611 |
'pattern' => '/^[a-zA-Z0-9_-]{20,}$/', |
| 612 |
'message' => 'TikTok verification must be at least 20 characters (letters, numbers, underscore, dash).', |
| 613 |
], |
| 614 |
'youtube_channel_id' => [ |
| 615 |
'pattern' => '/^UC[a-zA-Z0-9_-]{22}$/', |
| 616 |
'message' => 'YouTube channel ID must start with "UC" followed by 22 characters (letters, numbers, underscore, dash).', |
| 617 |
], |
| 618 |
'whatsapp_business_id' => [ |
| 619 |
'pattern' => '/^[0-9]{10,15}$/', |
| 620 |
'message' => 'WhatsApp Business ID must be 10-15 digits.', |
| 621 |
], |
| 622 |
]; |
| 623 |
} |
| 624 |
|
| 625 |
/** |
| 626 |
* Validate a single social platform field value against its shared format rule. |
| 627 |
* |
| 628 |
* Returns null for fields with no format rule (e.g. facebook_admins) and for |
| 629 |
* empty values, so callers can validate an arbitrary settings map and only |
| 630 |
* act on genuine format violations. |
| 631 |
* |
| 632 |
* @since 1.14.0 |
| 633 |
* |
| 634 |
* @param string $key Field key. |
| 635 |
* @param mixed $value Field value. |
| 636 |
* @return string|null Error message when the value violates the format, null otherwise. |
| 637 |
*/ |
| 638 |
public static function validate_platform_field(string $key, $value): ?string { |
| 639 |
$rules = self::get_platform_field_validation_rules(); |
| 640 |
|
| 641 |
if (!isset($rules[$key]) || $value === '' || $value === null) { |
| 642 |
return null; |
| 643 |
} |
| 644 |
|
| 645 |
if (!preg_match($rules[$key]['pattern'], (string) $value)) { |
| 646 |
return $rules[$key]['message']; |
| 647 |
} |
| 648 |
|
| 649 |
return null; |
| 650 |
} |
| 651 |
|
| 652 |
/** |
| 653 |
* Get detailed field validation breakdown |
| 654 |
* |
| 655 |
* @since 1.0.0 |
| 656 |
* |
| 657 |
* @param array $settings Settings array to validate |
| 658 |
* @param string $context Context for specific validation |
| 659 |
* @return array Detailed field validation results |
| 660 |
*/ |
| 661 |
private function get_detailed_field_validation(array $settings, string $context = 'all'): array { |
| 662 |
$field_details = []; |
| 663 |
|
| 664 |
// Return tab-specific validation based on context |
| 665 |
switch ($context) { |
| 666 |
case 'open-graph': |
| 667 |
return $this->validate_open_graph_fields($settings); |
| 668 |
case 'twitter-cards': |
| 669 |
return $this->validate_twitter_fields($settings); |
| 670 |
default: |
| 671 |
// For 'all' or unknown context, return only Social Media fields (Open Graph + Twitter) |
| 672 |
$field_details = array_merge($field_details, $this->validate_open_graph_fields($settings)); |
| 673 |
$field_details = array_merge($field_details, $this->validate_twitter_fields($settings)); |
| 674 |
return $field_details; |
| 675 |
} |
| 676 |
} |
| 677 |
|
| 678 |
/** |
| 679 |
* Validate Open Graph fields |
| 680 |
* |
| 681 |
* @since 1.0.0 |
| 682 |
* |
| 683 |
* @param array $settings Settings array to validate |
| 684 |
* @return array Open Graph field validation results |
| 685 |
*/ |
| 686 |
private function validate_open_graph_fields(array $settings): array { |
| 687 |
$field_details = []; |
| 688 |
|
| 689 |
// Open Graph Enabled |
| 690 |
if (!empty($settings['enable_open_graph'])) { |
| 691 |
$field_details[] = [ |
| 692 |
'field' => 'enable_open_graph', |
| 693 |
'label' => 'Open Graph is enabled for social media sharing.', |
| 694 |
'status' => 'valid', |
| 695 |
'icon' => '✓' |
| 696 |
]; |
| 697 |
|
| 698 |
// Site Name validation |
| 699 |
if (!empty($settings['og_site_name'])) { |
| 700 |
if (strlen($settings['og_site_name']) <= 60) { |
| 701 |
$field_details[] = [ |
| 702 |
'field' => 'og_site_name', |
| 703 |
'label' => 'Site name is properly configured for Open Graph.', |
| 704 |
'status' => 'valid', |
| 705 |
'icon' => '✓' |
| 706 |
]; |
| 707 |
} else { |
| 708 |
$field_details[] = [ |
| 709 |
'field' => 'og_site_name', |
| 710 |
'label' => 'Site name is longer than 60 characters, may be truncated.', |
| 711 |
'status' => 'warning', |
| 712 |
'icon' => '⚠' |
| 713 |
]; |
| 714 |
} |
| 715 |
} else { |
| 716 |
$field_details[] = [ |
| 717 |
'field' => 'og_site_name', |
| 718 |
'label' => 'Site name is required for Open Graph.', |
| 719 |
'status' => 'error', |
| 720 |
'icon' => '✗' |
| 721 |
]; |
| 722 |
} |
| 723 |
|
| 724 |
// Description validation |
| 725 |
if (!empty($settings['og_description'])) { |
| 726 |
$length = strlen($settings['og_description']); |
| 727 |
if ($length >= 120 && $length <= 160) { |
| 728 |
$field_details[] = [ |
| 729 |
'field' => 'og_description', |
| 730 |
'label' => 'Description is properly configured for social sharing.', |
| 731 |
'status' => 'valid', |
| 732 |
'icon' => '✓' |
| 733 |
]; |
| 734 |
} else { |
| 735 |
$field_details[] = [ |
| 736 |
'field' => 'og_description', |
| 737 |
'label' => 'Description length could be optimized (120-160 characters recommended).', |
| 738 |
'status' => 'warning', |
| 739 |
'icon' => '⚠' |
| 740 |
]; |
| 741 |
} |
| 742 |
} else { |
| 743 |
$field_details[] = [ |
| 744 |
'field' => 'og_description', |
| 745 |
'label' => 'Description is recommended for better social sharing.', |
| 746 |
'status' => 'warning', |
| 747 |
'icon' => '⚠' |
| 748 |
]; |
| 749 |
} |
| 750 |
|
| 751 |
// Content Type validation |
| 752 |
if (!empty($settings['og_type'])) { |
| 753 |
$field_details[] = [ |
| 754 |
'field' => 'og_type', |
| 755 |
'label' => 'Content type is configured for Open Graph.', |
| 756 |
'status' => 'valid', |
| 757 |
'icon' => '✓' |
| 758 |
]; |
| 759 |
} else { |
| 760 |
$field_details[] = [ |
| 761 |
'field' => 'og_type', |
| 762 |
'label' => 'Content type should be specified.', |
| 763 |
'status' => 'suggestion', |
| 764 |
'icon' => '⚠' |
| 765 |
]; |
| 766 |
} |
| 767 |
|
| 768 |
// Default Image validation |
| 769 |
if (!empty($settings['default_og_image'])) { |
| 770 |
if (filter_var($settings['default_og_image'], FILTER_VALIDATE_URL)) { |
| 771 |
$field_details[] = [ |
| 772 |
'field' => 'default_og_image', |
| 773 |
'label' => 'Default Open Graph image is configured.', |
| 774 |
'status' => 'valid', |
| 775 |
'icon' => '✓' |
| 776 |
]; |
| 777 |
} else { |
| 778 |
$field_details[] = [ |
| 779 |
'field' => 'default_og_image', |
| 780 |
'label' => 'Default Open Graph image URL appears invalid.', |
| 781 |
'status' => 'warning', |
| 782 |
'icon' => '⚠' |
| 783 |
]; |
| 784 |
} |
| 785 |
} else { |
| 786 |
$field_details[] = [ |
| 787 |
'field' => 'default_og_image', |
| 788 |
'label' => 'Default image is recommended for social sharing.', |
| 789 |
'status' => 'suggestion', |
| 790 |
'icon' => '⚠' |
| 791 |
]; |
| 792 |
} |
| 793 |
|
| 794 |
} else { |
| 795 |
$field_details[] = [ |
| 796 |
'field' => 'enable_open_graph', |
| 797 |
'label' => 'Open Graph is disabled. Enable for better social media sharing.', |
| 798 |
'status' => 'suggestion', |
| 799 |
'icon' => '⚠' |
| 800 |
]; |
| 801 |
} |
| 802 |
|
| 803 |
return $field_details; |
| 804 |
} |
| 805 |
|
| 806 |
/** |
| 807 |
* Validate Twitter fields |
| 808 |
* |
| 809 |
* @since 1.0.0 |
| 810 |
* |
| 811 |
* @param array $settings Settings array to validate |
| 812 |
* @return array Twitter field validation results |
| 813 |
*/ |
| 814 |
private function validate_twitter_fields(array $settings): array { |
| 815 |
$field_details = []; |
| 816 |
|
| 817 |
// Twitter Cards Enabled |
| 818 |
if (!empty($settings['enable_twitter_cards'])) { |
| 819 |
$field_details[] = [ |
| 820 |
'field' => 'enable_twitter_cards', |
| 821 |
'label' => 'Twitter Cards are enabled for Twitter sharing.', |
| 822 |
'status' => 'valid', |
| 823 |
'icon' => '✓' |
| 824 |
]; |
| 825 |
|
| 826 |
// Twitter Username validation |
| 827 |
if (!empty($settings['twitter_username'])) { |
| 828 |
$username = trim($settings['twitter_username']); |
| 829 |
$clean_username = ltrim($username, '@'); |
| 830 |
|
| 831 |
if (strlen($clean_username) <= 15 && preg_match('/^[A-Za-z0-9_]+$/', $clean_username)) { |
| 832 |
$field_details[] = [ |
| 833 |
'field' => 'twitter_username', |
| 834 |
'label' => 'Twitter username is properly formatted.', |
| 835 |
'status' => 'valid', |
| 836 |
'icon' => '✓' |
| 837 |
]; |
| 838 |
} else { |
| 839 |
$field_details[] = [ |
| 840 |
'field' => 'twitter_username', |
| 841 |
'label' => 'Twitter username format is invalid (max 15 chars, letters/numbers/underscore only).', |
| 842 |
'status' => 'error', |
| 843 |
'icon' => '✗' |
| 844 |
]; |
| 845 |
} |
| 846 |
} else { |
| 847 |
$field_details[] = [ |
| 848 |
'field' => 'twitter_username', |
| 849 |
'label' => 'Twitter username recommended for better attribution.', |
| 850 |
'status' => 'suggestion', |
| 851 |
'icon' => '⚠' |
| 852 |
]; |
| 853 |
} |
| 854 |
|
| 855 |
// Twitter Creator validation |
| 856 |
if (!empty($settings['twitter_creator'])) { |
| 857 |
$creator = trim($settings['twitter_creator']); |
| 858 |
$clean_creator = ltrim($creator, '@'); |
| 859 |
|
| 860 |
if (strlen($clean_creator) <= 15 && preg_match('/^[A-Za-z0-9_]+$/', $clean_creator)) { |
| 861 |
$field_details[] = [ |
| 862 |
'field' => 'twitter_creator', |
| 863 |
'label' => 'Twitter creator is properly formatted.', |
| 864 |
'status' => 'valid', |
| 865 |
'icon' => '✓' |
| 866 |
]; |
| 867 |
} else { |
| 868 |
$field_details[] = [ |
| 869 |
'field' => 'twitter_creator', |
| 870 |
'label' => 'Twitter creator format is invalid (max 15 chars, letters/numbers/underscore only).', |
| 871 |
'status' => 'error', |
| 872 |
'icon' => '✗' |
| 873 |
]; |
| 874 |
} |
| 875 |
} else { |
| 876 |
$field_details[] = [ |
| 877 |
'field' => 'twitter_creator', |
| 878 |
'label' => 'Twitter creator recommended for content attribution.', |
| 879 |
'status' => 'suggestion', |
| 880 |
'icon' => '⚠' |
| 881 |
]; |
| 882 |
} |
| 883 |
|
| 884 |
// Card Type validation |
| 885 |
$valid_card_types = ['summary', 'summary_large_image', 'app', 'player']; |
| 886 |
if (!empty($settings['twitter_card_type']) && in_array($settings['twitter_card_type'], $valid_card_types, true)) { |
| 887 |
$field_details[] = [ |
| 888 |
'field' => 'twitter_card_type', |
| 889 |
'label' => 'Twitter Card type is properly configured.', |
| 890 |
'status' => 'valid', |
| 891 |
'icon' => '✓' |
| 892 |
]; |
| 893 |
} else { |
| 894 |
$field_details[] = [ |
| 895 |
'field' => 'twitter_card_type', |
| 896 |
'label' => 'Valid Twitter Card type is required.', |
| 897 |
'status' => 'error', |
| 898 |
'icon' => '✗' |
| 899 |
]; |
| 900 |
} |
| 901 |
|
| 902 |
// Default Twitter Image validation |
| 903 |
if (!empty($settings['default_twitter_image'])) { |
| 904 |
if (filter_var($settings['default_twitter_image'], FILTER_VALIDATE_URL)) { |
| 905 |
$field_details[] = [ |
| 906 |
'field' => 'default_twitter_image', |
| 907 |
'label' => 'Default Twitter Card image is configured.', |
| 908 |
'status' => 'valid', |
| 909 |
'icon' => '✓' |
| 910 |
]; |
| 911 |
} else { |
| 912 |
$field_details[] = [ |
| 913 |
'field' => 'default_twitter_image', |
| 914 |
'label' => 'Default Twitter Card image URL appears invalid.', |
| 915 |
'status' => 'warning', |
| 916 |
'icon' => '⚠' |
| 917 |
]; |
| 918 |
} |
| 919 |
} else { |
| 920 |
$field_details[] = [ |
| 921 |
'field' => 'default_twitter_image', |
| 922 |
'label' => 'Default image recommended for Twitter sharing.', |
| 923 |
'status' => 'suggestion', |
| 924 |
'icon' => '⚠' |
| 925 |
]; |
| 926 |
} |
| 927 |
|
| 928 |
} else { |
| 929 |
$field_details[] = [ |
| 930 |
'field' => 'enable_twitter_cards', |
| 931 |
'label' => 'Twitter Cards are disabled. Enable for better Twitter sharing.', |
| 932 |
'status' => 'suggestion', |
| 933 |
'icon' => '⚠' |
| 934 |
]; |
| 935 |
} |
| 936 |
|
| 937 |
return $field_details; |
| 938 |
} |
| 939 |
|
| 940 |
|
| 941 |
/** |
| 942 |
* Get output data for frontend rendering (implements interface) |
| 943 |
* |
| 944 |
* @since 1.0.0 |
| 945 |
* |
| 946 |
* @param string $context_type The context type |
| 947 |
* @param int|null $context_id Optional. Context ID |
| 948 |
* @param string|null $fallback_title Optional. Effective SEO title to |
| 949 |
* use when no per-post Open Graph |
| 950 |
* title override is set, so |
| 951 |
* rendered output mirrors the |
| 952 |
* document title and the Social |
| 953 |
* metabox preview. |
| 954 |
* @param string|null $fallback_description Optional. Effective meta |
| 955 |
* description, used as the |
| 956 |
* Open Graph description fallback |
| 957 |
* for the same parity reason. |
| 958 |
* @return array Output data ready for frontend rendering |
| 959 |
*/ |
| 960 |
public function get_output_data(string $context_type, ?int $context_id, ?string $fallback_title = null, ?string $fallback_description = null): array { |
| 961 |
// Memoize per request: the OG, Twitter and platform wp_head callbacks |
| 962 |
// each call this with the same arguments, so the extraction work + |
| 963 |
// Site_Identity_Manager instantiation would otherwise run three times. |
| 964 |
$cache_key = $context_type . ':' . ($context_id ?? 0) . ':' . md5((string) $fallback_title . '|' . (string) $fallback_description); |
| 965 |
if (isset($this->output_data_cache[$cache_key])) { |
| 966 |
return $this->output_data_cache[$cache_key]; |
| 967 |
} |
| 968 |
|
| 969 |
$settings = $this->get_settings($context_type, $context_id); |
| 970 |
$output = [ |
| 971 |
'og_tags' => [], |
| 972 |
// Secondary og:image entries. A separate list because $og_tags is |
| 973 |
// keyed by property name and so can hold exactly one 'og:image' |
| 974 |
// (#636); the emitter writes these straight after the primary. |
| 975 |
'og_extra_images' => [], |
| 976 |
'twitter_tags' => [], |
| 977 |
'meta_tags' => [], |
| 978 |
'platform_tags' => [], |
| 979 |
// Per-feature flags so each emitter can honor its own toggle. The |
| 980 |
// aggregate `enabled` (true if either is on) is kept for callers |
| 981 |
// that only care whether social output ran at all. |
| 982 |
'og_enabled' => false, |
| 983 |
'twitter_enabled' => false, |
| 984 |
'enabled' => false, |
| 985 |
]; |
| 986 |
|
| 987 |
// Check if individual social features are enabled |
| 988 |
$og_enabled = !empty($settings['enable_open_graph'] ?? $settings['og_enabled'] ?? false); |
| 989 |
$twitter_enabled = !empty($settings['enable_twitter_cards'] ?? $settings['twitter_enabled'] ?? false); |
| 990 |
$output['og_enabled'] = $og_enabled; |
| 991 |
$output['twitter_enabled'] = $twitter_enabled; |
| 992 |
|
| 993 |
if (!$og_enabled && !$twitter_enabled) { |
| 994 |
$this->output_data_cache[$cache_key] = $output; |
| 995 |
return $output; |
| 996 |
} |
| 997 |
|
| 998 |
$output['enabled'] = true; |
| 999 |
|
| 1000 |
// Extract content data |
| 1001 |
$content_data = $this->extract_social_content_data($context_type, $context_id, $settings, $fallback_title, $fallback_description); |
| 1002 |
|
| 1003 |
// Generate Open Graph tags if enabled |
| 1004 |
if ($og_enabled) { |
| 1005 |
$output['og_tags'] = $this->generate_og_tags($content_data, $context_type); |
| 1006 |
|
| 1007 |
// Add custom OG tags |
| 1008 |
if (!empty($settings['custom_og_tags'])) { |
| 1009 |
$output['og_tags'] = array_merge($output['og_tags'], $settings['custom_og_tags']); |
| 1010 |
} |
| 1011 |
|
| 1012 |
// Alternatives to offer after the primary image. Collected from the |
| 1013 |
// resolved primary rather than re-deriving it, so the two can never |
| 1014 |
// disagree about which image is the main one. |
| 1015 |
if (!empty($settings['og_multiple_images'])) { |
| 1016 |
$output['og_extra_images'] = Social_Images::additional( |
| 1017 |
(int) $context_id, |
| 1018 |
(string) ($output['og_tags']['og:image'] ?? '') |
| 1019 |
); |
| 1020 |
} |
| 1021 |
} |
| 1022 |
|
| 1023 |
// Generate Twitter Card tags if enabled |
| 1024 |
if ($twitter_enabled) { |
| 1025 |
$output['twitter_tags'] = $this->generate_twitter_tags($content_data, $context_type); |
| 1026 |
} |
| 1027 |
|
| 1028 |
// Generate platform-specific meta tags |
| 1029 |
$output['platform_tags'] = $this->generate_platform_meta_tags($settings); |
| 1030 |
|
| 1031 |
// Convert to meta tag format for HTML output |
| 1032 |
$output['meta_tags'] = $this->convert_to_meta_tags($output['og_tags'], $output['twitter_tags'], $output['platform_tags']); |
| 1033 |
|
| 1034 |
$this->output_data_cache[$cache_key] = $output; |
| 1035 |
return $output; |
| 1036 |
} |
| 1037 |
|
| 1038 |
/** |
| 1039 |
* Request-scoped memoization of get_output_data() keyed by context + title/desc. |
| 1040 |
* |
| 1041 |
* @var array<string, array> |
| 1042 |
*/ |
| 1043 |
private array $output_data_cache = []; |
| 1044 |
|
| 1045 |
/** |
| 1046 |
* Site-wide default image keys inherited by every other context. |
| 1047 |
* |
| 1048 |
* @since 1.24.1 |
| 1049 |
* @var string[] |
| 1050 |
*/ |
| 1051 |
private const INHERITED_SITE_KEYS = [ |
| 1052 |
'default_og_image', |
| 1053 |
'default_twitter_image', |
| 1054 |
'default_image', |
| 1055 |
]; |
| 1056 |
|
| 1057 |
/** |
| 1058 |
* Site-wide switches with no per-context equivalent. |
| 1059 |
* |
| 1060 |
* Unlike INHERITED_SITE_KEYS above, these must inherit their site value |
| 1061 |
* even when it is FALSE. The empty()-guarded loop used for images can only |
| 1062 |
* ever propagate "on", which is right for an image URL (empty means "not |
| 1063 |
* configured") and wrong for a boolean, where false is a deliberate choice. |
| 1064 |
* |
| 1065 |
* Without this the master Open Graph / Twitter Cards switches were honoured |
| 1066 |
* on the homepage (mapped to the `site` context) and ignored on every post |
| 1067 |
* and page, which read as though the toggle had worked (#557). |
| 1068 |
* |
| 1069 |
* @since 2.2.0 |
| 1070 |
* @var string[] |
| 1071 |
*/ |
| 1072 |
private const SITE_ONLY_KEYS = [ |
| 1073 |
'enable_open_graph', |
| 1074 |
'enable_twitter_cards', |
| 1075 |
// Same shape as the two above and the same trap: a site-wide switch |
| 1076 |
// with no per-context equivalent. Left out, it read as on while the |
| 1077 |
// homepage rendered and as off on every post and page — which is where |
| 1078 |
// the alternatives it controls actually come from (#636). |
| 1079 |
'og_multiple_images', |
| 1080 |
]; |
| 1081 |
|
| 1082 |
/** |
| 1083 |
* Get settings for a context, inheriting the site-wide default images |
| 1084 |
* |
| 1085 |
* Two corrections over the generic lookup: |
| 1086 |
* |
| 1087 |
* 1. Site-wide settings are always stored with context_id 0, but the |
| 1088 |
* frontend maps a homepage request to the `site` context while still |
| 1089 |
* passing the queried object ID (non-zero on a static front page). That |
| 1090 |
* looked up `site`/<page ID>, matched no row and silently fell back to |
| 1091 |
* the schema defaults, so a configured default OG image never rendered |
| 1092 |
* on a static front page. Normalize the ID away for `site`. |
| 1093 |
* 2. `default_og_image` / `default_twitter_image` only exist in the site |
| 1094 |
* context, so post/page and archive contexts had nothing to fall back to |
| 1095 |
* when a post had no featured image — og:image dropped to the site logo |
| 1096 |
* or vanished entirely. Inherit those keys when the context has no value |
| 1097 |
* of its own. |
| 1098 |
* |
| 1099 |
* @since 1.24.1 |
| 1100 |
* |
| 1101 |
* @param string $context_type The context type |
| 1102 |
* @param int|null $context_id Optional. Context ID |
| 1103 |
* @return array Settings with site-wide image defaults applied |
| 1104 |
*/ |
| 1105 |
public function get_settings(string $context_type, ?int $context_id = null): array { |
| 1106 |
if ($context_type === 'site') { |
| 1107 |
$context_id = null; |
| 1108 |
} |
| 1109 |
|
| 1110 |
$settings = parent::get_settings($context_type, $context_id); |
| 1111 |
|
| 1112 |
if ($context_type === 'site') { |
| 1113 |
return $settings; |
| 1114 |
} |
| 1115 |
|
| 1116 |
$site_settings = parent::get_settings('site', null); |
| 1117 |
|
| 1118 |
// Site-wide switches: the site value is authoritative, false included. |
| 1119 |
// array_key_exists, not empty() — '' is how a disabled toggle is stored. |
| 1120 |
foreach (self::SITE_ONLY_KEYS as $key) { |
| 1121 |
if (array_key_exists($key, $site_settings)) { |
| 1122 |
$settings[$key] = $site_settings[$key]; |
| 1123 |
} |
| 1124 |
} |
| 1125 |
|
| 1126 |
// Default images: inherit only when this context has none of its own. |
| 1127 |
foreach (self::INHERITED_SITE_KEYS as $key) { |
| 1128 |
if (empty($settings[$key]) && !empty($site_settings[$key])) { |
| 1129 |
$settings[$key] = $site_settings[$key]; |
| 1130 |
} |
| 1131 |
} |
| 1132 |
|
| 1133 |
return $settings; |
| 1134 |
} |
| 1135 |
|
| 1136 |
/** |
| 1137 |
* Get default settings for a context type (implements interface) |
| 1138 |
* |
| 1139 |
* @since 1.0.0 |
| 1140 |
* |
| 1141 |
* @param string $context_type The context type to get defaults for |
| 1142 |
* @return array Default settings array |
| 1143 |
*/ |
| 1144 |
public function get_default_settings(string $context_type): array { |
| 1145 |
// Get WordPress site defaults |
| 1146 |
$site_name = get_bloginfo('name'); |
| 1147 |
$site_description = get_bloginfo('description'); |
| 1148 |
|
| 1149 |
$defaults = [ |
| 1150 |
// Open Graph settings |
| 1151 |
'enable_open_graph' => true, |
| 1152 |
'og_site_name' => $site_name, |
| 1153 |
'og_description' => $site_description, |
| 1154 |
'og_type' => 'website', |
| 1155 |
// Empty by design: og:locale is resolved from the site locale via |
| 1156 |
// get_og_locale(), which is where the thinkrank_og_locale filter (and |
| 1157 |
// therefore the WPML/Polylang/TranslatePress integration) applies. A |
| 1158 |
// hardcoded default was merged into every settings read, so the |
| 1159 |
// resolver was unreachable and every install advertised en_US. |
| 1160 |
'og_locale' => '', |
| 1161 |
'default_og_image' => '', |
| 1162 |
'og_image_width' => 1200, |
| 1163 |
'og_image_height' => 630, |
| 1164 |
// Offer alternative og:image tags after the primary one (#636). |
| 1165 |
// Off by default: a page that shares with one image today must |
| 1166 |
// keep sharing with that image after an update. |
| 1167 |
'og_multiple_images' => false, |
| 1168 |
|
| 1169 |
// Twitter Cards settings |
| 1170 |
'enable_twitter_cards' => true, |
| 1171 |
'twitter_username' => '', |
| 1172 |
'twitter_creator' => '', |
| 1173 |
'twitter_card_type' => 'summary_large_image', |
| 1174 |
'default_twitter_image' => '', |
| 1175 |
|
| 1176 |
// Facebook settings |
| 1177 |
'facebook_app_id' => '', |
| 1178 |
'facebook_admins' => '', |
| 1179 |
|
| 1180 |
// LinkedIn settings |
| 1181 |
'enable_linkedin' => false, |
| 1182 |
|
| 1183 |
// Pinterest settings |
| 1184 |
'enable_pinterest' => false, |
| 1185 |
'pinterest_site_verification' => '', |
| 1186 |
|
| 1187 |
// Instagram settings |
| 1188 |
'enable_instagram' => false, |
| 1189 |
'instagram_verification' => '', |
| 1190 |
|
| 1191 |
// TikTok settings |
| 1192 |
'enable_tiktok' => false, |
| 1193 |
'tiktok_verification' => '', |
| 1194 |
|
| 1195 |
// YouTube settings |
| 1196 |
'enable_youtube' => false, |
| 1197 |
'youtube_channel_id' => '', |
| 1198 |
|
| 1199 |
// WhatsApp Business settings |
| 1200 |
'enable_whatsapp' => false, |
| 1201 |
'whatsapp_business_id' => '', |
| 1202 |
|
| 1203 |
// Advanced settings |
| 1204 |
'auto_generate_descriptions' => true, |
| 1205 |
'fallback_to_excerpt' => true, |
| 1206 |
'strip_html_tags' => true, |
| 1207 |
'max_description_length' => 160, |
| 1208 |
|
| 1209 |
// oEmbed card (#637). All three default off: this rewrites what |
| 1210 |
// other people's sites display, so an upgrade must not silently |
| 1211 |
// change a card an existing embed has been showing for months. |
| 1212 |
'oembed_use_seo_title' => false, |
| 1213 |
'oembed_use_social_image' => false, |
| 1214 |
'oembed_remove_author' => false, |
| 1215 |
|
| 1216 |
// Legacy format for backward compatibility (only when needed) |
| 1217 |
'custom_og_tags' => [], |
| 1218 |
'image_optimization' => true, |
| 1219 |
'auto_generate' => true |
| 1220 |
]; |
| 1221 |
|
| 1222 |
// Context-specific defaults |
| 1223 |
switch ($context_type) { |
| 1224 |
case 'site': |
| 1225 |
$defaults['og_type'] = 'website'; |
| 1226 |
break; |
| 1227 |
case 'post': |
| 1228 |
$defaults['og_type'] = 'article'; |
| 1229 |
break; |
| 1230 |
case 'page': |
| 1231 |
$defaults['og_type'] = 'website'; |
| 1232 |
break; |
| 1233 |
case 'product': |
| 1234 |
$defaults['og_type'] = 'product'; |
| 1235 |
break; |
| 1236 |
} |
| 1237 |
|
| 1238 |
return $defaults; |
| 1239 |
} |
| 1240 |
|
| 1241 |
/** |
| 1242 |
* Get settings schema definition (implements interface) |
| 1243 |
* |
| 1244 |
* @since 1.0.0 |
| 1245 |
* |
| 1246 |
* @param string $context_type The context type to get schema for |
| 1247 |
* @return array Settings schema definition |
| 1248 |
*/ |
| 1249 |
public function get_settings_schema(string $context_type): array { |
| 1250 |
return [ |
| 1251 |
'enable_open_graph' => [ |
| 1252 |
'type' => 'boolean', |
| 1253 |
'title' => 'Enable Open Graph', |
| 1254 |
'description' => 'Generate Open Graph meta tags for social media sharing', |
| 1255 |
'default' => true |
| 1256 |
], |
| 1257 |
'og_site_name' => [ |
| 1258 |
'type' => 'string', |
| 1259 |
'title' => 'Site Name', |
| 1260 |
'description' => 'The name of your website for Open Graph', |
| 1261 |
'maxLength' => 60, |
| 1262 |
'default' => get_bloginfo('name') |
| 1263 |
], |
| 1264 |
'og_description' => [ |
| 1265 |
'type' => 'string', |
| 1266 |
'title' => 'Site Description', |
| 1267 |
'description' => 'Default description for Open Graph tags', |
| 1268 |
'maxLength' => 160, |
| 1269 |
'default' => get_bloginfo('description') |
| 1270 |
], |
| 1271 |
'og_locale' => [ |
| 1272 |
'type' => 'string', |
| 1273 |
'title' => 'Locale', |
| 1274 |
'description' => 'Optional override for og:locale. Leave empty to follow the site language.', |
| 1275 |
'default' => '' |
| 1276 |
], |
| 1277 |
'default_og_image' => [ |
| 1278 |
'type' => 'string', |
| 1279 |
'title' => 'Default Open Graph Image', |
| 1280 |
'description' => 'Default image URL for Open Graph tags', |
| 1281 |
'format' => 'uri', |
| 1282 |
'default' => '' |
| 1283 |
], |
| 1284 |
'og_image_width' => [ |
| 1285 |
'type' => 'integer', |
| 1286 |
'title' => 'Image Width', |
| 1287 |
'description' => 'Default width for Open Graph images', |
| 1288 |
'minimum' => 200, |
| 1289 |
'default' => 1200 |
| 1290 |
], |
| 1291 |
'og_image_height' => [ |
| 1292 |
'type' => 'integer', |
| 1293 |
'title' => 'Image Height', |
| 1294 |
'description' => 'Default height for Open Graph images', |
| 1295 |
'minimum' => 200, |
| 1296 |
'default' => 630 |
| 1297 |
], |
| 1298 |
'enable_twitter_cards' => [ |
| 1299 |
'type' => 'boolean', |
| 1300 |
'title' => 'Enable Twitter Cards', |
| 1301 |
'description' => 'Generate Twitter Card meta tags for Twitter sharing', |
| 1302 |
'default' => true |
| 1303 |
], |
| 1304 |
'twitter_username' => [ |
| 1305 |
'type' => 'string', |
| 1306 |
'title' => 'Twitter Username', |
| 1307 |
'description' => 'Twitter username for the site (without @, e.g., username)', |
| 1308 |
'pattern' => '^[a-zA-Z0-9_]{1,15}$', |
| 1309 |
'default' => '' |
| 1310 |
], |
| 1311 |
'twitter_creator' => [ |
| 1312 |
'type' => 'string', |
| 1313 |
'title' => 'Twitter Creator', |
| 1314 |
'description' => 'Content creator Twitter username (without @, e.g., creator_username)', |
| 1315 |
'pattern' => '^[a-zA-Z0-9_]{1,15}$', |
| 1316 |
'default' => '' |
| 1317 |
], |
| 1318 |
'twitter_card_type' => [ |
| 1319 |
'type' => 'string', |
| 1320 |
'title' => 'Twitter Card Type', |
| 1321 |
'description' => 'The type of Twitter Card to generate', |
| 1322 |
'enum' => $this->supported_platforms['twitter']['card_types'], |
| 1323 |
'default' => 'summary_large_image' |
| 1324 |
], |
| 1325 |
'og_type' => [ |
| 1326 |
'type' => 'string', |
| 1327 |
'title' => 'Open Graph Type', |
| 1328 |
'description' => 'The Open Graph type for this content', |
| 1329 |
'enum' => array_keys($this->og_types), |
| 1330 |
'default' => $this->get_default_settings($context_type)['og_type'] |
| 1331 |
], |
| 1332 |
'default_image' => [ |
| 1333 |
'type' => 'string', |
| 1334 |
'title' => 'Default Social Image', |
| 1335 |
'description' => 'Default image URL for social media sharing', |
| 1336 |
'format' => 'uri', |
| 1337 |
'default' => '' |
| 1338 |
], |
| 1339 |
'twitter_site' => [ |
| 1340 |
'type' => 'string', |
| 1341 |
'title' => 'Twitter Site Handle', |
| 1342 |
'description' => 'Twitter handle for the site (e.g., @username)', |
| 1343 |
'pattern' => '^@[a-zA-Z0-9_]{1,15}$', |
| 1344 |
'default' => '' |
| 1345 |
], |
| 1346 |
'default_twitter_image' => [ |
| 1347 |
'type' => 'string', |
| 1348 |
'title' => 'Default Twitter Image', |
| 1349 |
'description' => 'Default image URL for Twitter Cards', |
| 1350 |
'format' => 'uri', |
| 1351 |
'default' => '' |
| 1352 |
], |
| 1353 |
'facebook_app_id' => [ |
| 1354 |
'type' => 'string', |
| 1355 |
'title' => 'Facebook App ID', |
| 1356 |
'description' => 'Facebook App ID for analytics and insights', |
| 1357 |
'pattern' => '^[0-9]+$', |
| 1358 |
'default' => '' |
| 1359 |
], |
| 1360 |
'facebook_admins' => [ |
| 1361 |
'type' => 'string', |
| 1362 |
'title' => 'Facebook Admins', |
| 1363 |
'description' => 'Comma-separated list of Facebook admin user IDs', |
| 1364 |
'default' => '' |
| 1365 |
], |
| 1366 |
'enable_linkedin' => [ |
| 1367 |
'type' => 'boolean', |
| 1368 |
'title' => 'Enable LinkedIn', |
| 1369 |
'description' => 'Enable LinkedIn-specific optimizations', |
| 1370 |
'default' => false |
| 1371 |
], |
| 1372 |
'enable_pinterest' => [ |
| 1373 |
'type' => 'boolean', |
| 1374 |
'title' => 'Enable Pinterest', |
| 1375 |
'description' => 'Enable Pinterest-specific optimizations', |
| 1376 |
'default' => false |
| 1377 |
], |
| 1378 |
'pinterest_site_verification' => [ |
| 1379 |
'type' => 'string', |
| 1380 |
'title' => 'Pinterest Site Verification', |
| 1381 |
'description' => 'Pinterest site verification meta tag content', |
| 1382 |
'pattern' => '^[a-f0-9]{32}$', |
| 1383 |
'default' => '' |
| 1384 |
], |
| 1385 |
'enable_instagram' => [ |
| 1386 |
'type' => 'boolean', |
| 1387 |
'title' => 'Enable Instagram', |
| 1388 |
'description' => 'Enable Instagram-specific optimizations', |
| 1389 |
'default' => false |
| 1390 |
], |
| 1391 |
'instagram_verification' => [ |
| 1392 |
'type' => 'string', |
| 1393 |
'title' => 'Instagram Site Verification', |
| 1394 |
'description' => 'Instagram Business account verification code', |
| 1395 |
'pattern' => '^[a-zA-Z0-9_-]{20,}$', |
| 1396 |
'default' => '' |
| 1397 |
], |
| 1398 |
'enable_tiktok' => [ |
| 1399 |
'type' => 'boolean', |
| 1400 |
'title' => 'Enable TikTok', |
| 1401 |
'description' => 'Enable TikTok-specific optimizations', |
| 1402 |
'default' => false |
| 1403 |
], |
| 1404 |
'tiktok_verification' => [ |
| 1405 |
'type' => 'string', |
| 1406 |
'title' => 'TikTok Site Verification', |
| 1407 |
'description' => 'TikTok for Business verification code', |
| 1408 |
'pattern' => '^[a-zA-Z0-9_-]{20,}$', |
| 1409 |
'default' => '' |
| 1410 |
], |
| 1411 |
'enable_youtube' => [ |
| 1412 |
'type' => 'boolean', |
| 1413 |
'title' => 'Enable YouTube', |
| 1414 |
'description' => 'Enable YouTube-specific optimizations', |
| 1415 |
'default' => false |
| 1416 |
], |
| 1417 |
'youtube_channel_id' => [ |
| 1418 |
'type' => 'string', |
| 1419 |
'title' => 'YouTube Channel ID', |
| 1420 |
'description' => 'YouTube channel ID for content attribution', |
| 1421 |
'pattern' => '^UC[a-zA-Z0-9_-]{22}$', |
| 1422 |
'default' => '' |
| 1423 |
], |
| 1424 |
'enable_whatsapp' => [ |
| 1425 |
'type' => 'boolean', |
| 1426 |
'title' => 'Enable WhatsApp Business', |
| 1427 |
'description' => 'Enable WhatsApp Business optimizations', |
| 1428 |
'default' => false |
| 1429 |
], |
| 1430 |
'whatsapp_business_id' => [ |
| 1431 |
'type' => 'string', |
| 1432 |
'title' => 'WhatsApp Business ID', |
| 1433 |
'description' => 'WhatsApp Business account ID', |
| 1434 |
'pattern' => '^[0-9]{10,15}$', |
| 1435 |
'default' => '' |
| 1436 |
], |
| 1437 |
'auto_generate_descriptions' => [ |
| 1438 |
'type' => 'boolean', |
| 1439 |
'title' => 'Auto-generate Descriptions', |
| 1440 |
'description' => 'Automatically generate descriptions from content', |
| 1441 |
'default' => true |
| 1442 |
], |
| 1443 |
'fallback_to_excerpt' => [ |
| 1444 |
'type' => 'boolean', |
| 1445 |
'title' => 'Fallback to Excerpt', |
| 1446 |
'description' => 'Use post excerpt as fallback for descriptions', |
| 1447 |
'default' => true |
| 1448 |
], |
| 1449 |
'strip_html_tags' => [ |
| 1450 |
'type' => 'boolean', |
| 1451 |
'title' => 'Strip HTML Tags', |
| 1452 |
'description' => 'Remove HTML tags from generated descriptions', |
| 1453 |
'default' => true |
| 1454 |
], |
| 1455 |
'max_description_length' => [ |
| 1456 |
'type' => 'integer', |
| 1457 |
'title' => 'Max Description Length', |
| 1458 |
'description' => 'Maximum length for generated descriptions', |
| 1459 |
'minimum' => 50, |
| 1460 |
'maximum' => 300, |
| 1461 |
'default' => 160 |
| 1462 |
], |
| 1463 |
'custom_og_tags' => [ |
| 1464 |
'type' => 'object', |
| 1465 |
'title' => 'Custom Open Graph Tags', |
| 1466 |
'description' => 'Additional custom Open Graph meta tags', |
| 1467 |
'default' => [] |
| 1468 |
], |
| 1469 |
'image_optimization' => [ |
| 1470 |
'type' => 'boolean', |
| 1471 |
'title' => 'Enable Image Optimization', |
| 1472 |
'description' => 'Optimize images for social media platforms', |
| 1473 |
'default' => true |
| 1474 |
], |
| 1475 |
'auto_generate' => [ |
| 1476 |
'type' => 'boolean', |
| 1477 |
'title' => 'Auto-generate Tags', |
| 1478 |
'description' => 'Automatically generate social meta tags from content', |
| 1479 |
'default' => true |
| 1480 |
] |
| 1481 |
]; |
| 1482 |
} |
| 1483 |
|
| 1484 |
/** |
| 1485 |
* Extract content data for social meta generation |
| 1486 |
* |
| 1487 |
* @since 1.0.0 |
| 1488 |
* |
| 1489 |
* @param string $context_type The context type |
| 1490 |
* @param int|null $context_id Optional. Context ID |
| 1491 |
* @param array $settings Social meta settings |
| 1492 |
* @return array Extracted content data |
| 1493 |
*/ |
| 1494 |
private function extract_social_content_data(string $context_type, ?int $context_id, array $settings, ?string $fallback_title = null, ?string $fallback_description = null): array { |
| 1495 |
$data = [ |
| 1496 |
'title' => '', |
| 1497 |
'description' => '', |
| 1498 |
'url' => '', |
| 1499 |
'image' => '', |
| 1500 |
'twitter_title' => '', // Separate field for a Twitter-specific title |
| 1501 |
'twitter_description' => '', // Separate field for a Twitter-specific description |
| 1502 |
'twitter_image' => '', // Separate field for Twitter-specific images |
| 1503 |
// '' rather than 'website' means "derive it from the context". |
| 1504 |
// Seeding a concrete type here made an explicit choice |
| 1505 |
// indistinguishable from the shipped default (#398). |
| 1506 |
'type' => '', |
| 1507 |
'twitter_card_type' => '', |
| 1508 |
'author' => [], |
| 1509 |
'published_time' => '', |
| 1510 |
'modified_time' => '', |
| 1511 |
'site_name' => $settings['og_site_name'] ?? get_bloginfo('name') |
| 1512 |
]; |
| 1513 |
|
| 1514 |
// Explicit type choices, resolved once for whichever context this is. |
| 1515 |
$data['type'] = $this->configured_og_type($settings); |
| 1516 |
$data['twitter_card_type'] = $this->configured_twitter_card_type($settings); |
| 1517 |
|
| 1518 |
if ($context_type === 'site') { |
| 1519 |
// Site-wide data with Social Media tab settings priority. |
| 1520 |
// |
| 1521 |
// og:title priority: an explicitly-configured OG Site Name wins; |
| 1522 |
// otherwise mirror the effective SEO <title> (what search shows), |
| 1523 |
// then the blogname. og_site_name is always present because it is |
| 1524 |
// merged from a default equal to the blogname, so a value matching |
| 1525 |
// the blogname is treated as "not explicitly overridden" and we fall |
| 1526 |
// through to the passed effective SEO title. (og:site_name itself is |
| 1527 |
// set separately from og_site_name and is unaffected.) |
| 1528 |
$blogname = get_bloginfo('name'); |
| 1529 |
$og_site_name = $settings['og_site_name'] ?? ''; |
| 1530 |
if ($og_site_name !== '' && $og_site_name !== $blogname) { |
| 1531 |
$data['title'] = $og_site_name; |
| 1532 |
} elseif ($fallback_title !== null && $fallback_title !== '') { |
| 1533 |
$data['title'] = $fallback_title; |
| 1534 |
} else { |
| 1535 |
$data['title'] = $blogname; |
| 1536 |
} |
| 1537 |
$data['description'] = $settings['og_description'] ?? get_bloginfo('description'); |
| 1538 |
// Use home_url('/') so og:url matches the homepage canonical |
| 1539 |
// (class-seo-manager.php) and the WebSite schema, which both include |
| 1540 |
// the trailing slash. A bare home_url() would key a different URL in |
| 1541 |
// social caches than the canonical. |
| 1542 |
// |
| 1543 |
// Except when this is not the site home. detect_current_context() |
| 1544 |
// collapses is_home() && !is_front_page() into 'homepage', so a |
| 1545 |
// static posts page — and page 2 of any blog listing — advertised |
| 1546 |
// the site home as its og:url while its own canonical said |
| 1547 |
// otherwise (#397). |
| 1548 |
$data['url'] = self::current_home_url(); |
| 1549 |
|
| 1550 |
// Leaving this null lets generate_og_tags() fall through to |
| 1551 |
// get_og_locale(), which is what every other context already does. |
| 1552 |
// |
| 1553 |
// A stored 'en_US' is deliberately treated as "not set". It was the |
| 1554 |
// hardcoded default on every install and there has never been a UI |
| 1555 |
// control for this field, so it cannot represent a deliberate choice |
| 1556 |
// — it is the old default persisted by an unrelated save of the |
| 1557 |
// Social Media tab. Honouring it would leave every already-saved |
| 1558 |
// site broken after this fix. Any other stored value is a genuine |
| 1559 |
// override and still wins; a site that really wants to force en_US |
| 1560 |
// can do so through the thinkrank_og_locale filter. |
| 1561 |
$stored_locale = trim((string) ($settings['og_locale'] ?? '')); |
| 1562 |
$data['locale'] = ('' !== $stored_locale && 'en_US' !== $stored_locale) |
| 1563 |
? $stored_locale |
| 1564 |
: null; |
| 1565 |
|
| 1566 |
// Set Open Graph image with proper fallback |
| 1567 |
$data['image'] = $this->get_og_image_for_context($settings, null); |
| 1568 |
|
| 1569 |
// Set Twitter image with proper fallback |
| 1570 |
$data['twitter_image'] = $this->get_twitter_image_for_context($settings, null); |
| 1571 |
} elseif ($context_id && in_array($context_type, ['post', 'page', 'product'], true)) { |
| 1572 |
// Post-specific data |
| 1573 |
$post = get_post($context_id); |
| 1574 |
if ($post) { |
| 1575 |
// Per-post Open Graph overrides from the metabox Social tab take |
| 1576 |
// precedence over the derived title/description/image. These read |
| 1577 |
// the same meta keys the metabox save handler and the import |
| 1578 |
// migrator write to, so manual edits and migrated data flow |
| 1579 |
// through one path. Title/description may hold variable tags |
| 1580 |
// (e.g. %title%), resolved here to match output_basic_og_tags(). |
| 1581 |
$og_title_override = \ThinkRank\SEO\Pattern_Resolver::resolve_value( |
| 1582 |
(string) get_post_meta($post->ID, '_thinkrank_og_title', true), |
| 1583 |
$post->ID |
| 1584 |
); |
| 1585 |
$og_description_override = \ThinkRank\SEO\Pattern_Resolver::resolve_value( |
| 1586 |
(string) get_post_meta($post->ID, '_thinkrank_og_description', true), |
| 1587 |
$post->ID |
| 1588 |
); |
| 1589 |
$og_image_override = get_post_meta($post->ID, '_thinkrank_og_image', true); |
| 1590 |
|
| 1591 |
// Per-post Twitter-specific title override (metabox Social tab). |
| 1592 |
// Twitter Cards fall back to the og:title when this is empty, so |
| 1593 |
// only capture it here; the fallback is applied in |
| 1594 |
// generate_twitter_tags(). |
| 1595 |
$data['twitter_title'] = \ThinkRank\SEO\Pattern_Resolver::resolve_value( |
| 1596 |
(string) get_post_meta($post->ID, '_thinkrank_twitter_title', true), |
| 1597 |
$post->ID |
| 1598 |
); |
| 1599 |
|
| 1600 |
// Per-post Twitter-specific description. twitter:description |
| 1601 |
// falls back to the OG/meta description when this is empty, so |
| 1602 |
// only capture it here; generate_twitter_tags() applies the |
| 1603 |
// fallback. There was no counterpart to the title lookup above, |
| 1604 |
// so the stored value never entered $data at all (#406). |
| 1605 |
$data['twitter_description'] = \ThinkRank\SEO\Pattern_Resolver::resolve_value( |
| 1606 |
(string) get_post_meta($post->ID, '_thinkrank_twitter_description', true), |
| 1607 |
$post->ID |
| 1608 |
); |
| 1609 |
|
| 1610 |
// Title priority: per-post OG override > effective SEO title |
| 1611 |
// (document <title> / metabox preview) > post title. |
| 1612 |
if ($og_title_override !== '') { |
| 1613 |
$data['title'] = $og_title_override; |
| 1614 |
} elseif ($fallback_title !== null && $fallback_title !== '') { |
| 1615 |
$data['title'] = $fallback_title; |
| 1616 |
} else { |
| 1617 |
$data['title'] = get_the_title($post); |
| 1618 |
} |
| 1619 |
// Description priority: per-post OG override > effective meta |
| 1620 |
// description (meta tag / metabox preview) > derived excerpt. |
| 1621 |
if ($og_description_override !== '') { |
| 1622 |
$data['description'] = $og_description_override; |
| 1623 |
} elseif ($fallback_description !== null && $fallback_description !== '') { |
| 1624 |
$data['description'] = $fallback_description; |
| 1625 |
} else { |
| 1626 |
$data['description'] = $this->get_social_description($post); |
| 1627 |
} |
| 1628 |
// The canonical carries the <!--nextpage--> sub-page and the |
| 1629 |
// comment page; og:url said page 1 regardless, which is the |
| 1630 |
// same contradiction #397 fixed for the blog listing, one page |
| 1631 |
// type over (#397 review). |
| 1632 |
$data['url'] = self::with_singular_page((string) get_permalink($post)); |
| 1633 |
|
| 1634 |
$data['published_time'] = get_the_date('c', $post); |
| 1635 |
$data['modified_time'] = get_the_modified_date('c', $post); |
| 1636 |
$data['post_id'] = $post->ID; |
| 1637 |
|
| 1638 |
// Author data |
| 1639 |
$author_id = $post->post_author; |
| 1640 |
$data['author'] = [ |
| 1641 |
'name' => get_the_author_meta('display_name', $author_id), |
| 1642 |
'url' => get_author_posts_url($author_id), |
| 1643 |
'twitter' => get_the_author_meta('twitter', $author_id) |
| 1644 |
]; |
| 1645 |
|
| 1646 |
// Set Open Graph image: per-post override first, then the |
| 1647 |
// featured-image/default fallback chain. |
| 1648 |
$data['image'] = $og_image_override !== '' |
| 1649 |
? $og_image_override |
| 1650 |
: $this->get_og_image_for_context($settings, $post); |
| 1651 |
|
| 1652 |
// Set Twitter image with proper fallback |
| 1653 |
$data['twitter_image'] = $this->get_twitter_image_for_context($settings, $post); |
| 1654 |
} |
| 1655 |
} else { |
| 1656 |
// Archive-style contexts (category, tag, author, search, date). |
| 1657 |
// They carry no object of their own, but the site-wide default |
| 1658 |
// image still applies — without this they fell through to the raw |
| 1659 |
// logo/site-icon fallback in generate_og_tags() and ignored a |
| 1660 |
// configured default OG image. |
| 1661 |
$data['image'] = $this->get_og_image_for_context($settings, null); |
| 1662 |
$data['twitter_image'] = $this->get_twitter_image_for_context($settings, null); |
| 1663 |
|
| 1664 |
// A term archive owns SEO values of its own, and the caller has |
| 1665 |
// already resolved them into the fallbacks — the same strings |
| 1666 |
// rendered as the document <title> and the description tag. Leaving |
| 1667 |
// title and description empty here published the bare site name as |
| 1668 |
// og:title on every archive and no og:description at all, so a term |
| 1669 |
// SEO title never reached a social surface (#386). |
| 1670 |
// Archives have a URL of their own. The seed leaves it '', and the |
| 1671 |
// og:url emitter could not fall through to get_current_url() while |
| 1672 |
// the key existed, so no archive carried an og:url at all (#388). |
| 1673 |
// A search archive's URL is the search link, not the bare request |
| 1674 |
// path — get_current_url() reads $wp->request, which is empty for a |
| 1675 |
// search served from the front page, so og:url pointed at the site |
| 1676 |
// home while the page was a search result. |
| 1677 |
// The non-search archive URL is the page's own canonical, so og:url |
| 1678 |
// and <link rel="canonical"> agree on the paginated page rather than |
| 1679 |
// both claiming page 1 (#397). |
| 1680 |
// `?:` keeps the #388 guarantee that an archive always carries an |
| 1681 |
// og:url: get_non_singular_canonical_url() returns '' for a view it |
| 1682 |
// has no canonical rule for, and the request URL is still better |
| 1683 |
// than no tag at all. |
| 1684 |
$data['url'] = is_search() |
| 1685 |
? get_search_link() |
| 1686 |
: (self::current_archive_url() ?: $this->get_current_url()); |
| 1687 |
|
| 1688 |
$term = get_queried_object(); |
| 1689 |
$term_id = ($term instanceof \WP_Term) ? (int) $term->term_id : 0; |
| 1690 |
|
| 1691 |
$og_title_override = ''; |
| 1692 |
$og_description_override = ''; |
| 1693 |
|
| 1694 |
if ($term_id > 0) { |
| 1695 |
// Terms carry the same social override keys as posts — the |
| 1696 |
// abilities API and the metabox both write them. |
| 1697 |
$og_title_override = Pattern_Resolver::resolve_term_value( |
| 1698 |
(string) get_term_meta($term_id, '_thinkrank_og_title', true), |
| 1699 |
$term_id |
| 1700 |
); |
| 1701 |
$og_description_override = Pattern_Resolver::resolve_term_value( |
| 1702 |
(string) get_term_meta($term_id, '_thinkrank_og_description', true), |
| 1703 |
$term_id |
| 1704 |
); |
| 1705 |
|
| 1706 |
// Twitter Cards fall back to og:title when this is empty, so |
| 1707 |
// only capture it; generate_twitter_tags() applies the fallback. |
| 1708 |
$data['twitter_title'] = Pattern_Resolver::resolve_term_value( |
| 1709 |
(string) get_term_meta($term_id, '_thinkrank_twitter_title', true), |
| 1710 |
$term_id |
| 1711 |
); |
| 1712 |
$data['twitter_description'] = Pattern_Resolver::resolve_term_value( |
| 1713 |
(string) get_term_meta($term_id, '_thinkrank_twitter_description', true), |
| 1714 |
$term_id |
| 1715 |
); |
| 1716 |
|
| 1717 |
$term_og_image = (string) get_term_meta($term_id, '_thinkrank_og_image', true); |
| 1718 |
if ('' !== $term_og_image) { |
| 1719 |
$data['image'] = $term_og_image; |
| 1720 |
} |
| 1721 |
|
| 1722 |
$term_twitter_image = (string) get_term_meta($term_id, '_thinkrank_twitter_image', true); |
| 1723 |
if ('' !== $term_twitter_image) { |
| 1724 |
$data['twitter_image'] = $term_twitter_image; |
| 1725 |
} |
| 1726 |
} |
| 1727 |
|
| 1728 |
// Author, date and search archives have no ThinkRank-managed title |
| 1729 |
// to inherit — Author_Archives_Manager owns the author one, and the |
| 1730 |
// rest have no template — so the caller's fallback arrives empty and |
| 1731 |
// og:title used to collapse to the bare site name. Fall through to |
| 1732 |
// what the page itself is called (#388). |
| 1733 |
if ($og_title_override !== '') { |
| 1734 |
$data['title'] = $og_title_override; |
| 1735 |
} elseif ($fallback_title !== null && $fallback_title !== '') { |
| 1736 |
$data['title'] = $fallback_title; |
| 1737 |
} else { |
| 1738 |
$data['title'] = $this->archive_fallback_title(); |
| 1739 |
} |
| 1740 |
|
| 1741 |
if ($og_description_override !== '') { |
| 1742 |
$data['description'] = $og_description_override; |
| 1743 |
} elseif ($fallback_description !== null && $fallback_description !== '') { |
| 1744 |
$data['description'] = $fallback_description; |
| 1745 |
} else { |
| 1746 |
$data['description'] = $this->archive_fallback_description($term_id); |
| 1747 |
} |
| 1748 |
} |
| 1749 |
|
| 1750 |
return $data; |
| 1751 |
} |
| 1752 |
|
| 1753 |
/** |
| 1754 |
* The canonical URL of the archive currently being rendered. |
| 1755 |
* |
| 1756 |
* Deliberately the same value class-seo-manager.php puts in |
| 1757 |
* <link rel="canonical">: an og:url that disagrees with the canonical is |
| 1758 |
* the bug this is fixing, so the two read from one source. |
| 1759 |
* |
| 1760 |
* @since 2.0.1 |
| 1761 |
* |
| 1762 |
* @return string Archive URL, '' when there is none (search, 404). |
| 1763 |
*/ |
| 1764 |
private static function current_archive_url(): string { |
| 1765 |
if (!class_exists('\ThinkRank\Frontend\SEO_Manager')) { |
| 1766 |
return ''; |
| 1767 |
} |
| 1768 |
|
| 1769 |
return \ThinkRank\Frontend\SEO_Manager::get_non_singular_canonical_url(); |
| 1770 |
} |
| 1771 |
|
| 1772 |
/** |
| 1773 |
* A permalink with the current sub-page or comment page appended. |
| 1774 |
* |
| 1775 |
* @since 2.0.1 |
| 1776 |
* |
| 1777 |
* @param string $url Permalink. |
| 1778 |
* @return string |
| 1779 |
*/ |
| 1780 |
private static function with_singular_page(string $url): string { |
| 1781 |
if ('' === $url || !class_exists('\ThinkRank\Frontend\SEO_Manager')) { |
| 1782 |
return $url; |
| 1783 |
} |
| 1784 |
|
| 1785 |
return \ThinkRank\Frontend\SEO_Manager::with_singular_page($url); |
| 1786 |
} |
| 1787 |
|
| 1788 |
/** |
| 1789 |
* The URL of the page the 'site' context is actually being rendered for. |
| 1790 |
* |
| 1791 |
* home_url('/') for the front page, the posts page's own permalink when the |
| 1792 |
* site uses a static front page, and the paginated variant on page 2+. |
| 1793 |
* |
| 1794 |
* @since 2.0.1 |
| 1795 |
* |
| 1796 |
* @return string |
| 1797 |
*/ |
| 1798 |
private static function current_home_url(): string { |
| 1799 |
$url = home_url('/'); |
| 1800 |
|
| 1801 |
if (function_exists('is_home') && is_home() && !is_front_page()) { |
| 1802 |
$posts_page = (int) get_option('page_for_posts'); |
| 1803 |
|
| 1804 |
if ($posts_page > 0) { |
| 1805 |
$permalink = get_permalink($posts_page); |
| 1806 |
|
| 1807 |
if (is_string($permalink) && '' !== $permalink) { |
| 1808 |
$url = $permalink; |
| 1809 |
} |
| 1810 |
} |
| 1811 |
} |
| 1812 |
|
| 1813 |
if (!class_exists('\ThinkRank\Frontend\SEO_Manager')) { |
| 1814 |
return $url; |
| 1815 |
} |
| 1816 |
|
| 1817 |
// A static front page is a singular view, so its page number lives in |
| 1818 |
// `page`, not `paged` — the canonical already reads it that way, and |
| 1819 |
// og:url has to agree or the two describe different URLs. |
| 1820 |
if (function_exists('is_singular') && is_singular()) { |
| 1821 |
return \ThinkRank\Frontend\SEO_Manager::with_singular_page($url); |
| 1822 |
} |
| 1823 |
|
| 1824 |
return \ThinkRank\Frontend\SEO_Manager::with_pagination( |
| 1825 |
$url, |
| 1826 |
\ThinkRank\Frontend\SEO_Manager::current_page_number() |
| 1827 |
); |
| 1828 |
} |
| 1829 |
|
| 1830 |
/** |
| 1831 |
* Get Open Graph image for context with proper fallback |
| 1832 |
* |
| 1833 |
* @since 1.0.0 |
| 1834 |
* |
| 1835 |
* @param array $settings Social meta settings |
| 1836 |
* @param \WP_Post|null $post Optional. Post object for post-specific images |
| 1837 |
* @return string Image URL or empty string |
| 1838 |
*/ |
| 1839 |
private function get_og_image_for_context(array $settings, ?\WP_Post $post = null): string { |
| 1840 |
// For posts, check featured image first |
| 1841 |
if ($post) { |
| 1842 |
$image_id = get_post_thumbnail_id($post); |
| 1843 |
if ($image_id) { |
| 1844 |
$image_data = wp_get_attachment_image_src($image_id, 'large'); |
| 1845 |
if (!empty($image_data[0])) { |
| 1846 |
return $image_data[0]; |
| 1847 |
} |
| 1848 |
} |
| 1849 |
} |
| 1850 |
|
| 1851 |
// Fallback to configured Open Graph image |
| 1852 |
if (!empty($settings['default_og_image'])) { |
| 1853 |
return $settings['default_og_image']; |
| 1854 |
} |
| 1855 |
|
| 1856 |
// Final fallback to generic default image |
| 1857 |
if (!empty($settings['default_image'])) { |
| 1858 |
return $settings['default_image']; |
| 1859 |
} |
| 1860 |
|
| 1861 |
// Last-resort fallback to the site logo / site icon. Resolving it here |
| 1862 |
// (rather than late inside generate_og_tags()) writes it back to the |
| 1863 |
// shared $data['image'], so generate_twitter_tags() and |
| 1864 |
// determine_twitter_card_type() see the same image: twitter:image is |
| 1865 |
// emitted and the card is promoted to summary_large_image, and the |
| 1866 |
// image is routed through optimize_image_for_platform() so |
| 1867 |
// og:image:width/height/type/alt companions are produced. |
| 1868 |
return $this->get_default_social_image(); |
| 1869 |
} |
| 1870 |
|
| 1871 |
/** |
| 1872 |
* Get Twitter image for context with proper fallback |
| 1873 |
* |
| 1874 |
* @since 1.0.0 |
| 1875 |
* |
| 1876 |
* @param array $settings Social meta settings |
| 1877 |
* @param \WP_Post|null $post Optional. Post object for post-specific images |
| 1878 |
* @return string Image URL or empty string |
| 1879 |
*/ |
| 1880 |
private function get_twitter_image_for_context(array $settings, ?\WP_Post $post = null): string { |
| 1881 |
// For posts, check for post-specific Twitter image meta first (if implemented) |
| 1882 |
if ($post) { |
| 1883 |
// Check for post-specific Twitter image meta (future enhancement) |
| 1884 |
$post_twitter_image = get_post_meta($post->ID, '_thinkrank_twitter_image', true); |
| 1885 |
if (!empty($post_twitter_image)) { |
| 1886 |
return $post_twitter_image; |
| 1887 |
} |
| 1888 |
|
| 1889 |
// Check featured image as fallback for posts |
| 1890 |
$image_id = get_post_thumbnail_id($post); |
| 1891 |
if ($image_id) { |
| 1892 |
$image_data = wp_get_attachment_image_src($image_id, 'large'); |
| 1893 |
if (!empty($image_data[0])) { |
| 1894 |
return $image_data[0]; |
| 1895 |
} |
| 1896 |
} |
| 1897 |
} |
| 1898 |
|
| 1899 |
// Prioritize Twitter-specific default image |
| 1900 |
if (!empty($settings['default_twitter_image'])) { |
| 1901 |
return $settings['default_twitter_image']; |
| 1902 |
} |
| 1903 |
|
| 1904 |
// Fallback to Open Graph default image |
| 1905 |
if (!empty($settings['default_og_image'])) { |
| 1906 |
return $settings['default_og_image']; |
| 1907 |
} |
| 1908 |
|
| 1909 |
// Final fallback to generic default image |
| 1910 |
if (!empty($settings['default_image'])) { |
| 1911 |
return $settings['default_image']; |
| 1912 |
} |
| 1913 |
|
| 1914 |
return ''; |
| 1915 |
} |
| 1916 |
|
| 1917 |
/** |
| 1918 |
* Get social media description for post |
| 1919 |
* |
| 1920 |
* @since 1.0.0 |
| 1921 |
* |
| 1922 |
* @param \WP_Post $post Post object |
| 1923 |
* @return string Social media description |
| 1924 |
*/ |
| 1925 |
private function get_social_description(\WP_Post $post): string { |
| 1926 |
// A password-gated body must never become a social description. Core |
| 1927 |
// answers get_the_excerpt() with its "There is no excerpt because this |
| 1928 |
// is a protected post." placeholder rather than the body, so today the |
| 1929 |
// derive-from-content fallback below is unreachable here — but it is one |
| 1930 |
// core change away from leaking, and that placeholder sentence is not a |
| 1931 |
// description worth publishing to every crawler and unfurler either. |
| 1932 |
// An authored post_excerpt is written for public consumption, so it |
| 1933 |
// still stands (#363). |
| 1934 |
if (function_exists('post_password_required') && post_password_required($post)) { |
| 1935 |
return '' !== $post->post_excerpt ? $post->post_excerpt : get_bloginfo('description'); |
| 1936 |
} |
| 1937 |
|
| 1938 |
// Try excerpt first. On a Bricks page core would derive that excerpt |
| 1939 |
// from the `post_content` Bricks throws away, so the visible body is |
| 1940 |
// used instead — a hand-written excerpt still wins (#651). |
| 1941 |
$superseding = Builder_Content::superseding_excerpt_source($post); |
| 1942 |
$description = '' !== $superseding |
| 1943 |
? Pattern_Resolver::derive_excerpt($superseding, 30) |
| 1944 |
: get_the_excerpt($post); |
| 1945 |
|
| 1946 |
// If no excerpt, generate from content. Shortcodes and block delimiters |
| 1947 |
// are removed the way core's wp_trim_excerpt() does, so a shortcode-built |
| 1948 |
// page does not publish its source as og:description (#387). |
| 1949 |
if (empty($description)) { |
| 1950 |
$description = Pattern_Resolver::derive_excerpt(Builder_Content::visible_content($post), 30); |
| 1951 |
} |
| 1952 |
|
| 1953 |
// If still empty, use site description |
| 1954 |
if (empty($description)) { |
| 1955 |
$description = get_bloginfo('description'); |
| 1956 |
} |
| 1957 |
|
| 1958 |
return $description; |
| 1959 |
} |
| 1960 |
|
| 1961 |
/** |
| 1962 |
* Determine Open Graph type based on context |
| 1963 |
* |
| 1964 |
* @since 1.0.0 |
| 1965 |
* |
| 1966 |
* @param string $context Context type |
| 1967 |
* @param array $data Content data |
| 1968 |
* @return string OG type |
| 1969 |
*/ |
| 1970 |
private function determine_og_type(string $context, array $data): string { |
| 1971 |
switch ($context) { |
| 1972 |
case 'post': |
| 1973 |
return 'article'; |
| 1974 |
case 'product': |
| 1975 |
return 'product'; |
| 1976 |
case 'page': |
| 1977 |
case 'site': |
| 1978 |
default: |
| 1979 |
return 'website'; |
| 1980 |
} |
| 1981 |
} |
| 1982 |
|
| 1983 |
/** |
| 1984 |
* Determine Twitter Card type based on content |
| 1985 |
* |
| 1986 |
* @since 1.0.0 |
| 1987 |
* |
| 1988 |
* @param array $data Content data |
| 1989 |
* @param string $context Context type |
| 1990 |
* @return string Twitter Card type |
| 1991 |
*/ |
| 1992 |
private function determine_twitter_card_type(array $data, string $context): string { |
| 1993 |
// An explicitly chosen card type wins. Without this the setting was |
| 1994 |
// inert and the `app` and `player` options in the UI could never be |
| 1995 |
// emitted at all (#398). |
| 1996 |
$chosen = (string) ($data['twitter_card_type'] ?? ''); |
| 1997 |
if ('' !== $chosen) { |
| 1998 |
return $chosen; |
| 1999 |
} |
| 2000 |
|
| 2001 |
// Use a large-image card when a Twitter image will actually be emitted. |
| 2002 |
// twitter:image resolves to the twitter-specific image first, then the OG |
| 2003 |
// image, so key the card type off the same precedence. |
| 2004 |
$twitter_image = !empty($data['twitter_image']) ? $data['twitter_image'] : ($data['image'] ?? ''); |
| 2005 |
return !empty($twitter_image) ? 'summary_large_image' : 'summary'; |
| 2006 |
} |
| 2007 |
|
| 2008 |
/** |
| 2009 |
* What an archive calls itself, for the og:title of last resort. |
| 2010 |
* |
| 2011 |
* Deliberately not wp_get_document_title(): that re-enters the |
| 2012 |
* pre_get_document_title filter this plugin short-circuits, so it would |
| 2013 |
* recurse. get_the_archive_title() wraps its subject in a <span>, hence the |
| 2014 |
* strip. |
| 2015 |
* |
| 2016 |
* @since 2.0.1 |
| 2017 |
* |
| 2018 |
* @return string Archive title, or '' when there is nothing sensible to say. |
| 2019 |
*/ |
| 2020 |
private function archive_fallback_title(): string { |
| 2021 |
if (is_search()) { |
| 2022 |
/* translators: %s: search query. */ |
| 2023 |
return trim(sprintf(__('Search Results for "%s"', 'thinkrank'), get_search_query())); |
| 2024 |
} |
| 2025 |
|
| 2026 |
if (!function_exists('get_the_archive_title')) { |
| 2027 |
return ''; |
| 2028 |
} |
| 2029 |
|
| 2030 |
return trim(wp_strip_all_tags((string) get_the_archive_title())); |
| 2031 |
} |
| 2032 |
|
| 2033 |
/** |
| 2034 |
* What an archive says about itself, for the og:description of last resort. |
| 2035 |
* |
| 2036 |
* @since 2.0.1 |
| 2037 |
* |
| 2038 |
* @param int $term_id Queried term, or 0 when the archive is not a term. |
| 2039 |
* @return string Archive description, or '' when there is none. |
| 2040 |
*/ |
| 2041 |
private function archive_fallback_description(int $term_id): string { |
| 2042 |
if ($term_id > 0) { |
| 2043 |
$description = trim(wp_strip_all_tags((string) term_description($term_id))); |
| 2044 |
|
| 2045 |
if ('' !== $description) { |
| 2046 |
return $description; |
| 2047 |
} |
| 2048 |
} |
| 2049 |
|
| 2050 |
if (is_author()) { |
| 2051 |
$bio = trim(wp_strip_all_tags((string) get_the_author_meta('description', (int) get_query_var('author')))); |
| 2052 |
|
| 2053 |
if ('' !== $bio) { |
| 2054 |
return $bio; |
| 2055 |
} |
| 2056 |
} |
| 2057 |
|
| 2058 |
return ''; |
| 2059 |
} |
| 2060 |
|
| 2061 |
/** |
| 2062 |
* The Open Graph type the user explicitly chose, or '' when they did not. |
| 2063 |
* |
| 2064 |
* `og_type` ships a default of 'website' that is merged into every settings |
| 2065 |
* read, so a stored 'website' cannot be told apart from "never touched" — |
| 2066 |
* the same trap the `og_locale` note above documents. Treating it as unset |
| 2067 |
* keeps determine_og_type() reachable, so a post is still `article`, while |
| 2068 |
* any other stored value is a genuine override and wins. |
| 2069 |
* |
| 2070 |
* @since 2.0.1 |
| 2071 |
* |
| 2072 |
* @param array $settings Social meta settings. |
| 2073 |
* @return string The chosen type, or '' for "derive it". |
| 2074 |
*/ |
| 2075 |
private function configured_og_type(array $settings): string { |
| 2076 |
$type = trim((string) ($settings['og_type'] ?? '')); |
| 2077 |
|
| 2078 |
return ('' === $type || 'website' === $type) ? '' : $type; |
| 2079 |
} |
| 2080 |
|
| 2081 |
/** |
| 2082 |
* The Twitter card type the user explicitly chose, or '' when they did not. |
| 2083 |
* |
| 2084 |
* Same reasoning as configured_og_type(): the shipped default is |
| 2085 |
* 'summary_large_image', which is also what the automatic rule produces |
| 2086 |
* whenever an image is available, so it is treated as "not chosen" and the |
| 2087 |
* automatic rule stays in charge. `summary`, `app` and `player` are real |
| 2088 |
* choices and are honoured. |
| 2089 |
* |
| 2090 |
* @since 2.0.1 |
| 2091 |
* |
| 2092 |
* @param array $settings Social meta settings. |
| 2093 |
* @return string The chosen card type, or '' for "derive it". |
| 2094 |
*/ |
| 2095 |
private function configured_twitter_card_type(array $settings): string { |
| 2096 |
$type = trim((string) ($settings['twitter_card_type'] ?? '')); |
| 2097 |
|
| 2098 |
if (!in_array($type, ['summary', 'app', 'player'], true)) { |
| 2099 |
return ''; |
| 2100 |
} |
| 2101 |
|
| 2102 |
return $type; |
| 2103 |
} |
| 2104 |
|
| 2105 |
/** |
| 2106 |
* Optimize title for platform requirements |
| 2107 |
* |
| 2108 |
* @since 1.0.0 |
| 2109 |
* |
| 2110 |
* @param string $title Original title |
| 2111 |
* @param string $platform Target platform |
| 2112 |
* @return string Optimized title |
| 2113 |
*/ |
| 2114 |
private function optimize_title_for_platform(string $title, string $platform): string { |
| 2115 |
if (empty($title)) { |
| 2116 |
return get_bloginfo('name'); |
| 2117 |
} |
| 2118 |
|
| 2119 |
$max_length = $this->supported_platforms[$platform]['title_max_length'] ?? 60; |
| 2120 |
|
| 2121 |
// Multibyte-safe: byte-based substr() would split characters in |
| 2122 |
// CJK/Bengali/accented titles (WP ships an mbstring fallback). |
| 2123 |
if (mb_strlen($title) <= $max_length) { |
| 2124 |
return $title; |
| 2125 |
} |
| 2126 |
|
| 2127 |
// Truncate at a word boundary where there is one, and hard-cut where |
| 2128 |
// there is not. This used to try wp_trim_words() first, which counts |
| 2129 |
// CHARACTERS on th/ja/zh_* — so it returned ~10 characters, passed the |
| 2130 |
// $max_length check below, and that was accepted as the title (#687). |
| 2131 |
return \ThinkRank\Core\Seo_Text::trim_to_length($title, $max_length); |
| 2132 |
} |
| 2133 |
|
| 2134 |
/** |
| 2135 |
* Optimize description for platform requirements |
| 2136 |
* |
| 2137 |
* @since 1.0.0 |
| 2138 |
* |
| 2139 |
* @param string $description Original description |
| 2140 |
* @param string $platform Target platform |
| 2141 |
* @return string Optimized description |
| 2142 |
*/ |
| 2143 |
private function optimize_description_for_platform(string $description, string $platform): string { |
| 2144 |
if (empty($description)) { |
| 2145 |
return get_bloginfo('description'); |
| 2146 |
} |
| 2147 |
|
| 2148 |
$max_length = $this->supported_platforms[$platform]['description_max_length'] ?? 160; |
| 2149 |
|
| 2150 |
// Multibyte-safe: byte-based substr() would split characters in |
| 2151 |
// CJK/Bengali/accented descriptions (WP ships an mbstring fallback). |
| 2152 |
if (mb_strlen($description) <= $max_length) { |
| 2153 |
return $description; |
| 2154 |
} |
| 2155 |
|
| 2156 |
// Truncate at a word boundary where there is one, and hard-cut where |
| 2157 |
// there is not. This used to try wp_trim_words() first, which counts |
| 2158 |
// words in English but CHARACTERS in th/ja/zh_* — so on those locales |
| 2159 |
// it returned ~25 characters, comfortably under $max_length, and that |
| 2160 |
// was accepted as the answer (#687). |
| 2161 |
return \ThinkRank\Core\Seo_Text::trim_to_length($description, $max_length); |
| 2162 |
} |
| 2163 |
|
| 2164 |
/** |
| 2165 |
* Optimize image for platform requirements |
| 2166 |
* |
| 2167 |
* @since 1.0.0 |
| 2168 |
* |
| 2169 |
* @param string $image_url Image URL |
| 2170 |
* @param string $platform Target platform |
| 2171 |
* @return array Optimized image data |
| 2172 |
*/ |
| 2173 |
private function optimize_image_for_platform(string $image_url, string $platform): array { |
| 2174 |
$image_data = [ |
| 2175 |
'url' => $image_url, |
| 2176 |
'width' => '', |
| 2177 |
'height' => '', |
| 2178 |
'alt' => '', |
| 2179 |
'type' => '', |
| 2180 |
'valid' => false, |
| 2181 |
'warnings' => [] |
| 2182 |
]; |
| 2183 |
|
| 2184 |
if (empty($image_url)) { |
| 2185 |
return $image_data; |
| 2186 |
} |
| 2187 |
|
| 2188 |
// Get image metadata |
| 2189 |
$attachment_id = attachment_url_to_postid($image_url); |
| 2190 |
if ($attachment_id) { |
| 2191 |
$image_meta = wp_get_attachment_metadata($attachment_id); |
| 2192 |
$image_alt = get_post_meta($attachment_id, '_wp_attachment_image_alt', true); |
| 2193 |
$mime_type = get_post_mime_type($attachment_id); |
| 2194 |
|
| 2195 |
if ($image_meta && isset($image_meta['width'], $image_meta['height'])) { |
| 2196 |
$width = (int) $image_meta['width']; |
| 2197 |
$height = (int) $image_meta['height']; |
| 2198 |
|
| 2199 |
$image_data['alt'] = $image_alt ?: ''; |
| 2200 |
$image_data['type'] = $mime_type ?: ''; |
| 2201 |
|
| 2202 |
// SVGs and other vector uploads store 0x0 metadata. Dimension |
| 2203 |
// checks are meaningless there and dividing by 0 is fatal. |
| 2204 |
if ($width > 0 && $height > 0) { |
| 2205 |
$image_data['width'] = $width; |
| 2206 |
$image_data['height'] = $height; |
| 2207 |
|
| 2208 |
// Validate against platform requirements |
| 2209 |
$platform_spec = $this->supported_platforms[$platform] ?? []; |
| 2210 |
$min_width = $platform_spec['image_min_width'] ?? 300; |
| 2211 |
$min_height = $platform_spec['image_min_height'] ?? 200; |
| 2212 |
|
| 2213 |
if ($width >= $min_width && $height >= $min_height) { |
| 2214 |
$image_data['valid'] = true; |
| 2215 |
} else { |
| 2216 |
$image_data['warnings'][] = "Image dimensions ({$width}x{$height}) are below recommended minimum ({$min_width}x{$min_height}) for {$platform}"; |
| 2217 |
} |
| 2218 |
|
| 2219 |
// Check aspect ratio if specified |
| 2220 |
if (isset($platform_spec['image_recommended_ratio'])) { |
| 2221 |
$actual_ratio = $width / $height; |
| 2222 |
$recommended_ratio = $platform_spec['image_recommended_ratio']; |
| 2223 |
$ratio_tolerance = 0.1; |
| 2224 |
|
| 2225 |
if (abs($actual_ratio - $recommended_ratio) > $ratio_tolerance) { |
| 2226 |
$image_data['warnings'][] = sprintf( |
| 2227 |
"Image aspect ratio (%.2f) differs from recommended ratio (%.2f) for %s", |
| 2228 |
$actual_ratio, |
| 2229 |
$recommended_ratio, |
| 2230 |
$platform |
| 2231 |
); |
| 2232 |
} |
| 2233 |
} |
| 2234 |
} |
| 2235 |
} |
| 2236 |
} |
| 2237 |
|
| 2238 |
return $image_data; |
| 2239 |
} |
| 2240 |
|
| 2241 |
/** |
| 2242 |
* Get default social image |
| 2243 |
* |
| 2244 |
* @since 1.0.0 |
| 2245 |
* |
| 2246 |
* @return string Default social image URL |
| 2247 |
*/ |
| 2248 |
private function get_default_social_image(): string { |
| 2249 |
// Try custom logo first |
| 2250 |
$custom_logo_id = get_theme_mod('custom_logo'); |
| 2251 |
if ($custom_logo_id) { |
| 2252 |
$logo_data = wp_get_attachment_image_src($custom_logo_id, 'large'); |
| 2253 |
if ($logo_data) { |
| 2254 |
return $logo_data[0]; |
| 2255 |
} |
| 2256 |
} |
| 2257 |
|
| 2258 |
// Try site icon |
| 2259 |
$site_icon_id = get_option('site_icon'); |
| 2260 |
if ($site_icon_id) { |
| 2261 |
$icon_data = wp_get_attachment_image_src($site_icon_id, 'large'); |
| 2262 |
if ($icon_data) { |
| 2263 |
return $icon_data[0]; |
| 2264 |
} |
| 2265 |
} |
| 2266 |
|
| 2267 |
return ''; |
| 2268 |
} |
| 2269 |
|
| 2270 |
/** |
| 2271 |
* Get Open Graph locale |
| 2272 |
* |
| 2273 |
* @since 1.0.0 |
| 2274 |
* |
| 2275 |
* @return string OG locale |
| 2276 |
*/ |
| 2277 |
private function get_og_locale(): string { |
| 2278 |
/** |
| 2279 |
* Filter the locale used for og:locale. |
| 2280 |
* |
| 2281 |
* Defaults to get_locale(), which only tracks the active language once |
| 2282 |
* that language's translation files are installed — on a multilingual |
| 2283 |
* site without them every translated URL still reports the default |
| 2284 |
* locale. The multilingual integration answers with the locale its |
| 2285 |
* provider reports for the language actually being viewed. |
| 2286 |
* |
| 2287 |
* @since 1.23.0 |
| 2288 |
* |
| 2289 |
* @param string $locale Locale for the current request. |
| 2290 |
*/ |
| 2291 |
$locale = (string) apply_filters('thinkrank_og_locale', get_locale()); |
| 2292 |
|
| 2293 |
// Convert WordPress locale to OG locale format for the few that differ |
| 2294 |
// from the xx_YY form (e.g. bare 'ja'). |
| 2295 |
$og_locale_map = [ |
| 2296 |
'ja' => 'ja_JP', |
| 2297 |
]; |
| 2298 |
|
| 2299 |
if (isset($og_locale_map[$locale])) { |
| 2300 |
return $og_locale_map[$locale]; |
| 2301 |
} |
| 2302 |
|
| 2303 |
// Fall back to the actual site locale (normalized to xx_YY) rather than |
| 2304 |
// mislabeling every unmapped language as en_US. |
| 2305 |
if (preg_match('/^[a-z]{2,3}_[A-Z]{2}$/', $locale)) { |
| 2306 |
return $locale; |
| 2307 |
} |
| 2308 |
|
| 2309 |
// Bare language code (e.g. 'nl') → best-effort xx_XX. |
| 2310 |
if (preg_match('/^([a-z]{2,3})$/', $locale, $m)) { |
| 2311 |
return $m[1] . '_' . strtoupper($m[1]); |
| 2312 |
} |
| 2313 |
|
| 2314 |
return 'en_US'; |
| 2315 |
} |
| 2316 |
|
| 2317 |
/** |
| 2318 |
* Get current URL |
| 2319 |
* |
| 2320 |
* @since 1.0.0 |
| 2321 |
* |
| 2322 |
* @return string Current URL |
| 2323 |
*/ |
| 2324 |
private function get_current_url(): string { |
| 2325 |
if (is_admin()) { |
| 2326 |
return home_url(); |
| 2327 |
} |
| 2328 |
|
| 2329 |
global $wp; |
| 2330 |
return home_url(add_query_arg([], $wp->request)); |
| 2331 |
} |
| 2332 |
|
| 2333 |
/** |
| 2334 |
* Get Twitter site handle |
| 2335 |
* |
| 2336 |
* @since 1.0.0 |
| 2337 |
* |
| 2338 |
* @return string Twitter site handle |
| 2339 |
*/ |
| 2340 |
private function get_twitter_site_handle(): string { |
| 2341 |
$settings = $this->get_settings('site'); |
| 2342 |
$username = $settings['twitter_username'] ?? ''; |
| 2343 |
|
| 2344 |
if (empty($username)) { |
| 2345 |
return ''; |
| 2346 |
} |
| 2347 |
|
| 2348 |
// Ensure username starts with @ for meta tag output |
| 2349 |
return '@' . ltrim($username, '@'); |
| 2350 |
} |
| 2351 |
|
| 2352 |
/** |
| 2353 |
* Get Twitter creator handle |
| 2354 |
* |
| 2355 |
* @since 1.0.0 |
| 2356 |
* |
| 2357 |
* @return string Twitter creator handle |
| 2358 |
*/ |
| 2359 |
private function get_twitter_creator_handle(): string { |
| 2360 |
$settings = $this->get_settings('site'); |
| 2361 |
$creator = $settings['twitter_creator'] ?? ''; |
| 2362 |
|
| 2363 |
if (empty($creator)) { |
| 2364 |
return ''; |
| 2365 |
} |
| 2366 |
|
| 2367 |
// Ensure creator starts with @ for meta tag output |
| 2368 |
return '@' . ltrim($creator, '@'); |
| 2369 |
} |
| 2370 |
|
| 2371 |
/** |
| 2372 |
* Add context-specific Open Graph tags |
| 2373 |
* |
| 2374 |
* @since 1.0.0 |
| 2375 |
* |
| 2376 |
* @param array $og_tags OG tags array |
| 2377 |
* @param string $context Context type |
| 2378 |
* @param array $data Content data |
| 2379 |
* @param string $og_type OG type |
| 2380 |
* @return array Updated OG tags |
| 2381 |
*/ |
| 2382 |
private function add_context_specific_og_tags(array $og_tags, string $context, array $data, string $og_type): array { |
| 2383 |
switch ($og_type) { |
| 2384 |
case 'article': |
| 2385 |
if (!empty($data['author']['name'])) { |
| 2386 |
$og_tags['article:author'] = $data['author']['name']; |
| 2387 |
} |
| 2388 |
if (!empty($data['published_time'])) { |
| 2389 |
$og_tags['article:published_time'] = $data['published_time']; |
| 2390 |
} |
| 2391 |
if (!empty($data['modified_time'])) { |
| 2392 |
$og_tags['article:modified_time'] = $data['modified_time']; |
| 2393 |
} |
| 2394 |
// article:section — the post's primary category (parity with the |
| 2395 |
// basic emitter, which the active path previously omitted). |
| 2396 |
if (!empty($data['post_id'])) { |
| 2397 |
$categories = get_the_category((int) $data['post_id']); |
| 2398 |
if (!empty($categories) && !is_wp_error($categories)) { |
| 2399 |
$og_tags['article:section'] = $categories[0]->name; |
| 2400 |
} |
| 2401 |
} |
| 2402 |
break; |
| 2403 |
case 'product': |
| 2404 |
// Product-specific tags would be added here |
| 2405 |
// This could be extended with price, availability, etc. |
| 2406 |
break; |
| 2407 |
} |
| 2408 |
|
| 2409 |
// Add local business Open Graph tags if business data is available |
| 2410 |
$og_tags = $this->add_local_business_og_tags($og_tags, $data); |
| 2411 |
|
| 2412 |
return $og_tags; |
| 2413 |
} |
| 2414 |
|
| 2415 |
/** |
| 2416 |
* Add local business Open Graph tags |
| 2417 |
* |
| 2418 |
* @since 1.0.0 |
| 2419 |
* |
| 2420 |
* @param array $og_tags OG tags array |
| 2421 |
* @param array $data Content data |
| 2422 |
* @return array Updated OG tags with local business information |
| 2423 |
*/ |
| 2424 |
private function add_local_business_og_tags(array $og_tags, array $data): array { |
| 2425 |
// Get business data from Site Identity settings |
| 2426 |
$business_data = $this->get_local_business_data(); |
| 2427 |
|
| 2428 |
if (empty($business_data) || empty($business_data['business_name'])) { |
| 2429 |
return $og_tags; |
| 2430 |
} |
| 2431 |
|
| 2432 |
// Add business contact data Open Graph tags |
| 2433 |
if (!empty($business_data['business_address'])) { |
| 2434 |
$og_tags['business:contact_data:street_address'] = $business_data['business_address']; |
| 2435 |
} |
| 2436 |
|
| 2437 |
if (!empty($business_data['business_city'])) { |
| 2438 |
$og_tags['business:contact_data:locality'] = $business_data['business_city']; |
| 2439 |
} |
| 2440 |
|
| 2441 |
if (!empty($business_data['business_state'])) { |
| 2442 |
$og_tags['business:contact_data:region'] = $business_data['business_state']; |
| 2443 |
} |
| 2444 |
|
| 2445 |
if (!empty($business_data['business_postal_code'])) { |
| 2446 |
$og_tags['business:contact_data:postal_code'] = $business_data['business_postal_code']; |
| 2447 |
} |
| 2448 |
|
| 2449 |
if (!empty($business_data['business_country'])) { |
| 2450 |
$og_tags['business:contact_data:country_name'] = $business_data['business_country']; |
| 2451 |
} |
| 2452 |
|
| 2453 |
if (!empty($business_data['business_phone'])) { |
| 2454 |
$og_tags['business:contact_data:phone_number'] = $business_data['business_phone']; |
| 2455 |
} |
| 2456 |
|
| 2457 |
if (!empty($business_data['business_email'])) { |
| 2458 |
$og_tags['business:contact_data:email'] = $business_data['business_email']; |
| 2459 |
} |
| 2460 |
|
| 2461 |
// Add business hours if available |
| 2462 |
if (!empty($business_data['business_hours']) && is_array($business_data['business_hours'])) { |
| 2463 |
$formatted_hours = $this->format_business_hours_for_og($business_data['business_hours']); |
| 2464 |
if (!empty($formatted_hours)) { |
| 2465 |
$og_tags['business:hours'] = $formatted_hours; |
| 2466 |
} |
| 2467 |
} |
| 2468 |
|
| 2469 |
// Add business website |
| 2470 |
if (!empty($business_data['business_website'])) { |
| 2471 |
$og_tags['business:contact_data:website'] = $business_data['business_website']; |
| 2472 |
} |
| 2473 |
|
| 2474 |
// Add coordinates if available |
| 2475 |
if (!empty($business_data['business_latitude']) && !empty($business_data['business_longitude'])) { |
| 2476 |
$og_tags['place:location:latitude'] = $business_data['business_latitude']; |
| 2477 |
$og_tags['place:location:longitude'] = $business_data['business_longitude']; |
| 2478 |
} |
| 2479 |
|
| 2480 |
return $og_tags; |
| 2481 |
} |
| 2482 |
|
| 2483 |
/** |
| 2484 |
* Get local business data from Site Identity settings |
| 2485 |
* |
| 2486 |
* @since 1.0.0 |
| 2487 |
* |
| 2488 |
* @return array Business data array |
| 2489 |
*/ |
| 2490 |
private function get_local_business_data(): array { |
| 2491 |
// Try to get Site Identity Manager |
| 2492 |
if (!class_exists('ThinkRank\\SEO\\Site_Identity_Manager')) { |
| 2493 |
require_once THINKRANK_PLUGIN_DIR . 'includes/seo/class-site-identity-manager.php'; |
| 2494 |
} |
| 2495 |
|
| 2496 |
$site_identity_manager = new \ThinkRank\SEO\Site_Identity_Manager(); |
| 2497 |
$settings = $site_identity_manager->get_settings('site'); |
| 2498 |
|
| 2499 |
// Only return data if local SEO is enabled |
| 2500 |
if (empty($settings['local_seo_enabled'])) { |
| 2501 |
return []; |
| 2502 |
} |
| 2503 |
|
| 2504 |
return [ |
| 2505 |
'business_name' => $settings['business_name'] ?? '', |
| 2506 |
'business_address' => $settings['business_address'] ?? '', |
| 2507 |
'business_city' => $settings['business_city'] ?? '', |
| 2508 |
'business_state' => $settings['business_state'] ?? '', |
| 2509 |
'business_postal_code' => $settings['business_postal_code'] ?? '', |
| 2510 |
'business_country' => $settings['business_country'] ?? '', |
| 2511 |
'business_phone' => $settings['business_phone'] ?? '', |
| 2512 |
'business_email' => $settings['business_email'] ?? '', |
| 2513 |
'business_hours' => $settings['business_hours'] ?? [], |
| 2514 |
'business_website' => $settings['business_website'] ?? home_url(), |
| 2515 |
'business_latitude' => $settings['business_latitude'] ?? '', |
| 2516 |
'business_longitude' => $settings['business_longitude'] ?? '' |
| 2517 |
]; |
| 2518 |
} |
| 2519 |
|
| 2520 |
/** |
| 2521 |
* Format business hours for Open Graph tags |
| 2522 |
* |
| 2523 |
* @since 1.0.0 |
| 2524 |
* |
| 2525 |
* @param array $business_hours Business hours array |
| 2526 |
* @return string Formatted hours string |
| 2527 |
*/ |
| 2528 |
private function format_business_hours_for_og(array $business_hours): string { |
| 2529 |
$formatted_days = []; |
| 2530 |
|
| 2531 |
$day_names = [ |
| 2532 |
'monday' => 'Monday', |
| 2533 |
'tuesday' => 'Tuesday', |
| 2534 |
'wednesday' => 'Wednesday', |
| 2535 |
'thursday' => 'Thursday', |
| 2536 |
'friday' => 'Friday', |
| 2537 |
'saturday' => 'Saturday', |
| 2538 |
'sunday' => 'Sunday' |
| 2539 |
]; |
| 2540 |
|
| 2541 |
foreach ($day_names as $day => $display_name) { |
| 2542 |
if (isset($business_hours[$day]) && !empty($business_hours[$day])) { |
| 2543 |
$day_data = $business_hours[$day]; |
| 2544 |
|
| 2545 |
if (!empty($day_data['closed']) || empty($day_data['open']) || empty($day_data['close'])) { |
| 2546 |
$formatted_days[] = $display_name . ': Closed'; |
| 2547 |
} else { |
| 2548 |
$formatted_days[] = $display_name . ': ' . $day_data['open'] . ' - ' . $day_data['close']; |
| 2549 |
} |
| 2550 |
} |
| 2551 |
} |
| 2552 |
|
| 2553 |
return implode('; ', $formatted_days); |
| 2554 |
} |
| 2555 |
|
| 2556 |
/** |
| 2557 |
* Apply platform-specific optimizations |
| 2558 |
* |
| 2559 |
* @since 1.0.0 |
| 2560 |
* |
| 2561 |
* @param array $og_tags OG tags array |
| 2562 |
* @param string $platform Target platform |
| 2563 |
* @param array $data Content data |
| 2564 |
* @return array Optimized OG tags |
| 2565 |
*/ |
| 2566 |
private function apply_platform_specific_optimizations(array $og_tags, string $platform, array $data): array { |
| 2567 |
$settings = $this->get_settings('site'); |
| 2568 |
|
| 2569 |
switch ($platform) { |
| 2570 |
case 'linkedin': |
| 2571 |
// LinkedIn prefers professional content |
| 2572 |
if ($settings['enable_linkedin'] ?? false) { |
| 2573 |
if (isset($og_tags['og:description'])) { |
| 2574 |
$og_tags['og:description'] = $this->make_description_professional($og_tags['og:description']); |
| 2575 |
} |
| 2576 |
// Add LinkedIn-specific type if appropriate |
| 2577 |
if ($og_tags['og:type'] === 'article') { |
| 2578 |
$og_tags['article:author'] = $data['author'] ?? ''; |
| 2579 |
} |
| 2580 |
} |
| 2581 |
break; |
| 2582 |
|
| 2583 |
case 'pinterest': |
| 2584 |
// Pinterest prefers descriptive content |
| 2585 |
if ($settings['enable_pinterest'] ?? false) { |
| 2586 |
if (isset($og_tags['og:description'])) { |
| 2587 |
$og_tags['og:description'] = $this->make_description_descriptive($og_tags['og:description']); |
| 2588 |
} |
| 2589 |
// Pinterest prefers article type for rich pins |
| 2590 |
if (in_array($og_tags['og:type'], ['website', 'blog'], true)) { |
| 2591 |
$og_tags['og:type'] = 'article'; |
| 2592 |
} |
| 2593 |
} |
| 2594 |
break; |
| 2595 |
|
| 2596 |
case 'instagram': |
| 2597 |
// Instagram optimizations |
| 2598 |
if ($settings['enable_instagram'] ?? false) { |
| 2599 |
// Instagram prefers square or vertical images |
| 2600 |
if (isset($og_tags['og:description'])) { |
| 2601 |
$og_tags['og:description'] = $this->make_description_engaging($og_tags['og:description']); |
| 2602 |
} |
| 2603 |
} |
| 2604 |
break; |
| 2605 |
|
| 2606 |
case 'tiktok': |
| 2607 |
// TikTok optimizations |
| 2608 |
if ($settings['enable_tiktok'] ?? false) { |
| 2609 |
// TikTok prefers short, catchy descriptions |
| 2610 |
if (isset($og_tags['og:description'])) { |
| 2611 |
$og_tags['og:description'] = $this->make_description_catchy($og_tags['og:description']); |
| 2612 |
} |
| 2613 |
} |
| 2614 |
break; |
| 2615 |
} |
| 2616 |
|
| 2617 |
return $og_tags; |
| 2618 |
} |
| 2619 |
|
| 2620 |
/** |
| 2621 |
* Make description more professional for LinkedIn |
| 2622 |
* |
| 2623 |
* @since 1.0.0 |
| 2624 |
* |
| 2625 |
* @param string $description Original description |
| 2626 |
* @return string Professional description |
| 2627 |
*/ |
| 2628 |
private function make_description_professional(string $description): string { |
| 2629 |
// Remove casual language and emojis, add professional tone |
| 2630 |
$description = preg_replace('/[^\w\s\.,!?-]/', '', $description); |
| 2631 |
|
| 2632 |
// Add professional keywords if not present |
| 2633 |
$professional_words = ['insights', 'expertise', 'professional', 'industry', 'business']; |
| 2634 |
if (!preg_match('/\b(' . implode('|', $professional_words) . ')\b/i', $description)) { |
| 2635 |
$description = 'Professional insights: ' . $description; |
| 2636 |
} |
| 2637 |
|
| 2638 |
return $description; |
| 2639 |
} |
| 2640 |
|
| 2641 |
/** |
| 2642 |
* Make description more descriptive for Pinterest |
| 2643 |
* |
| 2644 |
* @since 1.0.0 |
| 2645 |
* |
| 2646 |
* @param string $description Original description |
| 2647 |
* @return string Descriptive description |
| 2648 |
*/ |
| 2649 |
private function make_description_descriptive(string $description): string { |
| 2650 |
// Pinterest users love detailed, searchable descriptions |
| 2651 |
$descriptive_words = ['discover', 'explore', 'learn', 'find', 'ideas']; |
| 2652 |
|
| 2653 |
if (!preg_match('/\b(' . implode('|', $descriptive_words) . ')\b/i', $description)) { |
| 2654 |
$description = 'Discover ' . lcfirst($description); |
| 2655 |
} |
| 2656 |
|
| 2657 |
return $description; |
| 2658 |
} |
| 2659 |
|
| 2660 |
/** |
| 2661 |
* Make description engaging for Instagram |
| 2662 |
* |
| 2663 |
* @since 1.0.0 |
| 2664 |
* |
| 2665 |
* @param string $description Original description |
| 2666 |
* @return string Engaging description |
| 2667 |
*/ |
| 2668 |
private function make_description_engaging(string $description): string { |
| 2669 |
// Instagram prefers engaging, visual language |
| 2670 |
$engaging_words = ['amazing', 'stunning', 'beautiful', 'incredible', 'inspiring']; |
| 2671 |
|
| 2672 |
if (!preg_match('/\b(' . implode('|', $engaging_words) . ')\b/i', $description)) { |
| 2673 |
$description = '✨ ' . $description; |
| 2674 |
} |
| 2675 |
|
| 2676 |
return $description; |
| 2677 |
} |
| 2678 |
|
| 2679 |
/** |
| 2680 |
* Make description catchy for TikTok |
| 2681 |
* |
| 2682 |
* @since 1.0.0 |
| 2683 |
* |
| 2684 |
* @param string $description Original description |
| 2685 |
* @return string Catchy description |
| 2686 |
*/ |
| 2687 |
private function make_description_catchy(string $description): string { |
| 2688 |
// TikTok prefers short, catchy descriptions |
| 2689 |
$catchy_words = ['viral', 'trending', 'must-see', 'epic', 'mind-blowing']; |
| 2690 |
|
| 2691 |
// Limit to 100 characters for TikTok. strlen()/substr() count BYTES, |
| 2692 |
// so this both fired three times too early on Thai/CJK text and cut |
| 2693 |
// mid-character, emitting a broken UTF-8 sequence rather than a short |
| 2694 |
// description (#687). |
| 2695 |
$description = \ThinkRank\Core\Seo_Text::trim_to_length($description, 100); |
| 2696 |
|
| 2697 |
if (!preg_match('/\b(' . implode('|', $catchy_words) . ')\b/i', $description)) { |
| 2698 |
$description = '🔥 ' . $description; |
| 2699 |
} |
| 2700 |
|
| 2701 |
return $description; |
| 2702 |
} |
| 2703 |
|
| 2704 |
/** |
| 2705 |
* Add Twitter Card specific tags |
| 2706 |
* |
| 2707 |
* @since 1.0.0 |
| 2708 |
* |
| 2709 |
* @param array $twitter_tags Twitter tags array |
| 2710 |
* @param string $card_type Card type |
| 2711 |
* @param array $data Content data |
| 2712 |
* @param string $context Context type |
| 2713 |
* @return array Updated Twitter tags |
| 2714 |
*/ |
| 2715 |
private function add_twitter_card_specific_tags(array $twitter_tags, string $card_type, array $data, string $context): array { |
| 2716 |
// The content extractor only produces summary / summary_large_image |
| 2717 |
// cards, so the player/app card variants were dead code that read keys |
| 2718 |
// (video_url, app_name, …) the extractor never sets. Kept as a filterable |
| 2719 |
// extension point for add-ons that do populate richer card data. |
| 2720 |
return apply_filters('thinkrank_twitter_card_specific_tags', $twitter_tags, $card_type, $data, $context); |
| 2721 |
} |
| 2722 |
|
| 2723 |
/** |
| 2724 |
* Generate Open Graph preview |
| 2725 |
* |
| 2726 |
* @since 1.0.0 |
| 2727 |
* |
| 2728 |
* @param array $og_tags OG tags |
| 2729 |
* @param string $platform Platform name |
| 2730 |
* @param array $preview Preview array |
| 2731 |
* @return array Updated preview |
| 2732 |
*/ |
| 2733 |
private function generate_og_preview(array $og_tags, string $platform, array $preview): array { |
| 2734 |
$preview['title'] = $og_tags['og:title'] ?? ''; |
| 2735 |
$preview['description'] = $og_tags['og:description'] ?? ''; |
| 2736 |
$preview['image'] = $og_tags['og:image'] ?? ''; |
| 2737 |
$preview['preview_url'] = $og_tags['og:url'] ?? ''; |
| 2738 |
|
| 2739 |
// Validate required fields |
| 2740 |
$required_fields = ['og:title', 'og:type', 'og:image', 'og:url']; |
| 2741 |
$missing_fields = []; |
| 2742 |
|
| 2743 |
foreach ($required_fields as $field) { |
| 2744 |
if (empty($og_tags[$field])) { |
| 2745 |
$missing_fields[] = $field; |
| 2746 |
} |
| 2747 |
} |
| 2748 |
|
| 2749 |
if (empty($missing_fields)) { |
| 2750 |
$preview['valid'] = true; |
| 2751 |
} else { |
| 2752 |
$preview['warnings'][] = 'Missing required fields: ' . implode(', ', $missing_fields); |
| 2753 |
} |
| 2754 |
|
| 2755 |
// Platform-specific validation |
| 2756 |
$platform_spec = $this->supported_platforms[$platform] ?? []; |
| 2757 |
if (isset($platform_spec['title_max_length']) && strlen($preview['title']) > $platform_spec['title_max_length']) { |
| 2758 |
$preview['warnings'][] = "Title exceeds {$platform} maximum length of {$platform_spec['title_max_length']} characters"; |
| 2759 |
} |
| 2760 |
|
| 2761 |
return $preview; |
| 2762 |
} |
| 2763 |
|
| 2764 |
/** |
| 2765 |
* Generate Twitter preview |
| 2766 |
* |
| 2767 |
* @since 1.0.0 |
| 2768 |
* |
| 2769 |
* @param array $twitter_tags Twitter tags |
| 2770 |
* @param array $preview Preview array |
| 2771 |
* @return array Updated preview |
| 2772 |
*/ |
| 2773 |
private function generate_twitter_preview(array $twitter_tags, array $preview): array { |
| 2774 |
$preview['title'] = $twitter_tags['twitter:title'] ?? ''; |
| 2775 |
$preview['description'] = $twitter_tags['twitter:description'] ?? ''; |
| 2776 |
$preview['image'] = $twitter_tags['twitter:image'] ?? ''; |
| 2777 |
|
| 2778 |
// Validate required fields |
| 2779 |
$required_fields = ['twitter:card', 'twitter:title']; |
| 2780 |
$missing_fields = []; |
| 2781 |
|
| 2782 |
foreach ($required_fields as $field) { |
| 2783 |
if (empty($twitter_tags[$field])) { |
| 2784 |
$missing_fields[] = $field; |
| 2785 |
} |
| 2786 |
} |
| 2787 |
|
| 2788 |
if (empty($missing_fields)) { |
| 2789 |
$preview['valid'] = true; |
| 2790 |
} else { |
| 2791 |
$preview['warnings'][] = 'Missing required fields: ' . implode(', ', $missing_fields); |
| 2792 |
} |
| 2793 |
|
| 2794 |
// Twitter-specific validation |
| 2795 |
$twitter_spec = $this->supported_platforms['twitter']; |
| 2796 |
if (strlen($preview['title']) > $twitter_spec['title_max_length']) { |
| 2797 |
$preview['warnings'][] = "Title exceeds Twitter maximum length of {$twitter_spec['title_max_length']} characters"; |
| 2798 |
} |
| 2799 |
|
| 2800 |
return $preview; |
| 2801 |
} |
| 2802 |
|
| 2803 |
/** |
| 2804 |
* Generate Pinterest preview |
| 2805 |
* |
| 2806 |
* @since 1.0.0 |
| 2807 |
* |
| 2808 |
* @param array $og_tags OG tags |
| 2809 |
* @param array $preview Preview array |
| 2810 |
* @return array Updated preview |
| 2811 |
*/ |
| 2812 |
private function generate_pinterest_preview(array $og_tags, array $preview): array { |
| 2813 |
$preview['title'] = $og_tags['og:title'] ?? ''; |
| 2814 |
$preview['description'] = $og_tags['og:description'] ?? ''; |
| 2815 |
$preview['image'] = $og_tags['og:image'] ?? ''; |
| 2816 |
$preview['preview_url'] = $og_tags['og:url'] ?? ''; |
| 2817 |
|
| 2818 |
// Validate required fields for Pinterest |
| 2819 |
$required_fields = ['og:title', 'og:image', 'og:url']; |
| 2820 |
$missing_fields = []; |
| 2821 |
|
| 2822 |
foreach ($required_fields as $field) { |
| 2823 |
if (empty($og_tags[$field])) { |
| 2824 |
$missing_fields[] = $field; |
| 2825 |
} |
| 2826 |
} |
| 2827 |
|
| 2828 |
if (empty($missing_fields)) { |
| 2829 |
$preview['valid'] = true; |
| 2830 |
} else { |
| 2831 |
$preview['warnings'][] = 'Missing required fields: ' . implode(', ', $missing_fields); |
| 2832 |
} |
| 2833 |
|
| 2834 |
// Pinterest-specific validation and suggestions |
| 2835 |
$pinterest_spec = $this->supported_platforms['pinterest'] ?? []; |
| 2836 |
|
| 2837 |
// Title length validation |
| 2838 |
if (isset($pinterest_spec['title_max_length']) && strlen($preview['title']) > $pinterest_spec['title_max_length']) { |
| 2839 |
$preview['warnings'][] = "Title exceeds Pinterest maximum length of {$pinterest_spec['title_max_length']} characters"; |
| 2840 |
} |
| 2841 |
|
| 2842 |
// Description length validation |
| 2843 |
if (isset($pinterest_spec['description_max_length']) && strlen($preview['description']) > $pinterest_spec['description_max_length']) { |
| 2844 |
$preview['warnings'][] = "Description exceeds Pinterest maximum length of {$pinterest_spec['description_max_length']} characters"; |
| 2845 |
} |
| 2846 |
|
| 2847 |
// Image dimension suggestions for Pinterest |
| 2848 |
if (!empty($preview['image'])) { |
| 2849 |
$image_data = $this->optimize_image_for_platform($preview['image'], 'pinterest'); |
| 2850 |
if (!empty($image_data['width']) && !empty($image_data['height'])) { |
| 2851 |
$aspect_ratio = $image_data['width'] / $image_data['height']; |
| 2852 |
|
| 2853 |
// Pinterest prefers vertical images (2:3 ratio is optimal) |
| 2854 |
if ($aspect_ratio > 1) { |
| 2855 |
$preview['suggestions'][] = 'Pinterest performs better with vertical images (2:3 aspect ratio recommended)'; |
| 2856 |
} elseif ($aspect_ratio < 0.6) { |
| 2857 |
$preview['suggestions'][] = 'Image is very tall - consider a 2:3 aspect ratio for optimal Pinterest performance'; |
| 2858 |
} |
| 2859 |
|
| 2860 |
// Minimum size recommendations |
| 2861 |
if ($image_data['width'] < 600) { |
| 2862 |
$preview['suggestions'][] = 'Pinterest recommends images at least 600px wide for better quality'; |
| 2863 |
} |
| 2864 |
} |
| 2865 |
} |
| 2866 |
|
| 2867 |
return $preview; |
| 2868 |
} |
| 2869 |
|
| 2870 |
/** |
| 2871 |
* Generate platform-specific meta tags |
| 2872 |
* |
| 2873 |
* Platform IDs and verification codes are owned by the Social Platforms tab |
| 2874 |
* (ThinkRank\API\Social_Platforms_Endpoint), which stores them in core |
| 2875 |
* Settings (wp_options) with the sensitive codes encrypted at rest. The |
| 2876 |
* social_meta settings table this manager normally reads no longer receives |
| 2877 |
* these values from the UI, so we resolve each key from core Settings first |
| 2878 |
* and fall back to any legacy value still present in the passed-in table |
| 2879 |
* settings — otherwise the verification tags would never render. |
| 2880 |
* |
| 2881 |
* @since 1.0.0 |
| 2882 |
* |
| 2883 |
* @param array $settings Settings array (social_meta table) — legacy fallback. |
| 2884 |
* @return array Platform-specific meta tags |
| 2885 |
*/ |
| 2886 |
private function generate_platform_meta_tags(array $settings): array { |
| 2887 |
$platform_tags = []; |
| 2888 |
|
| 2889 |
$core = \ThinkRank\Core\Settings::instance(); |
| 2890 |
|
| 2891 |
// One query for all seven instead of one query each. They are |
| 2892 |
// autoload=off like every thinkrank_* option, so WordPress cannot |
| 2893 |
// batch them out of `alloptions`, and this runs on every anonymous |
| 2894 |
// front-end request — on most sites to discover that all seven are |
| 2895 |
// empty and no tag is emitted at all (#393). |
| 2896 |
$core->prime(array_keys(self::PLATFORM_META_KEYS)); |
| 2897 |
|
| 2898 |
// Core Settings (decrypted for sensitive keys) wins; the table value is a |
| 2899 |
// backward-compat fallback for installs that saved these before the UI |
| 2900 |
// moved to the Social Platforms tab. |
| 2901 |
$resolve = static function (string $key) use ($core, $settings): string { |
| 2902 |
$value = (string) $core->get($key, ''); |
| 2903 |
if ('' === $value) { |
| 2904 |
$value = (string) ($settings[$key] ?? ''); |
| 2905 |
} |
| 2906 |
return $value; |
| 2907 |
}; |
| 2908 |
|
| 2909 |
foreach (self::PLATFORM_META_KEYS as $key => $meta_name) { |
| 2910 |
$value = $resolve($key); |
| 2911 |
|
| 2912 |
if ('' !== $value) { |
| 2913 |
$platform_tags[$meta_name] = $value; |
| 2914 |
} |
| 2915 |
} |
| 2916 |
|
| 2917 |
return $platform_tags; |
| 2918 |
} |
| 2919 |
|
| 2920 |
/** |
| 2921 |
* Platform verification settings, mapped to the meta name each is emitted |
| 2922 |
* under. One list so the batch primed in generate_platform_meta_tags() and |
| 2923 |
* the keys it then reads cannot drift apart. |
| 2924 |
* |
| 2925 |
* @since 2.1.0 |
| 2926 |
* @var array<string,string> |
| 2927 |
*/ |
| 2928 |
private const PLATFORM_META_KEYS = [ |
| 2929 |
'facebook_app_id' => 'fb:app_id', |
| 2930 |
'facebook_admins' => 'fb:admins', |
| 2931 |
'pinterest_site_verification' => 'pinterest-site-verification', |
| 2932 |
'instagram_verification' => 'instagram-site-verification', |
| 2933 |
'tiktok_verification' => 'tiktok-site-verification', |
| 2934 |
'youtube_channel_id' => 'youtube-channel-id', |
| 2935 |
'whatsapp_business_id' => 'whatsapp-business-id', |
| 2936 |
]; |
| 2937 |
|
| 2938 |
/** |
| 2939 |
* Convert OG, Twitter, and Platform tags to HTML meta tags |
| 2940 |
* |
| 2941 |
* @since 1.0.0 |
| 2942 |
* |
| 2943 |
* @param array $og_tags Open Graph tags |
| 2944 |
* @param array $twitter_tags Twitter tags |
| 2945 |
* @param array $platform_tags Platform-specific tags |
| 2946 |
* @return array HTML meta tags |
| 2947 |
*/ |
| 2948 |
private function convert_to_meta_tags(array $og_tags, array $twitter_tags, array $platform_tags = []): array { |
| 2949 |
$meta_tags = []; |
| 2950 |
|
| 2951 |
// Convert OG tags |
| 2952 |
foreach ($og_tags as $property => $content) { |
| 2953 |
if (!empty($content)) { |
| 2954 |
$meta_tags[] = [ |
| 2955 |
'property' => esc_attr($property), |
| 2956 |
'content' => esc_attr($content) |
| 2957 |
]; |
| 2958 |
} |
| 2959 |
} |
| 2960 |
|
| 2961 |
// Convert Twitter tags |
| 2962 |
foreach ($twitter_tags as $name => $content) { |
| 2963 |
if (!empty($content)) { |
| 2964 |
$meta_tags[] = [ |
| 2965 |
'name' => esc_attr($name), |
| 2966 |
'content' => esc_attr($content) |
| 2967 |
]; |
| 2968 |
} |
| 2969 |
} |
| 2970 |
|
| 2971 |
// Convert Platform tags |
| 2972 |
foreach ($platform_tags as $name => $content) { |
| 2973 |
if (!empty($content)) { |
| 2974 |
// Determine if it should be property or name attribute |
| 2975 |
if (strpos($name, 'fb:') === 0) { |
| 2976 |
// Facebook tags use property attribute |
| 2977 |
$meta_tags[] = [ |
| 2978 |
'property' => esc_attr($name), |
| 2979 |
'content' => esc_attr($content) |
| 2980 |
]; |
| 2981 |
} else { |
| 2982 |
// Other platform tags use name attribute |
| 2983 |
$meta_tags[] = [ |
| 2984 |
'name' => esc_attr($name), |
| 2985 |
'content' => esc_attr($content) |
| 2986 |
]; |
| 2987 |
} |
| 2988 |
} |
| 2989 |
} |
| 2990 |
|
| 2991 |
return $meta_tags; |
| 2992 |
} |
| 2993 |
|
| 2994 |
/** |
| 2995 |
* Validate social image |
| 2996 |
* |
| 2997 |
* @since 1.0.0 |
| 2998 |
* |
| 2999 |
* @param string $image_url Image URL to validate |
| 3000 |
* @return array Validation results |
| 3001 |
*/ |
| 3002 |
private function validate_social_image(string $image_url): array { |
| 3003 |
$validation = [ |
| 3004 |
'valid' => false, |
| 3005 |
'warnings' => [], |
| 3006 |
'suggestions' => [] |
| 3007 |
]; |
| 3008 |
|
| 3009 |
if (empty($image_url)) { |
| 3010 |
$validation['warnings'][] = 'No image provided'; |
| 3011 |
return $validation; |
| 3012 |
} |
| 3013 |
|
| 3014 |
// Check if URL is valid |
| 3015 |
if (!filter_var($image_url, FILTER_VALIDATE_URL)) { |
| 3016 |
$validation['warnings'][] = 'Invalid image URL'; |
| 3017 |
return $validation; |
| 3018 |
} |
| 3019 |
|
| 3020 |
// Get image metadata if it's a local attachment |
| 3021 |
$attachment_id = attachment_url_to_postid($image_url); |
| 3022 |
if ($attachment_id) { |
| 3023 |
$image_meta = wp_get_attachment_metadata($attachment_id); |
| 3024 |
$meta_width = isset($image_meta['width']) ? (int) $image_meta['width'] : 0; |
| 3025 |
$meta_height = isset($image_meta['height']) ? (int) $image_meta['height'] : 0; |
| 3026 |
|
| 3027 |
// SVGs and other vector uploads store 0x0 metadata — skip the |
| 3028 |
// dimension/ratio checks instead of dividing by 0. |
| 3029 |
if ($image_meta && $meta_width > 0 && $meta_height > 0) { |
| 3030 |
// Check minimum dimensions for major platforms |
| 3031 |
$min_width = 600; // Facebook minimum |
| 3032 |
$min_height = 315; // Facebook minimum |
| 3033 |
|
| 3034 |
if ($meta_width >= $min_width && $meta_height >= $min_height) { |
| 3035 |
$validation['valid'] = true; |
| 3036 |
} else { |
| 3037 |
$validation['warnings'][] = "Image dimensions ({$meta_width}x{$meta_height}) are below recommended minimum ({$min_width}x{$min_height})"; |
| 3038 |
} |
| 3039 |
|
| 3040 |
// Check file size |
| 3041 |
$file_path = get_attached_file($attachment_id); |
| 3042 |
if ($file_path && file_exists($file_path)) { |
| 3043 |
$file_size = filesize($file_path); |
| 3044 |
$max_size = 5 * 1024 * 1024; // 5MB |
| 3045 |
|
| 3046 |
if ($file_size > $max_size) { |
| 3047 |
$validation['warnings'][] = 'Image file size exceeds 5MB, may not display on some platforms'; |
| 3048 |
} |
| 3049 |
} |
| 3050 |
|
| 3051 |
// Check aspect ratio |
| 3052 |
$aspect_ratio = $meta_width / $meta_height; |
| 3053 |
if ($aspect_ratio < 1.5 || $aspect_ratio > 2.5) { |
| 3054 |
$validation['suggestions'][] = 'Consider using an image with 1.91:1 aspect ratio for optimal display'; |
| 3055 |
} |
| 3056 |
} |
| 3057 |
} else { |
| 3058 |
$validation['suggestions'][] = 'External images may not be optimized for social media platforms'; |
| 3059 |
} |
| 3060 |
|
| 3061 |
return $validation; |
| 3062 |
} |
| 3063 |
} |
| 3064 |
|
