-
Notifications
You must be signed in to change notification settings - Fork 0
Add city-only Provider Listings meta box with JSON-safe persistence #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Copilot
wants to merge
2
commits into
main
Choose a base branch
from
copilot/feat-add-admin-ui-meta-box
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+305
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
303 changes: 303 additions & 0 deletions
303
community-listings/includes/Admin/ProviderListingsMetaBox.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,303 @@ | ||
| <?php | ||
| /** | ||
| * Provider Listings meta box for city-level Community posts. | ||
| * | ||
| * @package SilverAssist\CommunityListings | ||
| * @author Silver Assist | ||
| * @license PolyForm-Noncommercial-1.0.0 | ||
| * @since 2.2.5 | ||
| */ | ||
|
|
||
| declare( strict_types=1 ); | ||
|
|
||
| namespace SilverAssist\CommunityListings\Admin; | ||
|
|
||
| use SilverAssist\CommunityListings\Core\Interfaces\LoadableInterface; | ||
|
|
||
| /** | ||
| * Registers and handles provider_listings meta box editing. | ||
| * | ||
| * @since 2.2.5 | ||
| */ | ||
| final class ProviderListingsMetaBox implements LoadableInterface { | ||
|
|
||
| /** | ||
| * Nonce action. | ||
| * | ||
| * @since 2.2.5 | ||
| * | ||
| * @var string | ||
| */ | ||
| private const NONCE_ACTION = 'provider_listings_meta_box_action'; | ||
|
|
||
| /** | ||
| * Nonce field name. | ||
| * | ||
| * @since 2.2.5 | ||
| * | ||
| * @var string | ||
| */ | ||
| private const NONCE_FIELD = 'provider_listings_meta_box_nonce'; | ||
|
|
||
| /** | ||
| * Textarea field name. | ||
| * | ||
| * @since 2.2.5 | ||
| * | ||
| * @var string | ||
| */ | ||
| private const FIELD_NAME = 'provider_listings_json'; | ||
|
|
||
| /** | ||
| * Query arg name for invalid JSON notice. | ||
| * | ||
| * @since 2.2.5 | ||
| * | ||
| * @var string | ||
| */ | ||
| private const INVALID_JSON_QUERY_ARG = 'provider_listings_json_invalid'; | ||
|
|
||
| /** | ||
| * Return the loading priority. | ||
| * | ||
| * @since 2.2.5 | ||
| * | ||
| * @return int Loading priority. | ||
| */ | ||
| public function priority(): int { | ||
| return 25; | ||
| } | ||
|
|
||
| /** | ||
| * Register WordPress hooks. | ||
| * | ||
| * @since 2.2.5 | ||
| * | ||
| * @return void | ||
| */ | ||
| public function register(): void { | ||
| \add_action( 'add_meta_boxes_community', array( $this, 'register_meta_box' ) ); | ||
| \add_action( 'save_post_community', array( $this, 'save_provider_listings' ), 10, 3 ); | ||
| \add_action( 'admin_notices', array( $this, 'render_invalid_json_notice' ) ); | ||
| } | ||
|
|
||
| /** | ||
| * Register the Provider Listings meta box for city-level communities. | ||
| * | ||
| * @since 2.2.5 | ||
| * | ||
| * @param \WP_Post $post Post object. | ||
| * @return void | ||
| */ | ||
| public function register_meta_box( \WP_Post $post ): void { | ||
| $listing_type = \get_post_meta( $post->ID, 'listing_type', true ); | ||
|
|
||
| if ( 'city' !== $listing_type ) { | ||
| return; | ||
| } | ||
|
|
||
| \add_meta_box( | ||
| 'provider-listings-meta-box', | ||
| \__( 'Provider Listings', 'community-listings' ), | ||
| array( $this, 'render_meta_box' ), | ||
| 'community', | ||
| 'normal', | ||
| 'high' | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Render the Provider Listings meta box. | ||
| * | ||
| * @since 2.2.5 | ||
| * | ||
| * @param \WP_Post $post Post object. | ||
| * @return void | ||
| */ | ||
| public function render_meta_box( \WP_Post $post ): void { | ||
| $raw_json = \get_post_meta( $post->ID, 'provider_listings', true ); | ||
| $raw_json = \is_string( $raw_json ) ? $raw_json : ''; | ||
|
|
||
| $formatted_json = $raw_json; | ||
| $decoded_json = null; | ||
|
|
||
| if ( '' !== $raw_json ) { | ||
| $decoded_json = \json_decode( $raw_json, true ); | ||
|
|
||
| if ( \JSON_ERROR_NONE === \json_last_error() ) { | ||
| $pretty_json = \json_encode( $decoded_json, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_UNICODE ); | ||
|
|
||
| if ( false !== $pretty_json ) { | ||
| $formatted_json = $pretty_json; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| $provider_count = \is_array( $decoded_json ) && \array_is_list( $decoded_json ) ? \count( $decoded_json ) : 0; | ||
| $byte_count = \strlen( $formatted_json ); | ||
| $nonce = \wp_create_nonce( self::NONCE_ACTION ); | ||
| ?> | ||
| <input type="hidden" name="<?php echo \esc_attr( self::NONCE_FIELD ); ?>" value="<?php echo \esc_attr( $nonce ); ?>" /> | ||
| <textarea | ||
| id="provider-listings-json" | ||
| name="<?php echo \esc_attr( self::FIELD_NAME ); ?>" | ||
| rows="20" | ||
| style="width: 100%; font-family: monospace;" | ||
| ><?php echo \esc_textarea( $formatted_json ); ?></textarea> | ||
| <p class="description"> | ||
| <strong id="provider-listings-byte-count"><?php echo \esc_html( \number_format_i18n( $byte_count ) ); ?> bytes</strong> | ||
| · | ||
| <strong id="provider-listings-provider-count"><?php echo \esc_html( \number_format_i18n( $provider_count ) ); ?> <?php echo \esc_html( 1 === $provider_count ? 'provider' : 'providers' ); ?></strong> | ||
| </p> | ||
| <p class="description" id="provider-listings-json-error" style="display: none; color: #d63638;"> | ||
| <?php \esc_html_e( 'Invalid JSON. Please correct before saving.', 'community-listings' ); ?> | ||
| </p> | ||
| <script> | ||
| (function () { | ||
| const textarea = document.getElementById('provider-listings-json'); | ||
| const errorMessage = document.getElementById('provider-listings-json-error'); | ||
| const byteCount = document.getElementById('provider-listings-byte-count'); | ||
| const providerCount = document.getElementById('provider-listings-provider-count'); | ||
| if (!textarea || !errorMessage || !byteCount || !providerCount) { | ||
| return; | ||
| } | ||
| const formatNumber = (num) => num.toLocaleString(); | ||
| const updateStats = () => { | ||
| const text = textarea.value; | ||
| byteCount.textContent = `${formatNumber((new TextEncoder().encode(text)).length)} bytes`; | ||
| try { | ||
| const parsed = JSON.parse(text); | ||
| const count = Array.isArray(parsed) ? parsed.length : 0; | ||
| providerCount.textContent = `${formatNumber(count)} ${count === 1 ? 'provider' : 'providers'}`; | ||
| textarea.style.borderColor = ''; | ||
| errorMessage.style.display = 'none'; | ||
| } catch (error) { | ||
| providerCount.textContent = '0 providers'; | ||
| textarea.style.borderColor = '#d63638'; | ||
| errorMessage.style.display = 'block'; | ||
| } | ||
| }; | ||
| textarea.addEventListener('blur', updateStats); | ||
| textarea.addEventListener('change', updateStats); | ||
| textarea.addEventListener('input', updateStats); | ||
| updateStats(); | ||
| })(); | ||
| </script> | ||
| <?php | ||
| } | ||
|
|
||
| /** | ||
| * Save provider_listings JSON using direct DB update. | ||
| * | ||
| * @since 2.2.5 | ||
| * | ||
| * @param int $post_id Post ID. | ||
| * @param \WP_Post $post Post object. | ||
| * @param bool $update Whether this is an existing post being updated. | ||
| * @return void | ||
| */ | ||
| public function save_provider_listings( int $post_id, \WP_Post $post, bool $update ): void { | ||
| unset( $post, $update ); | ||
|
|
||
| if ( ! \current_user_can( 'edit_posts' ) ) { | ||
| return; | ||
| } | ||
|
|
||
| if ( \wp_is_post_autosave( $post_id ) || \wp_is_post_revision( $post_id ) ) { | ||
| return; | ||
| } | ||
|
|
||
| $nonce = $_POST[ self::NONCE_FIELD ] ?? ''; | ||
| $nonce = \is_string( $nonce ) ? \wp_unslash( $nonce ) : ''; | ||
| if ( ! \wp_verify_nonce( $nonce, self::NONCE_ACTION ) ) { | ||
| return; | ||
| } | ||
|
|
||
| $listing_type = \get_post_meta( $post_id, 'listing_type', true ); | ||
| if ( 'city' !== $listing_type ) { | ||
| return; | ||
| } | ||
|
|
||
| $posted_json = $_POST[ self::FIELD_NAME ] ?? null; | ||
| if ( ! \is_string( $posted_json ) ) { | ||
| return; | ||
| } | ||
|
|
||
| $json_string = \wp_unslash( $posted_json ); | ||
| $decoded = \json_decode( $json_string, true ); | ||
|
|
||
| if ( \JSON_ERROR_NONE !== \json_last_error() ) { | ||
| \add_filter( 'redirect_post_location', array( $this, 'append_invalid_json_query_arg' ) ); | ||
| return; | ||
| } | ||
|
|
||
| unset( $decoded ); | ||
|
|
||
| global $wpdb; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited | ||
|
|
||
| $updated = $wpdb->update( | ||
| $wpdb->postmeta, | ||
| array( 'meta_value' => $json_string ), | ||
| array( | ||
| 'post_id' => $post_id, | ||
| 'meta_key' => 'provider_listings', | ||
| ), | ||
| array( '%s' ), | ||
| array( '%d', '%s' ) | ||
| ); | ||
|
|
||
| if ( false === $updated ) { | ||
| return; | ||
| } | ||
|
|
||
| if ( 0 === $updated && ! \metadata_exists( 'post', $post_id, 'provider_listings' ) ) { | ||
| $wpdb->insert( | ||
| $wpdb->postmeta, | ||
| array( | ||
| 'post_id' => $post_id, | ||
| 'meta_key' => 'provider_listings', | ||
| 'meta_value' => $json_string, | ||
| ), | ||
| array( '%d', '%s', '%s' ) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Add invalid JSON flag to redirect URL. | ||
| * | ||
| * @since 2.2.5 | ||
| * | ||
| * @param string $location Redirect URL. | ||
| * @return string | ||
| */ | ||
| public function append_invalid_json_query_arg( string $location ): string { | ||
| \remove_filter( 'redirect_post_location', array( $this, __FUNCTION__ ) ); | ||
| return \add_query_arg( self::INVALID_JSON_QUERY_ARG, '1', $location ); | ||
| } | ||
|
|
||
| /** | ||
| * Render invalid JSON admin notice. | ||
| * | ||
| * @since 2.2.5 | ||
| * | ||
| * @return void | ||
| */ | ||
| public function render_invalid_json_notice(): void { | ||
| $screen = \function_exists( 'get_current_screen' ) ? \get_current_screen() : null; | ||
| if ( ! $screen || 'community' !== $screen->post_type ) { | ||
| return; | ||
| } | ||
|
|
||
| $invalid_flag = $_GET[ self::INVALID_JSON_QUERY_ARG ] ?? ''; | ||
| $invalid_flag = \is_string( $invalid_flag ) ? \sanitize_text_field( \wp_unslash( $invalid_flag ) ) : ''; | ||
| if ( '1' !== $invalid_flag ) { | ||
| return; | ||
| } | ||
| ?> | ||
| <div class="notice notice-error is-dismissible"> | ||
| <p><?php \esc_html_e( 'Provider Listings not saved: invalid JSON.', 'community-listings' ); ?></p> | ||
| </div> | ||
| <?php | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a persistent object cache is enabled, this direct
$wpdb->update()leaves WordPress'post_metacache stale. The method already callsget_post_meta()forlisting_type, which primes the meta cache for the whole post before this write, so laterget_post_meta( $post_id, 'provider_listings', true )calls (including WPGraphQL consumers) can keep returning the old JSON even though the database row changed. Please clear or update the post meta cache after both the update and insert paths while preserving the direct SQL write.Useful? React with 👍 / 👎.