WordPress プラグインなしの目次のリンクがうまく動作しないとき

【目次】 [close]

1 目次のリンクがうまく動作しないとき
2 目次の自動生成についての説明
3 実際のコード
4 補足記事

目次のリンクがうまく動作しないとき

WordPressでプラグインなしで目次を自動生成する方法

ワードプレスで目次を自動作成する方法ワードプレスで記事内に目次を作りたい。と思ったとき、個人的には「functi...

likiroku.com

2019-03-01 05:00

上記の記事で以前書きましたが、

ワードプレスにおいてテーマに目次の機能が無かった場合、「『functions.php』と『style.css』を編集して目次を自動で生成してくるショートコードを作る」という方法がコスパがいいと思っています。

ただしテーマなど環境によってはこの目次のリンク機能がうまく動作しない場合があります。

この場合、対処法の一例として「functions.php」の「offset」のコードをいじることで改善する場合があります。

目次の自動生成についての説明

最近は標準で目次が自動生成されるテーマが多いですが、ものによっては目次機能がないテーマもあります。

手動で毎回目次を作るのは面倒なので自動生成する方法を検討するわけですが、プラグインはセキュリティや動作の軽快さの管理が面倒なのでできるだけ使いたくないところが本音です。

そのため、「functions.php」を編集していつでも好きなときに目次を自動生成できるショートコードを作ることになります。

さらに目次をクリックすると該当の場所にとべるリンク機能が備わっていると読み手も書き手も便利です。そういったコードを実装します。

ただしこのリンク機能がうまく動作しないことがあります。
例えば、リンクをクリックしても無反応あるいは冒頭にとんでしまうケースがあります。

これは該当の場所をワードプレスが探すことができていないためと考えられます。

そのため、コード内の「offset」を修正します。

実際のコード

//以下、目次の自動作成ショートコードの記述です
class Toc_Shortcode {
 
	private $add_script = false;
	private $atts = array();
 
	public function __construct() {
		add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
		add_shortcode( 'toc', array( $this, 'shortcode_content' ) );
		add_action( 'wp_footer', array( $this, 'add_script' ) );
	}
 
	function enqueue_scripts() {
		if ( !wp_script_is( 'jquery', 'done' ) ) {
			wp_enqueue_script( 'jquery' );
		}
	}
 
