Add initial support for handling of virtual posts #1171
There are no files selected for viewing
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
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
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 |
|---|---|---|
|
|
@@ -82,6 +82,15 @@ public static function delete_cpt_posts( string $post_type ) { | |
|
|
||
| global $wpdb; | ||
|
|
||
| /** | ||
| * Fires before deleting posts of a specific post type. | ||
| * | ||
| * @since 1.31.0 | ||
| * | ||
| * @param string $post_type Post Type. | ||
| */ | ||
| do_action( 'edac_before_delete_cpt_posts', $post_type ); | ||
|
|
||
| // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Safe variable used for table name, caching not required for one time operation. | ||
| return $wpdb->query( | ||
| $wpdb->prepare( | ||
|
|
||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -39,36 +39,34 @@ public static function get_scannable_post_statuses() { | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| */ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| public static function get_scannable_post_types() { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| if ( | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| class_exists( 'EqualizeDigital\AccessibilityCheckerPro\Admin\Settings' ) && | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| method_exists( 'EqualizeDigital\AccessibilityCheckerPro\Admin\Settings', 'get_scannable_post_types' ) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return \EqualizeDigital\AccessibilityCheckerPro\Admin\Settings::get_scannable_post_types(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+42
to
+49
Contributor
There was a problem hiding this comment. Back-compat booby trap: calling Pro::get_scannable_post_types with an extra arg can fatally error If older Pro versions expose Proposed back-compat safe delegation: - public static function get_scannable_post_types( $skip_filtering = false ) {
-
- if (
- class_exists( 'EqualizeDigital\AccessibilityCheckerPro\Admin\Settings' ) &&
- method_exists( 'EqualizeDigital\AccessibilityCheckerPro\Admin\Settings', 'get_scannable_post_types' )
- ) {
- return \EqualizeDigital\AccessibilityCheckerPro\Admin\Settings::get_scannable_post_types( $skip_filtering );
- }
+ public static function get_scannable_post_types( $skip_filtering = false ) {
+ $pro_class = '\EqualizeDigital\AccessibilityCheckerPro\Admin\Settings';
+ if ( class_exists( $pro_class ) && method_exists( $pro_class, 'get_scannable_post_types' ) ) {
+ // Back-compat: call with zero or one argument depending on the Pro signature.
+ try {
+ $ref = new \ReflectionMethod( $pro_class, 'get_scannable_post_types' );
+ if ( $ref->getNumberOfParameters() > 0 ) {
+ return $pro_class::get_scannable_post_types( $skip_filtering );
+ }
+ return $pro_class::get_scannable_post_types();
+ } catch ( \ReflectionException $e ) {
+ // Fall back to the safest call.
+ return $pro_class::get_scannable_post_types();
+ }
+ }📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $post_types = Helpers::get_option_as_array( 'edac_post_types' ); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // remove duplicates. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $post_types = array_unique( $post_types ); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // validate post types. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $args = [ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 'public' => true, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| '_builtin' => true, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ]; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| $valid_post_types = get_post_types( $args, 'names', 'and' ); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| unset( $valid_post_types['attachment'] ); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| foreach ( $post_types as $key => $post_type ) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| if ( ! post_type_exists( $post_type ) || ! array_key_exists( $post_type, $valid_post_types ) ) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| unset( $post_types[ $key ] ); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return $post_types; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
|---|---|---|
|
|
@@ -50,7 +50,7 @@ public static function maybe_enqueue_frontend_highlighter() { | |
|
|
||
| // Don't load on the frontend if we don't have a post to work with. | ||
| global $post; | ||
| $post_id = apply_filters( 'edac_filter_frontend_highlight_post_id', is_object( $post ) ? $post->ID : null ); | ||
|
Contributor
There was a problem hiding this comment. 🛠️ Refactor suggestion Add PHPDoc documentation for the new filter. The filter implementation is correct and follows WordPress conventions with the proper Add PHPDoc documentation above the filter: + /**
+ * Filter the post ID used for frontend highlighting.
+ *
+ * Allows external code to override which post ID is used for frontend
+ * highlighting functionality, supporting virtual posts for archive/taxonomy pages.
+ *
+ * @since 1.15.0
+ *
+ * @param int|null $post_id The post ID to use for frontend highlighting. Default is the current post ID or null.
+ */
$post_id = apply_filters( 'edac_filter_frontend_highlight_post_id', is_object( $post ) ? $post->ID : null );🤖 Prompt for AI Agents |
||
|
|
||
| if ( null === $post_id ) { | ||
|
Comment on lines
+55
to
57
Contributor
There was a problem hiding this comment. 🛠️ Refactor suggestion Gate logic should use the filtered $post_id’s post type (and allow virtual pages). Right now you ask get_post_type() without an ID, which can mismatch on archives. That’s sloppy—use the post type for the post you actually intend to highlight; also allow virtual/ghost posts to activate the highlighter. - $post_types = Settings::get_scannable_post_types();
- $current_post_type = get_post_type();
- $active = ( is_array( $post_types ) && in_array( $current_post_type, $post_types, true ) );
+ $post_types = Settings::get_scannable_post_types();
+ $current_post_type = $post_id ? get_post_type( $post_id ) : get_post_type();
+ $active = (
+ is_array( $post_types )
+ && (
+ in_array( $current_post_type, $post_types, true )
+ || ( function_exists( 'edac_is_virtual_page' ) && $post_id && edac_is_virtual_page( $post_id ) )
+ )
+ );Also applies to: 86-90 🤖 Prompt for AI Agents |
||
| return; | ||
|
|
||
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -225,7 +225,7 @@ public function clear_issues_for_post( $request ) { | |||||
| } | ||||||
|
|
||||||
| $post_type = get_post_type( $post ); | ||||||
| $post_types = apply_filters( 'edacp_fill_site_scan_scannable_post_types', Helpers::get_option_as_array( 'edac_post_types' ) ); | ||||||
| if ( empty( $post_types ) || ! in_array( $post_type, $post_types, true ) ) { | ||||||
| return new \WP_REST_Response( [ 'message' => 'The post type is not set to be scanned.' ], 400 ); | ||||||
| } | ||||||
|
|
@@ -297,7 +297,7 @@ public function set_post_scan_results( $request ) { | |||||
| } | ||||||
|
|
||||||
| $post_type = get_post_type( $post ); | ||||||
| $post_types = apply_filters( 'edacp_fill_site_scan_scannable_post_types', Helpers::get_option_as_array( 'edac_post_types' ) ); | ||||||
|
Contributor
There was a problem hiding this comment. The filter name $post_types = apply_filters( 'edacp_scannable_post_types', Helpers::get_option_as_array( 'edac_post_types' ) );
Contributor
There was a problem hiding this comment. Use The filter name Apply this diff to use the correct prefix: - $post_types = apply_filters( 'edacp_fill_site_scan_scannable_post_types', Helpers::get_option_as_array( 'edac_post_types' ) );
+ $post_types = apply_filters( 'edac_fill_site_scan_scannable_post_types', Helpers::get_option_as_array( 'edac_post_types' ) );📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||
| if ( empty( $post_types ) || ! in_array( $post_type, $post_types, true ) ) { | ||||||
|
|
||||||
| return new \WP_REST_Response( [ 'message' => 'The post type is not set to be scanned.' ], 400 ); | ||||||
|
|
||||||
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 |
|---|---|---|
|
|
@@ -162,7 +162,10 @@ function edac_custom_post_types() { | |
| $output = 'names'; // names or objects, note names is the default. | ||
| $operator = 'and'; // Options 'and' or 'or'. | ||
|
|
||
| return array_merge( | ||
| get_post_types( $args, $output, $operator ), | ||
| [ 'edac_virtual_page' => 'Archives' ] | ||
| ); | ||
|
Contributor
There was a problem hiding this comment. Bug: edac_custom_post_types() returns mixed shapes (strings + associative array). You’re merging a list of slugs with ['edac_virtual_page' => 'Archives'] which breaks consumers expecting a list of slugs. Fix it and only add the CPT when it exists. -return array_merge(
- get_post_types( $args, $output, $operator ),
- [ 'edac_virtual_page' => 'Archives' ]
- );
+ $virtual = class_exists( '\EqualizeDigital\AccessibilityCheckerPro\VirtualContent\VirtualPageType' )
+ ? [ \EqualizeDigital\AccessibilityCheckerPro\VirtualContent\VirtualPageType::POST_TYPE ]
+ : [];
+ return array_merge( get_post_types( $args, $output, $operator ), $virtual ); |
||
| } | ||
|
|
||
| /** | ||
|
|
@@ -770,12 +773,17 @@ function edac_generate_landmark_link( $landmark, $landmark_selector, $post_id, $ | |
|
|
||
| // If we have both landmark and selector, create a link. | ||
| if ( ! empty( $landmark_selector ) ) { | ||
| $link = apply_filters( | ||
| 'edac_get_origin_url_for_virtual_page', | ||
| $post_id | ||
| ); | ||
|
|
||
|
Comment on lines
+773
to
+780
Contributor
There was a problem hiding this comment. 🛠️ Refactor suggestion Use permalink as the filter’s default value and document the hook; remove type ambiguity and simplify fallback Passing Apply this diff: - $link = apply_filters(
- 'edac_get_origin_url_for_virtual_page',
- $post_id
- );
+ $base_link = get_the_permalink( $post_id );
+
+ /**
+ * Filter the base URL used for "View on page"/landmark links.
+ *
+ * Allows mapping virtual/ghost posts to their canonical origin URL (e.g., archives/taxonomies).
+ *
+ * @since 1.x.x
+ *
+ * @param string $base_link Default base URL (permalink for $post_id).
+ * @param int $post_id Post ID represented by the link (may be a virtual/ghost post).
+ * @param string $landmark_selector Unencoded CSS selector for the landmark being highlighted.
+ * @param string $landmark Human-readable landmark label.
+ *
+ * @return string Filtered base URL.
+ */
+ $link = apply_filters( 'edac_get_origin_url_for_virtual_page', $base_link, $post_id, $landmark_selector, $landmark );
+ if ( ! is_string( $link ) || '' === $link ) {
+ $link = $base_link;
+ }
@@
- is_string( $link ) ? $link : get_the_permalink( $post_id )
+ $linkNote: The hook name follows the edac_ prefix per team conventions (good). The added docblock aligns with “Document all custom hooks” guidance. Also applies to: 783-784 🤖 Prompt for AI Agents |
||
| $landmark_url = add_query_arg( | ||
| [ | ||
| 'edac_landmark' => base64_encode( $landmark_selector ), | ||
| 'edac_nonce' => wp_create_nonce( 'edac_highlight' ), | ||
| ], | ||
| is_string( $link ) ? $link : get_the_permalink( $post_id ) | ||
| ); | ||
|
|
||
| // translators: %s is the landmark type (e.g., "Header", "Navigation", "Main"). | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -5,6 +5,9 @@ | |
| * @package Accessibility_Checker | ||
| */ | ||
|
|
||
| // get the post type of the current editor page. | ||
| $is_virtual_page = ( get_post_type( get_the_ID() ) === 'edac_virtual_page' ); | ||
|
|
||
| ?> | ||
| <div id="edac-tabs"> | ||
| <p id="edac-tabs-label" class="screen-reader-text"><?php esc_html_e( 'Accessibility Checker issues panels', 'accessibility-checker' ); ?></p> | ||
|
|
@@ -31,7 +34,7 @@ class="active" | |
| <?php esc_html_e( 'Details', 'accessibility-checker' ); ?> | ||
| </button> | ||
| </li> | ||
| <li class="edac-tab" <?php echo $is_virtual_page ? 'style="display: none;"' : ''; ?>> | ||
| <button | ||
| role="tab" | ||
| aria-selected="false" | ||
|
|
||
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.
🛠️ Refactor suggestion
Add PHPDoc documentation for the new filter hook.
The filter hook implementation is correct and follows the
edac_prefix convention, but it lacks proper documentation. According to the coding guidelines, all custom hooks should be documented with clear descriptions and parameter types.Add PHPDoc documentation above the filter:
📝 Committable suggestion
🤖 Prompt for AI Agents