Feature request: `get_current_admin_url()` and `get_current_admin_hook()`

[Denis-de-Bernardy]

It would be sweet if to be able to get the current page's url using some kind of API. And its hook, for that matter. For instance:

    public function get_current_admin_page_url()
    {
        if (!is_admin()) {
            return false;
        }

        global $pagenow;
        global $typenow;
        global $taxnow;
        global $plugin_page;

        $url = $pagenow;
        if (!empty($plugin_page)) {
            $url .= '?page='.$plugin_page;
        }
        elseif (!empty($typenow)) {
            $url .= '?post_type='.$typenow;
        }
        elseif (!empty($taxnow)) {
            $url .= '?taxonomy='.$taxnow;
        }

        return $url;
    }

And something similar for get_current_admin_hook().

[jdgrimes]

Somewhat related: #27737

[rockwell15]

I could be misunderstanding, but doesn't global $hook_suffix cover the page's hook?

[mrahmadawais]

Replying to swissspidy:

I am up for it. Could you tell me where would it go? Inside pluggable.php ?

[swissspidy]

Replying to mrahmadawais:

Replying to swissspidy:

I am up for it. Could you tell me where would it go? Inside pluggable.php ?

pluggable.php is only for "pluggable" functions (wrapped in if ( ! function_exists( ... ) ) blocks), which is considered a bad practice.

I'm not that familiar with the file structure inside wp-admin, but I'd put it inside wp-admin/includes/misc.php for now.

Note: Not wp-includes, because the suggested functions are only needed in the admin.

[mrahmadawais]

Replying to swissspidy:

Replying to mrahmadawais:

Replying to swissspidy:

Got it, will contribute a patch at the weekend.

[brgweb]

@mrahmadawais are you working on it?

[mwtsn]

Patch to add a get_current_admin_page_url() function into wp-admin/includes/misc.php. This is my first patch, so be gentle with me when feeding back.

[mwtsn]

Patch to add a get_current_admin_hookl() function into wp-admin/includes/misc.php. This is only my second patch, so feedback appreciated.

[mwtsn]

I should note that 27888.2.diff contains both patches, including the one from 27888.diff.

[jorbin]

What are the use cases for these functions?

[PerS]

@jorbin, sample use case: I borrowed this function and use it in admin bar menu, allowing me to return to the page I was on when returning from the customizer, eg:

<?php
function add_admin_bar_customizer_url( $wp_admin_bar ) {
        global $post;
        $return_url = ( is_admin() ) ? $this->_get_current_admin_page_url() :  get_permalink( $post->ID );

        $args = array(
                'id' => 'plugin-customizer-link',
                'title' => __( 'Plugin Customizer', 'plugin-customizer' ),
                'href' => $this->_get_customizer_url( $return_url, 'plugin_settings_panel' ),
        );

        $wp_admin_bar->add_node( $args );
}

[sudar]

@mwtsn

Thanks for the patch.

I have enhanced your patch by adding phpdoc blocks to the functions.

Also I am wondering if we really need get_current_admin_hook, since right now it is just a wrapper to current_filter function.

[lucatume]

Hi there,

I've created a patch that adds tests to cover the two new functions, let me know if it helps. The patch only applies to the the tests/phpunit/tests/admin/includeMisc.php file.

[lucatume]

27888.4.patch (tests)

[lucatume]

Adding a further patch that refactors the previously existing tests to use data providers, again this patch will only apply to the tests/phpunit/tests/admin/includeMisc.php file.

[lucatume]

27888.5.patch (tests refinement)

[DrewAPicture]

Assigning ownership to mark the good-first-bug as "claimed".

Trac ticket: https://core.trac.wordpress.org/ticket/27888
Patch Refresh for: https://core.trac.wordpress.org/attachment/ticket/27888/27888.3.patch

[ozgursar]

Test Report

Description

This report validates whether the indicated patch works as expected.

Patch tested: ​https://github.com/WordPress/wordpress-develop/pull/8266

Environment

• WordPress: 7.0-alpha-61215-src
• PHP: 8.2.29
• Server: nginx/1.29.4
• Database: mysqli (Server: 8.4.7 / Client: mysqlnd 8.2.29)
• Browser: Chrome 143.0.0.0
• OS: macOS
• Theme: Twenty Twenty-One 2.7
• MU Plugins: None activated
• Plugins:
  • Code Snippets 3.9.4
  • Test Reports 1.2.1

Steps to Reproduce

1. Using Code Snippets plugin or to the functions.php of the theme add the following snippet to view the current admin page url and admin hook

// Add to admin bar
add_action( 'admin_bar_menu', function( $wp_admin_bar ) {
    if ( ! is_admin() ) {
        return;
    }

    $current_url = get_current_admin_page_url();
    $current_hook = get_current_admin_hook();

    // Parent menu item
    $wp_admin_bar->add_node( array(
        'id'    => 'debug-info',
        'title' => '🔍 Debug Info',
        'href'  => '#',
    ) );

    // Current page URL
    $wp_admin_bar->add_node( array(
        'parent' => 'debug-info',
        'id'     => 'current-page-url',
        'title'  => '<strong>Page URL:</strong> ' . esc_html( $current_url ),
        'href'   => '#',
    ) );

    // Current hook
    $wp_admin_bar->add_node( array(
        'parent' => 'debug-info',
        'id'     => 'current-hook',
        'title'  => '<strong>Hook:</strong> ' . esc_html( $current_hook ),
        'href'   => '#',
    ) );
}, 100 );

// Add some styling to make it more visible
add_action( 'admin_head', function() {
    ?>
    <style>
        #wp-admin-bar-debug-info > .ab-item {
            background: #2271b1 !important;
            color: white !important;
        }
        #wp-admin-bar-current-page-url .ab-item,
        #wp-admin-bar-current-hook .ab-item {
            font-family: monospace;
            font-size: 12px;
        }
    </style>
    <?php
} );

Actual Results

1. ✅ get_current_admin_page_url() and get_current_admin_hook() return the expected output.

Additional Notes

• I had to write the PHP code above to be able to test the functionality as no specific use case was provided for the test.

Supplemental Artifacts

Video:
​https://files.catbox.moe/q87hhq.mp4