Added: info icons linking to the documentation for several sections in the settings screen. by Dan0sz · Pull Request #322 · plausible/wordpress

Dan0sz · 2026-08-10T14:50:25Z

Summary by CodeRabbit

Documentation
- Added information icons with links to relevant documentation throughout settings for:
  - Cloaked Affiliate Links
  - Query Parameters
  - Dashboard statistics
  - User-role analytics tracking
  - Dashboard access roles
  - Toolbar menu settings
- Updated the changelog with the new documentation links.

…n the settings screen.

coderabbitai · 2026-08-10T14:51:08Z

📝 Walkthrough

Walkthrough

The settings API now provides reusable documentation links with contextual titles. Six settings groups configure documentation URLs for affiliate links, query parameters, dashboard statistics, user roles, and toolbar settings. The changelog documents these links.

Changes

Settings documentation links

Layer / File(s)	Summary
Reusable documentation link rendering `src/Admin/Settings/API.php`	The API adds `render_docs_link()` and uses it for checkbox documentation links and settings group headings.
Settings documentation URLs `src/Admin/Settings/Page.php`, `readme.txt`	Six settings groups receive documentation URLs. The changelog lists the related info links.

Possibly related PRs

plausible/wordpress#315: Updates related settings UI sections in API.php and Page.php.

Suggested reviewers: metmarkosaric, masteradhoc

Poem

A rabbit found six links in line,
With tiny icons bright and fine.
Settings now point where docs reside,
With helpful titles by their side.
“Hop,” said Bun, “the paths are clear!”

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the added documentation-linked info icons in the settings screen.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch add_section_info_icons

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

codecov · 2026-08-10T14:52:57Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Dan0sz · 2026-08-10T15:15:29Z

@coderabbitai review

coderabbitai · 2026-08-10T15:15:40Z

⚠️ Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Dan0sz · 2026-08-10T15:36:00Z

@coderabbitai review

coderabbitai · 2026-08-10T15:36:14Z

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/Admin/Settings/API.php`:
- Around line 112-117: Add a stable accessible name to the icon-only anchor in
the settings markup by applying an aria-label derived from $title, while
preserving the existing aria-hidden SVG and link behavior.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: fe8386af-dc5e-40ca-8e1e-cf79ed69660c

📥 Commits

Reviewing files that changed from the base of the PR and between 01f2852 and a613d99.

📒 Files selected for processing (3)

readme.txt
src/Admin/Settings/API.php
src/Admin/Settings/Page.php

coderabbitai · 2026-08-10T15:41:12Z

+		<a class="inline-flex items-center leading-none" href="<?php echo esc_url( $url ); ?>" rel="noreferrer" target="_blank" title="<?php echo esc_attr( $title ); ?>">
+			<svg xmlns="http://www.w3.org/2000/svg" class="text-gray-400 w-6 h-6 leading-none" stroke="currentColor" aria-hidden="true" fill="none" viewBox="0 0 24 24" stroke-width="1.5">
+				<path stroke-linecap="round" stroke-linejoin="round"
+					  d="M11.25 11.25l.041-.02a.75.75 0 011.063.852l-.708 2.836a.75.75 0 001.063.853l.041-.021M21 12a9 9 0 11-18 0 9 9 0 0118 0zm-9-3.75h.008v.008H12V8.25z"></path>
+			</svg>
+		</a>


🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Add a stable accessible name to the icon-only link.

The anchor has no text, and its only child SVG is aria-hidden. Its accessible name therefore depends on the title fallback. W3C notes that support for this fallback varies across assistive technologies. Add an aria-label or visually hidden text based on $title. (w3.org)

Proposed fix

- <a class="inline-flex items-center leading-none" href="<?php echo esc_url( $url ); ?>" rel="noreferrer" target="_blank" title="<?php echo esc_attr( $title ); ?>"> + <a class="inline-flex items-center leading-none" href="<?php echo esc_url( $url ); ?>" rel="noreferrer" target="_blank" aria-label="<?php echo esc_attr( $title ); ?>" title="<?php echo esc_attr( $title ); ?>">

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

<a class="inline-flex items-center leading-none" href="<?php echo esc_url( $url ); ?>" rel="noreferrer" target="_blank" title="<?php echo esc_attr( $title ); ?>">

<svg xmlns="http://www.w3.org/2000/svg" class="text-gray-400 w-6 h-6 leading-none" stroke="currentColor" aria-hidden="true" fill="none" viewBox="0 0 24 24" stroke-width="1.5">

<path stroke-linecap="round" stroke-linejoin="round"

d="M11.25 11.25l.041-.02a.75.75 0 011.063.852l-.708 2.836a.75.75 0 001.063.853l.041-.021M21 12a9 9 0 11-18 0 9 9 0 0118 0zm-9-3.75h.008v.008H12V8.25z"></path>

</svg>

</a>

<a class="inline-flex items-center leading-none" href="<?php echo esc_url( $url ); ?>" rel="noreferrer" target="_blank" aria-label="<?php echo esc_attr( $title ); ?>" title="<?php echo esc_attr( $title ); ?>">

<svg xmlns="http://www.w3.org/2000/svg" class="text-gray-400 w-6 h-6 leading-none" stroke="currentColor" aria-hidden="true" fill="none" viewBox="0 0 24 24" stroke-width="1.5">

<path stroke-linecap="round" stroke-linejoin="round"

d="M11.25 11.25l.041-.02a.75.75 0 011.063.852l-.708 2.836a.75.75 0 001.063.853l.041-.021M21 12a9 9 0 11-18 0 9 9 0 0118 0zm-9-3.75h.008v.008H12V8.25z"></path>

</svg>

</a>

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/Admin/Settings/API.php` around lines 112 - 117, Add a stable accessible name to the icon-only anchor in the settings markup by applying an aria-label derived from $title, while preserving the existing aria-hidden SVG and link behavior.

Added: info icons linking to the documentation for several sections i…

a613d99

…n the settings screen.

coderabbitai Bot reviewed Aug 10, 2026

View reviewed changes

Navigation Menu

Uh oh!

Added: info icons linking to the documentation for several sections in the settings screen. - #322

Added: info icons linking to the documentation for several sections in the settings screen.#322
Dan0sz wants to merge 1 commit into
developfrom
add_section_info_icons

Dan0sz commented Aug 10, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Aug 10, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

codecov Bot commented Aug 10, 2026

Uh oh!

Dan0sz commented Aug 10, 2026

Uh oh!

coderabbitai Bot commented Aug 10, 2026 •

edited

Loading

Uh oh!

Dan0sz commented Aug 10, 2026

Uh oh!

coderabbitai Bot commented Aug 10, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Aug 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

Dan0sz commented Aug 10, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

codecov Bot commented Aug 10, 2026

Codecov Report

Uh oh!

Dan0sz commented Aug 10, 2026

Uh oh!

coderabbitai Bot commented Aug 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Dan0sz commented Aug 10, 2026

Uh oh!

coderabbitai Bot commented Aug 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Dan0sz commented Aug 10, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 10, 2026 •

edited

Loading

coderabbitai Bot commented Aug 10, 2026 •

edited

Loading

coderabbitai Bot commented Aug 10, 2026 •

edited

Loading