Comment Block Parameters

This is a full list of available parameters for Piklist comment blocks. Not all parameters work with all Piklist parts (parts/ folders).

Action

  • Input: string
  • Returns: string

Align

How the pointer should be aligned on this edge, relative to the target.

Piklist Parts: pointers

  • Input: string
  • Returns: string
  • Values: top, bottom, left, right, middle

Anchor ID

  • Input: string
  • Returns: string

Capability

User capability that can view this group of fields. This is not the “minimum” capability, this is the actual capability. Do not include if you wish to allow all users to view. ** Do not use with “role”. Use one or the other

Piklist Parts: all

  • Input: comma-delimited
  • Returns: array
  • Default: Whatever is set in register post type
  • Examples:
Capability: edit_posts
Capability: edit_posts, edit_others_posts

Class

  • Input: comma-delimited
  • Returns: comma-delimited

Clear

When set to true, all meta-boxes that have been registered by WordPress or other plugins will be removed. This allows you to build your Workflow views exactly the way you want them.

Piklist Parts: workflows

  • Input: boolean
  • Default: false

Collapse

If set to true, this meta-box will be collapsed by default.

Piklist Parts: meta-boxes

  • Input: boolean
  • Returns: boolean
  • Default: false

Context

The part of the page where you want this group of fields to show.

Piklist Parts: meta-boxes

Example:

context: normal

Default

  • Input: boolean
  • Returns: boolean

Description

A description of this section. This field doesn’t do anything except add a description for you.

Piklist Parts: all

  • Input: string
  • Returns: string

Disable

  • Input: boolean
  • Returns: boolean

Ddge

Which edge should be adjacent to the target.

Piklist Parts: pointers

  • Input: string
  • Returns: string
  • Values: left, right, top, bottom

Editor

Add a button to the tinymce editor that will run your shortcode. The icon used is set by the icon parameter

Piklist Parts: shortcodes

  • Input: boolean
  • Default: false

Extend ID

  • Input: string
  • Returns: string

Filter

  • Input: boolean
  • Returns: boolean

Flow

  • Input: comma-delimited
  • Returns: array

Flow page

  • Input: comma-delimited
  • Returns: array
  • Input: boolean
  • Returns: boolean

Height

  • Input: numeric
  • Returns: numeric

Icon

Name of the dashicon to represent this shortcode.

Piklist Parts: shortcodes

Example:

icon: dashicons-editor-quote

ID

Display this group of fields for this object ID.

Piklist Parts: meta-boxes, terms, users, media, notices, workflows

  • Input: comma-delimited
  • Returns: array

Example:

id: 2
id: 2, 4

Inline

Display this shortcode inline.

Piklist Parts: shortcodes

  • Input: boolean
  • Default: false (block)

Example:

inline: true

Lock

Locking the meta-box stops the user from being able to drag it around the edit screen.

Piklist Parts: meta-boxes

  • Input: boolean
  • Returns: boolean
  • Default: false

Example:

lock: true

Logged in

Whether to show to logged in users or not.

Piklist Parts: all

  • Input: boolean
  • Returns: boolean
  • Default: true

Example:

logged_in: false

Message

The message to show after a successful submission of a form.

Piklist Parts: forms

  • Input: string
  • Returns: string

Example:

message: Thank you for your message. We will get back to you shortly.

Meta box

If set to false, the default box box “look” will be removed.

Piklist Parts: forms

  • Input: boolean
  • Returns: boolean
  • Default: true

Example:

Meta box: false

Method

The HTTP method used for this form.

Piklist Parts: forms

  • Input: string
  • Returns: string
  • Values: get, post
  • Default: Post

Example:

method: get

Name

The name of the part.

Piklist Parts: all

  • Input: string

Example:

name: My Shortcode
name: Theme Options

Network

Show this item in the network settings of a multisite install.

Piklist Parts: dashboard

  • Input: boolean
  • Returns: boolean

Example:

network: true

New

Show the fields in this file when creating a new term.

Piklist Parts: term

  • Input: boolean
  • Returns: boolean
  • Default: false

Example:

new: true

Notice ID

ID of an admin notice.

Piklist Parts: notices

  • Input: string
  • Returns: string

Example:

Notice ID: plugin-intro

Notice Type

ID of an admin notice.

Piklist Parts: notices

  • Input: string
  • Returns: string
  • Values: info, error, warning

Example:

Notice Type: info

Order

The sort order of this group of fields. Allows for creating an absolute order of field groups. NOTE: If the “lock” attribute is not set, or set to “false”, then the order you set is the default.

For meta-boxes, this is within the context and priority. The user can still drag and drop the meta-boxes and take them out of your designated order.

Piklist Parts: meta-boxes, terms, users, workflows, media

  • Input: numeric
  • Returns: numeric

Example:

order: 4

Page

What admin page will display this data. NOTE: To display on a settings page, use the menu_slug.

Piklist Parts: meta-boxes, terms, users, workflows, notices, media

  • Input: comma-delimited
  • Returns: array

Examples:

Page: post.php, post-new.php, post-edit.php
Page: profile.php, user-edit.php
Page: edit-tags.php, term.php
Page: my_settings_menu_slug

Pointer ID

ID of a pointer

Piklist Parts: pointers

  • Input: string
  • Returns: string

Example:

Pointer ID: plugin-settings

Position

The position of your workflow tabs

Piklist Parts: workflows

  • Input: string
  • Returns: string
  • Values: header, body, title, editor

Example:

Position: body

Post Type

The Post Type or a comma-delimited list of Post Types that will display this meta-box.

Piklist Parts: meta-boxes

  • Input: comma-delimited
  • Returns: array
  • Values: any registered post type

Example:

Post Type: post, page, custom_post_type

Preview

Show preview in the admin.

  • Input: boolean

Example:

Preview: false

Priority

The priority within the context where the boxes should show. Works with the context parameter.

Piklist Parts: meta-boxes

Example:

Priority: core

Redirect

Piklist Parts: forms

  • Input: string
  • Returns: string

Role

User role that can view this group of fields. This is not the “minimum” role, this is the actual role . Do not include if you wish to allow all users to view. ** Do not use with “capability”. Use one or the other.

Piklist Parts: all

  • Input: comma-delimited
  • Returns: array
  • Values: Any user role

Examples:

Role: administrator
Role: administrator, editor, custom-role

Setting

The setting this section belongs to, as defined when you initially register the Settings Page.

Piklist Parts: settings

  • Input: string
  • Returns: string
  • Values: Any registered setting

Examples:

Setting: my_settings

Shortcode

The name of the shortcode. Spaces are not allowed.

Piklist Parts: shortcodes

  • Input: string
  • Returns: string

Examples:

Shortcode: my_shortcode

Display the content in this file in the Help Tab Sidebar. Do not create a tab for it.

Piklist Parts: help

  • Input: boolean
  • Returns: boolean

Examples:

Sidebar: true

Slug

Available in Piklist Beta only

Display this group of fields for this object slug.

Piklist Parts: meta-boxes, terms, users, media, notices, workflows

  • Input: comma-delimited
  • Returns: array

When targeting a post, term or media item, use that items slug. When targeting a user, use their user ID.

Example:

slug: my-page
slug: my-page, my-term, my-media, a-user-id

Standalone

By default, Piklist takes all widgets created within a plugin or theme, and groups them as one widget. If you want your widget to not be part of a group, like the WordPress default, set this parameter to true.

Piklist Parts: help

  • Input: boolean
  • Returns: boolean
  • Default: false

Examples:

Standalone: true

Status

List of post statuses that will show this meta-box. Custom post statuses are allowed.

Piklist Parts: meta-boxes

  • Input: comma-delimited
  • Returns: array

Examples:

Status: my_custom_status
Status: my_custom_status, published

Sub Tab

If a Workflow and a Tab have already been defined, use this parameter to assign this field group to a sub-tab of a Tab.

Piklist Parts: meta-boxes, terms, users, settings, media

  • Input: comma-delimited
  • Returns: array

Examples:

Sub Tab: basic
Sub Tab: basic, tab one

Tab

If a Workflow has been defined, use this parameter to assign this field group to a specific Tab.

Piklist Parts: meta-boxes, terms, users, settings, media

  • Input: comma-delimited
  • Returns: array

Examples:

Tab: General
Tab: General, Advanced

Tags

  • Input: comma-delimited
  • Returns: comma-delimited

Taxonomy

The Taxonomy or a comma-delimited list of Taxonomies that will display this meta-box.

Piklist Parts: terms

  • Input: comma-delimited
  • Returns: array
  • Values: any registered taxonomy

Example:

Taxonomy: category, tag
Taxonomy: my_taxonomy

Template

The file name of the Page Template you want this meta-box to display, without “.php”. The page must be saved with this page template to work. If the file is in a directory, that directory must be included.

You must save the page before this parameter will work.

Piklist Parts: meta-boxes

  • Input: string
  • Returns: string
  • Values: any registered taxonomy

Example:

Template: my-template
Template: page-templates/my-template
Template: default

Title

Title of the section.

Piklist Parts: all

  • Input: string
  • Returns: string

Example:

Title: Theme Settings
Title: User Options

Type

  • Input: string

Width

The width of the widget UI in the admin

Piklist Parts: widgets

  • Input: numeric
  • Returns: numeric

Example:

Width: 500
Width: 720

Have ideas for improving the documentation?

This documentation is a community effort. Please create an issue or pull request to help!

Improve this page