OwlCyberSecurity - MANAGER
Edit File: meta-box.php
<?php /** * A class to rapid develop meta boxes for custom & built in content types * Piggybacks on WordPress * * @author Tran Ngoc Tuan Anh <rilwis@gmail.com> * @license GNU GPL2+ * @package Meta Box */ /** * The main meta box class. * * @package Meta Box */ class RW_Meta_Box { /** * Meta box parameters. * * @var array */ public $meta_box; /** * Fields parameters. * * @var array */ public $fields; /** * Detect whether the meta box is saved at least once. * Used to prevent duplicated calls like revisions, manual hook to wp_insert_post, etc. * * @var bool */ public $saved = false; /** * Create meta box based on given data. * * @param array $meta_box Meta box definition. */ public function __construct( $meta_box ) { $meta_box = self::normalize( $meta_box ); $meta_box['fields'] = self::normalize_fields( $meta_box['fields'] ); $this->meta_box = $meta_box; $this->fields = &$this->meta_box['fields']; if ( $this->is_shown() ) { $this->global_hooks(); $this->object_hooks(); } } /** * Conditional check for whether initializing meta box. * * - 1st filter applies to all meta boxes. * - 2nd filter applies to only current meta box. * * @return bool */ protected function is_shown() { $show = apply_filters( 'rwmb_show', true, $this->meta_box ); return apply_filters( "rwmb_show_{$this->meta_box['id']}", $show, $this->meta_box ); } /** * Add global hooks. */ protected function global_hooks() { // Enqueue common styles and scripts. add_action( 'admin_enqueue_scripts', array( $this, 'enqueue' ) ); // Add additional actions for fields. foreach ( $this->fields as $field ) { RWMB_Field::call( $field, 'add_actions' ); } } /** * Specific hooks for meta box object. Default is 'post'. * This should be extended in sub-classes to support meta fields for terms, user, settings pages, etc. */ protected function object_hooks() { // Add meta box. add_action( 'add_meta_boxes', array( $this, 'add_meta_boxes' ) ); // Hide meta box if it's set 'default_hidden'. add_filter( 'default_hidden_meta_boxes', array( $this, 'hide' ), 10, 2 ); // Save post meta. foreach ( $this->meta_box['post_types'] as $post_type ) { if ( 'attachment' === $post_type ) { // Attachment uses other hooks. // @see wp_update_post(), wp_insert_attachment(). add_action( 'edit_attachment', array( $this, 'save_post' ) ); add_action( 'add_attachment', array( $this, 'save_post' ) ); } else { add_action( "save_post_{$post_type}", array( $this, 'save_post' ) ); } } } /** * Enqueue common scripts and styles. */ public function enqueue() { if ( ! $this->is_edit_screen() ) { return; } wp_enqueue_style( 'rwmb', RWMB_CSS_URL . 'style.css', array(), RWMB_VER ); if ( is_rtl() ) { wp_enqueue_style( 'rwmb-rtl', RWMB_CSS_URL . 'style-rtl.css', array(), RWMB_VER ); } // Load clone script conditionally. foreach ( $this->fields as $field ) { if ( $field['clone'] ) { wp_enqueue_script( 'rwmb-clone', RWMB_JS_URL . 'clone.js', array( 'jquery-ui-sortable' ), RWMB_VER, true ); break; } } // Enqueue scripts and styles for fields. foreach ( $this->fields as $field ) { RWMB_Field::call( $field, 'admin_enqueue_scripts' ); } // Auto save. if ( $this->meta_box['autosave'] ) { wp_enqueue_script( 'rwmb-autosave', RWMB_JS_URL . 'autosave.js', array( 'jquery' ), RWMB_VER, true ); } /** * Allow developers to enqueue more scripts and styles * * @param RW_Meta_Box $object Meta Box object */ do_action( 'rwmb_enqueue_scripts', $this ); } /** * Add meta box for multiple post types */ public function add_meta_boxes() { foreach ( $this->meta_box['post_types'] as $post_type ) { add_meta_box( $this->meta_box['id'], $this->meta_box['title'], array( $this, 'show' ), $post_type, $this->meta_box['context'], $this->meta_box['priority'] ); } } /** * Hide meta box if it's set 'default_hidden' * * @param array $hidden Array of default hidden meta boxes. * @param object $screen Current screen information. * * @return array */ public function hide( $hidden, $screen ) { if ( $this->is_edit_screen( $screen ) && $this->meta_box['default_hidden'] ) { $hidden[] = $this->meta_box['id']; } return $hidden; } /** * Callback function to show fields in meta box */ public function show() { $saved = $this->is_saved(); // Container. printf( '<div class="rwmb-meta-box" data-autosave="%s">', $this->meta_box['autosave'] ? 'true' : 'false' ); wp_nonce_field( "rwmb-save-{$this->meta_box['id']}", "nonce_{$this->meta_box['id']}" ); // Allow users to add custom code before meta box content. // 1st action applies to all meta boxes. // 2nd action applies to only current meta box. do_action( 'rwmb_before', $this ); do_action( "rwmb_before_{$this->meta_box['id']}", $this ); foreach ( $this->fields as $field ) { RWMB_Field::call( 'show', $field, $saved ); } // Allow users to add custom code after meta box content. // 1st action applies to all meta boxes. // 2nd action applies to only current meta box. do_action( 'rwmb_after', $this ); do_action( "rwmb_after_{$this->meta_box['id']}", $this ); // End container. echo '</div>'; } /** * Save data from meta box * * @param int $post_id Post ID. */ public function save_post( $post_id ) { if ( ! $this->validate() ) { return; } $this->saved = true; // Make sure meta is added to the post, not a revision. $the_post = wp_is_post_revision( $post_id ); if ( $the_post ) { $post_id = $the_post; } // Before save action. do_action( 'rwmb_before_save_post', $post_id ); do_action( "rwmb_{$this->meta_box['id']}_before_save_post", $post_id ); foreach ( $this->fields as $field ) { $single = $field['clone'] || ! $field['multiple']; $old = RWMB_Field::call( $field, 'raw_meta', $post_id ); // @codingStandardsIgnoreLine $new = isset( $_POST[ $field['id'] ] ) ? $_POST[ $field['id'] ] : ( $single ? '' : array() ); // Allow field class change the value. if ( $field['clone'] ) { $new = RWMB_Clone::value( $new, $old, $post_id, $field ); } else { $new = RWMB_Field::call( $field, 'value', $new, $old, $post_id ); $new = RWMB_Field::filter( 'sanitize', $new, $field ); } $new = RWMB_Field::filter( 'value', $new, $field, $old ); // Call defined method to save meta value, if there's no methods, call common one. RWMB_Field::call( $field, 'save', $new, $old, $post_id ); } // After save action. do_action( 'rwmb_after_save_post', $post_id ); do_action( "rwmb_{$this->meta_box['id']}_after_save_post", $post_id ); } /** * Validate form when submit. Check: * - If this function is called to prevent duplicated calls like revisions, manual hook to wp_insert_post, etc. * - Autosave * - If form is submitted properly * * @return bool */ protected function validate() { $nonce = (string) filter_input( INPUT_POST, "nonce_{$this->meta_box['id']}" ); return true !== $this->saved && ( ! defined( 'DOING_AUTOSAVE' ) || $this->meta_box['autosave'] ) && wp_verify_nonce( $nonce, "rwmb-save-{$this->meta_box['id']}" ); } /** * Normalize parameters for meta box * * @param array $meta_box Meta box definition. * * @return array $meta_box Normalized meta box. */ public static function normalize( $meta_box ) { // Set default values for meta box. $meta_box = wp_parse_args( $meta_box, array( 'id' => sanitize_title( $meta_box['title'] ), 'context' => 'normal', 'priority' => 'high', 'post_types' => 'post', 'autosave' => false, 'default_hidden' => false, ) ); /** * Use 'post_types' for better understanding and fallback to 'pages' for previous versions. * * @since 4.4.1 */ if ( ! empty( $meta_box['pages'] ) ) { $meta_box['post_types'] = $meta_box['pages']; } // Make sure the post type is an array. $meta_box['post_types'] = (array) $meta_box['post_types']; return $meta_box; } /** * Normalize an array of fields * * @param array $fields Array of fields. * * @return array $fields Normalized fields. */ public static function normalize_fields( $fields ) { foreach ( $fields as $k => $field ) { $field = RWMB_Field::call( 'normalize', $field ); // Allow to add default values for fields. $field = apply_filters( 'rwmb_normalize_field', $field ); $field = apply_filters( "rwmb_normalize_{$field['type']}_field", $field ); $field = apply_filters( "rwmb_normalize_{$field['id']}_field", $field ); $fields[ $k ] = $field; } return $fields; } /** * Check if meta box is saved before. * This helps saving empty value in meta fields (text, check box, etc.) and set the correct default values. * * @return bool */ public function is_saved() { $post = get_post(); foreach ( $this->fields as $field ) { if ( empty( $field['id'] ) ) { continue; } $value = RWMB_Field::call( $field, 'raw_meta', $post->ID ); if ( ( ! $field['multiple'] && '' !== $value ) || ( $field['multiple'] && array() !== $value ) ) { return true; } } return false; } /** * Check if we're on the right edit screen. * * @param WP_Screen $screen Screen object. Optional. Use current screen object by default. * * @return bool */ public function is_edit_screen( $screen = null ) { if ( ! ( $screen instanceof WP_Screen ) ) { $screen = get_current_screen(); } return 'post' === $screen->base && in_array( $screen->post_type, $this->meta_box['post_types'], true ); } }