PluginHooks:StartShowLocalNavBlock

From StatusNet
Jump to: navigation, search

Contents

[edit] Description

Called before local nav block starts rendering. Local nav block is the list block that contains the listing of various views available for the current user. eg. Public, Groups, Recent tags, Popular

This hook can be used to put additional HTML before the local nav block.

Tip: If you are looking to manipulate/add to the local nav block itself, see StartPublicGroupNav, 
EndPublicGroupNav, StartSubGroupNav and EndSubGroupNav

[edit] Arguments

$action: instance of PublicAction class.

See the article on $action a listing of methods.

[edit] Related Code

File: /lib/action.php
Class: Action (An extension of HTMLOutputter class, pretty much the V in MVC)
Code: mainline

[edit] Example

class ExamplePlugin extends Plugin {
    onStartShowLocalNavBlock($action) {
        $action->startElement('div',array('id'=>'notification'));
        $action->raw('This plugin is under construction.');
        $action->endElement('div');
          // Puts a notification about this plugin being under construction
    }
}
Personal tools
Namespaces
Variants
Actions
Navigation
Status.net
Toolbox