Skip to content

refactor: simplify YoastLlmsTxt by merging duplicate rewrite methods #29

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.

Sign up for GitHub

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
jdevalk wants to merge 3 commits into
base: main
Choose a base branch
from
Open

refactor: simplify YoastLlmsTxt by merging duplicate rewrite methods #29

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1814d3d
refactor: simplify YoastLlmsTxt by merging duplicate rewrite methods
Feb 26, 2026
8414dc7
refactor: collapse register() add_action pairs into a loop
Feb 26, 2026
b236174
fix: address Copilot review feedback on PR #29
Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 11 additions & 34 deletions src/Integration/YoastLlmsTxt.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,10 @@ class YoastLlmsTxt {
public function register(): void {
// Wrap each trigger that causes Yoast to (re)generate the llms.txt file.
// Priority 9 = before Yoast's priority 10, priority 11 = after.

// 1. Feature toggle (enable/disable llms.txt in Yoast settings).
add_action( 'update_option_wpseo', [ $this, 'start' ], 9 );
add_action( 'update_option_wpseo', [ $this, 'stop' ], 11 );

// 2. llms.txt page selection settings change.
add_action( 'update_option_wpseo_llmstxt', [ $this, 'start' ], 9 );
add_action( 'update_option_wpseo_llmstxt', [ $this, 'stop' ], 11 );

// 3. Weekly cron regeneration.
add_action( 'wpseo_llms_txt_population', [ $this, 'start' ], 9 );
add_action( 'wpseo_llms_txt_population', [ $this, 'stop' ], 11 );
foreach ( [ 'update_option_wpseo', 'update_option_wpseo_llmstxt', 'wpseo_llms_txt_population' ] as $action ) {
add_action( $action, [ $this, 'start' ], 9 );
add_action( $action, [ $this, 'stop' ], 11 );
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update_option_wpseo / update_option_wpseo_llmstxt are core update_option_{$option} actions that pass arguments (old value, new value, option). With add_action(..., 9) the default accepted args is 1, so WordPress will pass an argument into start()/stop() which declare no parameters; this will throw an ArgumentCountError on PHP 8+. Fix by setting accepted args to 0 in these add_action calls, or update start/stop signatures to accept (and ignore) the incoming args.

Suggested change
add_action( $action, [ $this, 'start' ], 9 );
add_action( $action, [ $this, 'stop' ], 11 );
add_action( $action, [ $this, 'start' ], 9, 0 );
add_action( $action, [ $this, 'stop' ], 11, 0 );

Copilot uses AI. Check for mistakes.
}
}

/**
Expand All @@ -65,7 +57,7 @@ public function start(): void {

// from_post() fallback path: uses get_permalink() directly.
add_filter( 'post_link', [ $this, 'rewrite_post_link' ], 10, 2 );
add_filter( 'page_link', [ $this, 'rewrite_page_link' ], 10, 2 );
add_filter( 'page_link', [ $this, 'rewrite_post_link' ], 10, 2 );
add_filter( 'post_type_link', [ $this, 'rewrite_post_link' ], 10, 2 );
}

Expand All @@ -82,7 +74,7 @@ public function stop(): void {

remove_filter( 'wpseo_canonical', [ $this, 'rewrite_canonical' ], 10 );
remove_filter( 'post_link', [ $this, 'rewrite_post_link' ], 10 );
remove_filter( 'page_link', [ $this, 'rewrite_page_link' ], 10 );
remove_filter( 'page_link', [ $this, 'rewrite_post_link' ], 10 );
remove_filter( 'post_type_link', [ $this, 'rewrite_post_link' ], 10 );
}

Expand Down Expand Up @@ -110,12 +102,13 @@ public function rewrite_canonical( $canonical, $presentation ) {
}

/**
* Rewrite post/CPT permalink to .md.
* Rewrite post/page/CPT permalink to .md.
*
* Works for both post_link and post_type_link filters.
* Handles post_link, page_link, and post_type_link filters.
* get_post_type() accepts both a WP_Post object and an integer post ID.
*
* @param string $url The permalink.
* @param \WP_Post $post The post object.
* @param string $url The permalink.
* @param \WP_Post|int $post The post object or post ID.
* @return string
*/
public function rewrite_post_link( $url, $post ): string {
Expand All @@ -126,20 +119,4 @@ public function rewrite_post_link( $url, $post ): string {

return rtrim( $url, '/' ) . '.md';
}

/**
* Rewrite page permalink to .md.
*
* @param string $url The page URL.
* @param int $post_id The page ID.
* @return string
*/
public function rewrite_page_link( $url, $post_id ): string {
$post_type = get_post_type( $post_id );
if ( ! $post_type || ! PostTypeSupport::is_supported( $post_type ) ) {
return $url;
}

return rtrim( $url, '/' ) . '.md';
}
}