Based on my comment at #610234-83: Overlay implementation where these hooks were introduced:

The confusion is that there are several different ways Drupal categorizes pages as "admin" or not - e.g. deciding what pages the administrative theme applies to under regular conditions is (and must be) different than what the overlay uses. But, if we clarify that this hook is not really supposed to be about putting pages in definitive administrative vs non-administrative bins, but rather about tagging any page that has a little bit of "administrative-ness" to it, maybe it's OK.

The module upgrade docs that I just wrote at http://drupal.org/node/224333#hook_admin_paths already begin to explain the hooks in that way, but we should do so for the inline API docs of:

http://api.drupal.org/api/function/hook_admin_paths/7
http://api.drupal.org/api/function/hook_admin_paths_alter/7
http://api.drupal.org/api/function/path_is_admin/7
http://api.drupal.org/api/function/path_get_admin_paths/7

Comments

David_Rothstein’s picture

David_Rothstein CreditAttribution: David_Rothstein commented
Component: base system » documentation

Probably this was in the wrong queue.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

I'm not sure that these functions/hooks are actually working correctly, besides the fact that they may need more documentation. I'm confused about them, so I'm sure the doc is not very good. :)

David: Do you plan to fix the docs?

David_Rothstein’s picture

David_Rothstein CreditAttribution: David_Rothstein commented

Possibly... although might want to wait and see what happens at #669510: Merge administration theme with hook_admin_paths() before trying.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

Sounds like a plan...

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Active » Closed (works as designed)

I believe that the documentation on these hooks is consistent with the result of that other issue, so I'm closing this. Feel free to reopen (for Drupal 8) if I'm wrong.