Add CSS to Specific Admin Options Page

[chipbennett]

Currently, I am using the following hook to add CSS for a plugin options page:

 add_action('admin_head', array(&$this, 'cbnetmyplugin_css')); 
  

(The function, of course, then holds the added CSS.)

But, what if I want to target my own plugin options page, specifically? How can I do that?

Say, for instance, the URL for my options page is:

 /wordpress/wp-admin/options-general.php?page=cbnet-my-plugin-name 
  

I would like to add an if statement, like such:

 $mypluginoptionpageslug = 'cbnet-my-plugin-name';
$adminurl = foo; //what goes here?
$ismypluginoptionpage = ( strpos($adminurl,$mypluginoptionpageslug) !== false ? 'true' : 'false' );
 
if ( $ismypluginoptionpage == 'true' ) {
     add_action('admin_head', array(&$this, 'cbnetmyplugin_css'));
} 
  

So the question is, what goes in "foo":

 $adminurl = foo; //what goes here? 
  

That would give me the current URL, or other way of identifying which option page I'm currently on?

[Utkarsh]

Try

 $_SERVER['REQUEST_URI'] 
  

or

 $_SERVER['QUERY_STRING'] 
  

One of them should work.

Or maybe you could do a $_GET['page'] === 'cbnet-my-plugin-name' ?

[Otto]

If statements are lame. Use conditional hooks instead.

First, use get_plugin_page_hook to find out what your page's "hook" is. You can do this like so:

 $hook = get_plugin_page_hook('cbnet-my-plugin-name', 'options-general.php'); 
  

Then you add an action using that hook value:

 add_action("admin_head-{$hook}", whatever); 
  

Voila.

This needs to happen after you've called "add_options_page", otherwise your hook won't exist yet.

Note, the add_options_page call also returns the $hook. So you can do it right then and there if you want, like so:

 $hook = add_options_page(...);
add_action("admin_head-{$hook}", whatever); 
  

[andreasnrb]

This method is much better =).

 $page=add_*_page(...);// *=options,menu,submenu
add_action("admin_print_styles-$page", .... );
add_action("admin_print_scripts-$page", ... ); 
  

[EDIT]
Missed you wanted to add plain CSS. Use Ottos add_action("admin_head-{$page}", whatever);
Hook: admin head

[chipbennett]

Try

 $_SERVER['REQUEST_URI'] 
  

or

 $_SERVER['QUERY_STRING'] 
  

One of them should work.

Or maybe you could do a $_GET['page'] === 'cbnet-my-plugin-name' ?

What about:

 __FILE__ 
  

or

 $_SERVER['PHP_SELF'] 
  

With respect to pulling out my plugin options page slug from the URI, what are the practical differences among these variables?

[chipbennett]

If statements are lame. Use conditional hooks instead.

First, use get_plugin_page_hook to find out what your page's "hook" is. You can do this like so:

 $hook = get_plugin_page_hook('cbnet-my-plugin-name', 'options-general.php'); 
  

Then you add an action using that hook value:

 add_action("admin_head-{$hook}", whatever); 
  

Voila.

This needs to happen after you've called "add_options_page", otherwise your hook won't exist yet.

Note, the add_options_page call also returns the $hook. So you can do it right then and there if you want, like so:

 $hook = add_options_page(...);
add_action("admin_head-{$hook}", whatever); 
  

And these answers are why I ask the questions: to learn how to advance my PHP skills from lame to not-so-lame. :)

[andreasnrb]

adambrown has excellent hook database and wpseek is also good.

[chipbennett]

adambrown has excellent hook database and wpseek is also good.

I love WPSeek!

[Otto]

Few other tips in this area:

- Adding your options page should happen on the "admin_menu" action hook.

- If you want to reduce overhead for adding actions and such, hook your admin page setup function into the "load-{$hook}" action. You can also hook to just the "{$hook}" action. load-hook happens before the admin-header, the plain $hook happens afterwards.

- "admin_head-{$hook}" happens in the admin header itself. But the admin_print_styles-{$hook} and admin_print_scripts-{$hook} also both happen at the same time as the admin_head one. Ideally you would use the print styles/scripts hooks for printing CSS/Javascripts, respectively. In practice, it rarely makes a hell of a lot of difference. Still, it's good to have things in their proper places.

- Need to do stuff in the admin footer? You've got admin_footer, admin_print_footer_scripts, and admin_footer-{$hook}.

- Need to enqueue some special scripts? admin_enqueue_scripts is an action which has the $hook as the first parameter. You can use it like so:

  add_action('admin_enqueue_scripts','func');
function func($hook) {
if ($hook == "hook I'm expecting") {
// enqueue stuff
}
} 
  

[chipbennett]

Few other tips in this area:

- Adding your options page should happen on the "admin_menu" action hook.

- If you want to reduce overhead for adding actions and such, hook your admin page setup function into the "load-{$hook}" action. You can also hook to just the "{$hook}" action. load-hook happens before the admin-header, the plain $hook happens afterwards.

- "admin_head-{$hook}" happens in the admin header itself. But the admin_print_styles-{$hook} and admin_print_scripts-{$hook} also both happen at the same time as the admin_head one. Ideally you would use the print styles/scripts hooks for printing CSS/Javascripts, respectively. In practice, it rarely makes a hell of a lot of difference. Still, it's good to have things in their proper places.

- Need to do stuff in the admin footer? You've got admin_footer, admin_print_footer_scripts, and admin_footer-{$hook}.

- Need to enqueue some special scripts? admin_enqueue_scripts is an action which has the $hook as the first parameter. You can use it like so:

  add_action('admin_enqueue_scripts','func');
function func($hook) {
if ($hook == "hook I'm expecting") {
// enqueue stuff
}
} 
  

Have you ever thought of updating the related Codex articles? This is good stuff!