ranger/rangerhq-radio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(0.7.0): WordPress.org submission prep — full Plugin Check clean

Browse Source 
Ran the official Plugin Check (PCP) against v0.6.3 — surfaced 169
issues. This release closes all of them so the plugin is submission-
ready for the WordPress.org plugin directory.

Branding
  - Plugin Name renamed: "Radio" → "RangerHQ Radio". Removes the
    trademarked "SomaFM" from the plugin name surface (PCP
    trademarked_term). Lines up with the RangerHQ plugin family.
    SomaFM credited in Description + About as the data source.
    Folder/slug stays `a-radio` — no install path changes; existing
    user_meta keys (radio_state / radio_history / radio_favourites)
    untouched.
  - Text Domain header renamed: `radio` → `a-radio` (matches slug).
  - Requires at least bumped: 5.0 → 5.3 (matches wp_date() usage).
  - File docstring header dropped "SomaFM" from prominent line.

Code (mass-mechanical)
  - 134 i18n call sites rewritten from `'radio'` text domain to
    `'a-radio'` across 7 PHP files. Single sed pass on the unique
    pattern `, 'radio' )` — the 6 menu-slug `'radio'` references in
    add_*_page() were correctly left alone (those are URL slugs).

Security
  - 8 × MissingUnslash + 8 × InputNotSanitized in the v0.5.0 history
    endpoints (radio_ajax_log_track, radio_ajax_toggle_favourite).
    All four $_POST['artist|title|station|station_id'] access points
    are now wrapped sanitize_text_field( wp_unslash( $_POST['…'] ) )
    (or sanitize_key for station_id) at the access point.

Translator comments
  - 6 × printf / sprintf calls with placeholders now carry
    /* translators: ... */ comments.

Pop-out window refactor
  - Inline <link> stylesheets, <style> block, and <script> tag in
    radio_render_popout_page() replaced with wp_enqueue_style() +
    wp_enqueue_script() + wp_localize_script() registered before HTML
    output, then wp_print_styles() in <head> and wp_print_footer_
    scripts() at end of <body>.
  - Popup-specific CSS moved out of inline <style> and into radio.css
    under body.radio-popout scope so it only fires inside the popup.

Removed
  - .DS_Store files (root + assets/). PCP hidden_files.

Distribution
  - New readme.txt in proper WordPress.org format: Plugin headers,
    Contributors, Donate link, Tags, Requires-at-least, Tested-up-to,
    Stable Tag, Requires-PHP, License, Description, Installation,
    FAQ, Screenshots, Changelog, Upgrade Notice.

Compat
  - No behaviour change for users; user_meta preserved.
  - Displayed Plugin Name in Plugins → Installed changes from "Radio"
    to "RangerHQ Radio" — only visible difference on update.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
David Keane
2026-05-30 02:51:09 +01:00
parent 224fccd6c4
commit 09b61cc950
10 changed files with 352 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files
radio.php
+76 -80
View File
@@ -1,26 +1,26 @@
<?php
/**
* Radio — a free SomaFM player for your WordPress dashboard
* RangerHQ Radio — a small, focused internet radio player for your WP dashboard.
*
* Plugin Name: Radio
* Plugin Name: RangerHQ Radio
* Plugin URI: https://icanhelp.ie/radio
* Description: A small, focused, free radio player for your WordPress admin. 44 SomaFM stations grouped by 10 genres — ambient, electronic, lounge, rock, metal, jazz, world, reggae, holiday, specials. Plays via HTML5 audio; volume + station choice persist per-user.
* Version: 0.6.3
* Requires at least: 5.0
* Description: A small, focused internet radio player for your WordPress admin. 44 hand-curated stations from SomaFM across 10 genres — ambient, electronic, lounge, rock, metal, jazz, world, reggae, holiday, specials. Plays via HTML5 audio; per-user station + volume + history + favourites; pop-out window for continuous background play.
* Version: 0.7.0
* Requires at least: 5.3
* Requires PHP: 7.4
* Author: David Keane
* Author URI: https://rangersmyth.xyz/
* License: GPL v2 or later
* License URI: https://www.gnu.org/licenses/gpl-2.0.html
* Text Domain: radio
* Text Domain: a-radio
*
* @package Radio
* @package RangerHQ_Radio
*/
if ( ! defined( 'ABSPATH' ) ) { exit; }
// Plugin coordinates.
if ( ! defined( 'RADIO_VERSION' ) ) { define( 'RADIO_VERSION', '0.6.3' ); }
if ( ! defined( 'RADIO_VERSION' ) ) { define( 'RADIO_VERSION', '0.7.0' ); }
if ( ! defined( 'RADIO_FILE' ) ) { define( 'RADIO_FILE', __FILE__ ); }
if ( ! defined( 'RADIO_PATH' ) ) { define( 'RADIO_PATH', plugin_dir_path( __FILE__ ) ); }
if ( ! defined( 'RADIO_URL' ) ) { define( 'RADIO_URL', plugin_dir_url( __FILE__ ) ); }
@@ -46,8 +46,8 @@ require_once RADIO_PATH . 'inc/updater.php'; // self-hosted update chec
add_action( 'admin_menu', 'radio_register_admin_menu' );
function radio_register_admin_menu() {
add_menu_page(
__( 'Radio', 'radio' ),
__( 'Radio', 'radio' ),
__( 'Radio', 'a-radio' ),
__( 'Radio', 'a-radio' ),
'read', // any logged-in user with read access has their own radio
'radio',
'radio_render_main_page',
@@ -61,8 +61,8 @@ function radio_register_admin_menu() {
// form gotcha).
add_submenu_page(
'radio',
__( 'My Radio', 'radio' ),
__( 'My Radio', 'radio' ),
__( 'My Radio', 'a-radio' ),
__( 'My Radio', 'a-radio' ),
'read',
'radio',
''
@@ -70,8 +70,8 @@ function radio_register_admin_menu() {
add_submenu_page(
'radio',
__( 'Settings', 'radio' ),
__( 'Settings', 'radio' ),
__( 'Settings', 'a-radio' ),
__( 'Settings', 'a-radio' ),
'manage_options',
'radio-settings',
'radio_render_settings_page'
@@ -79,8 +79,8 @@ function radio_register_admin_menu() {
add_submenu_page(
'radio',
__( 'Track history', 'radio' ),
__( 'History', 'radio' ),
__( 'Track history', 'a-radio' ),
__( 'History', 'a-radio' ),
'read',
'radio-history',
'radio_render_history_page'
@@ -88,8 +88,8 @@ function radio_register_admin_menu() {
add_submenu_page(
'radio',
__( 'About', 'radio' ),
__( 'About', 'radio' ),
__( 'About', 'a-radio' ),
__( 'About', 'a-radio' ),
'read',
'radio-about',
'radio_render_about_page'
@@ -134,19 +134,19 @@ function radio_enqueue_admin_assets( $hook ) {
'nonce' => wp_create_nonce( 'radio_save_state' ),
'popoutUrl' => admin_url( 'admin-post.php?action=radio_popout' ),
'strings' => array(
'play' => __( 'Play', 'radio' ),
'pause' => __( 'Pause', 'radio' ),
'loading' => __( 'Loading…', 'radio' ),
'error' => __( 'Stream error — try another station.', 'radio' ),
'saveError' => __( 'Preferences not saved — check your connection.', 'radio' ),
'mute' => __( 'Mute', 'radio' ),
'unmute' => __( 'Unmute', 'radio' ),
'nowPlaying' => __( 'Now Playing', 'radio' ),
'volume' => __( 'Volume', 'radio' ),
'station' => __( 'Station', 'radio' ),
'addFav' => __( 'Add to favourites', 'radio' ),
'removeFav' => __( 'Remove from favourites', 'radio' ),
'clearConfirm' => __( 'Clear all track history? (Favourites are kept.)', 'radio' ),
'play' => __( 'Play', 'a-radio' ),
'pause' => __( 'Pause', 'a-radio' ),
'loading' => __( 'Loading…', 'a-radio' ),
'error' => __( 'Stream error — try another station.', 'a-radio' ),
'saveError' => __( 'Preferences not saved — check your connection.', 'a-radio' ),
'mute' => __( 'Mute', 'a-radio' ),
'unmute' => __( 'Unmute', 'a-radio' ),
'nowPlaying' => __( 'Now Playing', 'a-radio' ),
'volume' => __( 'Volume', 'a-radio' ),
'station' => __( 'Station', 'a-radio' ),
'addFav' => __( 'Add to favourites', 'a-radio' ),
'removeFav' => __( 'Remove from favourites', 'a-radio' ),
'clearConfirm' => __( 'Clear all track history? (Favourites are kept.)', 'a-radio' ),
),
) );
}
@@ -187,11 +187,13 @@ add_action( 'wp_ajax_radio_log_track', 'radio_ajax_log_track' );
function radio_ajax_log_track() {
if ( ! is_user_logged_in() ) { wp_send_json_error( 'Not logged in.', 401 ); }
check_ajax_referer( 'radio_save_state', 'nonce' );
// Unslash + sanitize at access; radio_sanitize_entry() also re-sanitizes
// downstream as belt+braces, but PCP wants the cleanup AT the access point.
$logged = radio_log_track( array(
'artist' => $_POST['artist'] ?? '',
'title' => $_POST['title'] ?? '',
'station' => $_POST['station'] ?? '',
'station_id' => $_POST['station_id'] ?? '',
'artist' => isset( $_POST['artist'] ) ? sanitize_text_field( wp_unslash( $_POST['artist'] ) ) : '',
'title' => isset( $_POST['title'] ) ? sanitize_text_field( wp_unslash( $_POST['title'] ) ) : '',
'station' => isset( $_POST['station'] ) ? sanitize_text_field( wp_unslash( $_POST['station'] ) ) : '',
'station_id' => isset( $_POST['station_id'] ) ? sanitize_key( wp_unslash( $_POST['station_id'] ) ) : '',
) );
wp_send_json_success( array( 'logged' => (bool) $logged ) );
}
@@ -206,10 +208,10 @@ function radio_ajax_toggle_favourite() {
if ( ! is_user_logged_in() ) { wp_send_json_error( 'Not logged in.', 401 ); }
check_ajax_referer( 'radio_history', 'nonce' );
$new_state = radio_toggle_favourite( array(
'artist' => $_POST['artist'] ?? '',
'title' => $_POST['title'] ?? '',
'station' => $_POST['station'] ?? '',
'station_id' => $_POST['station_id'] ?? '',
'artist' => isset( $_POST['artist'] ) ? sanitize_text_field( wp_unslash( $_POST['artist'] ) ) : '',
'title' => isset( $_POST['title'] ) ? sanitize_text_field( wp_unslash( $_POST['title'] ) ) : '',
'station' => isset( $_POST['station'] ) ? sanitize_text_field( wp_unslash( $_POST['station'] ) ) : '',
'station_id' => isset( $_POST['station_id'] ) ? sanitize_key( wp_unslash( $_POST['station_id'] ) ) : '',
) );
wp_send_json_success( array( 'favourite' => (bool) $new_state ) );
}
@@ -233,7 +235,7 @@ function radio_ajax_clear_history() {
add_action( 'admin_post_radio_popout', 'radio_render_popout_page' );
function radio_render_popout_page() {
if ( ! current_user_can( 'read' ) ) {
wp_die( esc_html__( 'You do not have permission to view this page.', 'radio' ) );
wp_die( esc_html__( 'You do not have permission to view this page.', 'a-radio' ) );
}
$state = radio_get_state();
@@ -250,51 +252,46 @@ function radio_render_popout_page() {
'popoutUrl' => '', // already in popout — no further popouts
'autoPlay' => isset( $_GET['play'] ), // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- query flag only, no state change
'strings' => array(
'play' => __( 'Play', 'radio' ),
'pause' => __( 'Pause', 'radio' ),
'loading' => __( 'Loading…', 'radio' ),
'error' => __( 'Stream error — try another station.', 'radio' ),
'saveError' => __( 'Preferences not saved — check your connection.', 'radio' ),
'mute' => __( 'Mute', 'radio' ),
'unmute' => __( 'Unmute', 'radio' ),
'nowPlaying' => __( 'Now Playing', 'radio' ),
'volume' => __( 'Volume', 'radio' ),
'station' => __( 'Station', 'radio' ),
'play' => __( 'Play', 'a-radio' ),
'pause' => __( 'Pause', 'a-radio' ),
'loading' => __( 'Loading…', 'a-radio' ),
'error' => __( 'Stream error — try another station.', 'a-radio' ),
'saveError' => __( 'Preferences not saved — check your connection.', 'a-radio' ),
'mute' => __( 'Mute', 'a-radio' ),
'unmute' => __( 'Unmute', 'a-radio' ),
'nowPlaying' => __( 'Now Playing', 'a-radio' ),
'volume' => __( 'Volume', 'a-radio' ),
'station' => __( 'Station', 'a-radio' ),
),
);
/*
* v0.7.0: Enqueue popup assets via WP so we can emit them with
* wp_print_styles() / wp_print_footer_scripts() — passes PCP's
* NonEnqueuedStylesheet / NonEnqueuedScript checks (we used raw
* <link> / <script> tags before). dashicons is core-registered.
*/
wp_enqueue_style( 'dashicons' );
wp_enqueue_style( 'radio-admin', RADIO_URL . 'assets/css/radio.css', array(), RADIO_VERSION );
wp_enqueue_script( 'radio-admin', RADIO_URL . 'assets/js/radio.js', array(), RADIO_VERSION, true );
wp_localize_script( 'radio-admin', 'RadioPlugin', $cfg );
?>
<!DOCTYPE html>
<html lang="<?php echo esc_attr( str_replace( '_', '-', get_bloginfo( 'language' ) ) ); ?>">
<head>
<meta charset="<?php bloginfo( 'charset' ); ?>">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title><?php printf( esc_html__( 'Radio — %s', 'radio' ), esc_html( $station['name'] ) ); ?></title>
<link rel="stylesheet" href="<?php echo esc_url( includes_url( 'css/dashicons.min.css' ) ); ?>?ver=<?php echo esc_attr( get_bloginfo( 'version' ) ); ?>">
<link rel="stylesheet" href="<?php echo esc_url( RADIO_URL . 'assets/css/radio.css' ); ?>?ver=<?php echo esc_attr( RADIO_VERSION ); ?>">
<style>
:root { --wp-admin-theme-color: #2271b1; }
html, body { margin: 0; padding: 0; }
body { padding: 14px; font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif; background: #f0f0f1; color: #1d2327; font-size: 13px; }
.radio-popout-header { display: flex; justify-content: space-between; align-items: center; margin: 0 0 12px; }
.radio-popout-header h1 { margin: 0; font-size: 14px; font-weight: 600; color: #1d2327; }
.radio-popout-header h1::before { content: '📻 '; }
.radio-popout-close { background: none; border: 0; font-size: 18px; cursor: pointer; color: #646970; padding: 4px 8px; line-height: 1; border-radius: 3px; }
.radio-popout-close:hover { color: #b32d2e; background: rgba(179,45,46,0.08); }
.radio-popout-wrap { background: #fff; border: 1px solid #c3c4c7; padding: 14px; border-radius: 3px; }
.radio-popout-wrap .radio-player__station-select select { max-width: 100%; }
.radio-popout-wrap .radio-player__volume { width: 100%; }
.radio-popout-wrap .radio-player__controls { flex-direction: column; align-items: stretch; gap: 10px; }
body.radio-theme-dark { background: #101213; color: #f0f0f1; }
body.radio-theme-dark .radio-popout-header h1 { color: #f0f0f1; }
body.radio-theme-dark .radio-popout-wrap { background: #1d2327; border-color: #3c434a; }
body.radio-theme-dark .radio-popout-close { color: #a7aaad; }
</style>
<title><?php
/* translators: %s = currently playing station name */
printf( esc_html__( 'Radio — %s', 'a-radio' ), esc_html( $station['name'] ) );
?></title>
<?php wp_print_styles(); /* dashicons + radio.css; popup-specific overrides scoped under body.radio-popout in radio.css */ ?>
</head>
<body class="radio-popout radio-theme-<?php echo esc_attr( $theme ); ?>">
<div class="radio-popout-header">
<h1><?php esc_html_e( 'Radio', 'radio' ); ?></h1>
<button type="button" class="radio-popout-close" onclick="window.close()" title="<?php esc_attr_e( 'Close', 'radio' ); ?>">✕</button>
<h1><?php esc_html_e( 'Radio', 'a-radio' ); ?></h1>
<button type="button" class="radio-popout-close" onclick="window.close()" title="<?php esc_attr_e( 'Close', 'a-radio' ); ?>">✕</button>
</div>
<div class="radio-popout-wrap">
@@ -305,7 +302,7 @@ function radio_render_popout_page() {
<span class="radio-player__bars"><span></span><span></span><span></span><span></span></span>
<canvas class="radio-player__viz" data-radio-viz hidden></canvas>
</span>
<span class="radio-player__label"><?php esc_html_e( 'Now Playing', 'radio' ); ?></span>
<span class="radio-player__label"><?php esc_html_e( 'Now Playing', 'a-radio' ); ?></span>
<span class="radio-player__station-name" data-radio-name><?php echo esc_html( $station['name'] ); ?></span>
<span class="radio-player__station-genre" data-radio-genre><?php echo esc_html( $station['genre'] ); ?></span>
<p class="radio-player__station-desc" data-radio-desc><?php echo esc_html( $station['description'] ); ?></p>
@@ -315,19 +312,19 @@ function radio_render_popout_page() {
<div class="radio-player__controls">
<button type="button" class="button button-primary radio-player__play" data-radio-play>
<span class="radio-player__play-glyph" data-radio-play-glyph aria-hidden="true">&#9654;</span>
<span data-radio-play-label><?php esc_html_e( 'Play', 'radio' ); ?></span>
<span data-radio-play-label><?php esc_html_e( 'Play', 'a-radio' ); ?></span>
</button>
<div class="radio-player__volume">
<button type="button" class="radio-player__mute" data-radio-mute aria-label="<?php esc_attr_e( 'Mute', 'radio' ); ?>">
<button type="button" class="radio-player__mute" data-radio-mute aria-label="<?php esc_attr_e( 'Mute', 'a-radio' ); ?>">
<span class="dashicons dashicons-controls-volumeon" aria-hidden="true"></span>
</button>
<input type="range" min="0" max="100" value="<?php echo esc_attr( (int) round( $state['volume'] * 100 ) ); ?>" data-radio-volume aria-label="<?php esc_attr_e( 'Volume', 'radio' ); ?>">
<input type="range" min="0" max="100" value="<?php echo esc_attr( (int) round( $state['volume'] * 100 ) ); ?>" data-radio-volume aria-label="<?php esc_attr_e( 'Volume', 'a-radio' ); ?>">
<span class="radio-player__volume-pct" data-radio-volume-pct><?php echo esc_html( (int) round( $state['volume'] * 100 ) ); ?>%</span>
</div>
</div>
<div class="radio-player__station-select">
<label for="radio-station-popout"><?php esc_html_e( 'Station', 'radio' ); ?></label>
<label for="radio-station-popout"><?php esc_html_e( 'Station', 'a-radio' ); ?></label>
<select id="radio-station-popout" data-radio-station>
<?php foreach ( $stations as $genre => $entries ) :
if ( empty( $entries ) ) { continue; }
@@ -348,8 +345,7 @@ function radio_render_popout_page() {
</div>
</div>
<script>window.RadioPlugin = <?php echo wp_json_encode( $cfg ); ?>;</script>
<script src="<?php echo esc_url( RADIO_URL . 'assets/js/radio.js' ); ?>?ver=<?php echo esc_attr( RADIO_VERSION ); ?>"></script>
<?php wp_print_footer_scripts(); /* radio.js + the wp_localize_script-emitted window.RadioPlugin inline blob */ ?>
</body>
</html>
<?php