' . "\n";
if ( $add_handle ) {
if ( $is_55 ) {
echo '' . "\n";
} else {
echo $toggle_button;
echo $title_tag;
}
echo '
' . "\n";
}
}
/**
* Output the closing markup for a context box.
*
* @since 2.2.4
* @param bool $add_inside_close Whether to add closing div for .inside.
*/
public function context_box_title_markup_close( $add_inside_close = true ) {
// Load the closing divs for a title box.
if ( $add_inside_close ) {
echo '
' . "\n"; // .inside
}
echo '
' . "\n"; // .context-box
}
/**
* Add metaboxes (to 'post' or 'comment' object types)
*
* @since 1.0.0
*/
public function add_metaboxes() {
if ( ! $this->show_on() ) {
return;
}
/*
* To keep from registering an actual post-screen metabox,
* omit the 'title' property from the metabox registration array.
*
* (WordPress will not display metaboxes without titles anyway)
*
* This is a good solution if you want to handle outputting your
* metaboxes/fields elsewhere in the post-screen.
*/
if ( ! $this->cmb->prop( 'title' ) ) {
return;
}
$page = get_current_screen()->id;
add_filter( "postbox_classes_{$page}_{$this->cmb->cmb_id}", array( $this, 'postbox_classes' ) );
foreach ( $this->cmb->box_types() as $object_type ) {
add_meta_box(
$this->cmb->cmb_id,
$this->cmb->prop( 'title' ),
array( $this, 'metabox_callback' ),
$object_type,
$this->cmb->prop( 'context' ),
$this->cmb->prop( 'priority' ),
$this->cmb->prop( 'mb_callback_args' )
);
}
}
/**
* Remove the specified default taxonomy metaboxes for a post-type.
*
* @since 2.2.3
*
*/
public function remove_default_tax_metaboxes() {
$to_remove = array_filter( (array) $this->cmb->tax_metaboxes_to_remove, 'taxonomy_exists' );
if ( empty( $to_remove ) ) {
return;
}
foreach ( $this->cmb->box_types() as $post_type ) {
foreach ( $to_remove as $taxonomy ) {
$mb_id = is_taxonomy_hierarchical( $taxonomy ) ? "{$taxonomy}div" : "tagsdiv-{$taxonomy}";
remove_meta_box( $mb_id, $post_type, 'side' );
}
}
}
/**
* Modify metabox postbox classes.
*
* @since 2.2.4
* @param array $classes Array of classes.
* @return array Modified array of classes
*/
public function postbox_classes( $classes ) {
if ( $this->cmb->prop( 'closed' ) && ! in_array( 'closed', $classes ) ) {
$classes[] = 'closed';
}
if ( $this->cmb->is_alternate_context_box() ) {
$classes = $this->alternate_context_postbox_classes( $classes );
} else {
$classes[] = 'cmb2-postbox';
}
return $classes;
}
/**
* Modify metabox altnernate context postbox classes.
*
* @since 2.2.4
* @param array $classes Array of classes.
* @return array Modified array of classes
*/
protected function alternate_context_postbox_classes( $classes ) {
$classes[] = 'context-box';
$classes[] = 'context-' . $this->cmb->prop( 'context' ) . '-box';
if ( in_array( $this->cmb->cmb_id, get_hidden_meta_boxes( get_current_screen() ) ) ) {
$classes[] = 'hide-if-js';
}
$add_wrap = $this->cmb->prop( 'title' ) || ! $this->cmb->prop( 'remove_box_wrap' );
if ( $add_wrap ) {
$classes[] = 'cmb2-postbox postbox';
} else {
$classes[] = 'cmb2-no-box-wrap';
}
return $classes;
}
/**
* Display metaboxes for a post or comment object.
*
* @since 1.0.0
*/
public function metabox_callback() {
$object_id = 'comment' === $this->object_type ? get_comment_ID() : get_the_ID();
$this->cmb->show_form( $object_id, $this->object_type );
}
/**
* Display metaboxes for new user page.
*
* @since 1.0.0
*
* @param mixed $section User section metabox.
*/
public function user_new_metabox( $section ) {
if ( $section === $this->cmb->prop( 'new_user_section' ) ) {
$object_id = $this->cmb->object_id();
$this->cmb->object_id( isset( $_REQUEST['user_id'] ) ? $_REQUEST['user_id'] : $object_id );
$this->user_metabox();
}
}
/**
* Display metaboxes for a user object.
*
* @since 1.0.0
*/
public function user_metabox() {
$this->show_form_for_type( 'user' );
}
/**
* Display metaboxes for a taxonomy term object.
*
* @since 2.2.0
*/
public function term_metabox() {
$this->show_form_for_type( 'term' );
}
/**
* Display metaboxes for an object type.
*
* @since 2.2.0
* @param string $type Object type.
* @return void
*/
public function show_form_for_type( $type ) {
if ( $type != $this->object_type ) {
return;
}
if ( ! $this->show_on() ) {
return;
}
if ( $this->cmb->prop( 'cmb_styles' ) ) {
self::enqueue_cmb_css();
}
if ( $this->cmb->prop( 'enqueue_js' ) ) {
self::enqueue_cmb_js();
}
$this->cmb->show_form( 0, $type );
}
/**
* Determines if metabox should be shown in current context.
*
* @since 2.0.0
* @return bool Whether metabox should be added/shown.
*/
public function show_on() {
// If metabox is requesting to be conditionally shown.
$show = $this->cmb->should_show();
/**
* Filter to determine if metabox should show. Default is true.
*
* @param array $show Default is true, show the metabox.
* @param mixed $meta_box_args Array of the metabox arguments.
* @param mixed $cmb The CMB2 instance.
*/
$show = (bool) apply_filters( 'cmb2_show_on', $show, $this->cmb->meta_box, $this->cmb );
return $show;
}
/**
* Get the CMB priority property set to numeric hook priority.
*
* @since 2.2.0
*
* @param integer $default Default display hook priority.
* @return integer Hook priority.
*/
public function get_priority( $default = 10 ) {
$priority = $this->cmb->prop( 'priority' );
if ( ! is_numeric( $priority ) ) {
switch ( $priority ) {
case 'high':
$priority = 5;
break;
case 'low':
$priority = 20;
break;
default:
$priority = $default;
break;
}
}
return $priority;
}
/**
* Save data from post metabox
*
* @since 1.0.0
* @param int $post_id Post ID.
* @param mixed $post Post object.
* @return void
*/
public function save_post( $post_id, $post = false ) {
$post_type = $post ? $post->post_type : get_post_type( $post_id );
$do_not_pass_go = (
! $this->can_save( $post_type )
// Check user editing permissions.
|| ( 'page' === $post_type && ! current_user_can( 'edit_page', $post_id ) )
|| ! current_user_can( 'edit_post', $post_id )
);
if ( $do_not_pass_go ) {
return;
}
$this->cmb->save_fields( $post_id, 'post', $_POST );
}
/**
* Save data from comment metabox.
*
* @since 2.0.9
* @param int $comment_id Comment ID.
* @return void
*/
public function save_comment( $comment_id ) {
$can_edit = current_user_can( 'moderate_comments', $comment_id );
if ( $this->can_save( get_comment_type( $comment_id ) ) && $can_edit ) {
$this->cmb->save_fields( $comment_id, 'comment', $_POST );
}
}
/**
* Save data from user fields.
*
* @since 1.0.x
* @param int $user_id User ID.
* @return void
*/
public function save_user( $user_id ) {
// check permissions.
if ( $this->can_save( 'user' ) ) {
$this->cmb->save_fields( $user_id, 'user', $_POST );
}
}
/**
* Save data from term fields
*
* @since 2.2.0
* @param int $term_id Term ID.
* @param int $tt_id Term Taxonomy ID.
* @param string $taxonomy Taxonomy.
* @return void
*/
public function save_term( $term_id, $tt_id, $taxonomy = '' ) {
$taxonomy = $taxonomy ? $taxonomy : $tt_id;
// check permissions.
if ( $this->taxonomy_can_save( $taxonomy ) && $this->can_save( 'term' ) ) {
$this->cmb->save_fields( $term_id, 'term', $_POST );
}
}
/**
* Delete term meta when a term is deleted.
*
* @since 2.2.0
* @param int $term_id Term ID.
* @param int $tt_id Term Taxonomy ID.
* @param string $taxonomy Taxonomy.
* @return void
*/
public function delete_term( $term_id, $tt_id, $taxonomy = '' ) {
if ( $this->taxonomy_can_save( $taxonomy ) ) {
$data_to_delete = array();
foreach ( $this->cmb->prop( 'fields' ) as $field ) {
$data_to_delete[ $field['id'] ] = '';
}
$this->cmb->save_fields( $term_id, 'term', $data_to_delete );
}
}
/**
* Determines if the current object is able to be saved.
*
* @since 2.0.9
* @param string $type Current object type.
* @return bool Whether object can be saved.
*/
public function can_save( $type = '' ) {
$can_save = (
$this->cmb->prop( 'save_fields' )
// check nonce.
&& isset( $_POST[ $this->cmb->nonce() ] )
&& wp_verify_nonce( $_POST[ $this->cmb->nonce() ], $this->cmb->nonce() )
// check if autosave.
&& ! ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE )
// get the metabox types & compare it to this type.
&& ( $type && in_array( $type, $this->cmb->box_types() ) )
// Don't do updates during a switch-to-blog instance.
&& ! ( is_multisite() && ms_is_switched() )
);
/**
* Filter to determine if metabox is allowed to save.
*
* @param bool $can_save Whether the current metabox can save.
* @param object $cmb The CMB2 instance.
*/
return apply_filters( 'cmb2_can_save', $can_save, $this->cmb );
}
/**
* Determine if taxonomy of term being modified is cmb2-editable.
*
* @since 2.2.0
*
* @param string $taxonomy Taxonomy of term being modified.
* @return bool Whether taxonomy is editable.
*/
public function taxonomy_can_save( $taxonomy ) {
if ( empty( $this->taxonomies ) || ! in_array( $taxonomy, $this->taxonomies ) ) {
return false;
}
$taxonomy_object = get_taxonomy( $taxonomy );
// Can the user edit this term?
if ( ! isset( $taxonomy_object->cap ) || ! current_user_can( $taxonomy_object->cap->edit_terms ) ) {
return false;
}
return true;
}
/**
* Enqueues the 'cmb2-display-styles' if the conditions match (has columns, on the right page, etc).
*
* @since 2.2.2.1
*/
protected function maybe_enqueue_column_display_styles() {
global $pagenow;
if (
$pagenow
&& $this->cmb->has_columns
&& $this->cmb->prop( 'cmb_styles' )
&& in_array( $pagenow, array( 'edit.php', 'users.php', 'edit-comments.php', 'edit-tags.php' ), 1 )
) {
self::enqueue_cmb_css( 'cmb2-display-styles' );
}
}
/**
* Includes CMB2 styles.
*
* @since 2.0.0
*
* @param string $handle CSS handle.
* @return mixed
*/
public static function enqueue_cmb_css( $handle = 'cmb2-styles' ) {
/**
* Filter to determine if CMB2'S css should be enqueued.
*
* @param bool $enqueue_css Default is true.
*/
if ( ! apply_filters( 'cmb2_enqueue_css', true ) ) {
return false;
}
self::register_styles();
/*
* White list the options as this method can be used as a hook callback
* and have a different argument passed.
*/
return wp_enqueue_style( 'cmb2-display-styles' === $handle ? $handle : 'cmb2-styles' );
}
/**
* Includes CMB2 JS.
*
* @since 2.0.0
*/
public static function enqueue_cmb_js() {
/**
* Filter to determine if CMB2'S JS should be enqueued.
*
* @param bool $enqueue_js Default is true.
*/
if ( ! apply_filters( 'cmb2_enqueue_js', true ) ) {
return false;
}
self::register_js();
return true;
}
}