File example-functions.php | CMB2 Documentation

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808

<?php
/**
 * Include and setup custom metaboxes and fields. (make sure you copy this file to outside the CMB2 directory)
 *
 * Be sure to replace all instances of 'yourprefix_' with your project's prefix.
 * http://nacin.com/2010/05/11/in-wordpress-prefix-everything/
 *
 * @category YourThemeOrPlugin
 * @package  Demo_CMB2
 * @license  http://www.opensource.org/licenses/gpl-license.php GPL v2.0 (or later)
 * @link     https://github.com/CMB2/CMB2
 */

/**
 * Get the bootstrap! If using the plugin from wordpress.org, REMOVE THIS!
 */

if ( file_exists( dirname( __FILE__ ) . '/cmb2/init.php' ) ) {
    require_once dirname( __FILE__ ) . '/cmb2/init.php';
} elseif ( file_exists( dirname( __FILE__ ) . '/CMB2/init.php' ) ) {
    require_once dirname( __FILE__ ) . '/CMB2/init.php';
}

/**
 * Conditionally displays a metabox when used as a callback in the 'show_on_cb' cmb2_box parameter
 *
 * @param  CMB2 $cmb CMB2 object.
 *
 * @return bool      True if metabox should show
 */
function yourprefix_show_if_front_page( $cmb ) {
    // Don't show this metabox if it's not the front page template.
    if ( get_option( 'page_on_front' ) !== $cmb->object_id ) {
        return false;
    }
    return true;
}

/**
 * Conditionally displays a field when used as a callback in the 'show_on_cb' field parameter
 *
 * @param  CMB2_Field $field Field object.
 *
 * @return bool              True if metabox should show
 */
function yourprefix_hide_if_no_cats( $field ) {
    // Don't show this field if not in the cats category.
    if ( ! has_tag( 'cats', $field->object_id ) ) {
        return false;
    }
    return true;
}

/**
 * Manually render a field.
 *
 * @param  array      $field_args Array of field arguments.
 * @param  CMB2_Field $field      The field object.
 */
function yourprefix_render_row_cb( $field_args, $field ) {
    $classes     = $field->row_classes();
    $id          = $field->args( 'id' );
    $label       = $field->args( 'name' );
    $name        = $field->args( '_name' );
    $value       = $field->escaped_value();
    $description = $field->args( 'description' );
    ?>
    <div class="custom-field-row <?php echo esc_attr( $classes ); ?>">
        <p><label for="<?php echo esc_attr( $id ); ?>"><?php echo esc_html( $label ); ?></label></p>
        <p><input id="<?php echo esc_attr( $id ); ?>" type="text" name="<?php echo esc_attr( $name ); ?>" value="<?php echo $value; ?>"/></p>
        <p class="description"><?php echo esc_html( $description ); ?></p>
    </div>
    <?php
}

/**
 * Manually render a field column display.
 *
 * @param  array      $field_args Array of field arguments.
 * @param  CMB2_Field $field      The field object.
 */
function yourprefix_display_text_small_column( $field_args, $field ) {
    ?>
    <div class="custom-column-display <?php echo esc_attr( $field->row_classes() ); ?>">
        <p><?php echo $field->escaped_value(); ?></p>
        <p class="description"><?php echo esc_html( $field->args( 'description' ) ); ?></p>
    </div>
    <?php
}

/**
 * Conditionally displays a message if the $post_id is 2
 *
 * @param  array      $field_args Array of field parameters.
 * @param  CMB2_Field $field      Field object.
 */
function yourprefix_before_row_if_2( $field_args, $field ) {
    if ( 2 == $field->object_id ) {
        echo '<p>Testing <b>"before_row"</b> parameter (on $post_id 2)</p>';
    } else {
        echo '<p>Testing <b>"before_row"</b> parameter (<b>NOT</b> on $post_id 2)</p>';
    }
}

add_action( 'cmb2_admin_init', 'yourprefix_register_demo_metabox' );
/**
 * Hook in and add a demo metabox. Can only happen on the 'cmb2_admin_init' or 'cmb2_init' hook.
 */
