meta_box = self::normalize( $meta_box ); $this->fields = &$this->meta_box['fields']; // List of meta box field types $this->types = array_unique( wp_list_pluck( $this->fields, 'type' ) ); // Load translation file // Call directly because we define meta boxes in 'admin_init' hook (@see demo/demo.php) // So the function won't run if we use 'add_action' to load textdomain here self::load_textdomain(); // Enqueue common styles and scripts add_action( 'admin_enqueue_scripts', array( &$this, 'admin_enqueue_scripts' ) ); foreach ( $this->types as $type ) { $class = self::get_class_name( $type ); // Add additional actions for fields if ( method_exists( $class, 'add_actions' ) ) call_user_func( array( $class, 'add_actions' ) ); } // Add meta box foreach ( $this->meta_box['pages'] as $page ) add_action( "add_meta_boxes_{$page}", array( &$this, 'add_meta_boxes' ) ); // Save post meta add_action( 'save_post', array( &$this, 'save_post' ) ); } /** * Load plugin translation * * @link http://wordpress.stackexchange.com/a/33314 Translation Tutorial by the author * @return void */ static function load_textdomain() { // l18n translation files $locale = get_locale(); $dir = trailingslashit( RWMB_DIR . 'lang' ); $mofile = "{$dir}{$locale}.mo"; // In themes/plugins/mu-plugins directory load_textdomain( 'rwmb', $mofile ); } /** * Enqueue common styles * * @return void */ function admin_enqueue_scripts() { $screen = get_current_screen(); // Enqueue scripts and styles for registered pages (post types) only if ( 'post' != $screen->base || ! in_array( $screen->post_type, $this->meta_box['pages'] ) ) return; wp_enqueue_style( 'rwmb', RWMB_CSS_URL . 'style.css', RWMB_VER ); // Load clone script conditionally $has_clone = false; foreach ( $this->fields as $field ) { if ( self::is_cloneable( $field ) ) $has_clone = true; // Enqueue scripts and styles for fields $class = self::get_class_name( $field['type'] ); if ( method_exists( $class, 'admin_enqueue_scripts' ) ) call_user_func( array( $class, 'admin_enqueue_scripts' ) ); } if ( $has_clone ) wp_enqueue_script( 'rwmb-clone', RWMB_JS_URL . 'clone.js', array( 'jquery' ), RWMB_VER, true ); } /************************************************** SHOW META BOX **************************************************/ /** * Add meta box for multiple post types * * @return void */ function add_meta_boxes() { foreach ( $this->meta_box['pages'] as $page ) { add_meta_box( $this->meta_box['id'], $this->meta_box['title'], array( &$this, 'show' ), $page, $this->meta_box['context'], $this->meta_box['priority'] ); } } /** * Callback function to show fields in meta box * * @return void */ public function show() { global $post; $saved = self::has_been_saved( $post->ID, $this->fields ); 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' ); do_action( "rwmb_before_{$this->meta_box['id']}" ); foreach ( $this->fields as $field ) { $type = $field['type']; $id = $field['id']; $meta = self::apply_field_class_filters( $field, 'meta', '', $post->ID, $saved ); $meta = apply_filters( "rwmb_{$type}_meta", $meta ); $meta = apply_filters( "rwmb_{$id}_meta", $meta ); $begin = self::apply_field_class_filters( $field, 'begin_html', '', $meta ); // Apply filter to field begin HTML // 1st filter applies to all fields // 2nd filter applies to all fields with the same type // 3rd filter applies to current field only $begin = apply_filters( "rwmb_begin_html", $begin, $field, $meta ); $begin = apply_filters( "rwmb_{$type}_begin_html", $begin, $field, $meta ); $begin = apply_filters( "rwmb_{$id}_begin_html", $begin, $field, $meta ); // Separate code for clonable and non-cloneable fields to make easy to maintain // Cloneable fields if ( self::is_cloneable( $field ) ) { $field_html = ''; $meta = (array) $meta; foreach ( $meta as $meta_data ) { add_filter( "rwmb_{$id}_html", array( &$this, 'add_delete_clone_button' ), 10, 3 ); // Wrap field HTML in a div with class="rwmb-clone" if needed $input_html = '
'; // Call separated methods for displaying each type of field $input_html .= self::apply_field_class_filters( $field, 'html', '', $meta_data ); // Apply filter to field HTML // 1st filter applies to all fields with the same type // 2nd filter applies to current field only $input_html = apply_filters( "rwmb_{$type}_html", $input_html, $field, $meta_data ); $input_html = apply_filters( "rwmb_{$id}_html", $input_html, $field, $meta_data ); $input_html .= '
'; $field_html .= $input_html; } } // Non-cloneable fields else { // Call separated methods for displaying each type of field $field_html = self::apply_field_class_filters( $field, 'html', '', $meta ); // Apply filter to field HTML // 1st filter applies to all fields with the same type // 2nd filter applies to current field only $field_html = apply_filters( "rwmb_{$type}_html", $field_html, $field, $meta ); $field_html = apply_filters( "rwmb_{$id}_html", $field_html, $field, $meta ); } $end = self::apply_field_class_filters( $field, 'end_html', '', $meta ); // Apply filter to field end HTML // 1st filter applies to all fields // 2nd filter applies to all fields with the same type // 3rd filter applies to current field only $end = apply_filters( "rwmb_end_html", $end, $field, $meta ); $end = apply_filters( "rwmb_{$type}_end_html", $end, $field, $meta ); $end = apply_filters( "rwmb_{$id}_end_html", $end, $field, $meta ); // Apply filter to field wrapper // This allow users to change whole HTML markup of the field wrapper (i.e. table row) // 1st filter applies to all fields with the same type // 2nd filter applies to current field only $html = apply_filters( "rwmb_{$type}_wrapper_html", "{$begin}{$field_html}{$end}", $field, $meta ); $html = apply_filters( "rwmb_{$id}_wrapper_html", $html, $field, $meta ); // Display label and input in DIV and allow user-defined classes to be appended $class = 'rwmb-field'; if ( isset( $field['class'] ) ) $class = $this->add_cssclass( $field[ 'class' ], $class ); // If the 'hidden' argument is set and TRUE, the div will be hidden if ( isset( $field['hidden'] ) && $field['hidden'] ) $class = $this->add_cssclass( 'hidden', $class ); echo "
{$html}
"; } // 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' ); do_action( "rwmb_after_{$this->meta_box['id']}" ); } /** * Show begin HTML markup for fields * * @param string $html * @param mixed $meta * @param array $field * * @return string */ static function begin_html( $html, $meta, $field ) { $class = 'rwmb-label'; if ( ! empty( $field['class'] ) ) $class = self::add_cssclass( $field['class'], $class ); if ( empty( $field['name'] ) ) return '
'; $html = <<
HTML; return $html; } /** * Show end HTML markup for fields * * @param string $html * @param mixed $meta * @param array $field * * @return string */ static function end_html( $html, $meta, $field ) { $id = $field['id']; $button = ''; if ( self::is_cloneable( $field ) ) $button = '' . __( '+', 'rwmb' ) . ''; $desc = ! empty( $field[ 'desc' ] ) ? "

{$field['desc']}

" : ''; // Closes the container $html = "{$button}{$desc}
"; return $html; } /** * Callback function to add clone buttons on demand * Hooks on the flight into the "rwmb_{$field_id}_html" filter before the closing div * * @param string $html * @param array $field * @param mixed $meta_data * * @return string $html */ static function add_delete_clone_button( $html, $field, $meta_data ) { $id = $field['id']; $button = '' . __( '–', 'rwmb' ) . ''; return "{$html}{$button}"; } /** * Standard meta retrieval * * @param mixed $meta * @param int $post_id * @param array $field * @param bool $saved * * @return mixed */ static function meta( $meta, $post_id, $saved, $field ) { $meta = get_post_meta( $post_id, $field['id'], ! $field['multiple'] ); // Use $field['std'] only when the meta box hasn't been saved (i.e. the first time we run) $meta = ( ! $saved && '' === $meta || array() === $meta ) ? $field['std'] : $meta; // Escape attributes for non-wysiwyg fields if ( 'wysiwyg' !== $field['type'] ) $meta = is_array( $meta ) ? array_map( 'esc_attr', $meta ) : esc_attr( $meta ); return $meta; } /************************************************** SAVE META BOX **************************************************/ /** * Save data from meta box * * @param int $post_id Post ID * * @return int|void */ function save_post( $post_id ) { global $post_type; $post_type_object = get_post_type_object( $post_type ); // Check whether: // - the post is autosaved // - the post is a revision // - current post type is supported // - user has proper capability if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || ( ! isset( $_POST['post_ID'] ) || $post_id != $_POST['post_ID'] ) || ( ! in_array( $post_type, $this->meta_box['pages'] ) ) || ( ! current_user_can( $post_type_object->cap->edit_post, $post_id ) ) ) { return $post_id; } // Verify nonce check_admin_referer( "rwmb-save-{$this->meta_box['id']}", "nonce_{$this->meta_box['id']}" ); foreach ( $this->fields as $field ) { $name = $field['id']; $old = get_post_meta( $post_id, $name, ! $field['multiple'] ); $new = isset( $_POST[ $name ] ) ? $_POST[ $name ] : ( $field['multiple'] ? array() : '' ); // Allow field class change the value $new = self::apply_field_class_filters( $field, 'value', $new, $old, $post_id ); // Use filter to change field value // 1st filter applies to all fields with the same type // 2nd filter applies to current field only $new = apply_filters( "rwmb_{$field['type']}_value", $new, $field, $old ); $new = apply_filters( "rwmb_{$name}_value", $new, $field, $old ); // Call defined method to save meta value, if there's no methods, call common one self::do_field_class_actions( $field, 'save', $new, $old, $post_id ); } } /** * Common functions for saving field * * @param mixed $new * @param mixed $old * @param int $post_id * @param array $field * * @return void */ static function save( $new, $old, $post_id, $field ) { $name = $field['id']; delete_post_meta( $post_id, $name ); if ( '' === $new || array() === $new ) return; if ( $field['multiple'] ) { foreach ( $new as $add_new ) { add_post_meta( $post_id, $name, $add_new, false ); } } else { update_post_meta( $post_id, $name, $new ); } } /************************************************** HELPER FUNCTIONS **************************************************/ /** * Normalize parameters for meta box * * @param array $meta_box Meta box definition * * @return array $meta_box Normalized meta box */ static function normalize( $meta_box ) { // Set default values for meta box $meta_box = wp_parse_args( $meta_box, array( 'context' => 'normal', 'priority' => 'high', 'pages' => array( 'post' ) ) ); // Set default values for fields foreach ( $meta_box['fields'] as &$field ) { $clone = isset( $field['clone'] ) ? $field['clone'] : false; $multiple = in_array( $field['type'], array( 'checkbox_list', 'file', 'image', 'plupload_image' ) ) ; $std = $multiple ? array() : ''; $format = 'date' === $field['type'] ? 'yy-mm-dd' : ( 'time' === $field['type'] ? 'hh:mm' : '' ); $field = wp_parse_args( $field, array( 'multiple' => $multiple, 'clone' => $clone, 'std' => $std, 'desc' => '', 'format' => $format ) ); $field['field_name'] = $field['id'] . ( $field['multiple'] || $field['clone'] ? '[]' : '' ); // Allow field class add/change default field values $field = self::apply_field_class_filters( $field, 'normalize_field', $field ); } return $meta_box; } /** * Get field class name * * @param string $type Field type * * @return bool|string Field class name OR false on failure */ static function get_class_name( $type ) { $type = ucwords( $type ); $class = "RWMB_{$type}_Field"; if ( class_exists( $class ) ) return $class; return false; } /** * Apply filters by field class, fallback to RW_Meta_Box method * * @param array $field * @param string $method_name * @param mixed $value * * @return mixed $value */ static function apply_field_class_filters( $field, $method_name, $value ) { $args = array_slice( func_get_args(), 2 ); $args[] = $field; // Call: field class method // Fallback: RW_Meta_Box method $class = self::get_class_name( $field['type'] ); if ( method_exists( $class, $method_name ) ) { $value = call_user_func_array( array( $class, $method_name ), $args ); } elseif ( method_exists( __CLASS__, $method_name ) ) { $value = call_user_func_array( array( __CLASS__, $method_name ), $args ); } return $value; } /** * Call field class method for actions, fallback to RW_Meta_Box method * * @param array $field * @param string $method_name * * @return mixed */ static function do_field_class_actions( $field, $method_name ) { $args = array_slice( func_get_args(), 2 ); $args[] = $field; // Call: field class method // Fallback: RW_Meta_Box method $class = self::get_class_name( $field['type'] ); if ( method_exists( $class, $method_name ) ) { call_user_func_array( array( $class, $method_name ), $args ); } elseif ( method_exists( __CLASS__, $method_name ) ) { call_user_func_array( array( __CLASS__, $method_name ), $args ); } } /** * Format Ajax response * * @param string $message * @param string $status * * @return void */ static function ajax_response( $message, $status ) { $response = array( 'what' => 'meta-box' ); $response['data'] = 'error' === $status ? new WP_Error( 'error', $message ) : $message; $x = new WP_Ajax_Response( $response ); $x->send(); } /** * Check if meta box has been saved * This helps saving empty value in meta fields (for text box, check box, etc.) * * @param int $post_id * @param array $fields * * @return bool */ static function has_been_saved( $post_id, $fields ) { $saved = false; foreach ( $fields as $field ) { if ( get_post_meta( $post_id, $field['id'], ! $field['multiple'] ) ) { $saved = true; break; } } return $saved; } /** * Adds a css class * Mainly a copy of the core admin menu function * As the core function is only meant to be used by core internally, * We copy it here - in case core changes functionality or drops the function. * * @param string $add * @param string $class | Class name - Default: empty * * @return string $class */ static function add_cssclass( $add, $class = '' ) { $class .= empty( $class ) ? $add : " {$add}"; return $class; } /** * Helper function to check for multi/clone field IDs * * @param array $field * * @return bool False if no cloneable */ static function is_cloneable( $field ) { return $field['clone']; } } }