OrganizeWP Docs
Hooks
OrganizeWP exposes a comprehensive set of filters so you can customize nearly every part of its behavior. All hook tags are slash-namespaced under buildworks/organizewp/.
Upgrading from a pre-2.0.5 install? These hooks were previously namespaced organizewp/… and are now buildworks/organizewp/… — update any custom code that referenced the old tags.
Admin menu
Post types
buildworks/organizewp/post_typesFilterControl the post types OrganizeWP will manage.
| Parameter | Type | Description |
|---|---|---|
$post_types |
string[] | Candidate post type names after the omit/blocklist diff. |
Returns array — post type names OrganizeWP manages (before the entry-count cap).
buildworks/organizewp/omitted_post_typesFilterControl the post types automatically excluded from OrganizeWP.
| Parameter | Type | Description |
|---|---|---|
$blocklist |
string[] | Excluded names; defaults to wp_block, wp_navigation, acf-field-group. |
Returns array — post type names to omit.
buildworks/organizewp/post_type/ignored_post_typesFilterControl which post types default to “off” — present in OrganizeWP but not shown until enabled in settings.
| Parameter | Type | Description |
|---|---|---|
$blocklist |
string[] | Defaulted-off names; defaults to forum, topic, reply, product. |
Returns array — post type names that default to hidden.
buildworks/organizewp/post_type_entry_maxFilterThe maximum number of entries a post type may have before OrganizeWP excludes it (for performance).
| Parameter | Type | Description |
|---|---|---|
$upper_limit |
int | Maximum entry count; default 1000. |
$post_type |
string | The post type name being evaluated. |
Returns int — the maximum allowed entry count.
buildworks/organizewp/post_type/current_user_can_editFilterOverride whether the current user may edit within a post type. Only reached when the core edit_posts capability check has already failed.
| Parameter | Type | Description |
|---|---|---|
$can_edit |
bool | Whether the user may edit; default false. |
$post_type |
PostType | The current PostType instance. |
$post_id |
int | The post ID being checked (default 0). |
Returns bool — whether the current user can edit within this post type.
buildworks/organizewp/post_type/argsFilterFilter the register_post_type() arguments OrganizeWP uses.
| Parameter | Type | Description |
|---|---|---|
$args |
array | The registration arguments (labels, public, supports, show_in_rest, …). |
Returns array — the post type registration arguments.
buildworks/organizewp/post_type/attributesFilterCustomize the attributes available for entries in a post type.
| Parameter | Type | Description |
|---|---|---|
$attributes |
array | PostTypeAttribute objects keyed by name (e.g. password, post_status). |
$post_type |
PostType | The current PostType instance. |
Returns array — kept items must be PostTypeAttribute instances meeting the min-version check.
buildworks/organizewp/post_type/entriesFilterCustomize a post type’s entries before OrganizeWP uses them.
| Parameter | Type | Description |
|---|---|---|
$entries |
Entry[] | Normalized Entry objects for this post type. |
$context |
array | [ 'post_type' => $post_type ]. |
Returns array — Entry objects (filtered to Entry instances).
buildworks/organizewp/entriesFilterFilter the normalized entries built from a query, across post types.
| Parameter | Type | Description |
|---|---|---|
$entries |
Entry[] | Entry objects built from the queried posts. |
Returns array — Entry objects.
buildworks/organizewp/post_type/sqlFilterInteract with the entry-retrieval query as a SQL string.
| Parameter | Type | Description |
|---|---|---|
$sql |
string | The assembled query (SELECT / FROM / JOIN / WHERE / ORDER BY / LIMIT), before $wpdb->prepare(). |
$context |
array | [ 'post_type' => $post_type, 'wp_posts_alias' => $alias ]. |
Returns string — the SQL query string.
buildworks/organizewp/post_type/sql_arrayFilterInteract with the entry-retrieval query as an array of clauses.
| Parameter | Type | Description |
|---|---|---|
$sql |
array | Clause parts keyed select, from, join, where, order_by, limit. |
$context |
array | [ 'post_type' => $post_type, 'wp_posts_alias' => $alias ]. |
Returns array — the SQL parts array.
Info Columns
buildworks/organizewp/post_type/info_columnsFilterAdd, remove, or reorder the Info Columns shown for a post type. See Info Columns.
| Parameter | Type | Description |
|---|---|---|
$columns |
array | PostTypeInfoColumn objects keyed by name (e.g. author, modified). |
$post_type |
PostType | The current PostType instance. |
Returns array — kept items must be PostTypeInfoColumn instances meeting the min-version check.
buildworks/organizewp/post_type/info_columns/authorFilterOpt the built-in Author Info Column in.
| Parameter | Type | Description |
|---|---|---|
$enabled |
bool | Whether to add the column; default false. |
$post_type |
PostType | The current PostType instance. |
Returns bool — return true to add the Author column.
buildworks/organizewp/post_type/info_columns/modifiedFilterOpt the built-in Modified Info Column in.
| Parameter | Type | Description |
|---|---|---|
$enabled |
bool | Whether to add the column; default false. |
$post_type |
PostType | The current PostType instance. |
Returns bool — return true to add the Modified column.
buildworks/organizewp/post_type/info_columns/modified/displayFilterCustomize the value displayed by the Modified Info Column.
| Parameter | Type | Description |
|---|---|---|
$time_ago |
string | The human-readable “X ago” string built from the entry’s post_modified time. |
$entry |
Entry | The entry being displayed. |
Returns string — the displayed modified-time text.
Entries & row actions
buildworks/organizewp/entry/edit_linkFilterCustomize the Edit link for an entry.
| Parameter | Type | Description |
|---|---|---|
$edit_url |
string|null | From core get_edit_post_link() (null without permission). |
$context |
array | [ 'ID' => $post_id ]. |
Returns string|null — the edit link URL.
buildworks/organizewp/entry/preview_linkFilterCustomize the preview/view link for an entry.
| Parameter | Type | Description |
|---|---|---|
$preview_link |
string | From core get_preview_post_link(). |
$context |
array | [ 'ID' => $id, 'post_type' => $post_type ]. |
Returns string — the preview link URL.
buildworks/organizewp/entry/trash_linkFilterCustomize the Trash link for an entry.
| Parameter | Type | Description |
|---|---|---|
$trash_link |
string | From get_delete_post_link(), or the permanent-delete link when the entry is already trashed. |
$context |
array | [ 'ID' => $id, 'post_type' => $post_type ]. |
Returns string — the trash (or permanent delete) link URL.
buildworks/organizewp/entry/untrash_linkFilterCustomize the Restore (untrash) link for a trashed entry.
| Parameter | Type | Description |
|---|---|---|
$untrash_link |
string|null | A nonced restore link when trashed; null otherwise. |
$context |
array | [ 'ID' => $id, 'post_type' => $post_type ]. |
Returns string|null — the restore link URL, or null.
buildworks/organizewp/entry/row_actionsFilterCustomize the row actions available for an entry.
| Parameter | Type | Description |
|---|---|---|
$actions |
array | Row-action markup strings; defaults to the result of the core post_row_actions filter. |
$context |
array | [ 'ID' => $id, 'post_type' => $post_type ]. |
Returns array — row-action HTML strings.
buildworks/organizewp/entry/authorFilterCustomize the author displayed for an entry.
| Parameter | Type | Description |
|---|---|---|
$value |
string | The author display name for the entry. |
Returns string — the author display name.
buildworks/organizewp/entry/post_dateFilterCustomize the publish date displayed for an entry.
| Parameter | Type | Description |
|---|---|---|
$value |
string | The publish date formatted with the site date format. |
Returns string — the formatted publish date.
Entry Panel
buildworks/organizewp/entry_panel/panesFilterAdd, remove, or reorder Entry Panel Panes. See Entry Panel.
| Parameter | Type | Description |
|---|---|---|
$panes |
array | EntryPanelPane objects keyed by name (e.g. actions, quick_info). |
$entry_panel |
EntryPanel | The current Entry Panel instance. |
Returns array — kept items must be EntryPanelPane instances.
buildworks/organizewp/entry_panel/panes/quick_infoFilterControl whether the Quick Info pane is added (return false to remove it).
| Parameter | Type | Description |
|---|---|---|
$enabled |
bool | Whether to include the pane; default true. |
$entry_panel |
EntryPanel | The current Entry Panel instance. |
Returns bool — whether the Quick Info pane is registered.
buildworks/organizewp/entry_panel/panes/actionsFilterControl whether the Actions pane is added (return false to remove it).
| Parameter | Type | Description |
|---|---|---|
$enabled |
bool | Whether to include the pane; default true. |
$entry_panel |
EntryPanel | The current Entry Panel instance. |
Returns bool — whether the Actions pane is registered.
Groups & Smart Groups
buildworks/organizewp/groups/taxonomyFilterCustomize the taxonomy name OrganizeWP uses for Groups.
| Parameter | Type | Description |
|---|---|---|
$taxonomy |
string | The Groups taxonomy slug; default organizewp_groups. |
Returns string — the Groups taxonomy slug.
buildworks/organizewp/group/entriesFilterManipulate the entries within a Group.
| Parameter | Type | Description |
|---|---|---|
$entries |
Entry[] | Entry objects belonging to the group. |
$context |
array | [ 'group' => $term ] — the group’s WP_Term. |
Returns array — the group’s Entry objects.
buildworks/organizewp/smart_groupsFilterRegister or remove Smart Groups. See Smart Groups.
| Parameter | Type | Description |
|---|---|---|
$smart_groups |
array | SmartGroup objects keyed by name; defaults to recently_edited. |
Returns array — Smart Groups (filtered to SmartGroup instances).
buildworks/organizewp/smart_groups/addFilterFilter each Smart Group as it is added to the collection.
| Parameter | Type | Description |
|---|---|---|
$group |
SmartGroup | The Smart Group being added. |
Returns mixed — return a falsy value to skip adding the group.
buildworks/organizewp/smart_groups/recently_edited/countFilterHow many entries the built-in Recently Edited Smart Group lists.
| Parameter | Type | Description |
|---|---|---|
$count |
int | Number of entries to list; default 7. |
Returns int — the number of entries to display.
buildworks/organizewp/smart_groups/recently_edited/linkFilterCustomize the link used for each entry in the Recently Edited Smart Group.
| Parameter | Type | Description |
|---|---|---|
$link |
string | The entry edit link. |
$entry |
WP_Post | The recently edited post. |
Returns string — the link URL.
Settings & miscellaneous
buildworks/organizewp/settings/capabilityFilterControl the capability required to manage OrganizeWP settings.
| Parameter | Type | Description |
|---|---|---|
$capability |
string | Required capability; default manage_options. |
Returns string — the required capability.
buildworks/organizewp/license/keyFilterManipulate the OrganizeWP license key — for example, define it in code.
| Parameter | Type | Description |
|---|---|---|
$key |
string | From the BUILDWORKS_ORGANIZEWP_LICENSE_KEY constant if defined, otherwise the stored license option. |
Returns string — the license key (sanitized and trimmed).
buildworks/organizewp/utils/add_post_type_entries/post_statusFilterThe default post status applied to bulk-added entries.
| Parameter | Type | Description |
|---|---|---|
$post_status |
string | The status for new entries; default draft. |
Returns string — the post status (validated against registered statuses).
buildworks/organizewp/view/varsFilterCustomize the data passed to OrganizeWP’s admin JavaScript app.
| Parameter | Type | Description |
|---|---|---|
$vars |
array | The localized data — postTypes, groups, smartGroups, user, config, license, env, … |
Returns array — the variables passed to the front-end app.
buildworks/organizewp/debugFilterControl whether OrganizeWP runs in debug mode.
| Parameter | Type | Description |
|---|---|---|
$active |
bool | Whether debugging is active (the debug log file exists). |
Returns bool — whether debug mode is enabled.
buildworks/organizewp/debug/dirFilterThe directory in which OrganizeWP writes its debug log.
| Parameter | Type | Description |
|---|---|---|
$dir |
string | The log directory; defaults to the uploads base directory. |
Returns string — the absolute log directory path.