Pending

User tests: Successful: Unsuccessful:

avatar brianteeman
brianteeman
20 Sep 2026

Pull Request resolves #46083 .

  • I read the Generative AI policy and my contribution is either not created with the help of AI or is compatible with the policy and GNU/GPL 2 or later.

Summary of Changes

Allow component Options forms to define a custom Help URL using the url attribute of the element in the component config.xml.

The configured URL is passed to the existing Joomla Help API as the URL override, allowing third-party extensions to link directly to their own documentation instead of using the Joomla Help site.

Existing Help behaviour, including the existing helpURL component parameter and configuration, is unchanged.

Testing Instructions

  1. Install a Joomla extension that provides a component Options form and has a config.xml file.
  2. Before testing the change test the existing help button on the component options - it will fail https://help.joomla.org/proxy?keyref=Help62:&lang=en
  3. configure the extension with a Help definition containing a key for example:
    <help key="Brian_Component:_Control_Panel"/> - it will fail https://help.joomla.org/proxy?keyref=Help62:Brian_Component:_Control_Panel&lang=en
  4. Apply the pr

Modify the extension's config.xml so that the <help> element contains a key AND a URL, for example:

<help
    key="Brian_Component:_Control_Panel"
    url="https://example.com/documentation/control-panel.html"
/>
  1. Test the help button on the components option page and the url specified will open
  2. Return to the extension's Options page in the Joomla Administrator.
  3. Click the Help button.
  4. Confirm that the browser opens the URL specified in the url attribute rather than a URL on help.joomla.org.
  5. If the extension uses the existing helpURL component parameter, test its Help button as well and confirm that its behaviour has not changed.

Actual result BEFORE applying this Pull Request

The element in a component's config.xml can specify a Help key, but the url attribute is not passed to the Help API by the component Options view.

As a result, a third-party extension cannot use the element to specify its own documentation URL on the component options page. The Help button uses the configured Joomla Help URL instead, such as:

https://help.joomla.org/proxy?keyref=Help62:News_Feed:_Options&lang=en

Expected result AFTER applying this Pull Request

The url attribute of the <help> element is passed to the Joomla Help API as the URL override.

Third-party extensions can therefore specify their own documentation URL, for example:


<help
    key="Brian_Component:_Control_Panel"
    url="https://example.com/documentation/control-panel.html"
/>

Clicking Help on the component Options page opens the configured documentation URL.

Existing Help configurations that do not specify a url attribute continue to use the existing Joomla Help behaviour.

Link to documentations

I'm sure this will need to be documented but I dont know where
Please select:

  • Documentation link for guide.joomla.org:

  • No documentation changes for guide.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

avatar brianteeman brianteeman - open - 20 Sep 2026
avatar brianteeman brianteeman - change - 20 Sep 2026
Status New ⇒ Pending
avatar joomla-cms-bot joomla-cms-bot - change - 20 Sep 2026
Category ⇒ Administration com_config
avatar brianteeman brianteeman - change - 20 Sep 2026
Title
…
[6.2] Add help to component options
[6.3] Add help to component options
avatar brianteeman brianteeman - edited - 20 Sep 2026
avatar brianteeman brianteeman - change - 20 Sep 2026
The description was changed
avatar brianteeman brianteeman - edited - 20 Sep 2026
avatar brianteeman brianteeman - change - 20 Sep 2026
The description was changed
avatar brianteeman brianteeman - edited - 20 Sep 2026

Add a Comment

Login with GitHub to post a comment