Extended CPTs

https://github.com/johnbillion/extended-cpts
Admin
Extended CPTs is a WordPress library that provides extended functionality for custom post types and...
Tokens:21,571
Snippets:163
Trust Score:9.3
License:GPL-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Minimal Examples for Registering Post Types and Taxonomies

Source: https://context7.com/johnbillion/extended-cpts/llms.txt

Provides minimal usage examples for registering post types and taxonomies with automatic label generation and default settings. This includes creating a basic hierarchical, public post type, a hierarchical taxonomy associated with a post type, a post type with REST API support and custom archive settings, and an exclusive taxonomy for single-term selection.

```php
add_action( 'init', function() {
    // Minimal post type (hierarchical, public, admin UI enabled)
    register_extended_post_type( 'article' );

    // Minimal taxonomy (hierarchical, public, admin UI enabled)
    register_extended_taxonomy( 'location', 'article' );
} );

// Post type with REST API and custom archive
add_action( 'init', function() {
    register_extended_post_type( 'portfolio', [
        'show_in_rest' => true,
        'archive' => [
            'posts_per_page' => 20,
            'orderby'        => 'menu_order',
            'order'          => 'ASC'
        ]
    ] );
} );

// Exclusive taxonomy (radio buttons, one term per post)
add_action( 'init', function() {
    register_extended_taxonomy( 'priority', 'task', [
        'exclusive' => true
    ] );
} );
```

--------------------------------

### Registering a Basic Post Type

Source: https://github.com/johnbillion/extended-cpts/wiki/Registering-Post-Types

This example demonstrates how to register a simple post type with minimal configuration. The function automatically generates labels and messages.

```APIDOC
## Registering a Basic Post Type

### Description
Registers a new custom post type with default settings. This is the simplest way to use the `register_extended_post_type` function.

### Method
PHP function call

### Endpoint
N/A (Server-side function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```php
add_action( 'init', function() {

	register_extended_post_type( 'article' );

} );
```

### Response
#### Success Response (200)
N/A (Function registers a post type)

#### Response Example
N/A
```

--------------------------------

### Install Extended CPTs using Composer

Source: https://github.com/johnbillion/extended-cpts/blob/develop/README.md

This command installs the Extended CPTs library as a dependency for your PHP project using Composer. Ensure you have Composer installed and configured in your project's root directory.

```bash
composer require johnbillion/extended-cpts
```

--------------------------------

### Registering an Advanced Post Type

Source: https://github.com/johnbillion/extended-cpts/wiki/Registering-Post-Types

This example shows how to register a post type with advanced configurations, including settings for RSS feed, block editor, admin columns, and filters.

```APIDOC
## Registering an Advanced Post Type

### Description
Registers a custom post type with various advanced configurations, such as showing in the main RSS feed, enabling the block editor, customizing admin columns, and adding admin filters.

### Method
PHP function call

### Endpoint
N/A (Server-side function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```php
add_action( 'init', function() {

	register_extended_post_type( 'story', array(

		// Add the post type to the site's main RSS feed:
		'show_in_feed' => true,

		// Use the block editor:
		'show_in_rest' => true,

		// Show all posts on the post type archive:
		'archive' => array(
			'nopaging' => true
		),

		// Add some custom columns to the admin screen:
		'admin_cols' => array(
			'featured_image' => array(
				'title'          => 'Illustration',
				'featured_image' => 'thumbnail'
			),
			'published' => array(
				'title'       => 'Published',
				'meta_key'    => 'published_date',
				'date_format' => 'd/m/Y'
			),
			'genre' => array(
				'taxonomy' => 'genre'
			)
		),

		// Add a dropdown filter to the admin screen:
		'admin_filters' => array(
			'genre' => array(
				'taxonomy' => 'genre'
			)
		)

	), array(

		// Override the base names used for labels:
		'singular' => 'Story',
		'plural'   => 'Stories',
		'slug'     => 'stories'

	) );

} );
```

### Response
#### Success Response (200)
N/A (Function registers a post type)

#### Response Example
N/A
```

--------------------------------

### Action on Extended Taxonomy Instance Setup

Source: https://github.com/johnbillion/extended-cpts/wiki/Available-filters-and-actions

Fires when an extended taxonomy instance is successfully set up. This action hook is useful for performing custom actions immediately after a taxonomy object is created and configured. It passes the taxonomy instance object.

```php
do_action( "ext-taxos/{$taxonomy}/instance", \ExtCPTs\Taxonomy $instance )
```

--------------------------------

### Action on Extended Taxonomy Admin Instance Setup

Source: https://github.com/johnbillion/extended-cpts/wiki/Available-filters-and-actions

Fires when the admin instance for an extended taxonomy is set up. This hook is specifically for actions related to the administration interface of custom taxonomies. It provides the admin instance object.

```php
do_action( "ext-taxos/{$taxonomy}/admin-instance", \ExtCPTs\TaxonomyAdmin $instance )
```

--------------------------------

### Registering Extended Post Type with Admin Filters

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

This example demonstrates how to register a new post type with various admin filters enabled, including post meta field filters and taxonomy filters.

```APIDOC
## POST /register_extended_post_type

### Description
Registers a new custom post type and enables admin filters for the post type listing screen.

### Method
POST

### Endpoint
/register_extended_post_type

### Parameters
#### Request Body
- **post_type** (string) - Required - The slug for the post type.
- **args** (array) - Required - An array of arguments for the post type registration.
  - **admin_filters** (array) - Optional - An associative array defining the admin filters.
    - **filter_key** (array) - Required - A unique key for the filter.
      - **title** (string) - Required - The title displayed for the filter.
      - **meta_key** (string) - Optional - For Post Meta Field Dropdown: The meta key to filter by.
      - **meta_search_key** (string) - Optional - For Post Meta Field Search Box: The meta key to search within.
      - **meta_exists** (array|string) - Optional - For Post Meta Field Exists: Filters by posts with a meta field having a non-empty value. Can be an array of allowed values or a single value for a checkbox.
      - **meta_key_exists** (array|string) - Optional - For Post Meta Key Exists: Filters by posts that have a meta field with the given key, regardless of its value. Can be an array of allowed values or a single value for a checkbox.
      - **taxonomy** (string) - Optional - For Taxonomy Terms Dropdown: The taxonomy slug to filter by.
      - **post_author** (boolean) - Optional - For Post Author Dropdown: Set to `true` to display a dropdown of all authors.
      - **options** (array|string) - Optional - Used with `meta_key` or `post_author` to provide custom filter options or a callback function name.
      - **date_query** (array) - Optional - Used with `post_date` to pass additional parameters to the WP_Query date query.

### Request Example
```json
{
  "post_type": "article",
  "args": {
    "admin_filters": {
      "foo": {
        "title": "Foo",
        "meta_key": "foo",
        "options": {
          "one": "One",
          "two": "Two"
        }
      },
      "bar": {
        "title": "Bar",
        "meta_search_key": "bar"
      },
      "genre": {
        "title": "Genre",
        "taxonomy": "genre"
      },
      "author": {
        "post_author": true,
        "options": [1, 7, 35]
      },
      "post_after": {
        "post_date": "after",
        "date_query": {
          "column": "post_modified_gmt"
        }
      }
    }
  }
}
```

### Response
#### Success Response (200)
Indicates the post type was registered successfully. The response body may be empty or contain registration details depending on the underlying WordPress function.

#### Response Example
```json
{
  "message": "Post type 'article' registered successfully."
}
```
```

--------------------------------

### Action on Extended Post Type Instance Setup

Source: https://github.com/johnbillion/extended-cpts/wiki/Available-filters-and-actions

Fires when an extended post type instance is successfully set up. This action hook is useful for performing actions immediately after a post type object is created and configured. It passes the post type instance object.

```php
do_action( "ext-cpts/{$post_type}/instance", \ExtCPTs\PostType $instance )
```

--------------------------------

### Action on Extended Post Type Admin Instance Setup

Source: https://github.com/johnbillion/extended-cpts/wiki/Available-filters-and-actions

Fires when the admin instance for an extended post type is set up. This hook is specifically for actions related to the administration interface of custom post types. It provides the admin instance object.

```php
do_action( "ext-cpts/{$post_type}/admin-instance", \ExtCPTs\PostTypeAdmin $instance )
```

--------------------------------

### Restrict Filter Visibility by Capability (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

This code example shows how to restrict the visibility of a filter to users possessing a specific capability. The 'cap' parameter is used to define the required user capability. This is useful for creating admin-only filters or filters accessible to specific roles.

```php
'my_filter' => array(
	'title'    => 'Admin-Only Filter',
	'meta_key' => 'foo',
	'cap'      => 'manage_options',
)
```

--------------------------------

### Register Extended Post Type with Admin Columns (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-columns

Example of registering a custom post type with configured admin columns using `register_extended_post_type`. This includes showcasing featured image, title, meta field, and taxonomy columns.

```php
register_extended_post_type( 'article', array(

	'admin_cols' => array(
		// A featured image column:
		'featured_image' => array(
			'title'          => 'Illustration',
			'featured_image' => 'thumbnail'
		),
		// The default Title column:
		'title',
		// A meta field column:
		'published' => array(
			'title'       => 'Published',
			'meta_key'    => 'published_date',
			'date_format' => 'd/m/Y'
		),
		// A taxonomy terms column:
		'genre' => array(
			'taxonomy' => 'genre'
		),
	),

) );
```

--------------------------------

### Display Taxonomy Terms Dropdown (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

This snippet demonstrates how to create a select dropdown populated with terms from a specified taxonomy. It utilizes the 'taxonomy' parameter to define which taxonomy to use. No external dependencies are required beyond a standard PHP environment.

```php
'genre' => array(
	'title'    => 'Genre',
	'taxonomy' => 'genre',
),
```

--------------------------------

### Configure Posts 2 Posts Connection Admin Column (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-columns

Illustrates how to display Posts 2 Posts connections in an admin column. Includes options for specifying the connection, field, value, and controlling the link type (`view`, `edit`, or `list`).

```php
'my_connection' => array(
	'title'      => 'Connected Posts',
	'connection' => 'my_connection',
),
```

```php
'my_connection' => array(
	'connection' => 'my_connection',
	'field'      => 'person',
	'value'      => 'john',
),
```

```php
'my_connection' => array(
	'title'      => 'Connected Posts',
	'connection' => 'my_connection',
	'link'       => 'list',
),
```

