* @copyright Copyright (c) 2013-2015, Nicolas GUILLAUME
* @link http://presscustomizr.com/customizr
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*/
if ( ! class_exists( 'TC_headings' ) ) :
class TC_headings {
static $instance;
function __construct () {
self::$instance =& $this;
//set actions and filters for posts and page headings
add_action( 'template_redirect' , array( $this , 'tc_set_post_page_heading_hooks') );
//set actions and filters for archives headings
add_action( 'template_redirect' , array( $this , 'tc_set_archives_heading_hooks') );
//Set headings user options
add_action( 'template_redirect' , array( $this , 'tc_set_headings_options') );
}
/******************************************
* HOOK SETTINGS ***************************
******************************************/
/**
* @return void
* set up hooks for archives headings
* hook : template_redirect
*
* @package Customizr
* @since Customizr 3.2.6
*/
function tc_set_archives_heading_hooks() {
//is there anything to render in the current context
//by default don't display the Customizr title in feeds
if ( apply_filters('tc_display_customizr_headings', ! $this -> tc_archive_title_and_class_callback() || is_feed() ) )
return;
//Headings for archives, authors, search, 404
add_action ( '__before_loop' , array( $this , 'tc_render_headings_view' ) );
//Set archive icon with customizer options (since 3.2.0)
add_filter ( 'tc_archive_icon' , array( $this , 'tc_set_archive_icon' ) );
add_filter( 'tc_archive_header_class' , array( $this , 'tc_archive_title_and_class_callback'), 10, 2 );
add_filter( 'tc_headings_archive_html' , array( $this , 'tc_archive_title_and_class_callback'), 10, 1 );
global $wp_query;
if ( tc__f('__is_home') )
add_filter( 'tc_archive_headings_separator' , '__return_false' );
}
/**
* @return void
* set up hooks for post and page headings
* callback of template_redirect
*
* @package Customizr
* @since Customizr 3.2.6
*/
function tc_set_post_page_heading_hooks() {
//by default don't display the Customizr title of the front page and in feeds
if ( apply_filters('tc_display_customizr_headings', ( is_front_page() && 'page' == get_option( 'show_on_front' ) ) ) || is_feed() )
return;
//Set single post/page icon with customizer options (since 3.2.0)
add_filter ( 'tc_content_title_icon' , array( $this , 'tc_set_post_page_icon' ) );
//Prepare the headings for post, page, attachment
add_action ( '__before_content' , array( $this , 'tc_render_headings_view' ) );
//Populate heading with default content
add_filter ( 'tc_headings_content_html' , array( $this , 'tc_post_page_title_callback'), 10, 2 );
//Create the Customizr title
add_filter( 'tc_the_title' , array( $this , 'tc_content_heading_title' ) , 0 );
//Add edit link
add_filter( 'tc_the_title' , array( $this , 'tc_add_edit_link_after_title' ), 2 );
//Set user defined archive titles
add_filter( 'tc_category_archive_title' , array( $this , 'tc_set_archive_custom_title' ) );
add_filter( 'tc_tag_archive_title' , array( $this , 'tc_set_archive_custom_title' ) );
add_filter( 'tc_search_results_title' , array( $this , 'tc_set_archive_custom_title' ) );
add_filter( 'tc_author_archive_title' , array( $this , 'tc_set_archive_custom_title' ) );
//SOME DEFAULT OPTIONS
//No hr if not singular
if ( ! is_singular() )
add_filter( 'tc_content_headings_separator' , '__return_false' );
//No headings for some post formats
add_filter( 'tc_headings_content_html' , array( $this, 'tc_post_formats_heading') , 100 );
}
/******************************************
* VIEWS ***********************************
******************************************/
/**
* Generic heading view : archives, author, search, 404 and the post page heading (if not font page)
* This is the place where every heading content blocks are hooked
* hook : __before_content AND __before_loop (for post lists)
*
* @package Customizr
* @since Customizr 3.1.0
*/
function tc_render_headings_view() {
$_heading_type = in_the_loop() ? 'content' : 'archive';
ob_start();
?>
post_formats_with_no_heading ) ) )
return;
return $_html;
}
/**
* Callback for tc_headings_content_html
* @return string
*
* @package Customizr
* @since Customizr 3.2.6
*/
function tc_post_page_title_callback( $_content = null , $_heading_type = null ) {
$_title = apply_filters( 'tc_title_text', get_the_title() );
return sprintf('<%1$s class="entry-title %2$s">%3$s',
apply_filters( 'tc_content_title_tag' , is_singular() ? 'h1' : 'h2' ),
apply_filters( 'tc_content_title_icon', 'format-icon' ),
apply_filters( 'tc_the_title', $_title )
);
}
/**
* Callback for tc_the_title
* @return string
*
* @package Customizr
* @since Customizr 3.2.6
*/
function tc_content_heading_title( $_title ) {
//Must be in the loop
if ( ! in_the_loop() )
return $_title;
//gets the post/page title
if ( is_singular() || ! apply_filters('tc_display_link_for_post_titles' , true ) )
return is_null($_title) ? apply_filters( 'tc_no_title_post', __( '{no title} Read the post »' , 'customizr' ) ) : $_title;
else
return sprintf('%3$s',
get_permalink(),
sprintf( apply_filters( 'tc_post_link_title' , __( 'Permalink to %s' , 'customizr' ) ) , esc_attr( strip_tags( get_the_title() ) ) ),
is_null($_title) ? apply_filters( 'tc_no_title_post', __( '{no title} Read the post »' , 'customizr' ) ) : $_title
);//end sprintf
}
/**
* Callback for tc_the_title
* @return string
*
* @package Customizr
* @since Customizr 3.2.6
*/
function tc_add_edit_link_after_title( $_title ) {
//Must be in the loop
if ( ! in_the_loop() )
return $_title;
if ( ! apply_filters( 'tc_edit_in_title', $this -> tc_is_edit_enabled() ) )
return $_title;
return sprintf('%1$s %2$s',
$_title,
$this -> tc_render_edit_link_view( $_echo = false )
);
}
/**
* Helper Boolean
* @return boolean
* @package Customizr
* @since Customizr 3.3+
*/
public function tc_is_edit_enabled() {
//never display when customizing
if ( TC___::$instance -> tc_is_customizing() )
return false;
//when are we displaying the edit link?
$edit_enabled = ( (is_user_logged_in()) && is_page() && current_user_can('edit_pages') ) ? true : false;
return ( (is_user_logged_in()) && 0 !== get_the_ID() && current_user_can('edit_post' , get_the_ID() ) && ! is_page() ) ? true : $edit_enabled;
}
/**
* Returns the edit link html string
* @return string
* @package Customizr
* @since Customizr 3.3+
*/
function tc_render_edit_link_view( $_echo = true ) {
$_view = sprintf('%2$s',
get_edit_post_link(),
__( 'Edit' , 'customizr' )
);
if ( ! $_echo )
return $_view;
echo $_view;
}
/**
* hook tc_content_title_icon
* @return boolean
*
* @package Customizr
* @since Customizr 3.2.0
*/
function tc_set_post_page_icon( $_bool ) {
if ( is_page() )
$_bool = ( 0 == esc_attr( TC_utils::$inst->tc_opt( 'tc_show_page_title_icon' ) ) ) ? false : $_bool;
if ( is_single() && ! is_page() )
$_bool = ( 0 == esc_attr( TC_utils::$inst->tc_opt( 'tc_show_post_title_icon' ) ) ) ? false : $_bool;
if ( ! is_single() )
$_bool = ( 0 == esc_attr( TC_utils::$inst->tc_opt( 'tc_show_post_list_title_icon' ) ) ) ? false : $_bool;
//last condition
return ( 0 == esc_attr( TC_utils::$inst->tc_opt( 'tc_show_title_icon' ) ) ) ? false : $_bool;
}
/**
* hook tc_archive_icon
* @return string
*
* @package Customizr
* @since Customizr 3.2.0
*/
function tc_set_archive_icon( $_class ) {
$_class = ( 0 == esc_attr( TC_utils::$inst->tc_opt( 'tc_show_archive_title_icon' ) ) ) ? '' : $_class;
//last condition
return 0 == esc_attr( TC_utils::$inst->tc_opt( 'tc_show_title_icon' ) ) ? '' : $_class;
}
/**
* Return 1) the archive title html content OR 2) the archive title class OR 3) the boolean
* hook : tc_display_customizr_headings
* @return boolean
*
* @package Customizr
* @since Customizr 3.2.0
*/
function tc_archive_title_and_class_callback( $_title = null, $_return_class = false ) {
//declares variables to return
$content = false;
$_header_class = false;
//case page for posts but not on front
global $wp_query;
if ( $wp_query -> is_posts_page && ! is_front_page() ) {
//get page for post ID
$page_for_post_id = get_option('page_for_posts');
$_header_class = array('entry-header');
if ( $_return_class )
return $_header_class;
$content = sprintf('<%1$s class="entry-title %2$s">%3$s',
apply_filters( 'tc_content_title_tag' , 'h1' ),
apply_filters( 'tc_content_title_icon', 'format-icon' ),
get_the_title( $page_for_post_id )
);
$content = apply_filters( 'tc_page_for_post_header_content', $content );
}
//404
else if ( is_404() ) {
$_header_class = array('entry-header');
if ( $_return_class )
return $_header_class;
$content = sprintf('%2$s
',
apply_filters( 'tc_archive_icon', '' ),
apply_filters( 'tc_404_title' , __( 'Ooops, page not found' , 'customizr' ) )
);
$content = apply_filters( 'tc_404_header_content', $content );
}
//search results
else if ( is_search() && ! is_singular() ) {
$_header_class = array('search-header');
if ( $_return_class )
return $_header_class;
$content = sprintf( '',
apply_filters( 'tc_search_result_header_title_class', 'span8' ),
apply_filters( 'tc_archive_icon', 'format-icon' ),
have_posts() ? '' : __( 'No' , 'customizr' ).' ' ,
apply_filters( 'tc_search_results_title' , __( 'Search Results for :' , 'customizr' ) ),
'' . get_search_query() . '',
apply_filters( 'tc_search_result_header_form_class', 'span4' ),
have_posts() ? get_search_form(false) : ''
);
$content = apply_filters( 'tc_search_results_header_content', $content );
}
// all archives
else if ( is_archive() ){
$_header_class = array('archive-header');
if ( $_return_class )
return $_header_class;
//author's posts page
if ( is_author() ) {
//gets the user ID
$user_id = get_query_var( 'author' );
$content = sprintf( '%2$s %3$s
',
apply_filters( 'tc_archive_icon', 'format-icon' ),
apply_filters( 'tc_author_archive_title' , '' ),
'' . get_the_author_meta( 'display_name' , $user_id ) . ''
);
if ( apply_filters ( 'tc_show_author_meta' , get_the_author_meta( 'description', $user_id ) ) ) {
$content .= sprintf('%1$s',
apply_filters( 'tc_author_meta_separator', '
' ),
apply_filters( 'tc_author_meta_wrapper_class', 'row-fluid' ),
sprintf('%2$s
',
apply_filters( 'tc_author_meta_avatar_class', 'comment-avatar author-avatar span2'),
get_avatar( get_the_author_meta( 'user_email', $user_id ), apply_filters( 'tc_author_bio_avatar_size' , 100 ) ),
apply_filters( 'tc_author_meta_content_class', 'author-description span10' ),
sprintf( __( 'About %s' , 'customizr' ), get_the_author() ),
get_the_author_meta( 'description' , $user_id )
)
);
}
$content = apply_filters( 'tc_author_header_content', $content );
}
//category archives
else if ( is_category() ) {
$content = sprintf( '%2$s %3$s
',
apply_filters( 'tc_archive_icon', 'format-icon' ),
apply_filters( 'tc_category_archive_title' , '' ),
'' . single_cat_title( '' , false ) . ''
);
if ( apply_filters ( 'tc_show_cat_description' , category_description() ) ) {
$content .= sprintf('%1$s
',
category_description()
);
}
$content = apply_filters( 'tc_category_archive_header_content', $content );
}
//tag archives
else if ( is_tag() ) {
$content = sprintf( '%2$s %3$s
',
apply_filters( 'tc_archive_icon', 'format-icon' ),
apply_filters( 'tc_tag_archive_title' , '' ),
'' . single_tag_title( '' , false ) . ''
);
if ( apply_filters ( 'tc_show_tag_description' , tag_description() ) ) {
$content .= sprintf('%1$s
',
tag_description()
);
}
$content = apply_filters( 'tc_tag_archive_header_content', $content );
}
//time archives
else if ( is_day() || is_month() || is_year() ) {
$archive_type = is_day() ? sprintf( __( 'Daily Archives: %s' , 'customizr' ), '' . get_the_date() . '' ) : __( 'Archives' , 'customizr' );
$archive_type = is_month() ? sprintf( __( 'Monthly Archives: %s' , 'customizr' ), '' . get_the_date( _x( 'F Y' , 'monthly archives date format' , 'customizr' ) ) . '' ) : $archive_type;
$archive_type = is_year() ? sprintf( __( 'Yearly Archives: %s' , 'customizr' ), '' . get_the_date( _x( 'Y' , 'yearly archives date format' , 'customizr' ) ) . '' ) : $archive_type;
$content = sprintf('%2$s
',
apply_filters( 'tc_archive_icon', 'format-icon' ),
$archive_type
);
$content = apply_filters( 'tc_time_archive_header_content', $content );
}
// all other archivers ( such as custom tax archives )
else if ( apply_filters('tc_show_tax_archive_title', true) ){
$content = sprintf('%2$s
',
apply_filters( 'tc_archive_icon', 'format-icon' ), /* handle tax icon? */
apply_filters( 'tc_tax_archive_title', get_the_archive_title() )
);
$tax_description = get_the_archive_description();
if ( apply_filters( 'tc_show_tax_description', $tax_description ) )
$content .= sprintf('%1$s
',
$tax_description
);
$content = apply_filters( 'tc_tax_archive_header_content', $content );
}
}// end all archives
return $_return_class ? $_header_class : $content;
}//end of fn
/**
* @return void
* set up user defined options
* callback of template_redirect
*
* @package Customizr
* @since Customizr 3.2.6
*/
function tc_set_headings_options() {
//by default don't display the Customizr title in feeds
if ( apply_filters('tc_display_customizr_headings', is_feed() ) )
return;
//Add update status next to the title (@since 3.2.6)
add_filter( 'tc_the_title' , array( $this , 'tc_add_update_notice_in_title'), 20);
}
/**
* Callback of the tc_the_title => add an updated status
* @return string
* User option based
*
* @package Customizr
* @since Customizr 3.2.0
*/
function tc_add_update_notice_in_title($html) {
//First checks if we are in the loop and we are not displaying a page
if ( ! in_the_loop() || is_page() )
return $html;
//Is the notice option enabled AND this post type eligible for updated notice ? (default is post)
if ( 0 == esc_attr( TC_utils::$inst->tc_opt( 'tc_post_metas_update_notice_in_title' ) ) || ! in_array( get_post_type(), apply_filters('tc_show_update_notice_for_post_types' , array( 'post') ) ) )
return $html;
//php version check for DateTime
//http://php.net/manual/fr/class.datetime.php
if ( version_compare( PHP_VERSION, '5.2.0' ) < 0 )
return $html;
//get the user defined interval in days
$_interval = esc_attr( TC_utils::$inst->tc_opt( 'tc_post_metas_update_notice_interval' ) );
$_interval = ( 0 != $_interval ) ? $_interval : 30;
//Check if the last update is less than n days old. (replace n by your own value)
$has_recent_update = ( TC_utils::$inst -> tc_post_has_update( true ) && TC_utils::$inst -> tc_post_has_update( 'in_days') < $_interval ) ? true : false;
if ( ! $has_recent_update )
return $html;
//Return the modified title
return apply_filters(
'tc_update_notice_in_title',
sprintf('%1$s %2$s',
$html,
esc_attr( TC_utils::$inst->tc_opt( 'tc_post_metas_update_notice_text' ) ),
esc_attr( TC_utils::$inst->tc_opt( 'tc_post_metas_update_notice_format' ) )
)
);
}
/**
* hooks : 'tc_category_archive_title', 'tc_tag_archive_title', 'tc_search_results_title', 'tc_author_archive_title'
* @param default title string
* @return string of user defined title
* @since Customizr 3.3+
*/
function tc_set_archive_custom_title( $_title ) {
switch ( current_filter() ) {
case 'tc_category_archive_title' :
return esc_attr( TC_utils::$inst->tc_opt( 'tc_cat_title' ) );
break;
case 'tc_tag_archive_title' :
return esc_attr( TC_utils::$inst->tc_opt( 'tc_tag_title' ) );
break;
case 'tc_search_results_title' :
return esc_attr( TC_utils::$inst->tc_opt( 'tc_search_title' ) );
break;
case 'tc_author_archive_title' :
return esc_attr( TC_utils::$inst->tc_opt( 'tc_author_title' ) );
break;
}
return $_title;
}
}//end of class
endif;