Files
Bookshelf/umbra-bookshelf/includes/books/class-umbra-seo.php
bdm dec732931c Consolidate three plugins into Umbra Bookshelf
Merge BD Bookshelf (0.1.0), BD BookShelfHelper (2.0.0) and BD SimpleEmail
(2.0.0) into a single plugin released as Umbra Bookshelf 1.0.0, with the
BD Bookshelf theme left as a separate, unrenamed artifact.

Modules
  includes/books/    catalogue, ISBN/ASIN, series, retail, ratings, shortcodes,
                     SEO, GDPR, scrapers, admin, CSV/post import
  includes/library/  book post type + series taxonomy, pen names, data entry,
                     shortlinks, reviews, migrate
  includes/email/    subscribers, newsletters, composition, sending

Renamed: plugin headers, text domains (all three -> umbra-bookshelf), classes
(BD_*/BDM_* -> Umbra_*), constants (-> UMBRA_BOOKSHELF_*), asset handles, JS
globals and admin slugs.

Deliberately not renamed -- persisted contract with live installs and with
published post content: table names, option keys, post meta keys, transients,
nonce actions, cron hooks, AJAX actions, shortcodes ([bd-book], [bd-books],
[bdm_signup]), post type `book`, taxonomy `series`, cookies and CSS classes.
BD_BookShelfHelper survives only as a class_alias for the unmodified theme.

Collisions resolved
  * class-umbra-theme-compatibility.php declared BD_BookShelfHelper, the same
    name as the library module's helper. Latent while the plugins were
    separate (only fired when both were active), but an unconditional fatal
    once merged. Renamed to Umbra_Theme_Compatibility with a class_alias.
  * All three modules called add_menu_page. One top-level menu is now
    registered by the bootstrap at admin_menu priority 9.
  * BD Bookshelf and BookShelfHelper both claimed bd-bookshelf-settings, leaving
    one Settings screen unreachable -> umbra-bookshelf-settings and
    umbra-bookshelf-library-settings.
  * Catalogue and library both enqueued bd-bookshelf-admin; the second enqueue
    was silently discarded -> unique handles per module.
  * Umbra_Admin and Umbra_Migration both registered bd_bookshelf_import_csv, so
    one handler silently replaced the other. The import page now lives only in
    Umbra_Admin (the variant wired to the admin JS); Umbra_Migration keeps only
    the preview/run endpoints it uniquely provides.
  * Modules were constructed from an init callback, so their own init
    registrations raced the hook being dispatched. Now constructed on
    plugins_loaded behind a re-entrancy guard.

