Using the User & Blog Settings (UBS) plugin allows Broadcast to be customized depending on things like which blog the user is on, which user is active, which post type is being broadcasted, etc.
Correctly configured, the plugin can do things like:
- Force broadcasting to blogs
- Hide the Broadcast meta box in the post editor
- Hide the Broadcast column in the post overview
- Hide post bulk actions
- Automatically select or unselect checkboxes in the meta box
The above can be done to:
- All users
- Specific users
- All users except…
- On all blogs
- Specific blogs
- All blogs except…
Repeat the above for:
Introducing the plugin
The plugin consists of two parts: modifications and criteria.
The modifications describe what is to be done to Broadcast, either Broadcast itself or the Broadcast meta box in the post editor. A modification can do things like hide the Broadcast column in the post overview or force broadcasting to various blogs in the network.
Criteria are attached to modifications and decide when the modification is to be applied. Criteria can react to users, blogs, post types, user roles, etc.
A modification is something that is done to either Broadcast itself or the Broadcast meta box when editing a post.
Modifications to Broadcast itself allow the admin to:
- hide the Broadcast column in the post overview
- hide the Broadcast menu for all users except super admins
- hide the Broadcast meta box
Below those special options are modifications to whatever inputs UBS finds in the meta box. Each input will have its own modification setting. The settings vary from leaving the input alone to forcing it on and then hiding it.
Actions vary per type of input. For checkboxes:
- Leave it alone does nothing.
- Leave it alone and hide it will do nothing but also hide the input using HTML.
- On will check it, but user can uncheck it.
- Force on will check it and not allow the user to uncheck it.
- Force on and hide will check and hide the input using HTML.
- Off will uncheck it, but still allow the user to check it.
- Force off will uncheck it and not allow the user to check it.
- Force off and hide will uncheck and hide the input using HTML.
The modifications are run
- When loading the admin page (in the case of the special options to decide whether to hide Broadcast from use)
- When editing a post, before displaying the meta box
- After the publish button is pressed, in order to force the checkboxes on and off.
When deciding which modifications to apply, criteria are used.
A criterion is something that Broadcast looks for to help decide whether to apply a modification or not.
A modification can have one or more criteria. The criteria can used together (operator: and) or by themselves (operator: or). If there are two and criterion, both must match before the modification is applied. If there are two or criterion, either must match before the modification is applied.
Note that some combinations make no sense: one and operator for a user criterion and one or criterion that matches all blogs will make the modification always apply. To help you figure out how your criteria are [not] matching, enable Broadcast debug mode.
The standard options common to all criteria are the operator and the invert input, which makes the criterion do the opposite.
Example: You want to match Blog1 and Blog2. Just select those blogs in the select box.
Example:You want to match all blogs, including Blog3, except Blog1 and Blog2. Do as the above, select Blog1 and Blog2, but use the invert option. The criterion will first check that the blog is in the list. If we are on Blog3 the criterion will miss, since only Blog1 and Blog2 are selected – but with the invert option selected the criterion will match.
- Custom fields
- Post types
- Post taxonomy terms (specific categories or tags)
- User roles
Apply when the existing post has certain custom fields set.
The custom fields are inputted as a name and value pair, one pair per line.
To enable this criterion when the post contains the custom field _wp_page_template, and has the exact value product_template, just input
on a line. You can also use regexps:
This is a special criterion, still in the beta stage, that only applies the modification if no other modifications are applicable.
After going through all the modifications, and none are applicable, then all the modifications with fallback criteria are applied.
Note that this functionality is subject to change in the future.
Apply for specific post types.
Apply when a post that is being broadcasted has one or all of the specified taxonomy terms.
Apply for specific user roles.
To get an overview of all of the modified settings, of all modifications, use the summary view.