{"id":931,"date":"2008-08-21T19:39:48","date_gmt":"2008-08-21T17:39:48","guid":{"rendered":"http:\/\/planetozh.com\/blog\/?page_id=931"},"modified":"2010-10-21T21:26:21","modified_gmt":"2010-10-21T19:26:21","slug":"api-for-plugin-coders","status":"publish","type":"page","link":"https:\/\/planetozh.com\/blog\/my-projects\/wordpress-admin-menu-drop-down-css\/api-for-plugin-coders\/","title":{"rendered":"API for Plugin Coders"},"content":{"rendered":"

The wonderful Admin Drop Down Menu<\/a> comes with a cool set of hooks that will allow plugin coders to hack everything to death.<\/p>\n

Add you own plugin icon<\/h2>\n

All the plugin have, by default, a cute green plugin icon. But your<\/b> plugin is special, right? It deserves its own icon!<\/p>\n

\"\"<\/p>\n

Your plugin will need the following :<\/p>\n

\n\n\t\t
\n\n\t\t
\n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
php<\/div>\n\n\t\t\n\t\t
\n\n\t<\/div>\n\t\n\t
\n\t\t
  1. \/\/ Add a page like usual<\/span><\/div><\/li>\n
  2. add_options_page(<\/span>'My Plugin Settings'<\/span>,<\/span> 'My Plugin'<\/span>,<\/span> 10<\/span>,<\/span> 'myplugin'<\/span>,<\/span> 'myplugin_do_admin_page'<\/span>)<\/span>;<\/span><\/div><\/li>\n
  3.  <\/div><\/li>\n
  4. \/\/ Add a cool icon<\/span><\/div><\/li>\n
  5. add_filter(<\/span> 'ozh_adminmenu_icon_myplugin'<\/span>,<\/span> 'myplugin_icon'<\/span>)<\/span>;<\/span><\/div><\/li>\n
  6. function<\/span> myplugin_icon(<\/span>)<\/span> {<\/span><\/div><\/li>\n
  7.     return<\/span> 'http:\/\/path\/to\/icon.png'<\/span>;<\/span><\/div><\/li>\n
  8. }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

    And that's all. The trick is simply to hook into ozh_adminmenu_icon_[your_plugin]<\/tt>.<\/p>\n

    Modify the menu itself<\/h2>\n

    Third party plugins can modify the menu or its entries, with the help of the almighty add_filter() function. Note: I'm not providing any help on this, as it implies you know what you're doing, how you'll do it, and why you need to do it.<\/p>\n

    The main function of the plugin is wp_ozh_adminmenu()<\/tt> which builds a new $ozh_menu<\/tt> from WordPress' $menu<\/tt> and $submenu<\/tt>.<\/p>\n

    If your plugin needs to modify menu entries, you'll find in wp_ozh_adminmenu()<\/tt> various filters to do so, this means you'll write stuff like:<\/p>\n

    \n\n\t\t
    \n\n\t\t
    \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
    php<\/div>\n\n\t\t\n\t\t
    \n\n\t<\/div>\n\t\n\t
    \n\t\t
    1. add_filter(<\/span> 'pre_ozh_adminmenu_menu'<\/span>,<\/span> 'myplugin_modify'<\/span> )<\/span>;<\/span><\/div><\/li>\n
    2. add_filter(<\/span> 'pre_ozh_adminmenu_submenu'<\/span>,<\/span> 'myplugin_hack'<\/span> )<\/span>;<\/span><\/div><\/li>\n
    3. add_filter(<\/span> 'pre_ozh_adminmenu_ozh_menu'<\/span>,<\/span> 'myplugin_break'<\/span> )<\/span>;<\/span><\/div><\/li>\n
    4. add_filter(<\/span> 'post_ozh_adminmenu_ozh_menu'<\/span>,<\/span> 'myplugin_scramble'<\/span> )<\/span>;<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

      Read the source of wp_ozh_adminmenu()<\/tt>, add various debugging print_r()<\/tt> everywhere and you'll manage your way :)<\/p>\n","protected":false},"excerpt":{"rendered":"

      The wonderful Admin Drop Down Menu comes with a cool set of hooks that will allow plugin coders to hack everything to death. Add you own plugin icon All the plugin have, by default, a cute green plugin icon. But your plugin is special, right? It deserves its own icon! Your plugin will need the […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":450,"menu_order":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-931","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/pages\/931","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/comments?post=931"}],"version-history":[{"count":0,"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/pages\/931\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/pages\/450"}],"wp:attachment":[{"href":"https:\/\/planetozh.com\/blog\/wp-json\/wp\/v2\/media?parent=931"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}