Also
  * Missing assets created: assets/images/default-cover.png (referenced but
    never committed, so every cover-less book 404'd) and email/assets/js/
    admin.js (enqueued on every email admin page but never committed).
  * Library module's strpos($hook, 'bd-bookshelf') asset check matched every
    catalogue and email screen once slugs shared the umbra-bookshelf- prefix;
    now matched against its own slug list.
  * Consolidated uninstall deduplicates the double drop of bd_books/bd_series.
  * Specs aligned to the new name; pre-merge specs retained under
    spec/archive/ with provenance notes.
  * Tests added: tests/verify_structure.py (static) and tests/smoke_runtime.php
    (WordPress-stub runtime boot, front-end and admin contexts).

Deferred and recorded in docs/KNOWN-ISSUES.md: the catalogue and library
modules still create bd_books and bd_series with two incompatible schemas
(pre-existing, now unconditional), and Goodreads/Amazon scraping is still
implemented twice on shared cron hooks.
2026-10-18 19:55:36 -07:00

227 lines
6.6 KiB
PHP

<?php
// Copyright 2026 Umbra Tools (umbratools.com)
// SPDX-License-Identifier: Apache-2.0
/**
* SEO Metadata Manager class
*
* @package Umbra_Bookshelf
*/
if (!defined('ABSPATH')) {
exit;
}
class Umbra_SEO {
/**
* Constructor
*/
public function __construct() {
add_action('wp_head', [$this, 'output_meta_tags'], 1);
add_action('wp_head', [$this, 'output_open_graph'], 2);
add_action('wp_head', [$this, 'output_twitter_cards'], 3);
// Add sitemap entries
add_filter('wp_sitemaps_posts_entry', [$this, 'filter_sitemap_entry'], 10, 2);
}
/**
* Get book SEO data
*/
public static function get_book_seo($book_id) {
global $wpdb;
$table = Umbra_Database::table('book_seo');
$seo = $wpdb->get_row(
$wpdb->prepare(
"SELECT * FROM {$table} WHERE book_id = %d",
$book_id
)
);
return $seo;
}
/**
* Update book SEO data
*/
public static function update_book_seo($book_id, $data) {
global $wpdb;
$table = Umbra_Database::table('book_seo');
$existing = self::get_book_seo($book_id);
$update_data = [
'book_id' => absint($book_id),
'seo_title' => sanitize_text_field($data['seo_title'] ?? ''),
'seo_description' => wp_kses_post($data['seo_description'] ?? ''),
'seo_keywords' => sanitize_text_field($data['seo_keywords'] ?? ''),
'og_title' => sanitize_text_field($data['og_title'] ?? ''),
'og_description' => wp_kses_post($data['og_description'] ?? ''),
'og_image' => esc_url_raw($data['og_image'] ?? ''),
];
if ($existing) {
$result = $wpdb->update(
$table,
$update_data,
['book_id' => $book_id],
null,
['%d']
);
} else {
$result = $wpdb->insert($table, $update_data);
}
return $result !== false;
}
/**
* Delete book SEO data
*/
public static function delete_book_seo($book_id) {
global $wpdb;
$table = Umbra_Database::table('book_seo');
return $wpdb->delete($table, ['book_id' => $book_id], ['%d']) !== false;
}
/**
* Output meta tags
*/
public function output_meta_tags() {
if (!is_singular()) {
return;
}
$post_id = get_queried_object_id();
$book_id = $this->get_book_id_for_post($post_id);
if (!$book_id) {
return;
}
$seo = self::get_book_seo($book_id);
if (!$seo) {
return;
}
if (!empty($seo->seo_title)) {
echo '<meta name="title" content="' . esc_attr($seo->seo_title) . '">' . "\n";
}
if (!empty($seo->seo_description)) {
echo '<meta name="description" content="' . esc_attr($seo->seo_description) . '">' . "\n";
}
if (!empty($seo->seo_keywords)) {
echo '<meta name="keywords" content="' . esc_attr($seo->seo_keywords) . '">' . "\n";
}
}
/**
* Output Open Graph tags
*/
public function output_open_graph() {
if (!is_singular()) {
return;
}
$post_id = get_queried_object_id();
$book_id = $this->get_book_id_for_post($post_id);
if (!$book_id) {
return;
}
$seo = self::get_book_seo($book_id);
$book = Umbra_Book_Manager::get_book($book_id);
if (!$book) {
return;
}
$og_title = !empty($seo->og_title) ? $seo->og_title : get_the_title($post_id);
$og_description = !empty($seo->og_description) ? $seo->og_description : wp_trim_words(get_the_excerpt($post_id), 30);
$og_image = !empty($seo->og_image) ? $seo->og_image : get_the_post_thumbnail_url($post_id, 'large');
echo '<meta property="og:type" content="book">' . "\n";
echo '<meta property="og:title" content="' . esc_attr($og_title) . '">' . "\n";
echo '<meta property="og:description" content="' . esc_attr($og_description) . '">' . "\n";
echo '<meta property="og:url" content="' . esc_url(get_permalink($post_id)) . '">' . "\n";
if ($og_image) {
echo '<meta property="og:image" content="' . esc_url($og_image) . '">' . "\n";
}
}
/**
* Output Twitter Card tags
*/
public function output_twitter_cards() {
if (!is_singular()) {
return;
}
$post_id = get_queried_object_id();
$book_id = $this->get_book_id_for_post($post_id);
if (!$book_id) {
return;
}
$seo = self::get_book_seo($book_id);
$twitter_title = !empty($seo->og_title) ? $seo->og_title : get_the_title($post_id);
$twitter_description = !empty($seo->og_description) ? $seo->og_description : wp_trim_words(get_the_excerpt($post_id), 30);
$twitter_image = !empty($seo->og_image) ? $seo->og_image : get_the_post_thumbnail_url($post_id, 'large');
echo '<meta name="twitter:card" content="summary_large_image">' . "\n";
echo '<meta name="twitter:title" content="' . esc_attr($twitter_title) . '">' . "\n";
echo '<meta name="twitter:description" content="' . esc_attr($twitter_description) . '">' . "\n";
if ($twitter_image) {
echo '<meta name="twitter:image" content="' . esc_url($twitter_image) . '">' . "\n";
}
}
/**
* Get book ID for a WordPress post
*/
private function get_book_id_for_post($post_id) {
// Check if there's a book ID stored in post meta
return get_post_meta($post_id, '_bd_bookshelf_book_id', true);
}
/**
* Filter sitemap entry for book posts
*/
public function filter_sitemap_entry($entry, $post) {
$book_id = $this->get_book_id_for_post($post->ID);
if (!$book_id) {
return $entry;
}
$book = Umbra_Book_Manager::get_book($book_id);
if (!$book) {
return $entry;
}
// Higher rating = higher priority
$rating = max($book->rating_amazon, $book->rating_goodreads);
$priority = 0.5 + ($rating / 10); // 0.5 to 1.0 based on rating
$entry['loc'] = get_permalink($post->ID);
$entry['lastmod'] = get_the_modified_date('c', $post);
$entry['changefreq'] = 'monthly';
$entry['priority'] = round($priority, 1);
return $entry;
}
}