I made a commit (r4485) that has far-reaching implications that
shouldn't really affect anyone, but I wanted people to know of and take
advantage of the change, if they can.
If you've written a plugin, you're probably aware of writing a set of these:
public function filter_plugin_config( $actions, $plugin_id )
{
if ( $plugin_id == $this->plugin_id() ){
$actions[] = _t( 'Configure' );
}
return $actions;
}
public function action_plugin_ui( $plugin_id, $action )
{
if ( $plugin_id == $this->plugin_id() ){
switch ( $action ){
case 'Configure' :
$ui = new FormUI();
$ui->out();
break;
}
}
}
In each of these, the plugin needs to check if the UI being configured
or displayed is the plugin itself. This allowed plugins to add UI to
other plugins, but is very rarely used.
I made a commit tonight that alters this behavior.
By default, both of these methods will execute only for the plugin that
they affect. Said a different way, the if() statements in the two
functions above will ALWAYS evalutate to true because Habari will not
call those methods on the plugin unless that is the case.
If you still want to add UI for other plugins, you may do so at the
hooks filter_plugin_config_any and action_plugin_ui_any. Those two are
called for every plugin.
The parameters for both of these have not changed -- the $plugin_id
value is still passed into the method. The net result is that most
existing plugins should do exactly the same thing they've been doing all
along.
An additional change is one that is related to something that Habari has
done all along that people should have been taking more advantage of
than they do.
When you return the array from filter_plugin_config(), the keys of the
array are used as the $action value when calling action_plugin_ui(). If
you do not provide a key, then the value is used as the $action. In
either case, the value is used in the display of the plugin's
configuration button.
If you are properly translating your plugins, you should have been doing
something like this:
public function filter_plugin_config( $actions, $plugin_id )
{
if ( $plugin_id == $this->plugin_id() ){
$actions['configure'] = _t( 'Configure' );
}
return $actions;
}
This causes the $action value passed to action_plugin_ui to be
'configure', regardless of what 'Configure' translates to. I've seen
code inside action_plugin_ui that puts a _t() in the switch. Don't do
this! Use the key instead.
Along those lines, it is now possible to name functions using the key of
the action array that respond to those calls in addition to
action_plugin_ui. For example, the following function will do the same
thing as the action_plugin_ui() shown above, but only for the
'configure' option:
public function action_plugin_ui_configure( $plugin_id, $action )
{
if ( $plugin_id == $this->plugin_id() ){
$ui = new FormUI();
$ui->out();
break;
}
}
This is much more elegant than writing a switch() with cases for each
menu option, although that method still works if there's some specific
need to do it (like in the case where you dynamically generate the keys,
for example, the podcast plugin).
All that said, using this recent commit, you can reduce the plugin
configuration UI code I wrote at the beginning of this message to just this:
public function filter_plugin_config( $actions, $plugin_id )
{
$actions['configure'] = _t( 'Configure' );
return $actions;
}
public function action_plugin_ui_configure()
{
$ui = new FormUI();
$ui->out();
}
This reads a lot better, is less effort to write, and generally seems to
be more what people expect when writing the code.
Obviously, the configure() method shortcut still works, and maps only to
the current plugin (as it should, and has been).
There should be no impact on existing plugins, at least as far as I am
aware, because there are currently no plugins that affect the menus or
UI's of other plugins in this way.
If you have any questions, problems, or concerns, please voice them in
this thread.
Thanks,
Owen
--
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at http://groups.google.com/group/habari-dev