--------------------------------

### Post Meta Field Dropdown Filter (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

Shows how to create a dropdown filter for a post meta field. It covers populating the dropdown with existing values, specifying custom options, and using a callback function to retrieve options.

```php
'foo' => array(
	'title'    => 'Foo',
	'meta_key' => 'foo',
),
```

```php
'foo' => array(
	'title'    => 'Foo',
	'meta_key' => 'foo',
	'options'  => array(
		'one'   => 'One',
		'two'   => 'Two',
		'three' => 'Three',
	),
),
```

```php
'foo' => array(
	'title'    => 'Foo',
	'meta_key' => 'foo',
	'options'  => 'get_foo_values',
),
```

--------------------------------

### Optional Parameters for Filters

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

Details on optional parameters that can be used to customize the behavior and appearance of admin filters.

```APIDOC
## Optional Parameters for Filters

### Description
Several optional parameters can be used to further customize the behavior and presentation of the admin filters.

### Method
POST (within `register_extended_post_type` arguments)

### Endpoint
N/A (Configuration within registration arguments)

### Parameters
#### Request Body (within `admin_filters` arguments)
- **title** (string) - Required - The human-readable title displayed for the filter.
- **options** (array|string) - Optional - Provides custom values for dropdown filters (`meta_key`, `post_author`) or specifies a callback function to generate these options.
  - **Type:** `array` (key-value pairs or simple list) or `string` (callback function name).
- **date_query** (array) - Optional - Used with the `post_date` filter to pass additional arguments to the `WP_Query` date parameters (e.g., `column`, `after`, `before`).
- **capability** (string) - Optional - Restricts the visibility of the filter to users with the specified WordPress capability.

### Request Example
```php
register_extended_post_type( 'event', array(
    'admin_filters' => array(
        'event_type' => array(
            'title'   => 'Event Type',
            'meta_key' => 'event_type',
            'options'  => 'get_event_types_for_dropdown', // Callback function to get options
        ),
        'event_date_range' => array(
            'title'      => 'Event Date Range',
            'post_date'  => 'after',
            'date_query' => array(
                'column' => 'post_date',
                'after'  => 'today',
            ),
            'capability' => 'view_events',
        ),
    ),
) );
```

### Response
#### Success Response (200)
Indicates successful registration of the post type with filters configured using optional parameters.

#### Response Example
```json
{
  "message": "Post type 'event' registered with custom filters."
}
```
```

--------------------------------

### Available Admin Filter Types

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

Details on the different types of admin filters that can be configured using the `admin_filters` parameter.

```APIDOC
## Admin Filter Types

### Post Meta Field Dropdown

- **Parameter:** `meta_key`
- **Description:** Displays a select dropdown populated with all unique existing values for the specified meta key.
- **Optional Parameter:** `options`
  - **Description:** Manually specify a list of values or a callback function to populate the dropdown.
  - **Type:** `array` or `string` (callback function name)

```php
'meta_filter' => array(
    'title'    => 'Custom Field Filter',
    'meta_key' => 'my_custom_field',
    'options'  => array(
        'value1' => 'Label 1',
        'value2' => 'Label 2',
    ),
),
```

### Post Meta Field Search Box

- **Parameter:** `meta_search_key`
- **Description:** Displays a text input field to search posts based on a partial match (LIKE query) of the specified meta key's value.

```php
'search_filter' => array(
    'title'           => 'Search by Value',
    'meta_search_key' => 'my_searchable_field',
),
```

### Post Meta Field Exists Checkbox/Dropdown

- **Parameter:** `meta_exists`
- **Description:** Filters posts based on the existence and value of a meta field. If a single value is provided, a checkbox is shown. If multiple values are provided, a select dropdown is shown.
- **Query:** Performs a `NOT IN ( '', '0', 'false', 'null' )` query for the meta value.

*Checkbox Example:*
```php
'status_filter' => array(
    'meta_exists' => array('completed' => 'Completed'),
),
```

*Dropdown Example:*
```php
'type_filter' => array(
    'title'       => 'Item Type',
    'meta_exists' => array(
        'active'   => 'Active',
        'inactive' => 'Inactive',
    ),
),
```

### Post Meta Key Exists Checkbox/Dropdown

- **Parameter:** `meta_key_exists`
- **Description:** Filters posts based on whether a meta key exists, regardless of its value. If a single value is provided, a checkbox is shown. If multiple values are provided, a select dropdown is shown.
- **Query:** Performs an `EXISTS` query for the meta key.

*Checkbox Example:*
```php
'featured_filter' => array(
    'meta_key_exists' => array('is_featured' => 'Featured'),
),
```

*Dropdown Example:*
```php
'priority_filter' => array(
    'title'           => 'Priority',
    'meta_key_exists' => array(
        'high'   => 'High Priority',
        'medium' => 'Medium Priority',
    ),
),
```

### Post Author Dropdown

- **Parameter:** `post_author`
- **Description:** Displays a select dropdown populated with authors of the post type.
- **Optional Parameter:** `options`
  - **Description:** Manually specify a list of user IDs or a callback function to populate the dropdown.
  - **Type:** `array` (user IDs) or `string` (callback function name)

```php
'author_filter' => array(
    'post_author' => true,
    'options'     => array(1, 5, 10),
),
```

### Post Date Picker

- **Parameter:** `post_date`
- **Description:** Displays a date picker for filtering posts by date. Typically used for range selection (`after`, `before`).
- **Optional Parameter:** `date_query`
  - **Description:** Allows passing additional parameters to the `WP_Query` date query.
  - **Type:** `array`

```php
'date_after_filter' => array(
    'post_date'  => 'after',
    'date_query' => array('column' => 'post_date'),
),
'date_before_filter' => array(
    'post_date'  => 'before',
    'date_query' => array('column' => 'post_date'),
),
```

### Taxonomy Terms Dropdown

- **Parameter:** `taxonomy`
- **Description:** Displays a select dropdown populated with terms from the specified taxonomy.

```php
'category_filter' => array(
    'title'    => 'Categories',
    'taxonomy' => 'category',
),
```
```

--------------------------------

### Custom Column Output with Callback Function (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-columns

Demonstrates how to define a custom column output using a PHP closure or function name. The function can echo content directly. For post types, it uses the global $post object; for taxonomies, it receives the term ID as a parameter.

```php
'my_column' => array(
	'title'    => 'Hello World',
	'function' => function() {
		echo 'Hello, World!';
	},
),
```

```php
'my_column' => array(
	'title'    => 'Hello World',
	'function' => 'my_custom_function',
)
```

--------------------------------

### Configure Taxonomy Term(s) Admin Column (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-columns

Explains how to display taxonomy terms in an admin column. Includes options for setting the `taxonomy`, `title`, and controlling the link type (`view`, `edit`, or `list`) for each term.

```php
'genre' => array(
	'title'    => 'Genre',
	'taxonomy' => 'genre',
),
```

```php
'genre' => array(
	'title'    => 'Genre',
	'taxonomy' => 'genre',
	'link'     => 'edit',
),
```

--------------------------------

### Post Date Picker Filter (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

Implements date picker filters for 'after' and 'before' post dates. This utilizes the native browser date input and can include custom `date_query` parameters for more specific filtering, such as on `post_modified_gmt`.

```php
'post_after' => [
	'post_date'  => 'after',
	'date_query' => [
		'column' => 'post_modified_gmt',
	],
],
'post_before' => [
	'post_date'  => 'before',
	'date_query' => [
		'column' => 'post_modified_gmt',
	],
],
```

--------------------------------

### Filter by Post Meta Key Exists (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Query-vars-for-filtering

Creates a site filter to select posts that possess a specific meta key, regardless of its value. This performs an SQL EXISTS query.

```php
'help_needed' => array(
	'meta_key_exists' => 'help_needed'
),
```

--------------------------------

### Post Author Dropdown Filter (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

Creates a dropdown filter for selecting post authors. It can display all authors of the post type or a manually specified list of user IDs, optionally using a callback function.

```php
'author' => [
	'post_author' => true,
],
```

```php
'author' => array(
	'post_author' => true,
	'options'     => array( 1, 7, 35, 220 ),
	),
),
```

```php
'author' => array(
	'post_author' => true,
	'options'     => 'get_author_values',
),
```

--------------------------------

### Register Post Type with Admin Filters (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

Demonstrates how to register a custom post type with multiple admin filters using the `register_extended_post_type` function. This includes meta field filters ('Foo', 'Bar') and a taxonomy filter ('Genre').

```php
register_extended_post_type( 'article', array(

	'admin_filters' => array(
		'foo' => array(
			'title'    => 'Foo',
			'meta_key' => 'foo',
		),
		'bar' => array(
			'title'           => 'Bar',
			'meta_search_key' => 'bar',
		),
		'genre' => array(
			'title'    => 'Genre',
			'taxonomy' => 'genre',
		),
	),

) );
```

--------------------------------

### Configure Featured Image Admin Column (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-columns

Shows how to add a featured image column to the post list screen. You can specify the image size and optionally set custom width and height for scaling in the browser.

```php
'illustration' => array(
	'title'          => 'Illustration',
	'featured_image' => 'thumbnail',
),
```

```php
'illustration' => array(
	'title'          => 'Illustration',
	'featured_image' => 'thumbnail',
	'width'          => 80,
	'height'         => 80,
),
```

--------------------------------

### Register Simple Post Type and Taxonomy - PHP

Source: https://github.com/johnbillion/extended-cpts/blob/develop/README.md

Demonstrates the basic usage of `register_extended_post_type` and `register_extended_taxonomy` for creating a simple post type and an associated taxonomy with automatically generated labels and admin UIs.

```php
add_action( 'init', function() {
	register_extended_post_type( 'article' );
} );

add_action( 'init', function() {
	register_extended_taxonomy( 'location', 'article' );
} );
```

--------------------------------

### Register Product Post Type with Custom Admin Columns (PHP)

Source: https://context7.com/johnbillion/extended-cpts/llms.txt

This PHP code snippet demonstrates how to register a new post type 'product' using the `register_extended_post_type` function. It configures custom columns for the admin list table, including featured images, titles, meta fields with date formatting, taxonomy terms with custom links, post fields, P2P connections, custom callback functions, and icon-only columns with conditional display.

```php
add_action( 'init', function() {
    register_extended_post_type( 'product', [
        'admin_cols' => [
            // Featured image column
            'image' => [
                'title'          => 'Image',
                'featured_image' => 'thumbnail',
                'width'          => 80,
                'height'         => 80
            ],

            // Default title column (preserves WordPress default)
            'title',

            // Post meta field with date formatting
            'release_date' => [
                'title'       => 'Release Date',
                'meta_key'    => 'release_date',
                'date_format' => 'D, d M Y'
            ],

            // Taxonomy terms with custom link behavior
            'category' => [
                'title'    => 'Category',
                'taxonomy' => 'product_category',
                'link'     => 'edit'  // Options: 'view', 'edit', 'list'
            ],

            // Post field (from wp_posts table)
            'last_modified' => [
                'title'      => 'Modified',
                'post_field' => 'post_modified'
            ],

            // Posts 2 Posts connection
            'related' => [
                'title'      => 'Related Products',
                'connection' => 'products_to_products',
                'link'       => 'list'
            ],

            // Custom function with global $post
            'custom_data' => [
                'title'    => 'Custom',
                'function' => function() {
                    global $post;
                    echo '<strong>' . esc_html( get_post_meta( $post->ID, 'custom', true ) ) . '</strong>';
                },
                'sortable' => false
            ],

            // Icon-only column title
            'expires' => [
                'title_icon'  => 'dashicons-clock',
                'meta_key'    => 'expiry_date',
                'date_format' => 'd/m/Y',
                'post_cap'    => 'edit_post'  // Show value only if user can edit this post
            ]
        ]
    ] );
} );
```

--------------------------------

### Define Custom Permalink Structures with Rewrite Tags

Source: https://context7.com/johnbillion/extended-cpts/llms.txt

Defines custom URL structures for post type permalinks using rewrite tags. This allows for flexible URL configurations based on dates, taxonomies, or custom fields. Supported rewrite tags include year, month, day, hour, minute, second, post ID, post name, category, author, and custom taxonomies.

```php
add_action( 'init', function() {
    // Date-based permalink structure
    register_extended_post_type( 'article', [
        'rewrite' => [
            'permastruct' => '/articles/%year%/%monthnum%/%article%'
        ]
    ] );
    // Result: example.com/articles/2024/12/my-article-title

    // Taxonomy-based permalink structure
    register_extended_post_type( 'product', [
        'rewrite' => [
            'permastruct' => '/shop/%product_category%/%product%'
        ]
    ] );
    // Result: example.com/shop/electronics/laptop-stand

    // Mixed rewrite tags
    register_extended_post_type( 'review', [
        'rewrite' => [
            'permastruct' => '/%review_type%/%year%/%review%'
        ]
    ] );
    // Result: example.com/movie-reviews/2024/inception-review
} );

// Supported rewrite tags: %year%, %monthnum%, %day%, %hour%, %minute%, %second%,
// %post_id%, %postname%, %category%, %author%, and any custom taxonomy
```

--------------------------------

### Configure Post Field Admin Column (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-columns

Demonstrates displaying standard post fields (from the `wp_posts` table) in an admin column. Date fields are automatically formatted, and other fields are formatted as appropriate.

```php
'last_modified' => array(
	'title'      => 'Last Modified',
	'post_field' => 'post_modified',
),
```

--------------------------------

### Customize Column Title with Icon or Callback (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-columns

Illustrates how to customize column titles. 'title_icon' uses a Dashicon name for the title. 'title_cb' accepts a callback function to generate the title, allowing for complex HTML or dynamic content.

```php
'admin_cols' => [
	'expires' => [
		'title_icon'  => 'dashicons-calendar-alt',
		'meta_key'    => 'expiry_date',
		'date_format' => 'd/m/Y',
	],
]
```

```php
'admin_cols' => [
	'expires' => [
		'title_cb' => function() {
			return '<b>Amazing</b> Field';
		},
		'meta_key' => 'expiry_date',
	],
]
```

--------------------------------

### Filter by Post Meta Field Search (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Query-vars-for-filtering

Sets up a site filter to search within the values of a post meta field. This uses a SQL LIKE query, allowing for partial string matches.

```php
'my_foo' => array(
	'meta_search_key' => 'foo',
),
```

--------------------------------

### Configure Post Meta Field Admin Column (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-columns

Demonstrates how to add a custom admin column to display a post meta field. It shows basic usage with `meta_key` and `title`, and advanced usage with `date_format` for timestamp values.

```php
'foo' => array(
	'title'    => 'Foo',
	'meta_key' => 'foo',
),
```

```php
'start_date' => array(
	'title'       => 'Start Date',
	'meta_key'    => 'start_date',
	'date_format' => 'D, d M Y',
),
```

--------------------------------

### Restrict Column Visibility by Capability (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-columns

Shows how to restrict column visibility based on user capabilities. The 'cap' parameter hides the column entirely for users lacking the specified capability. The 'post_cap' parameter shows the column but only displays its content for users with the specified capability for the current row's post.

```php
'my_column' => array(
	'title'    => 'Admin-Only Column',
	'meta_key' => 'foo',
	'cap'      => 'manage_options',
)
```

```php
'my_column' => array(
	'title'    => 'Editor-Only Column',
	'meta_key' => 'foo',
	'post_cap' => 'edit_post',
)
```

--------------------------------

### Add Taxonomy via Shorthand PHP

Source: https://github.com/johnbillion/extended-cpts/wiki/Integration-with-Extended-Taxonomies

Adds a custom taxonomy to an existing Extended CPT object using a shorthand method. This allows for a more concise way to register taxonomies associated with a post type. It takes the taxonomy name and an array of arguments similar to `register_taxonomy`. Dependencies include the Extended CPTs library.

```php
$example = register_extended_post_type( 'example', array(
	'featured_image' => 'Example image',
) );
$example->add_taxonomy( 'foo', array(
	'show_ui' => false,
) );
$example->add_taxonomy( 'bar', array(
	'hierarchical' => false,
) );
```

--------------------------------

### Restricting Filter Visibility by User Capability

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

This section explains how to control which user roles can see and use the admin filters.

```APIDOC
## Restricting Visibility by User Capability

### Description
Admin filters can be restricted to specific user capabilities. If a user does not possess the specified capability, the filter will not be displayed on the post type listing screen.

### Method
POST (within `register_extended_post_type` arguments)

### Endpoint
N/A (Configuration within registration arguments)

### Parameters
#### Request Body (within `admin_filters` arguments)
- **capability** (string) - Optional - The user capability required to view this filter. If not specified, the filter is visible to users who can edit the post type.

### Request Example
```php
register_extended_post_type( 'book', array(
    'admin_filters' => array(
        'published_only' => array(
            'title'      => 'Published Only',
            'meta_key'   => 'status',
            'options'    => array('published' => 'Published'),
            'capability' => 'edit_published_books', // Only users who can edit published books see this filter
        ),
    ),
) );
```

### Response
#### Success Response (200)
Indicates successful registration of the post type with capability restrictions applied.

#### Response Example
```json
{
  "message": "Post type 'book' registered with capability-restricted filters."
}
```
```

--------------------------------

### Filter by Post Meta Field Exists (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Query-vars-for-filtering

Configures a site filter to include posts that have a specific meta field with a non-empty value. This query excludes empty, '0', 'false', and 'null' values.

```php
'complete' => array(
	'meta_exists' => 'complete'
),
```

--------------------------------

### Post Meta Key Exists Filter (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

Adds a filter to check if a post meta key exists, regardless of its value. Similar to `meta_exists`, this can be a checkbox or dropdown and uses an SQL EXISTS query.

```php
'help_needed' => array(
	'meta_key_exists' => array(
		'help_needed' => 'Help Needed',
	),
),
```

```php
'review_type' => array(
	'title'       => 'Review Type',
	'meta_key_exists' => array(
		'editors_choice' => 'Editors choice',
		'help_needed'    => 'Help Needed',
	),
),
```

--------------------------------

### Filter All Taxonomy Names

Source: https://github.com/johnbillion/extended-cpts/wiki/Available-filters-and-actions

Filters the plural, singular, and slug names for any taxonomy. This provides a centralized method for managing taxonomy naming across the site. It takes the names array and the taxonomy name string.

```php
apply_filters( 'ext-taxos/names', array $names, string $taxonomy )
```

--------------------------------

### Filter Taxonomy Arguments by Taxonomy

Source: https://github.com/johnbillion/extended-cpts/wiki/Available-filters-and-actions

Filters the arguments for a specific taxonomy before registration. This allows for customization of taxonomy settings based on the taxonomy's slug. It takes an array of arguments and returns the modified array.

```php
apply_filters( "ext-taxos/{$taxonomy}/args", array $args )
```

--------------------------------

### Configure Sorting by Post Meta Field (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Query-vars-for-sorting

Specifies sorting for a post type archive or WP_Query based on a post meta field. The 'meta_key' parameter within the 'site_sortables' array indicates which custom field to use for ordering.

```php
'foo' => array(
	'meta_key' => 'foo',
),
```

--------------------------------

### Order Posts with WP_Query using Custom Sortable Fields (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Query-vars-for-sorting

Demonstrates how to use the custom sortable fields registered with Extended CPTs within a WP_Query. By setting the 'orderby' argument to a registered sortable field key (e.g., 'my_genre'), you can control the order of retrieved posts.

```php
new WP_Query( array(
	'post_type' => 'article',
	'orderby'   => 'my_genre',
	'order'     => 'DESC',
) );
```

--------------------------------

### Configure Sorting by Taxonomy Term(s) (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Query-vars-for-sorting

Enables sorting of posts by their associated taxonomy terms. The 'taxonomy' parameter within the 'site_sortables' array specifies the taxonomy name to sort by.

```php
'genre' => array(
	'taxonomy' => 'genre',
),
```

--------------------------------

### Extended Taxonomy Default Arguments - PHP

Source: https://github.com/johnbillion/extended-cpts/wiki/Registering-taxonomies

Illustrates the default arguments for custom taxonomies when using `register_extended_taxonomy()`. It highlights custom arguments like `exclusive`, `allow_hierarchy`, `meta_box` options, `dashboard_glance`, `admin_cols`, and `required`, many of which differ from WordPress' native `register_taxonomy()` defaults.

```php
'public'            => true,
'show_ui'           => true,
'hierarchical'      => true,
'query_var'         => true,
'exclusive'         => false, # Custom arg  // true means: just one can be selected
'allow_hierarchy'   => false, # Custom arg  //
'meta_box'          => null,  # Custom arg  // can be null, 'simple', 'radio', 'dropdown' -> 'radio' and 'dropdown' just allow exclusive choices (will overwrite the set choise), simple has exclusive and multi options
'dashboard_glance'  => false, # Custom arg  // show or not on dashboard glance
'checked_ontop'     => null,  # Custom arg  //
'admin_cols'        => null,  # Custom arg  // added admin columns
'required'          => false # Custom arg  //
```

--------------------------------

### Register Advanced Post Type and Taxonomy - PHP

Source: https://github.com/johnbillion/extended-cpts/blob/develop/README.md

Shows how to register a post type ('story') and a taxonomy ('genre') with advanced features like showing in RSS feed, custom admin columns, dropdown filters, and using radio buttons for taxonomy input. This utilizes `register_extended_post_type` and `register_extended_taxonomy` with extensive configuration options.

```php
add_action( 'init', function() {
	register_extended_post_type( 'story', [

		# Add the post type to the site's main RSS feed:
		'show_in_feed' => true,

		# Show all posts on the post type archive:
		'archive' => [
			'nopaging' => true,
		],

		# Add some custom columns to the admin screen:
		'admin_cols' => [
			'story_featured_image' => [
				'title'          => 'Illustration',
				'featured_image' => 'thumbnail'
			],
			'story_published' => [
				'title_icon'  => 'dashicons-calendar-alt',
				'meta_key'    => 'published_date',
				'date_format' => 'd/m/Y'
			],
			'story_genre' => [
				'taxonomy' => 'genre'
			],
		],

		# Add some dropdown filters to the admin screen:
		'admin_filters' => [
			'story_genre' => [
				'taxonomy' => 'genre'
			],
			'story_rating' => [
				'meta_key' => 'star_rating',
			],
		],

	], [

		# Override the base names used for labels:
		'singular' => 'Story',
		'plural'   => 'Stories',
		'slug'     => 'stories',

	] );

	register_extended_taxonomy( 'genre', 'story', [

		# Use radio buttons in the meta box for this taxonomy on the post editing screen:
		'meta_box' => 'radio',

		# Add a custom column to the admin screen:
		'admin_cols' => [
			'updated' => [
				'title_cb'    => function() {
					return '<em>Last</em> Updated';
				},
				'meta_key'    => 'updated_date',
				'date_format' => 'd/m/Y'
			],
		],

	] );
} );
```

--------------------------------

### Register Extended Taxonomy PHP

Source: https://github.com/johnbillion/extended-cpts/wiki/Integration-with-Extended-Taxonomies

Registers a custom taxonomy with extended functionality for a given object type. It accepts arguments for taxonomy name, object type, custom arguments for meta boxes and display, and naming conventions. Dependencies include WordPress. No explicit inputs or outputs are defined beyond the function's registration behavior.

```php
register_extended_taxonomy( 'book_type', 'book', array( 
	'meta_box' => 'simple',
        'checked_ontop' => true,
        'dashboard_glance' => true,
        'admin_cols' => array(
                'title',
		// A meta field column:
		'published' => array(
			'title'       => 'Published',
			'meta_key'    => 'published_date',
			'date_format' => 'd/m/Y'
		),

        ),
        'allow_hierarchy' => false 
),
array(
        'singular' => 'Book Type',
        'plural'   => 'Book Types',
        'slug'     => 'book-types'
) );
```

--------------------------------

### Register Front-End Query Variables for Filtering (PHP)

Source: https://context7.com/johnbillion/extended-cpts/llms.txt

This code registers public query variables for filtering custom post type archives and for use with `WP_Query`. It allows defining filters based on meta keys, including comparison operators, search capabilities, and existence checks. These variables can then be used in URLs or directly within `WP_Query` arguments for dynamic content retrieval. Dependencies include the Extended CPTs plugin or library.

```php
add_action( 'init', function() {
    register_extended_post_type( 'property', [
        'site_filters' => [
            // Exact meta value match
            'property_type' => [
                'meta_key' => 'property_type'
            ],

            // Meta value with comparison operator
            'min_price' => [
                'meta_key'   => 'price',
                'meta_query' => [
                    'compare' => '>='',
                    'type'    => 'NUMERIC'
                ]
            ],

            // Meta field search (LIKE query)
            'search_location' => [
                'meta_search_key' => 'location'
            ],

            // Meta field exists with non-empty value
            'has_photos' => [
                'meta_exists' => 'photo_gallery'
            ],

            // Meta key exists (any value)
            'is_featured' => [
                'meta_key_exists' => 'featured_listing'
            ],

            // Capability-restricted filter
            'admin_notes_filter' => [
                'meta_key' => 'admin_notes',
                'cap'      => 'edit_others_posts'
            ]
        ]
    ] );
} );

// URL usage: example.com/properties/?property_type=apartment&min_price=200000
// WP_Query usage:
$query = new WP_Query( [
    'post_type'     => 'property',
    'property_type' => 'apartment',
    'min_price'     => 200000,
    'has_photos'    => '1'
] );
```

--------------------------------

### Filter All Taxonomy Arguments

Source: https://github.com/johnbillion/extended-cpts/wiki/Available-filters-and-actions

Filters the arguments for any taxonomy. This general hook allows for global modifications to taxonomy arguments. It receives the taxonomy arguments array and the taxonomy name string.

```php
apply_filters( 'ext-taxos/args', array $args, string $taxonomy )
```

--------------------------------

### Filter by Post Meta Field Value (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Query-vars-for-filtering

Configures a site filter to query posts based on an exact match of a post meta field's value. The 'meta_key' parameter specifies the meta key to filter by.

```php
'my_foo' => array(
	'meta_key' => 'foo',
),
```

--------------------------------

### Restrict Filter Access by User Capability (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Query-vars-for-filtering

Applies a user capability restriction to a site filter. Only users possessing the specified capability will be able to utilize this filter.

```php
'my_filter' => array(
	'meta_key' => 'foo',
	'cap'      => 'manage_options',
),
```

--------------------------------

### Post Meta Field Exists Filter (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

Configures a filter to check for the existence of a post meta field. It can be displayed as a checkbox (single value) or a dropdown (multiple values) and filters posts with non-empty values for the specified meta key.

```php
'help_needed' => array(
	'meta_exists' => array(
		'complete' => 'Complete',
	),
),
```

```php
'review_type' => array(
	'title'       => 'Review Type',
	'meta_exists' => array(
		'complete' => 'Complete',
		'broken'   => 'Broken',
	),
),
```

--------------------------------

### Filter All Post Type Arguments

Source: https://github.com/johnbillion/extended-cpts/wiki/Available-filters-and-actions

Filters the arguments for any post type. This is a more general hook than filtering by a specific post type, allowing for global modifications to post type arguments. It takes the post type arguments array and the post type name as parameters.

```php
apply_filters( 'ext-cpts/args', array $args, string $post_type )
```

--------------------------------

### Register Public Orderby Values for Sorting

Source: https://context7.com/johnbillion/extended-cpts/llms.txt

Registers public orderby values for sorting post type archives and WP_Query. It allows sorting by meta fields, taxonomy terms, post fields, and numeric meta values. The default sort order for archives can also be specified.

```php
add_action( 'init', function() {
    register_extended_post_type( 'book', [
        'site_sortables' => [
            // Sort by meta field
            'publication_date' => [
                'meta_key' => 'publication_date',
                'default'  => 'DESC'  // Default sort order for archives
            ],

            // Sort by taxonomy term
            'author_name' => [
                'taxonomy' => 'book_author'
            ],

            // Sort by post field
            'last_updated' => [
                'post_field' => 'post_modified_gmt'
            ],

            // Numeric meta sorting
            'page_count' => [
                'meta_key' => 'page_count'
            ]
        ]
    ] );
} );

// URL usage: example.com/books/?orderby=publication_date&order=asc
// WP_Query usage:
$query = new WP_Query( [
    'post_type' => 'book',
    'orderby'   => 'publication_date',
    'order'     => 'ASC'
] );
```

--------------------------------

### Post Meta Field Search Box Filter (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Admin-filters

Implements a search box filter for a post meta field. This filter uses a SQL LIKE query to find posts where the meta field value matches the entered search term.

```php
'foo' => array(
	'title'           => 'Foo',
	'meta_search_key' => 'foo',
),
```

--------------------------------

### Register Basic Custom Post Type with Extended CPTs

Source: https://github.com/johnbillion/extended-cpts/wiki/Registering-Post-Types

Registers a simple custom post type named 'article' using the `register_extended_post_type()` function. This provides a hierarchical public post type with an admin UI and automatically generated labels and messages. It relies on the Extended CPTs plugin being active.

```php
add_action( 'init', function() {

	register_extended_post_type( 'article' );

} );
```

--------------------------------

### Register Extended Post Type with Custom Permalink Structure (PHP)

Source: https://github.com/johnbillion/extended-cpts/wiki/Custom-permalink-structures

This PHP code snippet demonstrates how to register a custom post type named 'article' using the `register_extended_post_type` function. It specifies a custom permalink structure using the `permastruct` argument within the `rewrite` configuration, including a custom taxonomy placeholder.

```php
register_extended_post_type( 'article', array(

	'rewrite' => array(
		'permastruct' => '/foo/%custom_tax%/%article%'
	),

) );
```

--------------------------------

### Force Enable/Disable Block Editor for Post Types

Source: https://github.com/johnbillion/extended-cpts/wiki/Other-admin-parameters

Forces the block editor on or off for a post type, overriding the Classic Editor plugin. Requires 'show_in_rest' to be true and uses the 'block_editor' parameter. This is useful for REST API integration.

```php
register_extended_post_type( 'article', array(
	'show_in_rest' => true,
	'block_editor' => false,
) );
```

--------------------------------

### Register a Simple Taxonomy with WordPress Extended CPTs

Source: https://github.com/johnbillion/extended-cpts/wiki/Registering-taxonomies

Registers a basic hierarchical public taxonomy with an admin interface. Labels and term update messages are automatically generated. This function is a wrapper for WordPress' `register_taxonomy()` and accepts all its parameters.

```php
register_extended_taxonomy( 'location', 'post' );
```
Tokens:
Raw