ACF_Admin_Post_Types{} │ ACF 1.0└─ ACF_Admin_Internal_Post_Type_List
The ACF Post Types admin controller class
No Hooks.
Usage
$ACF_Admin_Post_Types = new ACF_Admin_Post_Types(); // use class methods
Methods
- public __construct()
- public current_screen()
- public admin_menu()
- public admin_table_columns( $_columns )
- public render_admin_table_column( $column_name, $post )
- public render_admin_table_column_field_groups( $post_type )
- public render_admin_table_column_taxonomies( $post_type )
- public render_admin_table_column_num_posts( $post_type )
- public get_action_notice_text( $action, $count = 1 )
- public get_registration_error_state()
ACF_Admin_Post_Types{} ACF Admin Post Types{} code ACF 6.8.8
class ACF_Admin_Post_Types extends ACF_Admin_Internal_Post_Type_List {
/**
* The slug for the internal post type.
*
* @var string
*/
public $post_type = 'acf-post-type';
/**
* The admin body class used for the post type.
*
* @var string
*/
public $admin_body_class = 'acf-admin-post-types';
/**
* The name of the store used for the post type.
*
* @var string
*/
public $store = 'post-types';
/**
* Constructor.
*
* @since 6.2
*/
public function __construct() {
add_action( 'admin_menu', array( $this, 'admin_menu' ), 8 );
parent::__construct();
}
/**
* Current screen actions for the post types list admin page.
*
* @since 6.1
*/
public function current_screen() {
// Bail early if not post types admin page.
if ( ! acf_is_screen( "edit-{$this->post_type}" ) ) {
return;
}
parent::current_screen();
// Run a first-run routine to set some defaults which are stored in user preferences.
if ( ! acf_get_user_setting( 'post-type-first-run', false ) ) {
$option_key = 'manageedit-' . $this->post_type . 'columnshidden';
$hidden_items = get_user_option( $option_key );
if ( ! is_array( $hidden_items ) ) {
$hidden_items = array();
}
if ( ! in_array( 'acf-key', $hidden_items ) ) {
$hidden_items[] = 'acf-key';
}
update_user_option( get_current_user_id(), $option_key, $hidden_items, true );
acf_update_user_setting( 'post-type-first-run', true );
}
}
/**
* Add any menu items required for post types.
*
* @since 6.1
*/
public function admin_menu() {
$parent_slug = 'edit.php?post_type=acf-field-group';
$cap = acf_get_setting( 'capability' );
add_submenu_page( $parent_slug, __( 'Post Types', 'acf' ), __( 'Post Types', 'acf' ), $cap, 'edit.php?post_type=acf-post-type' );
}
/**
* Customizes the admin table columns.
*
* @date 1/4/20
* @since 5.9.0
*
* @param array $_columns The columns array.
* @return array
*/
public function admin_table_columns( $_columns ) {
// Set the "no found" label to be our custom HTML for no results.
if ( empty( acf_request_arg( 's' ) ) ) {
global $wp_post_types;
$wp_post_types[ $this->post_type ]->labels->not_found = $this->get_not_found_html();
}
$columns = array(
'cb' => $_columns['cb'],
'title' => $_columns['title'],
'acf-description' => __( 'Description', 'acf' ),
'acf-key' => __( 'Key', 'acf' ),
'acf-taxonomies' => __( 'Taxonomies', 'acf' ),
'acf-field-groups' => __( 'Field Groups', 'acf' ),
'acf-count' => __( 'Posts', 'acf' ),
);
if ( acf_get_local_json_files( $this->post_type ) ) {
$columns['acf-json'] = __( 'Local JSON', 'acf' );
}
return $columns;
}
/**
* Renders a specific admin table column.
*
* @date 17/4/20
* @since 5.9.0
*
* @param string $column_name The name of the column to display.
* @param array $post The main ACF post array.
* @return void
*/
public function render_admin_table_column( $column_name, $post ) {
switch ( $column_name ) {
case 'acf-key':
echo '<i class="acf-icon acf-icon-key-solid"></i>';
echo esc_html( $post['key'] );
break;
// Description.
case 'acf-description':
if ( ( is_string( $post['description'] ) || is_numeric( $post['description'] ) ) && ! empty( $post['description'] ) ) {
echo '<span class="acf-description">' . acf_esc_html( $post['description'] ) . '</span>';
} else {
echo '<span class="acf-emdash" aria-hidden="true">—</span>';
echo '<span class="screen-reader-text">' . esc_html__( 'No description', 'acf' ) . '</span>';
}
break;
case 'acf-taxonomies':
$this->render_admin_table_column_taxonomies( $post );
break;
case 'acf-field-groups':
$this->render_admin_table_column_field_groups( $post );
break;
case 'acf-count':
$this->render_admin_table_column_num_posts( $post );
break;
// Local JSON.
case 'acf-json':
$this->render_admin_table_column_local_status( $post );
break;
}
}
/**
* Renders the field groups attached to the post type in the list table.
*
* @since 6.1
*
* @param array $post_type The main post type array.
* @return void
*/
public function render_admin_table_column_field_groups( $post_type ) {
$field_groups = acf_get_field_groups( array( 'post_type' => $post_type['post_type'] ) );
if ( empty( $field_groups ) ) {
echo '<span class="acf-emdash" aria-hidden="true">—</span>';
echo '<span class="screen-reader-text">' . esc_html__( 'No field groups', 'acf' ) . '</span>';
return;
}
$labels = wp_list_pluck( $field_groups, 'title' );
$limit = 3;
$shown_labels = array_slice( $labels, 0, $limit );
$hidden_labels = array_slice( $labels, $limit );
$text = implode( ', ', $shown_labels );
if ( ! empty( $hidden_labels ) ) {
$text .= ', <span class="acf-more-items acf-js-tooltip" title="' . implode( ', ', $hidden_labels ) . '">+' . count( $hidden_labels ) . '</span>';
}
echo acf_esc_html( $text );
}
/**
* Renders the taxonomies attached to the post type in the list table.
*
* @since 6.1
*
* @param array $post_type The main post type array.
* @return void
*/
public function render_admin_table_column_taxonomies( $post_type ) {
$taxonomies = array();
$labels = array();
if ( is_array( $post_type['taxonomies'] ) ) {
$taxonomies = $post_type['taxonomies'];
}
$acf_taxonomies = acf_get_internal_post_type_posts( 'acf-taxonomy' );
foreach ( $acf_taxonomies as $acf_taxonomy ) {
if ( is_array( $acf_taxonomy['object_type'] ) && in_array( $post_type['post_type'], $acf_taxonomy['object_type'], true ) ) {
$taxonomies[] = $acf_taxonomy['taxonomy'];
}
}
$taxonomies = array_unique( $taxonomies );
foreach ( $taxonomies as $tax_slug ) {
$taxonomy = get_taxonomy( $tax_slug );
if ( ! is_object( $taxonomy ) || empty( $taxonomy->label ) ) {
continue;
}
$labels[] = $taxonomy->label;
}
if ( empty( $labels ) ) {
echo '<span class="acf-emdash" aria-hidden="true">—</span>';
echo '<span class="screen-reader-text">' . esc_html__( 'No taxonomies', 'acf' ) . '</span>';
return;
}
$limit = 3;
$shown_labels = array_slice( $labels, 0, $limit );
$hidden_labels = array_slice( $labels, $limit );
$text = implode( ', ', $shown_labels );
if ( ! empty( $hidden_labels ) ) {
$text .= ', <span class="acf-more-items acf-js-tooltip" title="' . implode( ', ', $hidden_labels ) . '">+' . count( $hidden_labels ) . '</span>';
}
echo acf_esc_html( $text );
}
/**
* Renders the number of posts created for the post type in the list table.
*
* @since 6.1
*
* @param array $post_type The main post type array.
* @return void
*/
public function render_admin_table_column_num_posts( $post_type ) {
$no_posts = '<span class="acf-emdash" aria-hidden="true">—</span>';
$no_posts .= '<span class="screen-reader-text">' . esc_html__( 'No posts', 'acf' ) . '</span>';
// WP doesn't count posts for post types that don't exist.
if ( empty( $post_type['active'] ) || 'trash' === get_post_status( $post_type['ID'] ) ) {
echo acf_esc_html( $no_posts );
return;
}
$num_posts = wp_count_posts( $post_type['post_type'] );
if ( is_object( $num_posts ) && property_exists( $num_posts, 'publish' ) ) {
$num_posts = $num_posts->publish;
}
if ( ! $num_posts || ! is_numeric( $num_posts ) ) {
echo acf_esc_html( $no_posts );
return;
}
printf(
'<a href="%s">%s</a>',
esc_url( admin_url( 'edit.php?post_type=' . $post_type['post_type'] ) ),
esc_html( number_format_i18n( $num_posts ) )
);
}
/**
* Gets the translated action notice text for list table actions (activate, deactivate, sync, etc.).
*
* @since 6.1
*
* @param string $action The action being performed.
* @param integer $count The number of items the action was performed on.
* @return string
*/
public function get_action_notice_text( $action, $count = 1 ) {
$text = '';
$count = (int) $count;
switch ( $action ) {
case 'acfactivatecomplete':
$text = sprintf(
/* translators: %s number of post types activated */
_n( 'Post type activated.', '%s post types activated.', $count, 'acf' ),
$count
);
break;
case 'acfdeactivatecomplete':
$text = sprintf(
/* translators: %s number of post types deactivated */
_n( 'Post type deactivated.', '%s post types deactivated.', $count, 'acf' ),
$count
);
break;
case 'acfduplicatecomplete':
$text = sprintf(
/* translators: %s number of post types duplicated */
_n( 'Post type duplicated.', '%s post types duplicated.', $count, 'acf' ),
$count
);
break;
case 'acfsynccomplete':
$text = sprintf(
/* translators: %s number of post types synchronized */
_n( 'Post type synchronized.', '%s post types synchronized.', $count, 'acf' ),
$count
);
break;
}
return $text;
}
/**
* Returns the registration error state.
*
* @since 6.1
*
* @return string
*/
public function get_registration_error_state() {
return '<span class="acf-js-tooltip dashicons dashicons-warning" title="' .
__( 'This post type could not be registered because its key is in use by another post type registered by another plugin or theme.', 'acf' ) .
'"></span> ' . _x( 'Registration Failed', 'post status', 'acf' );
}
}