Last active
February 21, 2024 21:32
-
-
Save igorbenic/c37d842728d1a24ddbce79721e42b8e0 to your computer and use it in GitHub Desktop.
How to create WordPress Metaboxes with OOP
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| class IBenic_WordPress_Metabox extends WordPressSettings { | |
| protected $title = ''; | |
| protected $slug = ''; | |
| protected $post_types = array(); | |
| protected $post_id = 0; | |
| protected $context = ''; | |
| protected $priority = ''; | |
| function __construct( $title, $slug, $post_types = array( 'post' ), $context = 'advanced', $priority = 'default' ) { | |
| if( $slug == '' || $context == '' || $priority == '' ) { | |
| return; | |
| } | |
| if( $title == '' ) { | |
| $this->title = ucfirst( $slug ); | |
| } | |
| if( empty( $post_types ) ) { | |
| return; | |
| } | |
| $this->title = $title; | |
| $this->slug = $slug; | |
| $this->post_types = $post_types; | |
| $this->settings_id = $this->slug; | |
| $this->context = $context; | |
| $this->priority = $priority; | |
| add_action( 'add_meta_boxes', array( $this, 'register' ) ); | |
| add_action( 'save_post', array( $this, 'save_meta_settings' ) ); | |
| } | |
| public function register( $post_type ) { | |
| if ( in_array( $post_type, $this->post_types ) ) { | |
| add_meta_box( $this->slug, $this->title, array( $this, 'render' ), $post_type ); | |
| } | |
| } | |
| public function render( $post ){ | |
| $this->post_id = $post->ID; | |
| $this->init_settings(); | |
| wp_nonce_field( 'metabox_' . $this->slug, 'metabox_' . $this->slug . '_nonce' ); | |
| echo '<table class="form-table">'; | |
| $this->render_fields( 'general' ); | |
| echo '</table>'; | |
| } | |
| /** | |
| * Get the settings from the database | |
| * @return void | |
| */ | |
| public function init_settings() { | |
| $post_id = $this->post_id; | |
| $this->settings = get_post_meta( $post_id, $this->settings_id, true ); | |
| foreach ( $this->fields as $tab_key => $tab ) { | |
| foreach ( $tab as $name => $field ) { | |
| if( isset( $this->settings[ $name ] ) ) { | |
| $this->fields[ $tab_key ][ $name ]['default'] = $this->settings[ $name ]; | |
| } | |
| } | |
| } | |
| } | |
| public function save_meta_settings( $post_id ) { | |
| // Check if our nonce is set. | |
| if ( ! isset( $_POST['metabox_' . $this->slug . '_nonce'] ) ) { | |
| return $post_id; | |
| } | |
| $nonce = $_POST['metabox_' . $this->slug . '_nonce']; | |
| // Verify that the nonce is valid. | |
| if ( ! wp_verify_nonce( $nonce, 'metabox_' . $this->slug ) ) { | |
| return $post_id; | |
| } | |
| /* | |
| * If this is an autosave, our form has not been submitted, | |
| * so we don't want to do anything. | |
| */ | |
| if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) { | |
| return $post_id; | |
| } | |
| // Check the user's permissions. | |
| if ( 'page' == $_POST['post_type'] ) { | |
| if ( ! current_user_can( 'edit_page', $post_id ) ) { | |
| return $post_id; | |
| } | |
| } else { | |
| if ( ! current_user_can( 'edit_post', $post_id ) ) { | |
| return $post_id; | |
| } | |
| } | |
| $this->post_id = $post_id; | |
| $this->save_settings(); | |
| } | |
| /** | |
| * Save settings from POST | |
| * @return [type] [description] | |
| */ | |
| public function save_settings(){ | |
| $this->posted_data = $_POST; | |
| if( empty( $this->settings ) ) { | |
| $this->init_settings(); | |
| } | |
| foreach ($this->fields as $tab => $tab_data ) { | |
| foreach ($tab_data as $name => $field) { | |
| $this->settings[ $name ] = $this->{ 'validate_' . $field['type'] }( $name ); | |
| } | |
| } | |
| update_post_meta( $this->post_id, $this->settings_id, $this->settings ); | |
| } | |
| } | |
| $metabox = new IBenic_WordPress_Metabox( 'Extra Settings', 'extra_settings', array( 'post', 'page' ) ); | |
| $metabox->add_field( | |
| array( | |
| 'name' => 'redirect_url', | |
| 'title' => 'Redirect', | |
| 'desc' => 'Insert Full URL where you want to redirect' )); | |
| add_action( 'template_redirect', 'ibenic_redirect' ); | |
| function ibenic_redirect(){ | |
| global $post; | |
| $get_settings = get_post_meta( $post->ID, 'extra_settings', true); | |
| if( isset( $get_settings[ 'redirect_url'] ) && $get_settings[ 'redirect_url'] != '' ) { | |
| wp_redirect( $get_settings[ 'redirect_url'], 301 ); | |
| exit; | |
| } | |
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| $metabox = new IBenic_WordPress_Metabox( 'Extra Settings', 'extra_settings', array( 'post', 'page' ) ); | |
| $metabox->add_field( | |
| array( | |
| 'name' => 'redirect_url', | |
| 'title' => 'Redirect', | |
| 'desc' => 'Insert Full URL where you want to redirect' )); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| add_action( 'template_redirect', 'ibenic_redirect' ); | |
| function ibenic_redirect(){ | |
| global $post; | |
| $get_settings = get_post_meta( $post->ID, 'extra_settings', true); | |
| if( isset( $get_settings[ 'redirect_url'] ) && $get_settings[ 'redirect_url'] != '' ) { | |
| wp_redirect( $get_settings[ 'redirect_url'], 301 ); | |
| exit; | |
| } | |
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| class IBenic_WordPress_Metabox extends WordPressSettings { | |
| /** | |
| * Metabox Title | |
| */ | |
| protected $title = ''; | |
| /** | |
| * Metabox ID | |
| */ | |
| protected $slug = ''; | |
| /** | |
| * Array of post types for which we allow the metabox | |
| */ | |
| protected $post_types = array(); | |
| /** | |
| * Post ID used to save or retrieve the settings | |
| */ | |
| protected $post_id = 0; | |
| /** | |
| * Metabox context | |
| */ | |
| protected $context = ''; | |
| /** | |
| * Metabox priority | |
| */ | |
| protected $priority = ''; | |
| // ... | |
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| class IBenic_WordPress_Metabox extends WordPressSettings { | |
| // ... | |
| public function __construct( $title, $slug, $post_types = array( 'post' ), $context = 'advanced', $priority = 'default' ) { | |
| if( $slug == '' || $context == '' || $priority == '' ) { | |
| return; | |
| } | |
| if( $title == '' ) { | |
| $this->title = ucfirst( $slug ); | |
| } | |
| if( empty( $post_types ) ) { | |
| return; | |
| } | |
| $this->title = $title; | |
| $this->slug = $slug; | |
| $this->post_types = $post_types; | |
| $this->settings_id = $this->slug; | |
| $this->context = $context; | |
| $this->priority = $priority; | |
| add_action( 'add_meta_boxes', array( $this, 'register' ) ); | |
| add_action( 'save_post', array( $this, 'save_meta_settings' ) ); | |
| } | |
| // ... | |
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| class IBenic_WordPress_Metabox extends WordPressSettings { | |
| // ... | |
| public function register( $post_type ) { | |
| if ( in_array( $post_type, $this->post_types ) ) { | |
| add_meta_box( $this->slug, $this->title, array( $this, 'render' ), $post_type ); | |
| } | |
| } | |
| // ... | |
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| class IBenic_WordPress_Metabox extends WordPressSettings { | |
| // ... | |
| public function render( $post ) { | |
| $this->post_id = $post->ID; | |
| $this->init_settings(); | |
| wp_nonce_field( 'metabox_' . $this->slug, 'metabox_' . $this->slug . '_nonce' ); | |
| echo '<table class="form-table">'; | |
| $this->render_fields( 'general' ); | |
| echo '</table>'; | |
| } | |
| // ... | |
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| class IBenic_WordPress_Metabox extends WordPressSettings { | |
| // ... | |
| /** | |
| * Get the settings from the database | |
| * @return void | |
| */ | |
| public function init_settings() { | |
| $post_id = $this->post_id; | |
| $this->settings = get_post_meta( $post_id, $this->settings_id, true ); | |
| foreach ( $this->fields as $tab_key => $tab ) { | |
| foreach ( $tab as $name => $field ) { | |
| if( isset( $this->settings[ $name ] ) ) { | |
| $this->fields[ $tab_key ][ $name ]['default'] = $this->settings[ $name ]; | |
| } | |
| } | |
| } | |
| } | |
| // ... | |
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| class IBenic_WordPress_Metabox extends WordPressSettings { | |
| // ... | |
| public function save_meta_settings( $post_id ) { | |
| // Check if our nonce is set. | |
| if ( ! isset( $_POST['metabox_' . $this->slug . '_nonce'] ) ) { | |
| return $post_id; | |
| } | |
| $nonce = $_POST['metabox_' . $this->slug . '_nonce']; | |
| // Verify that the nonce is valid. | |
| if ( ! wp_verify_nonce( $nonce, 'metabox_' . $this->slug ) ) { | |
| return $post_id; | |
| } | |
| /* | |
| * If this is an autosave, our form has not been submitted, | |
| * so we don't want to do anything. | |
| */ | |
| if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) { | |
| return $post_id; | |
| } | |
| // Check the user's permissions. | |
| if ( 'page' == $_POST['post_type'] ) { | |
| if ( ! current_user_can( 'edit_page', $post_id ) ) { | |
| return $post_id; | |
| } | |
| } else { | |
| if ( ! current_user_can( 'edit_post', $post_id ) ) { | |
| return $post_id; | |
| } | |
| } | |
| $this->post_id = $post_id; | |
| $this->save_settings(); | |
| } | |
| // ... | |
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| class IBenic_WordPress_Metabox extends WordPressSettings { | |
| // ... | |
| /** | |
| * Save settings from POST | |
| * @return [type] [description] | |
| */ | |
| public function save_settings(){ | |
| $this->posted_data = $_POST; | |
| if( empty( $this->settings ) ) { | |
| $this->init_settings(); | |
| } | |
| foreach ($this->fields as $tab => $tab_data ) { | |
| foreach ($tab_data as $name => $field) { | |
| $this->settings[ $name ] = $this->{ 'validate_' . $field['type'] }( $name ); | |
| } | |
| } | |
| update_post_meta( $this->post_id, $this->settings_id, $this->settings ); | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment