Title: feature-plugin-dependencies | Make WordPress Core

---

#  Tag Archives: feature-plugin-dependencies

 [  ](https://profiles.wordpress.org/costdev/) [Colin Stewart](https://profiles.wordpress.org/costdev/)
9:55 am _on_ February 15, 2024     
Tags: [6-5 ( 76 )](https://make.wordpress.org/core/tag/6-5/),
[core-upgrade-install ( 2 )](https://make.wordpress.org/core/tag/core-upgrade-install/),
[feature plugins ( 122 )](https://make.wordpress.org/core/tag/feature-plugins/),
[feature projects ( 52 )](https://make.wordpress.org/core/tag/feature-projects/),
feature-plugin-dependencies, [merge-proposals ( 8 )](https://make.wordpress.org/core/tag/merge-proposals/)

# 󠀁[Merge Announcement: Plugin Dependencies](https://make.wordpress.org/core/2024/02/15/merge-announcement-plugin-dependencies/)󠁿

_Note: This post was updated to add the “Third-party plugins not hosted on WordPress.
orgWordPress.org The community site where WordPress code is created and shared by
the users. This is where you can download the source code for WordPress core, plugins
and themes as well as the central location for community conversations and organization.
[https://wordpress.org/](https://wordpress.org/)” section. 15th February, 2024 –
[@costdev](https://profiles.wordpress.org/costdev/)_

View the [kickoff post](https://make.wordpress.org/core/2022/02/24/feature-project-plugin-dependencies/),
the [Trac ticket](https://core.trac.wordpress.org/ticket/22316) and the [feature plugin](https://wordpress.org/plugins/wp-plugin-dependencies/)
for PluginPlugin A plugin is a piece of software containing a group of functions
that can be added to a WordPress website. They can extend functionality or add new
features to your WordPress websites. WordPress plugins are written in the PHP programming
language and integrate seamlessly with WordPress. These can be free in the WordPress.
org Plugin Directory [https://wordpress.org/plugins/](https://wordpress.org/plugins/)
or can be cost-based plugin from a third-party. Dependencies.

## Purpose & Goals

Extensibility of WordPress through plugins and the HooksHooks In WordPress theme
and development, hooks are functions that can be applied to an action or a Filter
in WordPress. Actions are functions performed when a certain event occurs in WordPress.
Filters allow you to modify certain functions. Arguments used to hook both filters
and actions look the same. APIAPI An API or Application Programming Interface is
a software intermediary that allows programs to interact with each other and share
data in limited, clearly defined ways. is one of its most beneficial features. There
are many plugins that act purely as extensions of others, building functionality
on top. The Plugin Dependencies feature aims to make the process of installing/activating
addons (dependents) and the plugins they rely on (dependencies) consistent and easy
to use.

Plugin authors are currently implementing their own ways of informing users about
other plugins that they depend on. The implementations are inconsistent and sometimes
incomplete. Users are often left to search for and install the other required plugins
themselves.

The feature does not intend to replace the need for defensive coding within dependent
plugins, or ensure version compatibility with their dependencies; nor does it seek
to mitigate the vast array of potential plugin interactions. For WordPress and/or
PHPPHP The web scripting language in which WordPress is primarily architected. WordPress
requires PHP 7.4 or higher incompatibilities, CoreCore Core is the set of software
required to run WordPress. The Core Development Team builds WordPress. already has
handling for preventing installing, updating, or activating plugins with unmet requirements.

## Implementation Details

A plugin’s dependencies can be declared by the use of a new `Requires Plugins` headerHeader
The header of your site is typically the first thing people will experience. The
masthead or header art located across the top of your page is part of the look and
feel of your website. It can influence a visitor’s opinion about your content and
you/ your organization’s brand. It may also look different on different screen sizes.
in the dependent plugin’s main file. This must contain a comma-separated list of
WordPress.org slugs for its dependencies, such as `jetpack` (`jetpack/jetpack.php`
is not supported). It does not support commas in plugin slugs.

**Example**

    ```wp-block-code
    /** * Plugin Name: Bridge for Foo and Bar * Requires Plugins: foo, bar */
    ```

Version management support, such as providing specific minimum and maximum version
numbers through the `Requires Plugins` header value, is not currently supported.

### Requirements

Declaring a plugin dependency places the following requirements:

 1. **Bridge for Foo and Bar** can only be installed once **Foo** and **Bar** have 
    been installed.
 2. **Bridge for Foo and Bar** can only be activated once **Foo** and **Bar** have 
    been activated.
 3. **Foo** and **Bar** can only be deactivated once **Bridge for Foo and Bar** has
    been deactivated.
 4. **Foo** and **Bar** can only be deleted once **Bridge for Foo and Bar** has been
    deleted.

### Viewing, installing and activating dependencies

In the **Plugins > Add New** screen, dependencies are listed in the dependent’s 
plugin card. Next to these is a _View Details_ link to open a dependency’s information
modal. The dependency can be installed and activated using the buttons in the modal’s
footer.

Previously, the modal would close upon clicking the _Install Now_ or _Activate_ 
button. The feature makes the modal persistent, and the buttons used in the plugin
cards and modal now use the same underlying markup and functionality for consistency
and reduced maintenance burden.

The side effect of this shared functionality is that automatic redirection upon 
activating a plugin from **Plugins > Add New **is no longer available. This has 
the benefit of not redirecting a user away from the **Plugins > Add New** screen
for each plugin, removing them from their current context. Users can therefore install
and activate multiple plugins without leaving their current context.

For plugins with onboarding experiences, they often have additional logic in case
a plugin is installed and activated through a tool such as WP-CLIWP-CLI WP-CLI is
the Command Line Interface for WordPress, used to do administrative and development
tasks in a programmatic way. The project page is [http://wp-cli.org/](http://wp-cli.org/)
[https://make.wordpress.org/cli/](https://make.wordpress.org/cli/), so that the 
user is still presented with the onboarding experience upon navigating to a screen
deemed an appropriate starting place.

### Automatic deactivation of dependent plugins

As currently implemented, plugins with unmet dependencies are automatically deactivated.
While this was the approach suggested in initial discussions, there were valid concerns
raised about this behavior after merging into `trunk`. **These have been weighed
and discussed, and a decision was made to remove this behavior.**

### Third-party plugins not hosted on WordPress.org

Defining plugins not hosted on WordPress.org as dependencies will enforce and display
the dependencies to the user. However, there will be no ability to install the missing
plugins through the UIUI User interface changes, and these will need to be installed
manually.

## UI changes

The feature makes changes to the UI on two screens: **Plugins > Installed plugins**,
and **Plugins > Add New**.

### Design Feedback

Design feedback was requested on the ticketticket Created for both bug reports and
feature development on the bug tracker. and responses were received from [@azaozz](https://profiles.wordpress.org/azaozz/),
[@paaljoachim](https://profiles.wordpress.org/paaljoachim/) and [@karmatosed](https://profiles.wordpress.org/karmatosed/)
on [the ticket](https://core.trac.wordpress.org/ticket/22316#comment:277) and on
[the Feature Plugin repository](https://github.com/WordPress/wp-plugin-dependencies/issues).

### Plugins > Installed plugins

The following changes are made:

 1. Dependent plugin rows now contain a list of their dependencies, linked to the respective
    plugin modal to install and activate the dependency.
 2. Dependency plugin rows now contain a list of their dependents.
 3. If a plugin has dependencies that are not installed and active, the _Activate_ 
    link is disabled.
 4. If a plugin has dependents that are active, the _Deactivate_ and _Delete_ links
    are disabled.

**Before**

[⌊Plugin rows without listing any dependents or dependencies.⌉⌊Plugin rows without
listing any dependents or dependencies.⌉[

No dependents or dependencies are listed.

**After**

[⌊Plugin rows for a dependent and its two dependencies. The plugin row for a dependency
shows a list of plugins that depend on it, and a dependent's plugin row shows a 
list of plugins that it depends on. The dependent's plugin row links the names of
each dependency to a modal with buttons to install and activate the dependency.⌉⌊
Plugin rows for a dependent and its two dependencies. The plugin row for a dependency
shows a list of plugins that depend on it, and a dependent's plugin row shows a 
list of plugins that it depends on. The dependent's plugin row links the names of
each dependency to a modal with buttons to install and activate the dependency.⌉[

Dependents and dependencies are listed, and actions are enabled/disabled based on
the status of requirements.

### Plugins > Add New

The following changes are made:

 1. If a plugin has unmet dependencies, the _Install Now_ and _Activate_ buttons are
    disabled, both in their plugin card and their plugin information modal.
 2. Dependent plugin cards now contain a notice listing their dependencies, with a 
    _View Details_ link to the dependency’s information modal which contains _Install
    Now_ or _Activate_ buttons based on their current installation status.
 3. Plugin information modals are now persistent after button clicks, and modal-based
    plugin installation and activation are now performed through AJAX directly within
    the modal.

**Before**

[⌊A plugin card that does not list dependencies for the plugin, and allows installation
even if the dependencies are not installed first.⌉⌊A plugin card that does not list
dependencies for the plugin, and allows installation even if the dependencies are
not installed first.⌉[

Plugin card with no dependencies listed and an active Install Now button despite
unmet dependencies.

**After**

[⌊A plugin card with a notice containing a list of dependencies and a link to open
a modal with buttons to install and activate the dependency⌉⌊A plugin card with 
a notice containing a list of dependencies and a link to open a modal with buttons
to install and activate the dependency⌉[

Plugin card with dependencies listed with modal links to install and activate each
dependency, and the “Install Now” button disabled while dependencies are unmet.

## User Testing

The feature team released calls for testing in [October 2022](https://make.wordpress.org/core/2022/10/12/call-for-testing-plugin-dependencies/)
and [March 2023](https://make.wordpress.org/core/2023/03/28/call-for-testing-plugin-dependencies-ux/).
Additional user testing was performed during design and technical feedback with 
reports on the ticket and in the [#core-upgrade-install](https://make.wordpress.org/core/tag/core-upgrade-install/)
SlackSlack Slack is a Collaborative Group Chat Platform [https://slack.com/](https://slack.com/).
The WordPress community has its own Slack Channel at [https://make.wordpress.org/chat/](https://make.wordpress.org/chat/)
channel up to the day of commit.

### Outcomes

Based on responses to calls for testing, and design and technical feedback, the 
following UI changes were made:

 1. Adminadmin (and super admin) notices for each unmet dependency were reduced to 
    a single notice informing the user that there were plugins with unmet dependencies.
 2. A dedicated _Dependencies_ tab was removed from the **Plugins > Add New** screen
    in favour of an integrated solution in plugin rows on **Plugins > Installed plugins**
    and plugin cards on **Plugins > Add New**.
 3. The plugin row on **Plugins > Installed plugins** had a _Manage Dependencies_ action
    link removed, which linked to the removed _Dependencies_ tab.
 4. Messaging was improved to inform the user about missing dependencies.

### Security

A security review was performed by [@costdev](https://profiles.wordpress.org/costdev/)
during the development of the feature following WordPress security best practices
of escaping output, sanitizing input (slugs, _POST, etc._), verifying AJAX referrers
and using nonces where appropriate. Comparisons were also done with existing functionality
to avoid missed opportunity for hardening the feature.

### AccessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility)

The feature was reviewed by the team for accessibility concerns. In addition, [@costdev](https://profiles.wordpress.org/costdev/)
reached out to [@joedolson](https://profiles.wordpress.org/joedolson/) regarding
the use of links (`<a>`) as buttons, rather than `<button>` elements.

It was deemed that this approach, though likely not ideal, is consistent with the
patterns throughout the code base today. A wider conversation is needed before a
decision can be made about this specific  accessibility pattern at a later date.

`wp.a11y.speak()` is implemented where appropriate in JavascriptJavaScript JavaScript
or JS is an object-oriented computer programming language commonly used to create
interactive effects within web browsers. WordPress makes extensive use of JS for
a better user experience. While PHP is executed on the server, JS executes within
a user’s browser. [https://www.javascript.com](https://www.javascript.com/), consistent
with prior functionality in Core.

### Unit Tests

In addition to user testing, testing by Core developers, and the feature team, unit
tests have been written for the feature and the public API is covered. There are
plans to continue increasing test coverage during the 6.5 BetaBeta A pre-release
of software that is given out to a large group of users to trial under real conditions.
Beta versions have gone through alpha testing in-house and are generally fairly 
close in look, feel and function to the final product; however, design changes often
occur as part of the process. period.

_Props to [@afragen](https://profiles.wordpress.org/afragen/), [@pbiron](https://profiles.wordpress.org/pbiron/),
[@azaozz](https://profiles.wordpress.org/azaozz/) and [@desrosj](https://profiles.wordpress.org/desrosj/)
for peer review._

[#6-5](https://make.wordpress.org/core/tag/6-5/), [#feature-plugins](https://make.wordpress.org/core/tag/feature-plugins/),
[#feature-projects](https://make.wordpress.org/core/tag/feature-projects/), [#feature-plugin-dependencies](https://make.wordpress.org/core/tag/feature-plugin-dependencies/),
[#merge-proposals](https://make.wordpress.org/core/tag/merge-proposals/)