ranger
cba0df9439
Rebrand to RangerHQ Buddy and prepare for the WordPress.org Plugin Directory. Same workflow as rangerhq-radio v0.7.0 → v0.7.5. Changes: - Plugin Name: Buddy → RangerHQ Buddy (matches family naming) - Plugin URI: icanhelp.ie/buddy → davidtkeane.com/rangerhq-buddy - Author URI: rangersmyth.xyz → davidtkeane.com - Text Domain: buddy → rangerhq-buddy (62 occurrences across 8 PHP files) - Add LICENSE file (full GPL v2 text from gnu.org) - Add wp.org-format readme.txt with all 8 required headers - Remove inc/updater.php (self-hosted Gitea updater forbidden for wp.org-hosted plugins per the rangerhq-radio v0.7.3 walkback) - Replace mt_rand with wp_rand in inc/state.php for better RNG - Add 5 translator comments for printf-style i18n placeholders - Wrap 2 dashboard-widget.php printf placeholders in (int) casts - Add tests/ to .gitignore (PCP reports are local-only) PCP audit: 85 issues → ~1 (the .gitignore file itself, stripped from the submission zip). Plugin Check Namer Tool: "Generally Allowable" verdict on both name and slug. Plugin URI https://davidtkeane.com/rangerhq-buddy/ returns HTTP 200. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
121 lines
4.3 KiB
PHP
121 lines
4.3 KiB
PHP
<?php
|
|
/**
|
|
* Buddy — a friendly pet for your WordPress dashboard
|
|
*
|
|
* Plugin Name: RangerHQ Buddy
|
|
* Plugin URI: https://davidtkeane.com/rangerhq-buddy
|
|
* Description: Adopt a small companion that lives in your WordPress dashboard. Its mood reflects your site's health — published posts feed it, outdated plugins make it sick, clearing spam makes it happy. Gamifies WordPress maintenance with a bit of charm.
|
|
* Version: 0.1.3
|
|
* Requires at least: 5.0
|
|
* Requires PHP: 7.4
|
|
* Author: David Keane
|
|
* Author URI: https://davidtkeane.com
|
|
* License: GPL v2 or later
|
|
* License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
|
* Text Domain: rangerhq-buddy
|
|
*
|
|
* @package Buddy
|
|
*/
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) { exit; }
|
|
|
|
// Plugin coordinates.
|
|
if ( ! defined( 'BUDDY_VERSION' ) ) { define( 'BUDDY_VERSION', '0.1.3' ); }
|
|
if ( ! defined( 'BUDDY_FILE' ) ) { define( 'BUDDY_FILE', __FILE__ ); }
|
|
if ( ! defined( 'BUDDY_PATH' ) ) { define( 'BUDDY_PATH', plugin_dir_path( __FILE__ ) ); }
|
|
if ( ! defined( 'BUDDY_URL' ) ) { define( 'BUDDY_URL', plugin_dir_url( __FILE__ ) ); }
|
|
if ( ! defined( 'BUDDY_BASENAME' ) ) { define( 'BUDDY_BASENAME', plugin_basename( __FILE__ ) ); }
|
|
|
|
// Includes — each file owns one concern.
|
|
require_once BUDDY_PATH . 'inc/state.php'; // user_meta storage + stat helpers
|
|
require_once BUDDY_PATH . 'inc/sprite.php'; // inline-SVG character renderer
|
|
require_once BUDDY_PATH . 'inc/dashboard-widget.php'; // the pet on WP Dashboard
|
|
require_once BUDDY_PATH . 'inc/admin-page.php'; // dedicated Buddy admin page
|
|
require_once BUDDY_PATH . 'inc/about.php'; // About page
|
|
require_once BUDDY_PATH . 'inc/settings.php'; // Settings page
|
|
|
|
/**
|
|
* Admin menu registration. Buddy gets its own top-level menu — the pet
|
|
* is a discrete enough thing to deserve a sidebar entry rather than
|
|
* being buried under Tools or Settings. Icon is dashicons-pets for the
|
|
* literal-match-to-purpose vibe (paw print).
|
|
*/
|
|
add_action( 'admin_menu', 'buddy_register_admin_menu' );
|
|
function buddy_register_admin_menu() {
|
|
add_menu_page(
|
|
__( 'Buddy', 'rangerhq-buddy' ),
|
|
__( 'Buddy', 'rangerhq-buddy' ),
|
|
'read', // any logged-in user with read access can see their own pet
|
|
'buddy',
|
|
'buddy_render_main_page',
|
|
'dashicons-pets',
|
|
72 // sits below Comments, above plugin entries
|
|
);
|
|
|
|
// "My Buddy" — main landing submenu. Same slug as parent so clicking
|
|
// either entry lands on the same page. Empty callback so only the
|
|
// parent's renderer fires (lesson learned from Logbook's duplicate-
|
|
// form bug).
|
|
add_submenu_page(
|
|
'buddy',
|
|
__( 'My Buddy', 'rangerhq-buddy' ),
|
|
__( 'My Buddy', 'rangerhq-buddy' ),
|
|
'read',
|
|
'buddy',
|
|
''
|
|
);
|
|
|
|
add_submenu_page(
|
|
'buddy',
|
|
__( 'Settings', 'rangerhq-buddy' ),
|
|
__( 'Settings', 'rangerhq-buddy' ),
|
|
'manage_options',
|
|
'buddy-settings',
|
|
'buddy_render_settings_page'
|
|
);
|
|
|
|
add_submenu_page(
|
|
'buddy',
|
|
__( 'About', 'rangerhq-buddy' ),
|
|
__( 'About', 'rangerhq-buddy' ),
|
|
'read',
|
|
'buddy-about',
|
|
'buddy_render_about_page'
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Enqueue Buddy's CSS + JS on its own admin pages and on the main
|
|
* dashboard (where the widget lives).
|
|
*/
|
|
add_action( 'admin_enqueue_scripts', 'buddy_enqueue_admin_assets' );
|
|
function buddy_enqueue_admin_assets( $hook ) {
|
|
$buddy_hooks = array(
|
|
'index.php', // WP Dashboard (the widget lives here)
|
|
'toplevel_page_buddy', // Buddy main page
|
|
'buddy_page_buddy-settings', // Settings
|
|
'buddy_page_buddy-about', // About
|
|
);
|
|
if ( ! in_array( $hook, $buddy_hooks, true ) ) { return; }
|
|
|
|
wp_enqueue_style(
|
|
'buddy-admin',
|
|
BUDDY_URL . 'assets/css/buddy.css',
|
|
array(),
|
|
BUDDY_VERSION
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Activation hook: ensure the version option is set so the updater can
|
|
* track it.
|
|
*/
|
|
register_activation_hook( __FILE__, 'buddy_on_activate' );
|
|
function buddy_on_activate() {
|
|
if ( false === get_option( 'buddy_version' ) ) {
|
|
add_option( 'buddy_version', BUDDY_VERSION );
|
|
} else {
|
|
update_option( 'buddy_version', BUDDY_VERSION );
|
|
}
|
|
}
|