function yourprefix_register_demo_metabox() {
    /**
     * Sample metabox to demonstrate each field type included
     */
    $cmb_demo = new_cmb2_box( array(
        'id'            => 'yourprefix_demo_metabox',
        'title'         => esc_html__( 'Test Metabox', 'cmb2' ),
        'object_types'  => array( 'page' ), // Post type
        // 'show_on_cb' => 'yourprefix_show_if_front_page', // function should return a bool value
        // 'context'    => 'normal',
        // 'priority'   => 'high',
        // 'show_names' => true, // Show field names on the left
        // 'cmb_styles' => false, // false to disable the CMB stylesheet
        // 'closed'     => true, // true to keep the metabox closed by default
        // 'classes'    => 'extra-class', // Extra cmb2-wrap classes
        // 'classes_cb' => 'yourprefix_add_some_classes', // Add classes through a callback.

        /*
         * The following parameter is any additional arguments passed as $callback_args
         * to add_meta_box, if/when applicable.
         *
         * CMB2 does not use these arguments in the add_meta_box callback, however, these args
         * are parsed for certain special properties, like determining Gutenberg/block-editor
         * compatibility.
         *
         * Examples:
         *
         * - Make sure default editor is used as metabox is not compatible with block editor
         *      [ '__block_editor_compatible_meta_box' => false/true ]
         *
         * - Or declare this box exists for backwards compatibility
         *      [ '__back_compat_meta_box' => false ]
         *
         * More: https://wordpress.org/gutenberg/handbook/extensibility/meta-box/
         */
        // 'mb_callback_args' => array( '__block_editor_compatible_meta_box' => false ),
    ) );

    $cmb_demo->add_field( array(
        'name'       => esc_html__( 'Test Text', 'cmb2' ),
        'desc'       => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'         => 'yourprefix_demo_text',
        'type'       => 'text',
        'show_on_cb' => 'yourprefix_hide_if_no_cats', // function should return a bool value
        // 'sanitization_cb' => 'my_custom_sanitization', // custom sanitization callback parameter
        // 'escape_cb'       => 'my_custom_escaping',  // custom escaping callback parameter
        // 'on_front'        => false, // Optionally designate a field to wp-admin only
        // 'repeatable'      => true,
        // 'column'          => true, // Display field value in the admin post-listing columns
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Text Small', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_textsmall',
        'type' => 'text_small',
        // 'repeatable' => true,
        // 'column' => array(
        //  'name'     => esc_html__( 'Column Title', 'cmb2' ), // Set the admin column title
        //  'position' => 2, // Set as the second column.
        // );
        // 'display_cb' => 'yourprefix_display_text_small_column', // Output the display of the column values through a callback.
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Text Medium', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_textmedium',
        'type' => 'text_medium',
    ) );

    $cmb_demo->add_field( array(
        'name'       => esc_html__( 'Read-only Disabled Field', 'cmb2' ),
        'desc'       => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'         => 'yourprefix_demo_readonly',
        'type'       => 'text_medium',
        'default'    => esc_attr__( 'Hey there, I\'m a read-only field', 'cmb2' ),
        'save_field' => false, // Disables the saving of this field.
        'attributes' => array(
            'disabled' => 'disabled',
            'readonly' => 'readonly',
        ),
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Custom Rendered Field', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_render_row_cb',
        'type' => 'text',
        'render_row_cb' => 'yourprefix_render_row_cb',
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Website URL', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_url',
        'type' => 'text_url',
        // 'protocols' => array('http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet'), // Array of allowed protocols
        // 'repeatable' => true,
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Text Email', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_email',
        'type' => 'text_email',
        // 'repeatable' => true,
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Time', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_time',
        'type' => 'text_time',
        // 'time_format' => 'H:i', // Set to 24hr format
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Time zone', 'cmb2' ),
        'desc' => esc_html__( 'Time zone', 'cmb2' ),
        'id'   => 'yourprefix_demo_timezone',
        'type' => 'select_timezone',
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Date Picker', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_textdate',
        'type' => 'text_date',
        // 'date_format' => 'Y-m-d',
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Date Picker (UNIX timestamp)', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_textdate_timestamp',
        'type' => 'text_date_timestamp',
        // 'timezone_meta_key' => 'yourprefix_demo_timezone', // Optionally make this field honor the timezone selected in the select_timezone specified above
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Date/Time Picker Combo (UNIX timestamp)', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_datetime_timestamp',
        'type' => 'text_datetime_timestamp',
    ) );

    // This text_datetime_timestamp_timezone field type
    // is only compatible with PHP versions 5.3 or above.
    // Feel free to uncomment and use if your server meets the requirement
    // $cmb_demo->add_field( array(
    //  'name' => esc_html__( 'Test Date/Time Picker/Time zone Combo (serialized DateTime object)', 'cmb2' ),
    //  'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
    //  'id'   => 'yourprefix_demo_datetime_timestamp_timezone',
    //  'type' => 'text_datetime_timestamp_timezone',
    // ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Money', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_textmoney',
        'type' => 'text_money',
        // 'before_field' => '£', // override '$' symbol if needed
        // 'repeatable' => true,
    ) );

    $cmb_demo->add_field( array(
        'name'    => esc_html__( 'Test Color Picker', 'cmb2' ),
        'desc'    => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'      => 'yourprefix_demo_colorpicker',
        'type'    => 'colorpicker',
        'default' => '#ffffff',
        // 'options' => array(
        //  'alpha' => true, // Make this a rgba color picker.
        // ),
        // 'attributes' => array(
        //  'data-colorpicker' => json_encode( array(
        //      'palettes' => array( '#3dd0cc', '#ff834c', '#4fa2c0', '#0bc991', ),
        //  ) ),
        // ),
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Text Area', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_textarea',
        'type' => 'textarea',
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Text Area Small', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_textareasmall',
        'type' => 'textarea_small',
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Text Area for Code', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_textarea_code',
        'type' => 'textarea_code',
        // 'attributes' => array(
        //  // Optionally override the code editor defaults.
        //  'data-codeeditor' => json_encode( array(
        //      'codemirror' => array(
        //          'lineNumbers' => false,
        //          'mode' => 'css',
        //      ),
        //  ) ),
        // ),
        // To keep the previous formatting, you can disable codemirror.
        // 'options' => array( 'disable_codemirror' => true ),
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Title Weeeee', 'cmb2' ),
        'desc' => esc_html__( 'This is a title description', 'cmb2' ),
        'id'   => 'yourprefix_demo_title',
        'type' => 'title',
    ) );

    $cmb_demo->add_field( array(
        'name'             => esc_html__( 'Test Select', 'cmb2' ),
        'desc'             => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'               => 'yourprefix_demo_select',
        'type'             => 'select',
        'show_option_none' => true,
        'options'          => array(
            'standard' => esc_html__( 'Option One', 'cmb2' ),
            'custom'   => esc_html__( 'Option Two', 'cmb2' ),
            'none'     => esc_html__( 'Option Three', 'cmb2' ),
        ),
    ) );

    $cmb_demo->add_field( array(
        'name'             => esc_html__( 'Test Radio inline', 'cmb2' ),
        'desc'             => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'               => 'yourprefix_demo_radio_inline',
        'type'             => 'radio_inline',
        'show_option_none' => 'No Selection',
        'options'          => array(
            'standard' => esc_html__( 'Option One', 'cmb2' ),
            'custom'   => esc_html__( 'Option Two', 'cmb2' ),
            'none'     => esc_html__( 'Option Three', 'cmb2' ),
        ),
    ) );

    $cmb_demo->add_field( array(
        'name'    => esc_html__( 'Test Radio', 'cmb2' ),
        'desc'    => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'      => 'yourprefix_demo_radio',
        'type'    => 'radio',
        'options' => array(
            'option1' => esc_html__( 'Option One', 'cmb2' ),
            'option2' => esc_html__( 'Option Two', 'cmb2' ),
            'option3' => esc_html__( 'Option Three', 'cmb2' ),
        ),
    ) );

    $cmb_demo->add_field( array(
        'name'     => esc_html__( 'Test Taxonomy Radio', 'cmb2' ),
        'desc'     => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'       => 'yourprefix_demo_text_taxonomy_radio',
        'type'     => 'taxonomy_radio', // Or `taxonomy_radio_inline`/`taxonomy_radio_hierarchical`
        'taxonomy' => 'category', // Taxonomy Slug
        // 'inline'  => true, // Toggles display to inline
        // Optionally override the args sent to the WordPress get_terms function.
        'query_args' => array(
            // 'orderby' => 'slug',
            // 'hide_empty' => true,
        ),
    ) );

    $cmb_demo->add_field( array(
        'name'     => esc_html__( 'Test Taxonomy Select', 'cmb2' ),
        'desc'     => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'       => 'yourprefix_demo_taxonomy_select',
        'type'     => 'taxonomy_select', // Or `taxonomy_select_hierarchical`
        'taxonomy' => 'category', // Taxonomy Slug
    ) );

    $cmb_demo->add_field( array(
        'name'     => esc_html__( 'Test Taxonomy Multi Checkbox', 'cmb2' ),
        'desc'     => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'       => 'yourprefix_demo_multitaxonomy',
        'type'     => 'taxonomy_multicheck', // Or `taxonomy_multicheck_inline`/`taxonomy_multicheck_hierarchical`
        'taxonomy' => 'post_tag', // Taxonomy Slug
        // 'inline'  => true, // Toggles display to inline
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Checkbox', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_demo_checkbox',
        'type' => 'checkbox',
    ) );

    $cmb_demo->add_field( array(
        'name'    => esc_html__( 'Test Multi Checkbox', 'cmb2' ),
        'desc'    => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'      => 'yourprefix_demo_multicheckbox',
        'type'    => 'multicheck',
        // 'multiple' => true, // Store values in individual rows
        'options' => array(
            'check1' => esc_html__( 'Check One', 'cmb2' ),
            'check2' => esc_html__( 'Check Two', 'cmb2' ),
            'check3' => esc_html__( 'Check Three', 'cmb2' ),
        ),
        // 'inline'  => true, // Toggles display to inline
    ) );

    $cmb_demo->add_field( array(
        'name'    => esc_html__( 'Test wysiwyg', 'cmb2' ),
        'desc'    => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'      => 'yourprefix_demo_wysiwyg',
        'type'    => 'wysiwyg',
        'options' => array(
            'textarea_rows' => 5,
        ),
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'Test Image', 'cmb2' ),
        'desc' => esc_html__( 'Upload an image or enter a URL.', 'cmb2' ),
        'id'   => 'yourprefix_demo_image',
        'type' => 'file',
    ) );

    $cmb_demo->add_field( array(
        'name'         => esc_html__( 'Multiple Files', 'cmb2' ),
        'desc'         => esc_html__( 'Upload or add multiple images/attachments.', 'cmb2' ),
        'id'           => 'yourprefix_demo_file_list',
        'type'         => 'file_list',
        'preview_size' => array( 100, 100 ), // Default: array( 50, 50 )
    ) );

    $cmb_demo->add_field( array(
        'name' => esc_html__( 'oEmbed', 'cmb2' ),
        'desc' => sprintf(
            /* translators: %s: link to codex.wordpress.org/Embeds */
            esc_html__( 'Enter a youtube, twitter, or instagram URL. Supports services listed at %s.', 'cmb2' ),
            '<a href="https://wordpress.org/support/article/embeds/">codex.wordpress.org/Embeds</a>'
        ),
        'id'   => 'yourprefix_demo_embed',
        'type' => 'oembed',
    ) );

    $cmb_demo->add_field( array(
        'name'         => 'Testing Field Parameters',
        'id'           => 'yourprefix_demo_parameters',
        'type'         => 'text',
        'before_row'   => 'yourprefix_before_row_if_2', // callback.
        'before'       => '<p>Testing <b>"before"</b> parameter</p>',
        'before_field' => '<p>Testing <b>"before_field"</b> parameter</p>',
        'after_field'  => '<p>Testing <b>"after_field"</b> parameter</p>',
        'after'        => '<p>Testing <b>"after"</b> parameter</p>',
        'after_row'    => '<p>Testing <b>"after_row"</b> parameter</p>',
    ) );

}

