Skip to content

Added support for post type archives in association field #540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Added support for post type archives in association field #540

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
afba948
Added support for post type archives in association field
zevilz Jun 3, 2018
5b4ef60
updated
zevilz Jun 3, 2018
0b364eb
fixed post type archive hooks names
zevilz Jun 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 59 additions & 17 deletions core/Field/Association_Field.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ protected function value_string_to_property_array( $value_string ) {
Value_Set::VALUE_PROPERTY => $value_string,
'type' => $type,
'subtype' => $subtype,
'id' => intval( $id ),
'id' => ( $type == 'post_type_archive' ) ? $id : intval( $id ),
);
return $property_array;
}
Expand Down Expand Up @@ -179,7 +179,7 @@ protected function value_string_array_to_value_set( $value_string_array ) {
*
* Can be overriden or extended by the `carbon_association_title` filter.
*
* @param int $id The database ID of the item.
* @param int|string $id The database ID of the item or post type name if type is "post_type_archive".
* @param string $type Item type (post, term, user, comment, or a custom one).
* @param string $subtype The subtype - "page", "post", "category", etc.
* @return string $title The title of the item.
Expand All @@ -200,14 +200,19 @@ protected function get_title_by_type( $id, $type, $subtype = '' ) {
}
}

if ( $type === 'post_type_archive' ) {
$post_type_object = get_post_type_object($id);
$title = $post_type_object->label;
}

/**
* Filter the title of the association item.
*
* @param string $title The unfiltered item title.
* @param string $name Name of the association field.
* @param int $id The database ID of the item.
* @param string $type Item type (post, term, user, comment, or a custom one).
* @param string $subtype Subtype - "page", "post", "category", etc.
* @param string $title The unfiltered item title.
* @param string $name Name of the association field.
* @param int|string $id The database ID of the item or post type name if type is "post_type_archive".
* @param string $type Item type (post, term, user, comment, or a custom one).
* @param string $subtype Subtype - "page", "post", "category", etc.
*/
$title = apply_filters( 'carbon_fields_association_field_title', $title, $this->get_base_name(), $id, $type, $subtype );

Expand All @@ -223,9 +228,9 @@ protected function get_title_by_type( $id, $type, $subtype = '' ) {
*
* Can be overriden or extended by the `carbon_association_item_label` filter.
*
* @param int $id The database ID of the item.
* @param string $type Item type (post, term, user, comment, or a custom one).
* @param string $subtype Subtype - "page", "post", "category", etc.
* @param int|string $id The database ID of the item or post type name if type is "post_type_archive".
* @param string $type Item type (post, term, user, comment, or a custom one).
* @param string $subtype Subtype - "page", "post", "category", etc.
* @return string $label The label of the item.
*/
protected function get_item_label( $id, $type, $subtype = '' ) {
Expand All @@ -237,16 +242,18 @@ protected function get_item_label( $id, $type, $subtype = '' ) {
} elseif ( $type === 'term' ) {
$taxonomy_object = get_taxonomy( $subtype );
$label = $taxonomy_object->labels->singular_name;
} elseif ( $type === 'post_type_archive' ) {
$label = __('Post Type Archive');
}

/**
* Filter the label of the association item.
*
* @param string $label The unfiltered item label.
* @param string $name Name of the association field.
* @param int $id The database ID of the item.
* @param string $type Item type (post, term, user, comment, or a custom one).
* @param string $subtype Subtype - "page", "post", "category", etc.
* @param string $label The unfiltered item label.
* @param string $name Name of the association field.
* @param int|string $id The database ID of the item or post type name if type is "post_type_archive".
* @param string $type Item type (post, term, user, comment, or a custom one).
* @param string $subtype Subtype - "page", "post", "category", etc.
*/
return apply_filters( 'carbon_fields_association_field_item_label', $label, $this->get_base_name(), $id, $type, $subtype );
}
Expand Down Expand Up @@ -286,6 +293,41 @@ protected function get_post_options( $type ) {
return $posts;
}

/**
* Get post type archive options
*
* @return array $options
*/
protected function get_post_type_archive_options( $type ) {
/**
* Filter the default query when fetching post types for a particular field.
*
* @param array $args The parameters, passed to get_post_types().
*/
$filter_name = 'carbon_fields_association_field_options_' . $this->get_base_name() . '_' . $type['type'];
$args = apply_filters( $filter_name, array(
'public' => true,
'has_archive' => true,
) );

// fetch and prepare post types archives as association items
$post_types = get_post_types($args, 'names');
foreach ( $post_types as &$p ) {
$post_type = $p;
$p = array(
'id' => $post_type,
'title' => $this->get_title_by_type( $p, $type['type'] ),
'type' => $type['type'],
'subtype' => 'post_type_archive',
'label' => $this->get_item_label( $p, $type['type'] ),
'is_trashed' => false,
'edit_link' => false,
);
}
$post_type_archives = array_values($post_types);
return $post_type_archives;
}

/**
* Get term options
*
Expand Down Expand Up @@ -538,7 +580,7 @@ public function allow_duplicates( $allow = true ) {
* where the value of each array item contains:
* - Type of data (post, term, user or comment)
* - Subtype of data (the particular post type or taxonomy)
* - ID of the item (the database ID of the item)
* - ID of the item (the database ID of the item) or post type name if type is "post_type_archive"
*/
protected function value_to_json() {
$value_set = $this->get_value();
Expand All @@ -547,7 +589,7 @@ protected function value_to_json() {
$item = array(
'type' => $entry['type'],
'subtype' => $entry['subtype'],
'id' => intval( $entry['id'] ),
'id' => ( $entry['type'] == 'post_type_archive' ) ? $entry['id'] : intval( $entry['id'] ),
'title' => $this->get_title_by_type( $entry['id'], $entry['type'], $entry['subtype'] ),
'label' => $this->get_item_label( $entry['id'], $entry['type'], $entry['subtype'] ),
'is_trashed' => ( $entry['type'] == 'post' && get_post_status( $entry['id'] ) === 'trash' ),
Expand Down