Skip to content

Tag - Add a Tag.merge API action and SearchKit "Merge Tags" bulk task - #36512

Open
mattwire wants to merge 1 commit into
civicrm:masterfrom
mattwire:core-tag-merge-action-and-searchkit-task
Open

Tag - Add a Tag.merge API action and SearchKit "Merge Tags" bulk task#36512
mattwire wants to merge 1 commit into
civicrm:masterfrom
mattwire:core-tag-merge-action-and-searchkit-task

Conversation

@mattwire

Copy link
Copy Markdown
Contributor

Overview

Adds a Tag.merge API4 action and wires it up as a SearchKit bulk task, so merging duplicate/overlapping tags can be done by selecting rows in a Tag listing instead of only through the dedicated CRM_Tag_Form_Merge popup.

image

Before

Tag merging was only reachable via civicrm/tag/merge, a standalone form outside of any SearchKit-driven listing. There was no API action wrapping the merge logic, so it couldn't be exposed as a bulk task on a Tag SearchDisplay.

After

A new Tag.merge action takes a targetId, a list of tagIds to merge into it, and an optional new label. Any Tag SearchDisplay with update and delete actions gets a "Merge Tags" bulk task once 2+ rows are selected, opening a dialog to pick the merge target and label.

Technical Details

  • Civi\Api4\Action\Tag\Merge wraps the existing CRM_Core_BAO_EntityTag::mergeTags() logic (already handles child reparenting, used_for union, and de-duping EntityTag rows) — it isn't reimplemented, just exposed through a proper API4 action.
  • Reserved tags require administer reserved tags to merge, mirroring the existing form's permission check.
  • GetSearchTasks.php registers the merge task for Tag displays; crmSearchTaskTagMerge.ctrl.js/.html is a new, purpose-built controller (not the generic apiBatch mechanism — merge needs to pick one selected row as the target, which apiBatch's one-call-per-row model can't express) for choosing the target tag and label.
  • Test coverage in TagTest.php covers a normal merge and the reserved-tag permission check.

Comments

Manually verified in the browser: selecting 3 tags in a Tag listing, merging into one with a new label, correctly reparents children and unions used_for.

Merging duplicate/overlapping tags was only possible through the dedicated CRM_Tag_Form_Merge popup, with no way to do it as part of a SearchKit-driven workflow (e.g. selecting several rows in a tag listing and merging them in one step).

Add Civi\Api4\Action\Tag\Merge, wrapping the existing CRM_Core_BAO_EntityTag::mergeTags() logic (which already handles child reparenting, used_for union, and de-duping entity-tag rows) behind a proper API4 action that accepts a target tag plus a list of tags to merge into it, with an optional new label for the result. Reserved tags require the "administer reserved tags" permission to merge, mirroring the existing form's behavior.

Register a "Merge Tags" bulk task in SearchKit's GetSearchTasks for any Tag-backed SearchDisplay with update+delete actions and 2+ rows selected, with a new Angular controller/template for picking the merge target and an optional new label.
@civibot

civibot Bot commented Aug 17, 2026

Copy link
Copy Markdown

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
PR commands & links...
  • /rebase <branch-name> will rebase your branch and change the base of the PR.
  • /squash will combine all commits (keeping only the first commit messsage).
  • /port <branch-name> will create a copy of this PR against a different branch.
  • /lintroll will automatically fix linting errors, amending commits as needed.
  • retest this please will rerun the tests and rebuild the demo site.
  • 📖 Review standards
  • 🗒️ Review template (brief or verbose)

➡️ Online demo of this PR 🔗

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant