remove-label macro

Overview

Use the remove-label macro to remove a content label – either the current page or blog post, or the immediate child pages.

Where to use it?

Optional.

One or more remove-label macros can be put in a trigger macro.

Parameters

Parameter

Required

Default

Notes

Parameter

Required

Default

Notes

unnamed first parameter
or label



Name of label to remove:

children



false

What should the label be removed from?

  • true – all immediate children of the page, but not the page itself

  • false – the page or blog post itself

Only works for pages, not blog posts. Use with caution!

Conditions

The following conditions are applicable to label events

  • haslabel

  • parenthaslabel

The stickylabels parameter on a workflow limits the users who can remove a defined label(s) on a page to those users with admin permission. If the workflow includes a trigger action to remove a label defined by the stickylabels parameter, the label will only be removed when the workflow event the trigger was listening for is actioned by a user with appropriate admin permission.

Events

The following events are generated by this macro

  • labelremoved

Example

{workflow:Labelled} {state:Editing|submit=Review} {state} {state:Review|rejected=Editing|approved=Review} {approval:Review} {state} {trigger:pagerejected|approval=Review} {remove-label:being-reviewed} {trigger} {workflow}

All examples

See also

Workflow Authoring Guide: