If you're not familiar with the concept of DRY coding, DRY is acronym that means Don't Repeat Yourself. But what does this really mean? Let's take a look at an example from the Genesis Framework. The following snippet is the code from the Executive Pro theme's archive-portfolio.php. This is a custom archive template for the Portfolio custom post type. I've taken the liberty of highlighting a few lines for clarity.
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 | /** * This file adds the custom portfolio post type archive template to the Executive Pro Theme. * * @author StudioPress * @package Executive Pro * @subpackage Customizations */ //* Force full width content layout add_filter( 'genesis_pre_get_option_site_layout', '__genesis_return_full_width_content' ); //* Remove the breadcrumb navigation remove_action( 'genesis_before_loop', 'genesis_do_breadcrumbs' ); //* Remove the post info function remove_action( 'genesis_entry_header', 'genesis_post_info', 5 ); //* Remove the post content remove_action( 'genesis_entry_content', 'genesis_do_post_content' ); //* Remove the post image remove_action( 'genesis_entry_content', 'genesis_do_post_image', 8 ); //* Add portfolio body class to the head add_filter( 'body_class', 'executive_add_portfolio_body_class' ); function executive_add_portfolio_body_class( $classes ) { $classes[] = 'executive-pro-portfolio'; return $classes; } //* Add the featured image after post title add_action( 'genesis_entry_header', 'executive_portfolio_grid' ); function executive_portfolio_grid() { if ( $image = genesis_get_image( 'format=url&size=portfolio' ) ) { printf( '<div class="portfolio-featured-image"><a href="%s" rel="bookmark"><img src="%s" alt="%s" /></a></div>', get_permalink(), $image, the_title_attribute( 'echo=0' ) ); } } //* Remove the post meta function remove_action( 'genesis_entry_footer', 'genesis_post_meta' ); genesis(); |
Notice how the WordPress remove_action function is called over and over again to remove Genesis actions? This can be done in a much simpler way, without repeating the function call over and over again. The advantage is that there is only one place in your code to go to when you need to look for or change something. This snippet is a refactoring of all of those remove_action calls:
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 | function remove_genesis_actions_for_portfolio_archive() { $actions_to_remove = array( 'genesis_before_loop' => array( 'function_to_remove' => 'genesis_do_breadcrumbs', ), 'genesis_entry_header' => array( 'function_to_remove' => 'genesis_post_info', 'priority' => 5, ), 'genesis_entry_content' => array( 'function_to_remove' => 'genesis_do_post_content', ), 'genesis_entry_content' => array( 'function_to_remove' => 'genesis_do_post_image', 'priority' => 8, ), 'genesis_entry_footer' => array( 'function_to_remove' => 'genesis_post_meta', ), ); foreach ( $actions_to_remove as $tag => $args ) { $priority = array_key_exists( 'priority', $args ) ? $args['priority'] : 10; remove_action( $tag, $args['function_to_remove'], $priority ); } } |
The same can be done with add_filter or add_action is there you have more than one reason to call them in your code. It makes for easier to maintain, readable code.
Leave a Reply