add_action( 'cmb2_admin_init', 'yourprefix_register_about_page_metabox' );
/**
 * Hook in and add a metabox that only appears on the 'About' page
 */
function yourprefix_register_about_page_metabox() {

    /**
     * Metabox to be displayed on a single page ID
     */
    $cmb_about_page = new_cmb2_box( array(
        'id'           => 'yourprefix_about_metabox',
        'title'        => esc_html__( 'About Page Metabox', 'cmb2' ),
        'object_types' => array( 'page' ), // Post type
        'context'      => 'normal',
        'priority'     => 'high',
        'show_names'   => true, // Show field names on the left
        'show_on'      => array(
            'id' => array( 2 ),
        ), // Specific post IDs to display this metabox
    ) );

    $cmb_about_page->add_field( array(
        'name' => esc_html__( 'Test Text', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_about_text',
        'type' => 'text',
    ) );

}

add_action( 'cmb2_admin_init', 'yourprefix_register_repeatable_group_field_metabox' );
/**
 * Hook in and add a metabox to demonstrate repeatable grouped fields
 */
function yourprefix_register_repeatable_group_field_metabox() {

    /**
     * Repeatable Field Groups
     */
    $cmb_group = new_cmb2_box( array(
        'id'           => 'yourprefix_group_metabox',
        'title'        => esc_html__( 'Repeating Field Group', 'cmb2' ),
        'object_types' => array( 'page' ),
    ) );

    // $group_field_id is the field id string, so in this case: 'yourprefix_group_demo'
    $group_field_id = $cmb_group->add_field( array(
        'id'          => 'yourprefix_group_demo',
        'type'        => 'group',
        'description' => esc_html__( 'Generates reusable form entries', 'cmb2' ),
        'options'     => array(
            'group_title'    => esc_html__( 'Entry {#}', 'cmb2' ), // {#} gets replaced by row number
            'add_button'     => esc_html__( 'Add Another Entry', 'cmb2' ),
            'remove_button'  => esc_html__( 'Remove Entry', 'cmb2' ),
            'sortable'       => true,
            // 'closed'      => true, // true to have the groups closed by default
            // 'remove_confirm' => esc_html__( 'Are you sure you want to remove?', 'cmb2' ), // Performs confirmation before removing group.
        ),
    ) );

    /**
     * Group fields works the same, except ids only need
     * to be unique to the group. Prefix is not needed.
     *
     * The parent field's id needs to be passed as the first argument.
     */
    $cmb_group->add_group_field( $group_field_id, array(
        'name'       => esc_html__( 'Entry Title', 'cmb2' ),
        'id'         => 'title',
        'type'       => 'text',
        // 'repeatable' => true, // Repeatable fields are supported w/in repeatable groups (for most types)
    ) );

    $cmb_group->add_group_field( $group_field_id, array(
        'name'        => esc_html__( 'Description', 'cmb2' ),
        'description' => esc_html__( 'Write a short description for this entry', 'cmb2' ),
        'id'          => 'description',
        'type'        => 'textarea_small',
    ) );

    $cmb_group->add_group_field( $group_field_id, array(
        'name' => esc_html__( 'Entry Image', 'cmb2' ),
        'id'   => 'image',
        'type' => 'file',
    ) );

    $cmb_group->add_group_field( $group_field_id, array(
        'name' => esc_html__( 'Image Caption', 'cmb2' ),
        'id'   => 'image_caption',
        'type' => 'text',
    ) );

}

add_action( 'cmb2_admin_init', 'yourprefix_register_user_profile_metabox' );
/**
 * Hook in and add a metabox to add fields to the user profile pages
 */
function yourprefix_register_user_profile_metabox() {

    /**
     * Metabox for the user profile screen
     */
    $cmb_user = new_cmb2_box( array(
        'id'               => 'yourprefix_user_edit',
        'title'            => esc_html__( 'User Profile Metabox', 'cmb2' ), // Doesn't output for user boxes
        'object_types'     => array( 'user' ), // Tells CMB2 to use user_meta vs post_meta
        'show_names'       => true,
        'new_user_section' => 'add-new-user', // where form will show on new user page. 'add-existing-user' is only other valid option.
    ) );

    $cmb_user->add_field( array(
        'name'     => esc_html__( 'Extra Info', 'cmb2' ),
        'desc'     => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'       => 'yourprefix_user_extra_info',
        'type'     => 'title',
        'on_front' => false,
    ) );

    $cmb_user->add_field( array(
        'name'    => esc_html__( 'Avatar', 'cmb2' ),
        'desc'    => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'      => 'yourprefix_user_avatar',
        'type'    => 'file',
    ) );

    $cmb_user->add_field( array(
        'name' => esc_html__( 'Facebook URL', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_user_facebookurl',
        'type' => 'text_url',
    ) );

    $cmb_user->add_field( array(
        'name' => esc_html__( 'Twitter URL', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_user_twitterurl',
        'type' => 'text_url',
    ) );

    $cmb_user->add_field( array(
        'name' => esc_html__( 'Google+ URL', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_user_googleplusurl',
        'type' => 'text_url',
    ) );

    $cmb_user->add_field( array(
        'name' => esc_html__( 'Linkedin URL', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_user_linkedinurl',
        'type' => 'text_url',
    ) );

    $cmb_user->add_field( array(
        'name' => esc_html__( 'User Field', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_user_user_text_field',
        'type' => 'text',
    ) );

}

add_action( 'cmb2_admin_init', 'yourprefix_register_taxonomy_metabox' );
/**
 * Hook in and add a metabox to add fields to taxonomy terms
 */
function yourprefix_register_taxonomy_metabox() {

    /**
     * Metabox to add fields to categories and tags
     */
    $cmb_term = new_cmb2_box( array(
        'id'               => 'yourprefix_term_edit',
        'title'            => esc_html__( 'Category Metabox', 'cmb2' ), // Doesn't output for term boxes
        'object_types'     => array( 'term' ), // Tells CMB2 to use term_meta vs post_meta
        'taxonomies'       => array( 'category', 'post_tag' ), // Tells CMB2 which taxonomies should have these fields
        // 'new_term_section' => true, // Will display in the "Add New Category" section
    ) );

    $cmb_term->add_field( array(
        'name'     => esc_html__( 'Extra Info', 'cmb2' ),
        'desc'     => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'       => 'yourprefix_term_extra_info',
        'type'     => 'title',
        'on_front' => false,
    ) );

    $cmb_term->add_field( array(
        'name' => esc_html__( 'Term Image', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_term_avatar',
        'type' => 'file',
    ) );

    $cmb_term->add_field( array(
        'name' => esc_html__( 'Arbitrary Term Field', 'cmb2' ),
        'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'   => 'yourprefix_term_term_text_field',
        'type' => 'text',
    ) );

}

add_action( 'cmb2_admin_init', 'yourprefix_register_theme_options_metabox' );
/**
 * Hook in and register a metabox to handle a theme options page and adds a menu item.
 */
function yourprefix_register_theme_options_metabox() {

    /**
     * Registers options page menu item and form.
     */
    $cmb_options = new_cmb2_box( array(
        'id'           => 'yourprefix_theme_options_page',
        'title'        => esc_html__( 'Theme Options', 'cmb2' ),
        'object_types' => array( 'options-page' ),

        /*
         * The following parameters are specific to the options-page box
         * Several of these parameters are passed along to add_menu_page()/add_submenu_page().
         */

        'option_key'      => 'yourprefix_theme_options', // The option key and admin menu page slug.
        'icon_url'        => 'dashicons-palmtree', // Menu icon. Only applicable if 'parent_slug' is left empty.
        // 'menu_title'              => esc_html__( 'Options', 'cmb2' ), // Falls back to 'title' (above).
        // 'parent_slug'             => 'themes.php', // Make options page a submenu item of the themes menu.
        // 'capability'              => 'manage_options', // Cap required to view options-page.
        // 'position'                => 1, // Menu position. Only applicable if 'parent_slug' is left empty.
        // 'admin_menu_hook'         => 'network_admin_menu', // 'network_admin_menu' to add network-level options page.
        // 'priority'                => 10, // Define the page-registration admin menu hook priority.
        // 'display_cb'              => false, // Override the options-page form output (CMB2_Hookup::options_page_output()).
        // 'save_button'             => esc_html__( 'Save Theme Options', 'cmb2' ), // The text for the options-page save button. Defaults to 'Save'.
        // 'disable_settings_errors' => true, // On settings pages (not options-general.php sub-pages), allows disabling.
        // 'message_cb'              => 'yourprefix_options_page_message_callback',
        // 'tab_group'               => '', // Tab-group identifier, enables options page tab navigation.
        // 'tab_title'               => null, // Falls back to 'title' (above).
        // 'autoload'                => false, // Defaults to true, the options-page option will be autloaded.
    ) );

    /**
     * Options fields ids only need
     * to be unique within this box.
     * Prefix is not needed.
     */
    $cmb_options->add_field( array(
        'name'    => esc_html__( 'Site Background Color', 'cmb2' ),
        'desc'    => esc_html__( 'field description (optional)', 'cmb2' ),
        'id'      => 'bg_color',
        'type'    => 'colorpicker',
        'default' => '#ffffff',
    ) );

}

/**
 * Callback to define the optionss-saved message.
 *
 * @param CMB2  $cmb The CMB2 object.
 * @param array $args {
 *     An array of message arguments
 *
 *     @type bool   $is_options_page Whether current page is this options page.
 *     @type bool   $should_notify   Whether options were saved and we should be notified.
 *     @type bool   $is_updated      Whether options were updated with save (or stayed the same).
 *     @type string $setting         For add_settings_error(), Slug title of the setting to which
 *                                   this error applies.
 *     @type string $code            For add_settings_error(), Slug-name to identify the error.
 *                                   Used as part of 'id' attribute in HTML output.
 *     @type string $message         For add_settings_error(), The formatted message text to display
 *                                   to the user (will be shown inside styled `<div>` and `<p>` tags).
 *                                   Will be 'Settings updated.' if $is_updated is true, else 'Nothing to update.'
 *     @type string $type            For add_settings_error(), Message type, controls HTML class.
 *                                   Accepts 'error', 'updated', '', 'notice-warning', etc.
 *                                   Will be 'updated' if $is_updated is true, else 'notice-warning'.
 * }
 */
function yourprefix_options_page_message_callback( $cmb, $args ) {
    if ( ! empty( $args['should_notify'] ) ) {

        if ( $args['is_updated'] ) {

            // Modify the updated message.
            $args['message'] = sprintf( esc_html__( '%s &mdash; Updated!', 'cmb2' ), $cmb->prop( 'title' ) );
        }

        add_settings_error( $args['setting'], $args['code'], $args['message'], $args['type'] );
    }
}

/**
 * Only show this box in the CMB2 REST API if the user is logged in.
 *
 * @param  bool                 $is_allowed     Whether this box and its fields are allowed to be viewed.
 * @param  CMB2_REST_Controller $cmb_controller The controller object.
 *                                              CMB2 object available via `$cmb_controller->rest_box->cmb`.
 *
 * @return bool                 Whether this box and its fields are allowed to be viewed.
 */
function yourprefix_limit_rest_view_to_logged_in_users( $is_allowed, $cmb_controller ) {
    if ( ! is_user_logged_in() ) {
        $is_allowed = false;
    }

    return $is_allowed;
}

add_action( 'cmb2_init', 'yourprefix_register_rest_api_box' );
/**
 * Hook in and add a box to be available in the CMB2 REST API. Can only happen on the 'cmb2_init' hook.
 * More info: https://github.com/CMB2/CMB2/wiki/REST-API
 */
function yourprefix_register_rest_api_box() {
    $cmb_rest = new_cmb2_box( array(
        'id'            => 'yourprefix_rest_metabox',
        'title'         => esc_html__( 'REST Test Box', 'cmb2' ),
        'object_types'  => array( 'page' ), // Post type
        'show_in_rest' => WP_REST_Server::ALLMETHODS, // WP_REST_Server::READABLE|WP_REST_Server::EDITABLE, // Determines which HTTP methods the box is visible in.
        // Optional callback to limit box visibility.
        // See: https://github.com/CMB2/CMB2/wiki/REST-API#permissions
        // 'get_box_permissions_check_cb' => 'yourprefix_limit_rest_view_to_logged_in_users',
    ) );

    $cmb_rest->add_field( array(
        'name'       => esc_html__( 'REST Test Text', 'cmb2' ),
        'desc'       => esc_html__( 'Will show in the REST API for this box and for pages.', 'cmb2' ),
        'id'         => 'yourprefix_rest_text',
        'type'       => 'text',
    ) );

    $cmb_rest->add_field( array(
        'name'       => esc_html__( 'REST Editable Test Text', 'cmb2' ),
        'desc'       => esc_html__( 'Will show in REST API "editable" contexts only (`POST` requests).', 'cmb2' ),
        'id'         => 'yourprefix_rest_editable_text',
        'type'       => 'text',
        'show_in_rest' => WP_REST_Server::EDITABLE,// WP_REST_Server::ALLMETHODS|WP_REST_Server::READABLE, // Determines which HTTP methods the field is visible in. Will override the cmb2_box 'show_in_rest' param.
    ) );
}

Packages

Classes

Hooks