Skip to content

Add filters for modifying plugin and theme editor documentation urls #8358

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
dontfeedthecode wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Add filters for modifying plugin and theme editor documentation urls #8358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1d07e2
Add filters for modifying plugin and theme documentation urls
dontfeedthecode Feb 20, 2025
d1ea689
Resolve WCS standards issues
dontfeedthecode Feb 20, 2025
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
15 changes: 13 additions & 2 deletions src/wp-admin/plugin-editor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,18 @@
$docs_select .= '<option value="">' . esc_html__( 'Function Name&hellip;' ) . '</option>';

foreach ( $functions as $function ) {
$docs_select .= '<option value="' . esc_attr( $function ) . '">' . esc_html( $function ) . '()</option>';

/**
* Allows the documentation URL to be filtered for the Plugin Editor.
*
* @since x
*
* @param string $function Name of the selected function.
* @param string $file Path to the file being edited.
* @param string $plugin Plugin file/directory name.
*/
$option_value = apply_filters( 'plugin_editor_documentation_url', $function, $file, $plugin );
$docs_select .= '<option value="' . esc_attr( $option_value ) . '">' . esc_html( $function ) . '()</option>';
}

$docs_select .= '</select>';
Expand Down Expand Up @@ -295,7 +306,7 @@
<div id="documentation" class="hide-if-no-js">
<label for="docs-list"><?php _e( 'Documentation:' ); ?></label>
<?php echo $docs_select; ?>
<input disabled id="docs-lookup" type="button" class="button" value="<?php esc_attr_e( 'Look Up' ); ?>" onclick="if ( '' !== jQuery('#docs-list').val() ) { window.open( 'https://api.wordpress.org/core/handbook/1.0/?function=' + escape( jQuery( '#docs-list' ).val() ) + '&amp;locale=<?php echo urlencode( get_user_locale() ); ?>&amp;version=<?php echo urlencode( get_bloginfo( 'version' ) ); ?>&amp;redirect=true'); }" />
<input disabled id="docs-lookup" type="button" class="button" value="<?php esc_attr_e( 'Look Up' ); ?>" onclick="(() => { const v = jQuery('#docs-list').val(); if (!v) return; let url; if (v.startsWith('http://') || v.startsWith('https://')) { url = v; } else { try { new URL(v); url = v; } catch { url = `https://api.wordpress.org/core/handbook/1.0/?function=${escape(v)}&locale=<?php echo urlencode( get_user_locale() ); ?>&version=<?php echo urlencode( get_bloginfo( 'version' ) ); ?>&redirect=true`; } } window.open(url); })()" />
</div>
<?php endif; ?>

Expand Down
16 changes: 14 additions & 2 deletions src/wp-admin/theme-editor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,19 @@
$docs_select .= '<option value="">' . esc_html__( 'Function Name&hellip;' ) . '</option>';

foreach ( $functions as $function ) {
$docs_select .= '<option value="' . esc_attr( $function ) . '">' . esc_html( $function ) . '()</option>';

/**
* Allows the documentation URL to be filtered for the Theme Editor.
*
* @since x
*
* @param string $function Name of the selected function.
* @param string $file Path to the file being edited.
* @param string $theme Directory name of the theme being edited.
*/
$option_value = apply_filters( 'theme_editor_documentation_url', $function, $file, $theme->get_stylesheet() );

$docs_select .= '<option value="' . esc_attr( $option_value ) . '">' . esc_html( $function ) . '()</option>';
}

$docs_select .= '</select>';
Expand Down Expand Up @@ -324,7 +336,7 @@
<div id="documentation" class="hide-if-no-js">
<label for="docs-list"><?php _e( 'Documentation:' ); ?></label>
<?php echo $docs_select; ?>
<input disabled id="docs-lookup" type="button" class="button" value="<?php esc_attr_e( 'Look Up' ); ?>" onclick="if ( '' !== jQuery('#docs-list').val() ) { window.open( 'https://api.wordpress.org/core/handbook/1.0/?function=' + escape( jQuery( '#docs-list' ).val() ) + '&amp;locale=<?php echo urlencode( get_user_locale() ); ?>&amp;version=<?php echo urlencode( get_bloginfo( 'version' ) ); ?>&amp;redirect=true'); }" />
<input disabled id="docs-lookup" type="button" class="button" value="<?php esc_attr_e( 'Look Up' ); ?>" onclick="(() => { const v = jQuery('#docs-list').val(); if (!v) return; let url; if (v.startsWith('http://') || v.startsWith('https://')) { url = v; } else { try { new URL(v); url = v; } catch { url = `https://api.wordpress.org/core/handbook/1.0/?function=${escape(v)}&locale=<?php echo urlencode( get_user_locale() ); ?>&version=<?php echo urlencode( get_bloginfo( 'version' ) ); ?>&redirect=true`; } } window.open(url); })()" />
</div>
<?php endif; ?>

Expand Down
Loading