	public function shortcode_content( $atts ) {
		$this->atts = shortcode_atts( array(
			'id' => '',
			'class' => 'toc',
			'title' => '<span class="icon-info"></span> 【目次】 ',
			'toggle' => 'true',
			'opentext' => 'open',
			'closetext' => 'close',
			'showcount' => 2,
			'depth' => 0,
			'toplevel' => 2,
			'targetclass' => 'entry-content',
			'offset' => '0',
			'duration' => 'normal'
		), $atts );
 
		$content = get_the_content();
 
		$headers = array();
		preg_match_all( '/<([hH][1-6]).*?>(.*?)<\/[hH][1-6].*?>/u', $content, $headers );
		$header_count = count( $headers[0] );
		$counter = 0;
		$counters = array( 0, 0, 0, 0, 0, 0 );
		$current_depth = 0;
		$prev_depth = 0;
		$top_level = intval( $this->atts['toplevel'] );
		if ( $top_level < 1 ) $top_level = 1;
		if ( $top_level > 6 ) $top_level = 6;
		$this->atts['toplevel'] = $top_level;
 
		// 表示する階層数
		$max_depth = ( ( $this->atts['depth'] == 0 ) ? 6 : intval( $this->atts['depth'] ) );
 
		$toc_list = '';
		for ( $i = 0; $i < $header_count; $i++ ) {
			$depth = 0;
			switch ( strtolower( $headers[1][$i] ) ) {
				case 'h1': $depth = 1 - $top_level + 1; break;
				case 'h2': $depth = 2 - $top_level + 1; break;
				case 'h3': $depth = 3 - $top_level + 1; break;
				case 'h4': $depth = 4 - $top_level + 1; break;
				case 'h5': $depth = 5 - $top_level + 1; break;
				case 'h6': $depth = 6 - $top_level + 1; break;
			}
			if ( $depth >= 1 && $depth <= $max_depth ) {
				if ( $current_depth == $depth ) {
					$toc_list .= '</li>';
				}
				while ( $current_depth > $depth ) {
					$toc_list .= '</li></ul>';
					$current_depth--;
					$counters[$current_depth] = 0;
				}
				if ( $current_depth != $prev_depth ) {
					$toc_list .= '</li>';
				}
				if ( $current_depth < $depth ) {
					$toc_list .= '<ul' . ( ( $current_depth == 0 ) ? ' class="toc-list"' : '' ) . '>';
					$current_depth++;
				}
				$counters[$current_depth - 1]++;
				$number = $counters[0];
				for ( $j = 1; $j < $current_depth; $j++ ) {
					$number .= '.' . $counters[$j];
				}
				$counter++;
				$toc_list .= '<li><a href="#toc' . ($i + 1) . '"><span class="contentstable-number">' . $number . '</span> ' . $headers[2][$i] . '</a>';
				$prev_depth = $depth;
			}
		}
		while ( $current_depth >= 1 ) {
			$toc_list .= '</li></ul>';
			$current_depth--;
		}
 
		$html = '';
		if ( $counter >= $this->atts['showcount'] ) {
			$this->add_script = true;
 
			$toggle = '';
			if ( strtolower( $this->atts['toggle'] ) == 'true' ) {
				$toggle = ' <span class="toc-toggle">[<a class="internal" href="javascript:void(0);">' . $this->atts['closetext'] . '</a>]</span>';
			}
 
			$html .= '<div' . ( $this->atts['id'] != '' ? ' id="' . $this->atts['id'] . '"' : '' ) . ' class="' . $this->atts['class'] . '">';
			$html .= '<p class="toc-title">' . $this->atts['title'] . $toggle . '</p>';
			$html .= $toc_list;
			$html .= '</div>' . "\n";
		}
 
		return $html;
	}
 
	public function add_script() {
		if ( !$this->add_script ) {
			return false;
		}
 
		$class = $this->atts['class'];
		$offset = is_numeric( $this->atts['offset'] ) ? (int)$this->atts['offset'] : - 1;
		$duration = is_numeric( $this->atts['duration'] ) ? (int)$this->atts['duration'] : '"' . $this->atts['duration'] . '"';
		$targetclass = trim( $this->atts['targetclass'] );
		if ( $targetclass == '' ) {
			$targetclass = get_post_type();
		}
		$targetclass = ".$targetclass :header";
		$opentext = $this->atts['opentext'];
		$closetext = $this->atts['closetext'];
		?>
<script type="text/javascript">
(function ($) {
  var offset = <?php echo $offset; ?>;
  var idCounter = 0;
  $("<?php echo $targetclass; ?>").each(function () {
    idCounter++;
    this.id = "toc" + idCounter;
  });
  $(".<?php echo $class; ?> a[href^='#']").click(function () {
    var href = $(this).attr("href");
    var target = $(href === "#" || href === "" ? "html" : href);
    var h = (offset === -1 ? $("#wpadminbar").height() + $(".navbar-fixed-top").height() : offset);
    var position = target.offset().top - h - 4;
    $("html, body").animate({scrollTop: position}, <?php echo $duration; ?>, "swing");
    return false;
  });
  $(".toc-toggle a").click(function () {
    var tocList = $(".toc-list");
    if (tocList.is(":hidden")) {
      tocList.show();
      $(this).text("<?php echo $closetext; ?>");
    } else {
      tocList.hide();
      $(this).text("<?php echo $opentext; ?>");
    }
  });
})(jQuery);
</script>
		<?php
	}
 
}
 
new Toc_Shortcode();
//以上、目次の自動作成ショートコードの記述でした。

上記が実際のコードであり、具体的には赤字が修正箇所です。

「offset」に０を入れています。