(この記事は2025年05月27日に投稿されました。)

WordPressサイトを運営されている皆さん、お問い合わせフォームやコメント欄のスパム対策、しっかり行っていますか？

多くのサイトで利用されている便利なスパム対策ツールの一つに「Invisible reCaptcha」があります。

しかし、この「Invisible reCaptcha」を導入した際に、「Warning: __wakeup()XXXXXX」といったエラーメッセージに遭遇し、頭を抱えている方もいらっしゃるのではないでしょうか。

このエラーは、サイトの表示には直接的な影響がないように見えても、放置しておくとセキュリティ上の不安が残ったり、将来的に予期せぬ不具合を引き起こす可能性も否定できません。

何より、トップページでエラーが表示されるのは、気持ちの良いものではありませんよね。

今回はWordPressのgInvisible reCaptchaで__wakeup()のWarningエラーが発生した際の解消方法について紹介していきます。

エラーに悩まされている方はもちろん、これから「Invisible reCaptcha」の導入を検討している方も、安心して運用できるサイト構築のために、ぜひ最後までお読みください。

この記事はこんな方におすすめ

WordPressのInvisible reCaptchaを導入したい場合

Invisible reCaptchaを有効化した際に発生するWarningエラーを消したい場合

Invisible reCaptchaとは

Invisible reCaptchaは、Googleが提供するスパム対策ツールの一種で、ユーザーにチェックボックスや画像認証を表示せず、バックグラウンドで自動的に人間かボットかを判別する仕組みを導入することができるプラグインになります。

WordPressのサイトを登録して「サイトキー」と「シークレットキー」を取得し、プラグインに追記することで、簡単にreCaptchaを導入することができます。

Invisible reCaptchaで発生した__wakeup()のWarningエラーの内容

Invisible reCaptchaで発生した__wakeup()のWarningエラーの内容ですが、下記の内容になります。

Warningエラー画面

Waringエラー

Warningエラーとしましては、「__wakeup() メソッドはpublicで可視化すべき」という内容になります。

色々調べてみたのですが、PHP7.4より前のバージョンだと、__wakeup()メソッドはprivateで宣言することが許容されていましたが、PHP7.4以降では、__wakeup()メソッドは必ずpublicで宣言しなければならないと変更になったようです。

出典: PHP: マジックメソッド – Manual

おそらく、プラグインの更新が止まっているため、最新のPHPとの互換性があってないのが原因でした。

Invisible reCaptchaの__wakeup()のWarningエラーを解消するには

Invisible reCaptchaの__wakeup()のWarningエラーを解消するには、プラグインのソースコードを直接修正する必要があります。

修正するは箇所は「invisible-recaptcha/includes/plugin/」にある「MchBasePublicPlugin.php」になります。

● MchBasePublicPlugin.php

<?php
/**
 * Copyright (c) 2016 Ultra Community (http://www.ultracommunity.com)
 */

namespace InvisibleReCaptcha\MchLib\Plugin;

abstract class MchBasePublicPlugin extends MchBasePlugin
{

	public abstract function enqueuePublicScriptsAndStyles();
	public abstract function registerAfterSetupThemeHooks();

	protected function __construct()
	{
		parent::__construct();

		add_action('wp_enqueue_scripts', array( $this, 'enqueuePublicScriptsAndStyles' ));
		add_action('after_setup_theme', array( $this, 'registerAfterSetupThemeHooks' ));

	}

	public function initializePlugin()
	{
		parent::initializePlugin();
		//$this->enqueuePublicScriptsAndStyles();
	}

	public static function registerShortCode($tagName, $callBackHandler)
	{
		add_shortcode($tagName, $callBackHandler );
	}

	private function __clone()
	{}

	private function __wakeup()
	{}

}

上記ソースコードのの37行目にある「private」を「public」に変更します。

● MchBasePublicPlugin.php

<?php
/**
 * Copyright (c) 2016 Ultra Community (http://www.ultracommunity.com)
 */

namespace InvisibleReCaptcha\MchLib\Plugin;

abstract class MchBasePublicPlugin extends MchBasePlugin
{

	public abstract function enqueuePublicScriptsAndStyles();
	public abstract function registerAfterSetupThemeHooks();

	protected function __construct()
	{
		parent::__construct();

		add_action('wp_enqueue_scripts', array( $this, 'enqueuePublicScriptsAndStyles' ));
		add_action('after_setup_theme', array( $this, 'registerAfterSetupThemeHooks' ));

	}

	public function initializePlugin()
	{
		parent::initializePlugin();
		//$this->enqueuePublicScriptsAndStyles();
	}

	public static function registerShortCode($tagName, $callBackHandler)
	{
		add_shortcode($tagName, $callBackHandler );
	}

	private function __clone()
	{}

	public function __wakeup()
	{}

}

Warningエラー画面:修正後

表示されたWarningエラーが表示されなくなりました。

また、定期的にページをロードしても、定期的に読み込むとWarningエラーが表示されません。

Invisible reCaptchaの__wakeup()のWarningエラーを解消するための方法

上記の修正を行うための方法としては下記の2つがあります。

それぞれの方法について解説しています。

FTPを使用する

まず、1つ目はFTPを使用することです。

FTPとはFile Transfer Protocol(ファイル・トランスファー・プロトコル)といい、コンピュータネットワーク上のクライアントとサーバの間でファイル転送を行うための通信プロトコルの一つになります。

そのため、自分のPC内からレンタルしたサーバーの中へファイルを送ったり、とってきたりすることができます。

FTPではテーマファイルだけでなく、インストールしたプラグイファイルも入っているため、Invisible reCaptchaの自分のファイルを自分のPCにとってきて編集し、編集したファイルをサーバーに送ることで、修正することが可能になります。

ここでは、FTPの細かい設定の説明はここでは省き、接続できた前提で説明します。

FTPの接続が完了しましたら、自分のドメインのディレクトリまで移動し、「Plugin」ファイルの中にある「Invisible reCaptcha」をクリックします。

すると、Invisible reCaptchaのプラグインファイルが表示されますので、「invisible-recaptcha/includes/plugin/MchBasePublicPlugin.php」を右クリック → [ダウンロード]をクリックして自分のPCへダウンロードします。

自分のPCにてソースコードを修正した後に「MchBasePublicPlugin.php」を右クリック → [アップロード]をクリックして、サーバーへアップロードすると修正完了です。

プラグインファイルエディタを使用する

2つ目はプラグインファイルエディタを使用することです。

WordPress上の[プラグインメニュー]にて[プラグインファイルエディタ]という項目があるため、そちらを選択します。

プラグインファイルエディタの選択後、インストールしてあるプラグインのファイルが表示されるため、編集するプラグインを選択に「Invisible reCaptcha」を選択して[選択]をクリックします。

すると、Invisible reCaptchaのプラグインファイルが表示されますので、「invisible-recaptcha/includes/plugin/MchBasePublicPlugin.php」をクリックすると、修正対象のソースコードが表示されます。

37行目のソースコード箇所を修正し、[ファイルを更新]をクリックすると完了です。

今回のInvisible reCaptchaのWarningエラーがどうしても解消されない場合

上記の方法でも今回発生したWaringエラーが消えない場合は他のプラグインを使用することをおすすめします。

ここでは、Invisible reCaptchaの代わりとなるプラグインを下記の2つご紹介します。

Advanced Google reCAPTCHA

Advanced Google reCAPTCHAとは、WordPressサイトにGoogle reCAPTCHA(リキャプチャ)を簡単に導入するためのプラグインとなります。

Google reCAPTCHAの管理コンソールにアクセスし、WordPressのサイトを登録して「サイトキー」と「シークレットキー」を取得することで、reCAPTCHAを設置することができます。

またv2とv3の両方を選べるため、WordPressサイトの基本的なセキュリティ強化に非常に有効なプラグインとなっています。

reCaptcha by BestWebSoft

reCaptcha by BestWebSoftとは、BestWebSoft社によって開発されたWordPressサイトをスパムやボットから保護するために、Google reCAPTCHAを導入するプラグインとなります。

同様にGoogle reCAPTCHAの管理コンソールにアクセスし、WordPressのサイトを登録して「サイトキー」と「シークレットキー」を取得することで、reCAPTCHAを設置することができます。

また「v2」と「v3」の両方を選べるため、こちらもWordPressサイトの基本的なセキュリティ強化に非常に有効なプラグインとなっています。

まとめ

(この記事は2025年05月25日に投稿されました。)

WordPressでサイトを構築していると「指定したカテゴリー情報を取得して処理したり表示したりしたい」という場面によく遭遇します。

例えば、カテゴリー名、スラッグ、説明文、親カテゴリー情報など、様々なデータにアクセスできれば、より柔軟で動的なサイト設計が可能になります。

WordPressで指定したカテゴリーの情報するにはget_category()を使用します。

get_category()とは指定したカテゴリーの情報を取得するWordPressの関数となります。

カテゴリー情報をオブジェクトで取得し、オブジェクトに対してプロパティを指定することで欲しい情報のみを取得することが可能になります。

そのため、こちらの関数を活用することで、指定したカテゴリーのあらゆる情報を簡単に取得し、思い通りの表示を実現することができます。

今回はWordPressのget_category()で指定したカテゴリーの情報を取得する方法について徹底的に紹介していきます。

この記事を読み終える頃には、あなたも get_category()をマスターし、WordPressによる表現力の可能性をさらに引き出すことができるようになるでしょう。

この記事はこんな方におすすめ

投稿記事に付与したカテゴリーの情報を取得したい場合

カテゴリー情報を条件分岐として使用したい場合

WordPressのget_category()とは

get_category()とは、指定したカテゴリーの情報を取得するWordPressの関数になります。

WordPress内で登録したカテゴリーをプログラム内で取得し、処理として使用したり、様々なページで出力したりすることができます。

get_category()の書き方

get_category()の書き方は下記のようになります。

get_category('カテゴリーID', ['取得形式'])

get_category()と記載し、括弧の中に必須な引数を1つ、任意な引数を1つ指定することで使用できます。

get_category()のパラメータ

get_category()のパラメータは下記のようになります。

get_category()を記載し、括弧の中に必須の引数として、「カテゴリーID」を指定します。

続けて、括弧の中に任意の引数として、「取得形式」を指定します。

get_category()の戻り値

get_category()の戻り値は「オブジェクト」であり、指定したカテゴリーの情報を格納して返すようになります。

get_category()の呼び出し元

get_category()の呼び出し元は「wp-includes/category.php」となります。

function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
	$category = get_term( $category, 'category', $output, $filter );

	if ( is_wp_error( $category ) ) {
		return $category;
	}

	_make_cat_compat( $category );

	return $category;
}

get_category()は、get_terms()を呼び出しており、エラーでない場合、指定したカテゴリーの情報を返り値に指定しています。

get_category()を使用するメリット

get_category()を使用するメリットについてご紹介します。

ここでは、下記の3点について解説していきます。

特定のカテゴリー情報をピンポイントで取得できる

まず、1つ目は特定のカテゴリー情報をピンポイントで取得できるということです。

特定のカテゴリーIDさえ分かれば、そのカテゴリーに関する様々な情報を効率的に取得できます。

取得したいカテゴリー情報のみを取得することができるため、不要なデータ処理を省き、パフォーマンス向上にも期待ができます。

サイトのページを動的に表示することができる

2つ目はサイトのページを動的に表示することができるということです。

取得した情報を使用することでカテゴリーごとに異なる表示をしたり、特定のカテゴリーへのリンクを動的に生成したりできます。

例えば、「カテゴリーA」のページでは説明文をページ上部に表示し、他のページには説明文を表示しないなど、静的な表示では難しい表現が可能になります。

SEO対策に有効である

3つ目はSEO対策に有効であるということです。

カテゴリーの説明文などを動的に表示できるため、ユーザーだけでなく検索エンジンにもそのカテゴリーが何についてのものなのかを明確に伝えられます。

また、特定のカテゴリーアーカイブページへのリンクを適切に配置することもできるため、クローラビリティの向上からSEO対策に繋がります。

get_category()で指定したカテゴリーの情報を取得するサンプルコード

get_category()で指定したカテゴリーの情報を取得するサンプルコードを紹介します。

ここでは、下記の2ケースでget_category()を使用します。

存在するカテゴリーIDを指定する場合

存在するカテゴリーIDを指定する場合にget_category()を使用すると、指定したカテゴリーの情報を取得します。

試しに、下記の画像である「テスト」のカテゴリー情報を取得します。

「テスト」のカテゴリーIDは「8」であるため、引数に「8」を指定します。

カテゴリー一覧画面

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を取得</h1>
  <?php $category = get_category('8'); ?>
  <div>
     <?php print_r($category); ?>
  </div>
</div>

実行結果

get_category()で存在するカテゴリーIDを指定してカテゴリーの情報を取得しています。

そのため、カテゴリー「テスト」のカテゴリー情報が表示されています。

存在しないカテゴリーIDを指定する場合

存在しないカテゴリーIDを指定する場合にget_category()を使用すると、カテゴリー情報を取得しません。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を取得</h1>
  <?php $category = get_category('999'); ?>
  <div>
     <?php print_r($category); ?>
  </div>
</div>

実行結果

get_category()で存在しないカテゴリーIDを指定してカテゴリーの情報を取得しています。

「999」を指定していますが、「999」のカテゴリーが存在しないため、情報を取得できず、何も表示されていません。

カテゴリーIDを指定しないでget_category()を使用する場合

カテゴリーIDを指定しないでget_category()を使用するとエラーが発生します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を取得</h1>
  <?php $category = get_category(); ?>
  <div>
     <?php print_r($category); ?>
  </div>
</div>

実行結果

get_category()でカテゴリーIDを指定しないで、カテゴリーの情報を取得しています。

カテゴリーIDは必須であるため、「get_category() の引数が少なすぎる」というエラーが表示されています。

get_category()でカテゴリー情報を別々で取得する場合

get_category()でカテゴリー情報を別々で取得する場合は、取得したデータに対して、アロー演算子を使用します。

アロー演算子とは、オブジェクトの中身にアクセスするための演算子であリ、オブジェクトが持つプロパティやメソッドを呼び出すことができます。

そのため、取得したオブジェクトに対してアロー演算子を使用すると、取得したカテゴリー情報を別々で取得することが可能になります。

ここでは下記の6ケースでget_category()を使用し、カテゴリーの情報を別々で取得します。

ここでは下記のカテゴリー情報を取得することとします。

カテゴリー一覧画面

カテゴリーの名前を取得する場合

カテゴリーの名前を取得する場合は、get_category()で取得したオブジェクトに対して、「name」もしくは「cat_name」というプロパティを指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を取得</h1>
  <?php $category = get_category('8'); ?>
  <div>
     <p>name: <?php echo ($category->name); ?></p>
     <p>cat_name: <?php echo ($category->cat_name); ?></p>
  </div>
</div>

実行結果

get_category()でカテゴリーの名前を取得しています。

そのため、カテゴリーの名前である「テスト」それぞれ表示されています。

カテゴリーのIDを取得する場合

カテゴリーのIDを取得する場合は、get_category()で取得したオブジェクトに対して、「term_id」もしくは「cat_ID」というプロパティを指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を取得</h1>
  <?php $category = get_category('8'); ?>
  <div>
     <p>term_id: <?php echo ($category->term_id); ?></p>
     <p>cat_ID: <?php echo ($category->cat_ID); ?></p>
  </div>
</div>

実行結果

get_category()でカテゴリーのIDを取得しています。

そのため、「テスト」カテゴリーのIDである「8」がそれぞれ表示されています。

カテゴリーのスラッグ名を取得する場合

カテゴリー名を取得する場合は、get_category()で取得したオブジェクトに対して、「slug」もしくは「category_nicename」というプロパティを指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を取得</h1>
  <?php $category = get_category('8'); ?>
  <div>
     <p>slug: <?php echo ($category->slug); ?></p>
     <p>category_nicename: <?php echo ($category->category_nicename); ?></p>
  </div>
</div>

実行結果

get_category()でカテゴリーのスラッグを取得しています。

そのため、「お知らせ」カテゴリーのスラッグである「test」がそれぞれ表示されています。

カテゴリーの説明を取得する場合

カテゴリーの説明を取得する場合は、get_category()で取得したオブジェクトに対して、「description」もしくは「category_description」というプロパティを指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を取得</h1>
  <?php $category = get_category('8'); ?>
  <div>
     <p>description: <?php echo ($category->description); ?></p>
     <p>category_description: <?php echo ($category->category_description); ?></p>
  </div>
</div>

実行結果

get_category()でカテゴリーの説明を取得しています。

そのため、「テスト」カテゴリーの説明文がそれぞれ表示されています。

カテゴリーの投稿数を取得する場合

カテゴリー名を取得する場合は、get_category()で取得したオブジェクトに対して、「count」もしくは「category_count」というプロパティを指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を取得</h1>
  <?php $category = get_category('8'); ?>
  <div>
     <p>count: <?php echo ($category->count); ?></p>
     <p>category_count: <?php echo ($category->category_count); ?></p>
  </div>
</div>

実行結果

get_category()でカテゴリーの投稿数を取得しています。

そのため、「テスト」のカテゴリーの投稿数である「12」が表示されています。

親カテゴリーのIDを取得する場合

親カテゴリーのIDを取得する場合は、get_category()で取得したオブジェクトに対して、「parent」もしくは「category_parent」というプロパティを指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を取得</h1>
  <?php $category = get_category('8'); ?>
  <div>
     <p>parent: <?php echo ($category->parent); ?></p>
     <p>category_parent: <?php echo ($category->category_parent); ?></p>
  </div>
  <?php $category = get_category('2'); ?>
  <div>
     <p>parent: <?php echo ($category->parent); ?></p>
     <p>category_parent: <?php echo ($category->category_parent); ?></p>
  </div>
</div>

実行結果

get_category()で親カテゴリーIDを取得しています。

「テスト」カテゴリーは親カテゴリーがいないため、「0」が表示されています。

また、「テスト1」カテゴリーは親が存在するため、親カテゴリー「テスト」のIDである「8」が表示されています。

取得形式を指定してget_category()で指定したカテゴリーの情報を取得する場合

取得形式を指定してget_category()で指定したカテゴリーの情報を取得するにはパラメータに「取得形式」を指定します。

取得形式を変更することで、カテゴリー情報を自分の好みの形式を指定して受け取ることが可能になります。

そのため、ここでは下記の3ケースでget_category()を使用します。

オブジェクトで取得する場合

指定したカテゴリーの情報をオブジェクトで取得するには「引数なし」にするか、パラメータである取得形式に「OBJECT」を指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を取得</h1>
  <?php $category1 = get_category('8'); ?>
  <div>
     <?php print_r($category1); ?>
     <p><?php print_r($category2->name); ?></p>
  </div>
  <?php $category2 = get_category('8', 'OBJECT'); ?>
  <div>
     <?php print_r($category2); ?>
     <p><?php print_r($category2->name); ?></p>
  </div>
</div>

実行結果

get_category()でカテゴリー情報をオブジェクトで取得しています。

nameプロパティにカテゴリー名が格納されているため、アロー関数にnameを指定して「テスト」が表示されています。

連想配列形式で取得する場合

指定したカテゴリーの情報を連想配列形式で取得するには、パラメータである取得形式に「ARRAY_A」を指定します。

連想配列のため、キーを指定することで、取得したいカテゴリーの情報を取得することが可能になります。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を連祖配列で取得</h1>
  <?php $category = get_category('8', 'ARRAY_A'); ?>
  <div>
     <?php print_r($category); ?>
     <p><?php print_r($category[name]); ?></p>
  </div>
</div>

実行結果

get_category()でカテゴリー情報を連祖配列で取得しています。

「name」のキーにはカテゴリー名が格納されているため、「name」を指定して「テスト」が表示されています。

配列で取得する場合

get_category()で指定したカテゴリーの情報を配列で取得するには、パラメータである取得形式に「ARRAY_N」を指定します。

配列のため、カテゴリー情報をインデックスで取得することが可能になります。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_category()で指定したカテゴリー情報を添字形式で取得</h1>
  <?php $category = get_category('8', 'ARRAY_N'); ?>
  <div>
     <?php print_r($category); ?>
     <p><?php print_r($category[1]); ?></p>
  </div>
</div>

実行結果

get_category()でカテゴリー情報を配列で取得しています。

配列の2番目にはカテゴリー名が格納されているため、インデックスに「1」を指定して「テスト」が表示されています。

get_category()を使用した実際のケース

get_category()を使用した実際のケースについてご紹介します。

ここでは、下記の2ケースをご紹介します。

特定のカテゴリーページのみ追加情報を表示する

get_category()を使用することで、特定のカテゴリーページのみ追加情報を表示することができます。

例えば、get_category()で「テスト」のカテゴリーページである場合のみ、ページの概要を表示するようにします。

● category.php

<?php get_header(); ?>
<?php if ( have_posts() ) : ?>
	<header>
        <h2 class='h2-title'><span><?php echo single_cat_title(); ?></span></h2>
        <?php 
        $cat_id = get_query_var('cat');
        $category = get_category($cat_id, 'ARRAY_A');
        if ($category[name] == 'テスト'): ?>
          <p class=''>このページは弊社がテストを行った実績一覧を紹介しています。</p>
          <?php endif ;?>
	</header>
        <div class= 'flex'>	 
	<?php while ( have_posts() ) : ?>
		<?php the_post(); ?>
		<?php // 記事の出力処理 ?> 
	<?php endwhile; ?>
        </div>
<?php else : ?>
	<p>現在、記事はありません。</p>
<?php endif; ?>

<?php get_footer(); ?>

● style.css

.h2-title {
    text-align:center;
}
.explanation {
    width: 80%;
    margin: 0 auto;
    text-align: center;
    font-size: 1.25em;
}
.flex {
    display: flex;
    flex-wrap: wrap;
}
article {
    width: 42.5%;
    margin: 0 auto;
}

実行結果

get_category()でテストのIDと一致した場合に、カテゴリーページの概要を出力するようにしています。

そのため、テストのページ一覧に「弊社で行ったテストの実績一覧が表示されています。」という文章が表示されています。

カテゴリーによってコンテンツやレイアウトを変更する

get_category()で、カテゴリーによってコンテンツやレイアウトを変更することができます。

例えば、get_category()で「テスト」のカテゴリーページと「お知らせ」のカテゴリーページとで、それぞれ異なるレイアウトで表示します。

● category.php

<?php get_header(); ?>
<header>
<?php $cat_id = get_query_var('cat');
      $category = get_category($cat_id, 'ARRAY_A');
?>
</header>
<?php 
$category = get_category($cat_id, 'ARRAY_A');
if(($category[name]) == 'テスト'): 
?>
<div class='flex box-size'>
    <div class= 'post-flex'>
    <?php while ( have_posts() ) : ?>
         <?php the_post(); ?>
         <?php // 記事の出力処理 ?> 
    <?php endwhile; ?>
    </div>
    <aside class='sidebar'>
       <h2 class='entry-title mrgn-tp'>カテゴリー一覧</h2>
       <?php $categories = get_categories(); ?>
       <div>
          <ul>
          <?php foreach($categories as $category):
                  $categoryName = $category->name; ?>
             <li style="text-align: left;">
                <?php echo $categoryName; ?>
             </li>
          <?php endforeach; ?>
          </ul>	 
       </div>
    </aside>
</div>

<?php else: ?>
<div class= 'flex'>
    <?php while ( have_posts() ): ?>
       <?php the_post(); ?>
       <?php // 記事の出力処理 ?> 
    <?php endwhile; ?>
</div>
<?php endif; ?>
<?php get_footer(); ?>

● style.css

h2.entry-title {
    text-align: center;
    font-size: 1.75em;
}
.mrgn-tp{
	margin-top: 10px;
}
.flex {
    display: flex;
    flex-wrap: wrap;
}
.box-size {
    width: 85%;
    margin: 10% auto;
}
article {
    width: 42.5%;
    margin: 13px auto;
    border: 2px solid lightgrey;
    box-shadow: 10px 10px 15px -10px;
}
.post-flex {
    width: 75%;
    display:flex;
	flex-wrap:wrap;
}
.sidebar {
    width:24.5%;
	border:1px solid lightgray;
	box-shadow: 10px 10px 15px -10px;	
}

実行結果

get_category()でカテゴリーによってコンテンツやレイアウトを変更しています。

そのため、「テスト」のカテゴリーページと「お知らせ」のカテゴリーページを表示すると、それぞれレイアウトが変更されています。

WordPressでカテゴリー情報を取得する他の関数

get_category()でカテゴリーの情報を取得しましたが、他にもカテゴリー情報を取得できる関数は存在します。

そのため、ここではWordPressでカテゴリー情報を取得できる他の関数についてご紹介します。

get_categories()

全てのカテゴリー情報を取得するには、get_categories()を使用します。

get_categories()とは、WordPress上で登録されているカテゴリーの情報を全て取得することができるWordPressの関数になります。

カテゴリー情報を取得するため、こちらもオブジェクトでデータを返すようになります。

● index.php

<div class= 'cat-list'>
    <h1 class="entry-title">get_categories()で全てのカテゴリー情報を取得</h1>
    <?php $categories = get_categories(); ?>
    <div>
        <ol>
            <?php foreach($categories as $category):
                $categoryName = $category->name; ?>
                <li style="text-align: left;"><?php echo $categoryName; ?></li>
            <?php endforeach; ?>
        </ol>	 
    </div>
</div>

実行結果

get_categories()で全てのカテゴリー情報を取得しています。

今回はカテゴリー名だけを取得して表示したため、WordPress内に登録されている全てのカテゴリー名が表示されています。

get_the_category()

get_the_category()とは、投稿記事に付与されているカテゴリーの情報を取得する関数になります。

そのため、各投稿記事のページにて付与されているカテゴリー情報を取得したり、表示したりすることができます。

● index.php

<div class= 'cat-list'>
    <h1 class="entry-title">get_the_category()でカテゴリーの情報を取得</h1>
    <?php $category = get_the_category(141); ?>
    <?php $cat =  $category[0]; ?>
    <div class= "cat-info">
        <p><?php echo($cat->name); ?></p>
        <p><?php echo($cat->slug); ?></p>
    </div>
</div>

投稿一覧画面

実行結果

get_the_category()で投稿記事に付与したカテゴリーの情報を取得しています。

投稿記事ID「141」には「お知らせ」のカテゴリーが付与されているため、お知らせのカテゴリー情報が表示されています。

もし、get_the_category()について詳しく知りたい場合は下記の記事をご参考ください。

Sossyの助太刀ブログ

11月 01, 2024

【WordPress】get_the_category()でカテゴリー情報を取得！使い方を徹底解説！

https://sossy-blog.com/wordpress/13568/

まとめ

(この記事は2025年05月22日に投稿されました。)

WordPressで特定のカテゴリー内にある子カテゴリーをリンク付きで表示することでユーザーとって親切で、魅力的なページへと変身します。

例えば、ブログの記事数が多くなってきた時、関連性の高い子カテゴリーを整理して表示できれば、ユーザーはよりスムーズに目的の情報へとたどり着くことが可能になります。

つまり、ユーザーの満足度が高まり、クローラーが循環しやすくなるため、SEO対策としても有効です。

こちらの記事で紹介している方法は、コードを直接修正する方法にはなりますが、プラグインを使用して特定のカテゴリー内にある子カテゴリーをリンク付きで表示する方法についても補足として記載しています、

この記事を読めば、ユーザーが求める情報へ最短距離でアクセスできるようになり、サイト全体の価値を高めることができるでしょう。

今回はWordPressで特定のカテゴリー内の子カテゴリーをリンク付きで表示する方法について紹介していきます。

この記事はこんな方におすすめ

サイトのユーザビリティを高めたい場合

親子関係となっているカテゴリーをリンク付きで出力したい場合

特定のカテゴリー内の子カテゴリーをリンク付きで表示するメリット

WordPressで特定のカテゴリー内の子カテゴリーをリンク付きで表示すると、下記のようなメリットがあります。

それぞれのメリットについて解説します。

ユーザビリティーが向上する

まず、1つ目はユーザビリティーが向上することです。

子カテゴリーを表示することで、そのページに関連するカテゴリーページへと遷移できるため、目的のコンテンツへのスムーズな導線を引くことができます。

また、サイト全体の構造が分かりやすくなるため、サイト内の循環経路が完成し、回遊率の向上にも繋がります。

回遊率とは「ユーザーがサイト内の複数のページを閲覧する割合を示す指標」であり、回遊率が高いほどユーザーがサイト内のコンテンツに興味を持ち、積極的に探索しているということになります。

SEO対策になる

2つ目はSEO対策になるということです。

子カテゴリーを表示することで、サイトの内部リンクの強化に繋がるため、クローラーの巡回を促進することができます。

また、親子カテゴリーに属している記事はとても関連している内容が書かれているため、関連性の高いコンテンツ間の連携強化にもつながります。

特定のカテゴリー内の子カテゴリーをリンク付きで表示するには

特定のカテゴリー内の子カテゴリーをリンク付きで表示するには下記の2つの方法があります。

2つの方法についてそれぞれ解説していきます。

また、今回使用する親子カテゴリーは下記の画像のように「テスト」内に「テスト1」、「テスト2」、「テスト3」が含まれているとします。

カテゴリー一覧画面

get_categories()を使用する

まず、1つ目はget_categories()を使用する方法です。

get_categories()とはWordPres内で登録されている全てのカテゴリー情報を取得することができる関数になります。

そのため、get_categories()にパラメータを指定することで対象のカテゴリーと親子関係になっているか確認し、親子関係であるカテゴリー情報のみを取得することで、子カテゴリーをリンク付きで表示することが可能になります。

<?php get_header(); ?>
<body>
    <main id="main_content">
    <h1 class="entry-title">get_categories()で子カテゴリーのリンクを表示</h1>
    <!-- このコードを追記　START -->
     <?php
     $cat_id = get_query_var('cat');
     ?>
     <h2 class='h2-title'><span><?php echo single_cat_title(); ?></span>の一覧記事</h2>
     <?php 
     $args = array('orderby' => 'name','order' => 'ASC','hide_empty' => 1);
     $categories = get_categories($args); 
     ?>
     <div class="childCat_list">
       <ul>
     <?php
     foreach($categories as $category):
      if(($category->parent) == $cat_id):
      ?>
      <li>
        <a href="<?php echo get_category_link($category->term_id); ?>">
          <span><?php echo $category->name; ?></span> : 
          <span><?php echo $category->count; ?></span>件
        </a>
      </li>
      <?php endif; ?>
     <?php endforeach; ?>  
        </ul>
      </div>   
    <!-- このコードを追記　END -->
     .
     .
     .
    </main>
</body>
<?php get_footer(); ?>

● style.css

.h2-title {
　　　text-align:center;
}
.childCat_list > ul {
　　　text-align: center;
　　　padding: 0;
}
.childCat_list > ul > li {
　　　display:inline-block;
}

実行結果

上記のコードについて解説します。

そのため、get_categories()で特定のカテゴリー内にある子カテゴリーをリンク付きで表示されています。

また、カテゴリー名だけでなく、各カテゴリーの記事数も表示され、クリックすると各カテゴリーページへ遷移しています。

こちらは方法だと全てのカテゴリーに対して処理を行っています。
そのため、内部的な処理として使用する場合にはこちらの方法が有効かもです。

wp_list_categories()を使用する

2つ目の方法はwp_list_categories()を使用する方法です。

そもそも、wp_list_categories()とは、カテゴリーの一覧を生成し、HTMLのリスト形式で表示することができる関数になります。

そのため、wp_list_categories()にパラメータを指定して使用することで、特定のカテゴリー内にある子カテゴリーをリンク付きで表示することが可能になります。

● category.php

<?php get_header(); ?>
<body>
    <main id="main_content">
    <h1 class="entry-title">get_categories()で子カテゴリーのリンクを表示</h1>
    <!-- このコードを追記　START -->
     <?php
       $cat_id = get_query_var('cat');
      ?>
     <h2><span><?php echo single_cat_title(); ?></span>の一覧記事</h2>
     <?php
     $arg  = 'show_option_none=&echo=0&show_count=1&use_desc_for_title=0&depth=1&title_li=&child_of='.$cat_id;
     $childCat = wp_list_categories($arg);
     if (!empty($childCat)): ?>
     <div class="childCat_list">
        <ul><?php echo $childCat; ?></ul>
     </div>
     <?php endif; ?>   
    <!-- このコードを追記　END -->
     .
     .
     .
    </main>
</body>
<?php get_footer(); ?>

● style.css

.h2-title {
　　　text-align:center;
}
.childCat_list > ul {
　　　text-align: center;
　　　padding: 0;
}
.cat-item {
　　　display:inline-block;
}

実行結果

上記のコードについて解説します。

そのため、wp_list_categories()で特定のカテゴリー内にある子カテゴリーをリンク付きで表示しています。

こちらも、カテゴリー名だけでなく、各カテゴリーの記事数も表示されています。

こちらは方法はWordPressで登録しているカテゴリーの関係性を維持したままカテゴリーを表示しています。
そのため、サイドバーなど、手軽にカテゴリーリストをHTML出力したい場合に有効かもです。

WordPressで特定のカテゴリー内の子カテゴリーをリンク付きで表示する実際のケース

特定のカテゴリー内にある子カテゴリーをリンク付きで表示する実際のケースを紹介します。

ここでご紹介するのは、下記の2ケースのとなります。

また、今回使用する親子カテゴリーも下記の画像のようになります。

カテゴリー一覧画面

対象のカテゴリーページ一覧内に子カテゴリー名のボタンを表示する

子カテゴリーのリンク付き表示は対象のカテゴリーページ一覧内に子カテゴリー名のボタンを表示する場合に使用できます。

対象のカテゴリーページ一覧内に子カテゴリー名のボタンを表示することで、自分が見たい記事のカテゴリーへ移動するため、滞在時間やPV数を上げることが可能になります。

● category.php

<?php get_header(); ?>
<body>
    <main id="main_content">
     <?php
       $cat_id = get_query_var('cat');
      ?>
     <h2 class='h2-title'><span><?php echo single_cat_title(); ?></span>の一覧記事</h2>
     <?php 
     $args = array('orderby' => 'name','order' => 'ASC','hide_empty' => 1);
     $categories = get_categories($args); 
     ?>
     <div class="childCat_list">
       <ul>
        <?php
        foreach($categories as $category):
          if(($category->parent) == $cat_id):
        ?>
        <li>
          <a href="<?php echo get_category_link($category->term_id); ?>" class= "linkBtn">
            <span><?php echo $category->name; ?></span> : 
            <span><?php echo $category->count; ?></span>件
          </a>
        </li>
          <?php endif; ?>
        <?php endforeach; ?>  
      </ul>
    </div>   
     .
     .
     .
    </main>
</body>
<?php get_footer(); ?>

● style.css

.h2-title {
	text-align:center;
}
.childCat_list > ul {
	text-align: center;
	padding: 0;
}
.childCat_list > ul > li {
	display:inline-block;
}	
.linkBtn {
  background-color: #fff;
  border: double 6px #3cb371;
  color: #3cb371;
  border-radius: 10px;
  padding: 10px;
  text-decoration: none;
  font-size: 1em;
}
.linkBtn:hover {
  background-color: #3cb371;
  border: double 6px #fff;
  color: #fff;
}

実行結果

対象のカテゴリーページ一覧内に子カテゴリー名のボタンを表示しています。

そのため、子カテゴリー名のボタンをクリックすると、子カテゴリーページの一覧画面が表示されます。

サイドバーに対象記事と関連するカテゴリーの投稿記事を表示する

また、サイドバーに対象記事と関連するカテゴリーの投稿記事を表示する場合にも使用できます。

サイドバーに対象記事と関連するカテゴリーの投稿記事を表示することで、カテゴリー外の関連しそうな記事を続けて読んでくれる可能性があるため、滞在時間をあげることが可能になります。

● sidebar.php

<div id="sidebar1">
<aside>
    <div id="sidebar">
        <?php if (is_single): ?>
        <p class="block-head">関連カテゴリーの記事</p>
        <div class="block">
            <div class="block-group">
        <?php
            $the_cat = get_the_category();
            foreach ($the_cat as $category):
                $the_cat_id = $category->cat_ID;
                $the_cat_parent = $category->parent;
                if (!empty($the_cat_parent)):
                    $args = array('orderby' => 'name','order' => 'ASC','hide_empty' => 1,'exclude' => $the_cat_id);
                    $categories = get_categories($args);
                    foreach ($categories as $wpcategory):
                        if ($the_cat_parent == $wpcategory->parent): ?>
                <h2 class="side-block-head"><?php echo $wpcategory->name?></h2>
                <ul class="block-list">
                <?php $cat_posts = get_posts(array(
                    'post_type' => 'post', 
                    'category' => $wpcategory->cat_ID, 
                    'posts_per_page' => 3, 
                    'orderby' => 'date'
                ));
                global $post;
                if($cat_posts):
                    foreach($cat_posts as $post):
                        setup_postdata($post); ?>
                    <li>
                        <a href="<?php the_permalink() ?>"><?php the_post_thumbnail(); ?><span class="side-post-title"><?php the_title(); ?></span></a></li></a>
                    </li>
                    <?php endforeach; endif; 
                    wp_reset_postdata(); ?>
                </ul>
                <?php endif; endforeach; ?>
            <?php endif; endforeach; ?>
            </div>
        </div>
        <?php endif; ?>
    </div>
    <?php endif;?>
</aside>
</div>

● style.css

.side-head {	
	color: #ffffff;
    padding: 7px 13px;
    font-size: 1.2em;
    font-weight: bold;
    background: #6bb6ff;
    margin: 0;
    border-bottom: 2px solid #b3b8dc;
}
.block-group {
	box-sizing: border-box;
}
.sidebar .block-group h2 {
    margin-bottom: 0;
    padding: 7px 13px;
    font-size: 1.2em;
}
h2.side-block-head {
    margin: 0;
	color: #655d5d;
    background-color: #c8e4ff;
}
ul.block-list {
    margin: 0;
    background-color: #fff;
}
img.attachment-post-thumbnail.size-post-thumbnail.wp-post-image {
    width: 32%;
}
.block-list > li {
    border-bottom: 1.5px dashed #e5e0e0
}
.block-list .side-post-title {
	margin-left: 8px;
}

実行結果

サイドバーに対象記事と関連するカテゴリーの投稿記事を表示しています。

そのため、「テスト1」の投稿記事には関連するカテゴリーの一覧として「テスト2」と「テスト3」が、「テスト3」の投稿記事には「テスト1」と「テスト2」が関連するカテゴリーの一覧としてサイドバーに表示されています。

まとめ

(この記事は2024年12月15日に投稿されました。)

みなさんは海外でWordPressを使用したことがありますか？

海外からWordPressにアクセスする際、接続制限やセキュリティが気になることがあります。

そんな時、VPNを活用することで、海外からでも安全にWordPressの管理画面にアクセスし、作業を進めることが可能になります。

VPNとはVirtual Private Network(ヴァーチャル プライベート ネットワーク)といい、インターネットにアクセスする際に仮想の専用回線を利用する技術となります。

物理的な専用回線を使用せずにインターネットに接続するため、ウイルス感染など気にすることなく使用することができ、コストも抑えることが可能となります。

今回は、海外からWordPressにアクセスするのにVPNがおすすめである理由や実際の使い方、おすすめサービスなどを紹介します。

この記事はこんな方におすすめ

海外からでもWordPressを使用したい場合

不正アクセスを防ぎながらWordPressを使用したい場合

海外からWordPressにアクセスできる？

海外からWordPressにアクセスすることは可能なのかどうかというと可能です。

そもそも、WordPressとは、世界中で多くの人に選ばれている人気のCMSとなります。

CMSとは「Contents Management System」といい、Webサイトのコンテンツを管理・更新するためのシステムであり、利用することで初心者の方でも簡単にWebサイトを作成することが可能になります。

しかし、普段使用している国以外からアクセスしようとすると、ログインページが表示されなかったりエラーが発生したりすることがあります。

これには主に、サーバー側のセキュリティ設定が関係しています。

一部のウェブホスティングサービスやセキュリティプラグインは、不正アクセスを防ぐために国外からのアクセスを制限する機能を搭載しています。

Webサイトの保護が強化される一方、正当なユーザーであっても海外からのアクセスが制限されることがあります。

ただし、海外からのアクセス制限は、セキュリティ設定を変更したり、VPNなどのツールを使ったりすることで回避が可能です。

海外からWordPressへのアクセスが制限される理由

海外からWordPressへのアクセスが制限される主な理由は、サーバーセキュリティの観点からあります。

不正アクセスやハッキングは国際的に行われることが多いため、一部のサーバーやプラグインでは国外や特定の地域からのログイン試行を自動的にブロックする仕組みを導入しています。

特に、海外のIPアドレスを制限する設定は、管理者アカウントの乗っ取りを防ぐセキュリティ対策として有効です。

ただし、その反面、正当な管理者が海外からアクセスする場合も同様に制限されてしまうため、海外から作業をすることが多い人の場合、不便を感じることもあるでしょう。

海外からWordPressにアクセスする2つの方法

それでは海外からWordPressにアクセスするにはどうすれば良いのでしょうか？

海外からWordPressにアクセスする方法は、主に2つあります。

それぞれの方法についてご紹介していきます。

海外アクセス制限をオフにする

まず1つ目は、海外アクセス制限をオフにすることです。

海外からWordPressにアクセスする方法の1つ目は、レンタルサーバーのセキュリティ設定を変更し、海外IPアドレスからのアクセス制限を解除する方法です。

サーバーの設定画面で海外からのアクセス制限をオフにすることで、海外からでも日本と同じようにアクセスできるようになります。

しかし、アクセス制限を解除することには、一定のセキュリティリスクが伴います。

不正アクセスやハッキングのリスクが高まり、サイトの安全性が損なわれる可能性があるため、あくまで一時的な対処法として行うといいでしょう。

継続的に海外からWordPressにアクセスしたい場合は、より安全な方法としてVPNの使用がおすすめです。

VPNを使用する

そして2つ目は、VPNを使用することです。

VPNを使用することで、レンタルサーバーの海外アクセス制限を変更することなく、海外からWordPressにアクセスすることができます。

先ほども言いましたが、VPNとはインターネット上のセキュリティとプライバシーを強化する技術となります。

VPNを使って日本にあるサーバーに接続してユーザーのIPアドレスを隠し、あたかも日本国内からアクセスしているように見せかけることで、海外アクセス制限を回避することができます。

この方法の大きなメリットは、安全性が高いことです。

海外からのアクセス制限を解除する必要がないため、不正アクセスのリスクを増加させることなく、どの国からでも必要な作業をスムーズに行えます。

さらに、VPNは通信データの暗号化機能を備えており、ログイン情報や作業内容を第三者に盗まれる心配もありません。

海外から安全にWordPressにアクセスしたいなら、VPNの活用が最適です。

VPNを使って海外からWordPressにアクセスする方法

こちらではVPNを使って海外からWordPressにアクセスする方法についてご紹介します。

VPNを使って海外からWordPressにアクセスするのは簡単で、一般的に以下の4ステップで行えます。

ここでは例として、NordVPNを使ったWordPressへのアクセス方法を手順ごとに詳しく解説します。

出典: NordVPN

NordVPNとは、サイバーセキュリティ企業Nord Securityが提供している個人向けの仮想プライベートネットワーク (VPN) サービスとなります。

VPNサービスに登録する

まず、VPNサービスに登録します。

VPNサービスは有料と無料版があるのですが、無料VPNはセキュリティリスクが高いため避け、セキュリティが高く、接続が安定しているプロバイダーを選ぶことが大切です。

NordVPNを利用する場合は、公式サイトにアクセスして購入ページに進みます。

NordVPNでは、利用できるデバイスの台数やセキュリティ機能などが異なる幅広いプランから選べます。

自分に合ったプランを選び、購入しましょう。

VPN専用アプリをインストールしログインする

VPNサービスへの登録が完了しましたら、WordPressにアクセスしたいお手持ちの端末にVPN専用アプリをインストールしログインします。

NordVPNの場合は公式サイトのメニューに[VPNをダウンロード]がありますので、クリックし自分の対応しているデバイスを選択してインストールします。

出典: NordVPN

アプリをインストールしたら、IDとパスワードを入力してログインするだけで設定は完了です。

インストール後、右上の[ログイン/登録]をクリックし、登録した際のIDとパスワードを入力します。

アプリを使って簡単にVPNを設定できるので、初心者の方でも簡単に設定することができます。

日本国内のサーバーに接続する

VPN専用アプリをインストールし、ログインできましたら日本国内のサーバーに接続します。

NordVPNアプリではVPNサーバーの接続先一覧が表示されるので、「Japan（日本）」を選択します。

「クイック接続」でもVPNサーバーに接続できますが、今回は日本のVPNサーバーにアクセスしたいので、必ず日本を選びましょう。

「Japanに接続済み」と表示されたら完了です。

接続が完了すると、接続先の日本のVPNサーバーのIPアドレスが表示されます。

設定方法がとても簡単ですね！

WordPressの管理画面にログインする

VPN接続が完了したら、通常通りWordPressの管理画面にログインしましょう。

VPNを接続した状態で、今まで使用していたWordPressにログインします。

日本のVPNサーバーに接続されているので、まるで日本に居るかのようにWordPressにアクセスすることができます。

VPNを使う際の注意点

VPNサービスへの登録が完了したところですが、VPNを使ってWordPressにアクセスする際の注意点が2つあります。

それぞれの注意点について解説していきます。

接続が不安定になることがある

まず、1つ目は接続が不安定になることがあるということです。

VPNはインターネット接続を暗号化し、VPNサーバーを経由してアクセスする仕組みのため、接続が不安定になることがあります。

特に、海外から日本のサーバーに接続する際は、物理的な距離が遠いため、通信速度が低下したり遅延が発生したりすることもあります。

また、一部のウェブサイトやアプリケーションではVPN接続をブロックし、アクセスや機能が制限される可能性もあります。

これらの問題を最小限に抑えるには、接続速度や安定性に定評のあるVPNサービスを選ぶことが大切です。

コストがかかる

そして、2つ目はコストがかかるということです。

VPNの利用には、一定のコストが発生します。

中には、無料VPNもありますが、セキュリティや通信速度の面でリスクが伴うため、一般的には有料の信頼性の高いVPNサービスを選ぶことが推奨されます。

有料のVPNサービスの料金は、月額数百円から数千円と幅がありますが、長期プランを選ぶことでコストを抑えられることが多いです。

特に、海外からのWordPress管理にVPNを利用する場合、セキュリティが脆弱なサービスではサイバー攻撃のリスクが高まるため、十分な機能を備えたVPNを選ぶ必要があります。

コストを負担する価値があるかを判断し、用途や予算に最適なサービスを選択しましょう。

実際に「NordVPN」を使ってWordPressにアクセスしてみた

実際に「NordVPN」を使用してWordPressにアクセスしてみました。

ユーザーの登録からWordPressを使用するところまでの流れがとても簡単で、かかった時間は約5分くらいでした。

登録の操作もわかりやすく、次になにをすればよいかが明確になっているため、初心者の方でも簡単に使用できるかと感じました。

そして、WordPressを使用した時の所感ですが、VPNの接続中は違和感を感じることなく、普段使用しているWordPressと同様な感じがしました。

また、海外滞在中にNordVPNを使って日本のサーバーに接続し、WordPressでの作業を行ったところ、日本に居るときと同じように作業ができました。

接続速度も安定しており、ストレスを感じることもありませんでした。

僕も普段不正アクセスが多いことにストレスを感じていたため、いつも使用しているWordPressにプラスで不正アクセスを防ぐことができるのはとても利便性がよく、今後導入してみるのもありかと思います。

海外からWordPressを使うならNordVPNがおすすめ

海外からWordPressを安全かつスムーズに利用したいなら、NordVPNがおすすめです。

上でも少しご紹介しましたが、NordVPNとは、サイバーセキュリティ企業Nord Securityが提供している個人向けの仮想プライベートネットワーク (VPN) サービスとなります。

世界111カ国に6,700台以上のサーバーを展開し、広範囲で安定した接続を提供しています。

そして、日本国内にも130台以上のサーバーを保持しているため、海外から日本国内のサービスやWordPressの管理画面へ簡単にアクセスできます。

また、NordVPNは、ノーログポリシーを採用し、セキュリティ面で高い評価を受けています。

高速通信技術により、WordPressの管理や編集作業もストレスなく行うことが可能です。

さらに、NordVPNによる「IPアドレスの検索機能」を利用することで、自分が正しいサーバーに接続できているかを簡単に確認できます。

海外滞在中の作業効率と安全性を向上させるべく、ぜひNordVPNの活用をおすすめします！

まとめ

この記事では、海外からWordPressにアクセスする際に役立つVPNの使い方やおすすめサービスなどについて紹介しました。

VPNを使えば、海外からでも安全かつスムーズにWordPressを管理できます。

特に、信頼性の高いVPNサービスを選ぶことで、セキュリティと通信速度の両方を確保できる点は大きなメリットです。

海外滞在中で快適なサイト運営を続けたい方、不正アクセスが多くて悩んでいる方、ぜひVPNの導入を検討してみてください。

(この記事は2024年11月01日に投稿されました。)

WordPressでカテゴリー情報を取得するにget_the_category()を使用します。

get_the_category()とは投稿記事に付与したカテゴリーの情報を取得するWordPressの関数となります。

パラメータに投稿記事のIDを指定することで、指定した記事に登録されているカテゴリーの情報を取得します。

そして、get_the_category()はWP_Term()のオブジェクトを返すため、カテゴリーの名前やスラッグなど必要なデータのみを取得することができます。

また、こちらの関数はカテゴリー情報を取得するのみになりますので、画面に出力したい場合はecho関数を使用しましょう。

今回はWordPressのget_the_category()でカテゴリー情報を取得する方法について紹介していきます。

この記事はこんな方におすすめ

投稿記事に付与したカテゴリーの情報を取得したい場合

カテゴリー情報を条件分岐として使用したい場合

get_the_category()とは

get_the_category()とは、投稿記事に付与されているカテゴリーの情報を取得するWordPressの関数になります。

投稿記事を公開した際に、カテゴリー枠にチェックを入れたカテゴリーの情報を取得することができるようになります。

get_the_category()の書き方

get_the_category()の書き方は下記のようになります。

get_the_category(['投稿記事ID'])

get_the_category()と記載し、括弧の中に任意な引数を1つ指定することで使用できます。

get_the_category()のパラメータ

get_the_category()のパラメータは下記のようになります。

get_the_category()を記載し、括弧の中に任意の引数として、「投稿記事ID」を指定します。

get_the_category()の戻り値

get_the_category()の戻り値は「WP_Tearmオブジェクト」であり、カテゴリー情報（オブジェクト）を配列に格納して返すようになります。

get_the_category()の呼び出し元

get_the_category()の呼び出し元は「post-templete.php」となります。

function get_the_category( $post_id = false ) {
	$categories = get_the_terms( $post_id, 'category' );
	if ( ! $categories || is_wp_error( $categories ) ) {
		$categories = array();
	}

	$categories = array_values( $categories );

	foreach ( array_keys( $categories ) as $key ) {
		_make_cat_compat( $categories[ $key ] );
	}

	/**
	 * Filters the array of categories to return for a post.
	 *
	 * @since 3.1.0
	 * @since 4.4.0 Added the `$post_id` parameter.
	 *
	 * @param WP_Term[] $categories An array of categories to return for the post.
	 * @param int|false $post_id    The post ID.
	 */
	return apply_filters( 'get_the_categories', $categories, $post_id );
}

get_the_category()は、get_the_terms()を呼び出しており、指定した投稿記事IDのカテゴリー情報を返しています。

get_the_category()でカテゴリー情報を取得するサンプルコード

get_the_category()でカテゴリー情報を取得するサンプルコードを紹介します。

ここでは、下記の2ケースでget_the_category()を使用します。

存在する投稿記事IDを指定する場合

存在する投稿記事IDを指定する場合にget_the_category()を使用すると、指定した投稿記事に付与されているカテゴリーの情報を取得します。

試しに、下記の画像である投稿記事IDが「141」の記事に付与されたカテゴリー情報を取得します。

投稿記事一覧画面

カテゴリー一覧画面

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_the_category()でカテゴリーの情報を取得</h1>
  <?php $category = get_the_category(141); ?>
  <?php $cat =  $category[0]; ?>
  <div class= "cat-info">
    <p><?php print_r($cat); ?></p>
  </div>
</div>

実行結果

get_the_category()で指定した投稿記事に付与されているカテゴリーの情報を取得しています。

「141」の投稿記事には「お知らせ」というカテゴリーが付与されていたため、「お知らせ」のカテゴリー情報がオブジェクトとして表示されています。

存在しない投稿記事IDを指定する場合

存在しない投稿記事IDを指定する場合にget_the_category()を使用すると、カテゴリー情報を取得しません。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_the_category()でカテゴリーの情報を取得</h1>
  <?php $category = get_the_category(9999); ?>
  <?php $cat =  $category[0]; ?>
  <div class= "cat-info">
    <p><?php print_r($cat); ?></p>
  </div> 
</div>

実行結果

get_the_category()で指定した投稿記事に付与されているカテゴリーの情報を取得しています。

「9999」を指定していますが、「9999」を持つ投稿記事が存在しないため、カテゴリー情報を取得することができず「array(」のみが表示されています。

投稿記事IDを指定しないでget_the_category()を使用する場合

投稿記事IDを指定しない場合にget_the_category()を使用すると、最新の投稿記事に付与されているカテゴリー情報を取得します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_the_category()でカテゴリーの情報を取得</h1>
  <?php $category = get_the_category(); ?>
  <?php $cat =  $category[0]; ?>
  <div class= "cat-info">
    <p><?php print_r($cat); ?></p>
  </div> 
</div>

投稿記事一覧画面

実行結果

get_the_category()で指定した投稿記事に付与されているカテゴリーの情報を取得しています。

投稿記事IDを指定していないため、一番最新の投稿記事に付与されている「」のカテゴリー情報が表示されています。

get_the_category()でカテゴリー情報を別々で取得する場合

get_the_category()でカテゴリー情報を別々で取得する場合は、取得したデータに対して、アロー演算子を使用します。

アロー演算子とは、オブジェクトの中身にアクセスするための演算子であリ、オブジェクトが持つプロパティやメソッドを呼び出すことができます。

そのため、取得したオブジェクトに対してアロー演算子を使用すると、取得したカテゴリー情報を別々で取得することが可能になります。

ここでは下記の6ケースでget_the_category()を使用し、カテゴリーの情報を別々で取得します。

カテゴリーの名前を取得する場合

カテゴリーの名前を取得する場合は、get_category()で取得したオブジェクトに対して、「name」もしくは「cat_name」というプロパティを指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_the_category()でカテゴリーの名前を取得</h1>
  <?php $category = get_the_category(141); ?>
  <?php $cat =  $category[0]; ?>
  <div class= "cat-info">
    <p>name: <?php echo $cat->name; ?></p>
    <p>cat_name: <?php echo $cat->cat_name; ?></p>
  </div> 
</div>

実行結果

get_the_category()でカテゴリーの名前を取得しています。

そのため、カテゴリーの名前である「お知らせ」が表示されています。

カテゴリーのIDを取得する場合

カテゴリーのIDを取得する場合は、get_category()で取得したオブジェクトに対して、「term_id」もしくは「cat_ID」というプロパティを指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_the_category()でカテゴリーのIDを取得</h1>
  <?php $category = get_the_category(141); ?>
  <?php $cat =  $category[0]; ?>
  <div class= "cat-info">
    <p>term_id: <?php echo $cat->term_id; ?></p>
    <p>cat_ID: <?php echo $cat->cat_ID; ?></p>
  </div> 
</div>

実行結果

get_the_category()でカテゴリーのIDを取得しています。

そのため、「お知らせ」カテゴリーのIDである「8」が表示されています。

カテゴリーのスラッグ名を取得する場合

カテゴリー名を取得する場合は、get_category()で取得したオブジェクトに対して、「slug」もしくは「category_nicename」というプロパティを指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_the_category()でカテゴリーのスラッグ名を取得</h1>
  <?php $category = get_the_category(141); ?>
  <?php $cat =  $category[0]; ?>
  <div class= "cat-info">
    <p>slug: <?php echo $cat->slug; ?></p>
    <p>category_nicename: <?php echo $cat->category_nicename; ?></p>
  </div> 
</div>

実行結果

get_the_category()でカテゴリーのスラッグを取得しています。

そのため、「お知らせ」カテゴリーのスラッグである「news」が表示されています。

カテゴリーの説明を取得する場合

カテゴリーの説明を取得する場合は、get_category()で取得したオブジェクトに対して、「description」もしくは「category_description」というプロパティを指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_the_category()でカテゴリーの説明を取得</h1>
  <?php $category = get_the_category(141); ?>
  <?php $cat =  $category[0]; ?>
  <div class= "cat-info">
    <p>description: <?php echo $cat->description; ?></p>
    <p>category_description: <?php echo $cat->category_description; ?></p>
  </div> 
</div>

実行結果

カテゴリーの投稿数を取得する場合

カテゴリー名を取得する場合は、get_category()で取得したオブジェクトに対して、「count」もしくは「category_count」というプロパティを指定します。

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_the_category()でカテゴリーの投稿数を取得</h1>
  <?php $category = get_the_category(141); ?>
  <?php $cat =  $category[0]; ?>
  <div class= "cat-info">
    <p>count: <?php echo $cat->count; ?></p>
    <p>category_count: <?php echo $cat->category_count; ?></p>
  </div> 
</div>

実行結果

get_the_category()でカテゴリーの投稿数を取得しています。

そのため、「お知らせ」のカテゴリーの投稿数である「6」が表示されています。

親カテゴリーのIDを取得する場合

親カテゴリーのIDを取得する場合は、get_category()で取得したオブジェクトに対して、「parent」もしくは「category_parent」というプロパティを指定します。

ここでは下記2つの投稿記事に付与されているカテゴリー情報を取得します

投稿記事一覧画面

カテゴリー一覧画面

● index.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_the_category()で親カテゴリーのIDを取得</h1>
  <?php $category = get_the_category(141); ?>
  <?php $cat =  $category[0]; ?>
  <div class= "cat-info">
    <p>parent: <?php echo $cat->parent; ?></p>
    <p>category_parent: <?php echo $cat->category_parent; ?></p>
  </div>
  <?php $category = get_the_category(); ?>
  <?php $cat =  $category[0]; ?>
  <div class= "cat-info">
    <p>parent: <?php echo $cat->parent; ?></p>
    <p>category_parent: <?php echo $cat->category_parent; ?></p>
  </div>
</div>

実行結果

get_the_category()で親カテゴリーIDを取得しています。

「お知らせ」カテゴリーは親がいないため、「0」が表示されています。

また、「テスト1」カテゴリーは親が存在するため、親カテゴリー「テスト」のIDである「8」が表示されています。

get_the_category()で複数のカテゴリー情報を取得する場合

先ほどまでは、引数に1つのカテゴリー情報を取得していましたが、2つ以上のカテゴリー情報をまとめて取得することもできます。

get_the_category()で複数のカテゴリー情報を取得するにはforeach()を使用します。

foreach()とは、指定した配列のそれぞれの要素に対して処理を行う文法になります。

今回、カテゴリー情報はオブジェクトで取得するため、forEach()を使用することで記事に紐づいている複数のカテゴリー情報を取得することが可能になります。

もし、foreach()について詳しく知りたい場合は下記の記事をご参考ください。

Sossyの助太刀ブログ

9月 18, 2022

【PHP】foreach文で配列や連想配列の要素数に合わせて繰り返し処理を行う！

"https://sossy-blog.com/useful/4951

● single.php

<div class= 'cat-list'>
  <h1 class="entry-title">get_the_category()で複数のカテゴリー情報を取得</h1>
  <div class= "cat-info">
  <?php 
   $categories = get_the_category(141);
   foreach ( $categories as $category ) {
	echo '<p>';
    print_r($category);
	echo '</p>';
   }
  ?>
  </div>
  <div class= "cat_info">
  <?php
   $categories = get_the_category(141);
   foreach ( $categories as $category ) {
    $cat_name = $category->name;
    $cat_slug = $category->slug;
    echo '<p>'.$name.$cat_name.'</p>';
    echo '<p>'.$slug.$cat_slug.'</p>';
   }
  ?>
  </div>
</div>

投稿一覧画面

実行結果

get_the_category()で複数のカテゴリー情報を取得しています。

今回は「お知らせ」と「テスト」のカテゴリーが付与されているため、それぞれのカテゴリー情報が表示されています。

また、それぞれのカテゴリー情報から「カテゴリー名」と「スラッグ」を取得して表示されています。

get_the_category()を使用した実際のケース

get_the_category()を使用した実際のケースについてご紹介します。

投稿記事と同じカテゴリーの記事を表示する

get_the_category()を使用することで、カテゴ投稿記事と同じカテゴリーの記事を表示することができます。

例えば、表示している投稿記事内に関連記事の枠を設け、その枠に同じカテゴリーに属している投稿記事を関連記事として表示することができます。

するとサイト内での循環がよくなり、サイト内の投稿記事をみたユーザがほかの記事を見てくれるようになります。

● single.php

<article>
    <header>
       <h1 style='font-size:32px;'><?php the_title(); ?></h1>
    </header>	
    <div>
       <?php the_content(); ?>
    </div>

    <h2 style='text-align:center;'>関連記事</h2>
    <div class='related-list'>
      <?php 
        $post_id = get_the_ID();
        $post_cat = get_the_category();
        $post_slug = $post_cat[0]->slug;
      ?>
      <?php
        $args = array(
          'post_type'      => 'post', // 投稿タイプ
          'posts_per_page' => 9, // 表示件数
          'post__not_in'   => array($post_id), // 自分記事
          'category_name'  => $post_slug
        );

        $wp_query = new WP_Query( $args );
　　　   $the_query = new WP_Query($args);
        if($the_query->have_posts()):
        while($the_query->have_posts()): $the_query->the_post();
      ?>
        <div class="related-post">
           <h3><?php the_title(); ?></h3>
            <div class="post-thumb">
               <?php the_post_thumbnail(); ?>
            </div>
        </div>
      <?php
        endwhile;
        endif;
      ?>
    </div>
</article>

● style.css

.related-list {
    display: flex;
    flex-wrap: wrap;
    margin: 0 auto;
    width: 60%;
    margin: 0 auto;
}
.related-post {
    width: 32%;
    border: 2px solid black;
    margin-top: 8px;
    margin-right: 2%;
    list-style:none;
}
.related-post > a {
    text-decoration:none;
}
.related-post:nth-child(3n) {
    margin-right: 0;
}
.post-thumb {
    width: 100%;
    height: 100%;
}
.post-title {
    margin: 16px;
}

投稿一覧画面

実行結果

get_the_category()で投稿記事と同じカテゴリーの記事を表示しています。

WP_Query()オブジェクトで同じカテゴリに属している自分以外の投稿記事を10件取得するようにしています。

そのため、それぞれの記事を表示すると同じカテゴリに属している投稿記事が関連記事として表示されています。

付与しているカテゴリーで表示する内容を変える

get_the_category()を使用することで、付与しているカテゴリーで表示する内容を変えることができます。

例えば、get_the_category()で「お知らせ」のカテゴリーを付与している記事と「紹介」のカテゴリーを付与している記事とで、それぞれ異なるキャッチ文を表示します。

● index.html

<article>
    <header>
    <?php 
      $post_cat = get_the_category();
      $post_slug = $post_cat[0]->slug;
    ?>
    
    <?php 
      $content1 = '';
      $content2 = ''; 
      switch ($post_slug) {
        case 'news':
          $content1 = '2024年12月9日に新しいエリアがオープン！';
          $content2 = '詳しい情報はこちらから！';
          break
        case 'intro':
          $content1 = '岩盤浴エリアでは9つのエリアが遊び放題！';
          $content2 = 'フードコートもあり、子供も大人も一日中楽しめます！';
          break
        }
    ?>

    <?php
      if ($content1 != '' || $content2 != '') {
        $html1 =  "<div class= 'new-title'><p>".$content1.'</p>';
        $html2 = '<p>'.$content2.'</p></div>';
        echo $html1.$html2;
       }
    ?>
       <?php the_post_thumbnail('medium'); ?>
       <?php the_title('<h1>', '</h1>'); ?>
    </header>

    <div>
       <?php the_content(); ?>
    </div>

    <footer></footer>
</article>

● style.css

.new-title {
	text-align:center;
	font-size:20px;
	font-weight:bold;
}

投稿一覧画面

実行結果

get_the_category()で取得したデータからスラッグ名を取得し、スラッグ名を条件として該当する記事には投稿内容の前に固定の文字列を出力するようにしています。

そのため、「お知らせ」のカテゴリーに属している記事と「紹介」のカテゴリーに属している記事にはそれぞれ別の文章が表示されています。

全てのカテゴリー情報を取得する場合

全てのカテゴリー情報を取得するには、get_categories()を使用します。

get_categories()とは、WordPress上で登録されているカテゴリーの情報を全て取得することができるWordPressの関数になります。

カテゴリー情報を取得するため、こちらのWP_Term()のオブジェクトを返すようになります。

● index.html

<div class= 'cat-list'>
  <h1 class="entry-title">get_categories()で全てのカテゴリー情報を取得</h1>
  <?php $categories = get_categories(); ?>
  <div>
　　　<ol>
　　　<?php 
	foreach( $categories as $category ) {
　　　　　　$category = $category->name; 
　　　　　　echo '<li style="text-align: left;">'.$category.'</li>';
	}
　　　　?>
　　　</ol>	 
  </div>
</div>

実行結果

get_categories()で全てのカテゴリー情報を取得しています。

今回はカテゴリー名だけを表示したため、WordPress内に登録されている全てのカテゴリー名が表示されています。

カテゴリーをHTML要素として表示する場合

カテゴリーをHTML要素として表示するには、the_category()を使用します。

the_category()とは、投稿記事に付与されているカテゴリー名をHTMLタグ付きで表示することができるWordPressの関数になります。

リンク付きで表示することができるため、それぞれの記事にカテゴリー名を表示したり、カテゴリーページと繋げたりしたい場合に使用できます。

● index.html

ndex.html
<article>
    <header>
       <h1 style='font-size:32px;'>the_category()でカテゴリーをHTML要素として表示</h1>
    　　<div>
　　　　　　<?php the_post_thumbnail('thumbnail'); ?>
　　　　　　<?php the_title('<h3>', '</h3>') ?>
   　　 </div>　　
    </header> 
    <div>
       <?php the_content(); ?>
    </div>
    <div>
       <?php the_category(); ?>
    </div>
</article>

実行結果

the_category()でカテゴリーをHTML要素として表示しています。

そのため、それぞれの投稿記事に付与されているカテゴリーがリンク付きで表示されています。

まとめ

(この記事は2024年10月03日に投稿されました。)

WordPressでページのタイトルを取得するにはget_the_title()を使用します。

get_the_title()とは指定したページのタイトルを取得するWordPressの関数となります。

パラメータに記事のIDを指定することで、指定した投稿ページのタイトル枠に入力された文字列を取得することができます。

あくまで、タイトルの文字列を取得するだけになりますので、もし取得したタイトルをページ上に出力したい場合はecho関数などで出力するようにしてください。

また、こちらの関数を使用することで、サイトのTOPページ上投稿記事の一覧を表示することができたり、ジャンル別で表示したりしてとても便利ですのでもし、ページのタイトルを取得したい場合は使用しましょう。

今回はWordPressのget_the_title()でページのタイトルを取得する方法について紹介していきます。

この記事はこんな方におすすめ

指定した投稿記事のタイトルを取得する場合

投稿記事のタイトルを一覧で取得する場合

get_the_title()とは

get_the_title()とは、指定したページのタイトルを取得するWordPressの関数になります。

投稿ページ編集画面に表示されているタイトル枠に入力した文字列を取得するようになります。

get_the_title()の書き方

get_the_title()の書き方は下記のようになります。

● index.php

get_the_title('記事のID')

get_the_title()と記載し、括弧の中に必須な引数を1つ指定することで使用できます。

get_the_title()のパラメータ

get_the_title()のパラメータは下記のようになります。

get_the_title()は、必須な引数として「記事のID」を指定します。

get_the_title()の戻り値

get_the_title()の戻り値は投稿のタイトルの文字列となります。

get_the_title()の呼び出し元

get_the_title()の呼び出し元は、post-template.phpになります。

function get_the_title( $post = 0 ) {
	$post = get_post( $post );
	$post_title = isset( $post->post_title ) ? $post->post_title : '';
	$post_id    = isset( $post->ID ) ? $post->ID : 0;

	if ( ! is_admin() ) {
		if ( ! empty( $post->post_password ) ) {
			$prepend = __( 'Protected: %s' );
			$protected_title_format = apply_filters( 'protected_title_format', $prepend, $post );
			$post_title = sprintf( $protected_title_format, $post_title );

		} elseif ( isset( $post->post_status ) && 'private' === $post->post_status ) {
			$prepend = __( 'Private: %s' );
			$private_title_format = apply_filters( 'private_title_format', $prepend, $post );
			$post_title = sprintf( $private_title_format, $post_title );
		}
	}
	return apply_filters( 'the_title', $post_title, $post_id );
}

記事から記事のタイトルを取得し、管理画面を表示していないならば、そのままタイトルを取得します。

また、管理画面の場合は条件によって「パスワード保護のタイトル」か「非公開のタイトル」を取得するようになります。

get_the_title()でページのタイトルを取得するサンプルコード

get_the_title()で記事のタイトルを取得するサンプルコードをご紹介します。

ここでは下記の2パータンでget_the_title()を使用します。

記事のIDが存在するIDである場合

記事IDが存在するIDである場合にget_the_title()を使用すると、記事で設定したタイトルの文字列を取得します。

● single.php

<article>
    <header>
       <h1 style='font-size:32px;'>get_the_title()でページのタイトルを取得</h1>
       <?php $title = get_the_title(82) ?>
       <h3><?php echo $title ?></h3>
    </header>	
    <div>
       <?php the_content(); ?>
    </div>
</article>

実行結果

記事のIDが存在するIDである場合にget_the_title()でページのタイトルを取得しています。

今回は「82」の記事IDを指定したため、「記事で登録したタイトルを表示！」が表示されています。

記事のIDが存在しないIDである場合

記事IDが存在しないIDである場合にget_the_title()を使用すると、ページのタイトルが取得できず、「名称未設定」という文字列を取得します。

● single.php

<article>
    <header>
       <h1 style='font-size:32px;'>get_the_title()でページのタイトルを取得</h1>
       <?php $title = get_the_title(999) ?>
       <h3><?php echo $title ?></h3>
    </header>	
    <div>
       <?php the_content(); ?>
    </div>
</article>

実行結果

記事のIDが存在しないIDである場合にget_the_title()でページのタイトルを取得しています。

存在しないIDの投稿ページを指定したため、「名称未設定」が表示されています。

get_the_title()で公開状態の異なるページのタイトルを取得する場合

get_the_title()で公開状態の異なるページのタイトルを取得すると、管理画面では取得したタイトルの先頭に特定の文字列がつくようになります。

そのため、ここでは下記の3パータンでget_the_title()を使用します。

投稿ページが公開状態ある場合

投稿ページが公開である場合にget_the_title()を使用すると、記事で設定したタイトルの文字列をそのまま取得します。

● single.php

<article>
    <header>
       <h1 style='font-size:32px;'>get_the_title()でページのタイトルを取得</h1>
       <?php $title = get_the_title(82) ?>
       <h3><?php echo $title ?></h3>
    </header>	
    <div>
       <?php the_content(); ?>
    </div>
</article>

投稿画面

実行結果

投稿ページが公開状態である場合にget_the_title()でページのタイトルを取得しています。

そのため、「記事で登録したタイトルを表示！」が表示されています。

投稿ページがパスワード保護状態である場合

投稿ページがパスワード保護状態である場合にget_the_title()を使用すると、記事で設定したタイトルの前に「保護中:」の文字列を取得します。

● single.php

<article>
    <header>
       <h1 style='font-size:32px;'>get_the_title()でページのタイトルを取得</h1>
       <?php $title = get_the_title(82) ?>
       <h3><?php echo $title ?></h3>
    </header>	
    <div>
       <?php the_content(); ?>
    </div>
</article>

投稿画面

実行結果

投稿ページがパスワード保護状態である場合にget_the_title()でページのタイトルを取得しています。

そのため、「保護中：記事で登録したタイトルを表示！」が表示されています。

投稿ページが非公開状態である場合

投稿ページが非公開状態である場合にget_the_title()を使用すると、記事で設定したタイトル前に「非公開:」の文字列を取得します。

● single.php

<article>
    <header>
       <h1 style='font-size:32px;'>get_the_title()でページのタイトルを取得</h1>
       <?php $title = get_the_title(82) ?>
       <h3><?php echo $title ?></h3>
    </header>	
    <div>
       <?php the_content(); ?>
    </div>
</article>

投稿画面

実行結果

投稿ページが非公開状態である場合にget_the_title()でページのタイトルを取得しています。

そのため、「非公開：記事で登録したタイトルを表示！」が表示されています。

get_the_title()で現在のページのタイトルを動的に取得する場合

get_the_title()で現在のページのタイトルを動的に取得するには、引数にget_the_ID()を指定します。

get_the_ID()とは、現在開いているページのIDを取得することができるWordPressの関数になります。

つまり、get_the_ID()で取得したIDをget_the_title()のパラメータに指定することで、現在表示しているページのタイトルを取得することが可能になります。

● index.html

<article>
    <header>
       <h1 style='font-size:32px;'>get_the_title()でページのタイトルを取得</h1>
       <?php 
        $post = get_the_ID();
        $title = get_the_title($post); 
       ?>
       <h3><?php echo $title ?></h3>
    </header>	
    <div>
       <?php the_content(); ?>
    </div>
</article>

投稿画面

実行結果

get_the_title()で現在のページのタイトルを動的に取得しています。

そのため、表示されている投稿記事のタイトルが表示されています。

get_the_titile()でページのタイトルを一括で取得する場合

get_the_title()でページのタイトルを一括で取得するには繰り返し処理とthe_post()を組み合わせて使用します。

the_post()とは、取得した投稿記事をループで順番に表示するためのWordPressの関数になります。

そのため、the_post()で登録されている投稿記事のIDを順番に取得し、get_the_title()のパラメータに指定することで投稿ページのタイトルを一括で取得するとができます。

● index.php

<article>
    <header>
       <h1 class='entry-title'>get_the_title()でページのタイトルを一括で取得</h1>
       <div class= 'title-lists'>
       <?php 
       if(have_posts()) :
         while(have_posts()) : the_post();
            $postId = get_the_id(); 
            echo '<p>'.get_the_title($postId).'</p>';
         endwhile; ?>
      <?php else: ?>
      <?php endif; ?>
      </div>
    </header>	
    <div>
       <?php the_content(); ?>
    </div>
</article>

● style.css

.title-lists {
    border: 2px solid;
    text-align: center;
    width: 80%;
    margin: 0 auto;
    font-size: 24px;
}
.entry-title {
    font-size:32px; 
    text-align:center;
}

投稿画面

実行結果

get_the_titile()でページのタイトルを一括で取得しています。

投稿一覧には8つの記事が投稿されているため、「sossyテスト1」から「sossyテスト8」までの記事のタイトルが表示されています。

get_the_title()の具体的な使用ケース

ここでは、get_the_title()を使用した具体的な使用ケースについてご紹介します。

ブログカードを作成する場合

get_the_title()を使用することで、ブログカードを作成することができます。

例えば、ブログのTOPページに新着10記事をブログカードで作成します。

● index.php

<h1 class="entry-title">get_the_title()でページのタイトルを取得</h1>
<?php 
  // データの取得
  $query = new WP_Query(array(
      'posts_per_page' => 10, //投稿件数
      'orderby' => 'data', //日付
      'order' => 'DESC', //日付が新しいもの
  )
); 
?>
<div class= 'blog-card-list'>
　<?php if($query->have_posts()) :
　　while($query->have_posts()) : $query->the_post(); ?>
　　　<div class = "blog-card">
　　　　<a href="<?php the_permalink(); ?>">
　　　　　<?php $postId = get_the_id(); ?>
　　　　　<div class= "card-thum">
　　　　　<?php if(has_post_thumbnail()):
　　　　　　the_post_thumbnail("thumbnail"); ?>
　　　　　<?php endif; ?>
　　　　　</div>
　　　　　<div class= "card-title">
　　　　　　<?php echo '<span>'.get_the_title($postId).'</span>'; ?>
　　　　　 </div>
　　　　</a>
　　　 </div>
　　 <?php endwhile; ?>
　<?php else: ?>
　<?php endif; ?>
</div>

● style.css

.entry-title {
    text-align:center;
}
.blog-card-list {
    width: 64%;
    display: flex;
    flex-wrap: wrap;
    margin: 3px auto;
}
.blog-card {
    width: 40%;
    background: antiquewhite;
    border: 2px solid black;
    margin: 3px auto;
    height: fit-content;
    box-shadow: 8px 8px 8px rgb(0 0 0 / 50%);
}
.blog-card a {
    text-decoration: none;
}
.card-thum {
    display: inline-block;
    width: 28%;
    height: 88%;
    margin: 6px 6px 4px 4px;
}
.card-title {
    display: inline-block;
}

投稿画面

実行結果

get_the_title()でブログカードを作成し、ページ上に表示しています。

投稿画面を見ると、WordPress内の記事は全部で「11」ありますが、今回は表示数を「10」に指定しています。

そして、投稿記事データを日付の降順で取得しているため、最近投稿した10記事がブログカードとして表示されています。

また、サムネイルが登録されている場合はthe_post_thumbnail()でサムネイル画像を表示しています。

もし、the_post_thumbnail()について詳しく知りたい場合は下記の記事をご参考ください。

Sossyの助太刀ブログ

9月 11, 2024

【WordPress】the_post_thumbnail()でアイキャッチ画像をページに表示する！

https://sossy-blog.com/wordpress/13368/

投稿記事をジャンル別で表示する

get_the_title()を使用することで投稿記事をジャンル別で表示することができます。

例えば、お知らせ欄に最新のお知らせ情報が表示され、クリックすると、お知らせの詳細内容を表示します。

● index.php

<?php 
  // データの取得
  $query = new WP_Query(array(
      'posts_per_page' => 5, //投稿件数
      'orderby' => 'data', //日付
      'order' => 'DESC', //日付が新しいもの
      'category_name' => 'news', //お知らせ
  )
); 
?>

<div class= 'news-lists'>
   <h1 class="entry-title">お知らせ</h1>
   <?php if($query->have_posts()) : ?>
      <?php while($query->have_posts()) : $query->the_post(); ?>
	<div class = "news-list">
　　　　    <a href="<?php the_permalink(); ?>">
　　　　　    <?php $postId = get_the_id(); ?>
            <p><?php the_date(); ?></p>
	    <p><?php echo get_the_title($postId); ?></p>
　　　　   </a>
　    　</div>
       <?php endwhile; ?>
   <?php else: ?>
   <?php endif; ?>

   <?php $cat_obj = get_category_by_slug( 'news ');
         $cat_id = $cat_obj->term_id; ?>
   <p class="news-all">
      <a href='<?php echo get_category_link($cat_id);?>'>お知らせの一覧を見る</a>
   </p>
</div>

● style.css

.entry-title {
     text-align:center;
}
.news-lists {
     width: 80%;
     margin: 3px auto;
     text-align:center;
}
.news-list a {
     text-decoration-line:none;
}
.news-all {
     text-align:right;
}

投稿画面

実行結果

get_the_title()で投稿記事をジャンル別で表示しています。

今回は、the_post()で「お知らせ」というカテゴリーに属している最新の投稿記事5件を取得しています。

そして、get_the_id()で取得した投稿記事のIDを取得し、get_the_title()のパラメータに指定することでタイトルを表示しています。

そのため、お知らせに関する記事のみがページ上に表示され、クリックすると内容が表示されます。

HTMLタグも含めてページのタイトルを表示する場合

HTMLタグも含めてページのタイトルを表示するにはthe_title()を使用します。

the_title()とは、表示しているページのタイトルをHTMLごと出力するWordPressの関数になります。

そのため、WordPressで作成されたブログや記事のタイトルはこちらの関数でページ表示しています。

● index.html

<article>
    <header>
       <h1 style='font-size:32px;'>get_the_title()でページのタイトルを取得</h1>
       <?php the_title('<h3>', '</h3>') ?>
    </header>	
    <div>
       <?php the_content(); ?>
    </div>
</article>

投稿画面

実行結果

the_title()でHTMLタグも含めてページのタイトルを表示しています。

そのため、それぞれのページのタイトルである「さんぽ」や「君が代」が表示されています。

また、ソースコードを見てみると、タイトルが<h3>で囲まれていることがわかります。

● index.html

<header>
    <h1 style="font-size:32px;">the_title()でページのタイトルを取得</h1>
    <h3>さんぽ</h3>	
</header>

まとめ

(この記事は2024年09月11日に投稿されました。)

WordPressでアイキャッチ画像をページに表示するにはthe_post_thumbnail()使用します。

the_post_thumbnail()とは、登録したアイキャッチの画像をページに表示する関数になります。

そのため、各投稿記事で表示されているアイキャッチ画像はおそらくこちらの関数を使用してページに出力されています。

また、the_post_thumbnail()に引数を指定することで大きさを変えたり、属性を付与したりしてアイキャッチ画像を表示することができます。

こちらの関数を使用することで、各記事に登録したアイキャッチ画像を簡単に表示することができるので、アイキャッチ画像を各記事に投稿したいと思った場合はthe_post_thumbnail()を使用しましょう。

今回はWordPressのthe_post_thumbnail()でアイキャッチ画像をページに表示する方法について紹介していきます。

この記事はこんな方におすすめ

WordPressの投稿記事にアイキャッチ画像を表示したい場合

the_post_thumbnail()とは

the_post_thumbnail()と各投稿で登録されているアイキャッチ画像をimgタグとしてページ上に表示させることができる関数になります。

投稿画面にてアイキャッチ画像というウィジェットがあるため、そこに画像を登録し、こちらの関数を使用することで、そのページに登録したアイキャッチ画像を表示することができます。

そもそも、アイキャッチ画像とは、読者の目を引くために使用される画像になります。

ブログ記事やウェブサイトのコンテンツに視覚的な魅力を加え、記事の内容を象徴的に表したり、読者の興味を掻き立てたりする役割を果たします。

YouTubeで言うと、サムネイルみたいなイメージになります。

そして、アイキャッチは登録することでオリジナルだけでなく、大、中、小のサイズの異なる3種類の画像が自動で生成されて保存されます。

the_post_thumbnail()の書き方

the_post_thuumbnail()の書き方は下記のようになります。

<? php
the_post_thuumbnail([サイズ, 属性])
?>

the_post_thuumbnail()の括弧の中に任意なパラメータを2つまで指定して使用します。

the_post_thumbnail()のパラメータ

the_post_thumbnail()のパラメータは下記のようになります。

the_post_thunbnail()は任意のパラメータとして1つ目に「サイズ」を指定します。

また、2つ目に任意のパラメータとして「属性」を指定します。

the_post_thumbnail()の呼び出し元

the_post_thunmbnail()の呼び出し元は「post-thumbnail-template.php」となります。

function the_post_thumbnail( $size = 'post-thumbnail', $attr = '' ) {
	echo get_the_post_thumbnail( null, $size, $attr );
}

get_the_post_thumbnail()を呼び出していますが、こちらの関数は指定した投稿IDに登録されているアイキャッチ画像のデータを取得し、返り値として、<img>タグを付与したアイキャッチ画像を返します。

つまり、the_post_thumbnail()を使用することで、特定のアイキャッチ画像を表示することができるようになります。

the_post_thumbnail()でアイキャッチ画像をページに表示するサンプルコード

the_post_thumbnail()でアイキャッチ画像をページに表示するサンプルコードをご紹介します。

例えば、ページを表示する際に一番上にアイキャッチ画像を表示するようなコードを作成します。

● single.php

<?php get_header(); ?>
  <div id="content">
    <div id="inner-content" class="**********">
      <main id="main" class="**********">
        <?php if (have_posts()) : while (have_posts()) : the_post(); ?>
          <article id="****">
            <header class="*************************">
                <h1 class="page-title"><?php the_title(); // タイトル ?></h1>
              <?php endif; ?>
              <?php if (has_post_thumbnail()) : // アイキャッチ ?>
                <p class="*******"><?php the_post_thumbnail('large');?></p>
              <?php endif; ?>
            </header>
            <section class="*************">
              <?php
                the_content();
              ?>
            </section>
            <?php comments_template(); ?>
          </article>
        <?php endwhile; ?>
        <?php else : ?>
        <?php get_template_part('content', 'not-found'); ?>
        <?php endif; ?>
      </main>
      <?php get_sidebar(); ?>
    </div>
  </div>
<?php get_footer(); ?>

実行結果

こちらは、当サイトの投稿ページ用のPHPファイルですが、サムネイルを表示するために、the_post_thumbnail()を使用してるのがわかります。

the_post_thumbnail()でアイキャッチ画像をページに表示しています。

そのため、投稿編集画面で登録した画像がWebページ上に表示されています。

the_post_thumbnail()でアイキャッチ画像のサイズを指定してページに表示する場合

the_post_thumbnail()でアイキャッチ画像にサイズを指定してページに表示するには、第1パラメータの「サイズ」を指定して使用ます。

そのため、ここでは下記の5パターンでthe_post_thumbnail()を使用します。

小サイズで表示する場合

小サイズで表示するには、サイズに「thumbnail」を指定します。

小サイズになるため、横 × 縦のデフォルトである「150px ×　150px」の大きさになって画面に表示されます。

● single.php

<article id="*****">
	<header class="******">
		<h1 class="entry-title" style='font-size:32px;'>the_post_thumbnail()でアイキャッチ画像を表示</h1>
		<?php the_post_thumbnail('thumbnail'); ?>
	</header>
	
	<div class="*****">
	<?php the_content();　?>
	</div>
	
	<footer class="*****">
		<?php get_footer(); ?>
	</footer>

</article>

実行結果-1

実行結果-2

the_post_thumbnail()でアイキャッチ画像を小サイズでページに表示しています。

そのため、投稿記事に「150 × 150」の大きさのアイキャッチ画像が表示されています。

中サイズで表示する場合

中サイズで表示するには、サイズに「medium」を指定します。

中サイズになるため、横 × 縦が「300px × 300px」の大きさになって画面に表示されます。

● single.php

<article id="*****">
	<header class="******">
		<h1 class="entry-title" style='font-size:32px;'>the_post_thumbnail()でアイキャッチ画像を表示</h1>
		<?php the_post_thumbnail('medium'); ?>
	</header>
	
	<div class="*****">
	<?php the_content();　?>
	</div>
	
	<footer class="*****">
		<?php get_footer(); ?>
	</footer>

</article>

実行結果-1

実行結果-2

the_post_thumbnail()でアイキャッチ画像を中サイズでページに表示しています。

今回は横を「300px」とした場合に縦の長さを調整しているため、投稿記事に「300 × 194.141」の大きさのアイキャッチ画像が表示されています。

大サイズで表示する場合

大サイズで表示するには、サイズに「large」を指定します。

大サイズになるため、横 × 縦が「1024px ×　1024px」の大きさになって画面に表示されます。

● single.php

<article id="*****">
	<header class="******">
		<h1 class="entry-title" style='font-size:32px;'>the_post_thumbnail()でアイキャッチ画像を表示</h1>
		<?php the_post_thumbnail('large'); ?>
	</header>
	
	<div class="*****">
	<?php the_content();　?>
	</div>
	
	<footer class="*****">
		<?php get_footer(); ?>
	</footer>

</article>

実行結果-1

実行結果-2

the_post_thumbnail()でアイキャッチ画像を大サイズでページに表示しています。

今回は横を「1024」とした場合に縦の長さを調整しているため、投稿記事に「1024 × 663.031」の大きさのアイキャッチ画像が表示されています。

オリジナルサイズで表示する場合

オリジナルサイズで表示するには、サイズに「full」を指定します。

こちらは登録したアイキャッチ画像のサイズがそのままページに表示されるようになります。

● single.php

<article id="*****">
	<header class="******">
		<h1 class="entry-title" style='font-size:32px;'>the_post_thumbnail()でアイキャッチ画像を表示</h1>
		<?php the_post_thumbnail(array(500, 500)); ?>
	</header>
	
	<div class="*****">
	<?php the_content();　?>
	</div>
	
	<footer class="*****">
		<?php get_footer(); ?>
	</footer>

</article>

実行結果-1

実行結果-2

the_post_thumbnail()でアイキャッチ画像をオリジナルでページに表示しています。

今回は「1200 × 777」の画像をアイキャッチ画像に登録したため、投稿記事に「1200 × 777」のアイキャッチ画像が表示されています。

指定したサイズで表示する場合

指定したサイズで表示するには、サイズに「array(横,縦)」の配列で指定します。

指定したサイズのため、自分の好きなサイズでアイキャッチ画像を表示することができるようになります。

● single.php

<article id="*****">
    <header class="******">
        <h1 class="entry-title" style='font-size:32px;'>the_post_thumbnail()でアイキャッチ画像を表示</h1>
		<?php the_post_thumbnail(array(130, 130)); ?>
	</header>
	
	<div class="*****">
	<?php the_content();　?>
	</div>
	
	<footer class="*****">
		<?php get_footer(); ?>
	</footer>
    
</article>

実行結果-1

実行結果-2

the_post_thumbnail()でアイキャッチ画像を好きなサイズでページに表示しています。

今回は「130 × 130」をアイキャッチ画像に指定したため、投稿記事に「130px × 130px」の大きさの画像が表示されています。

the_post_thumbnail()でアイキャッチ画像に属性を追加してページに表示する場合

the_post_thumbnail()でアイキャッチ画像に属性を追加してページに表示するには、第2パラメータである属性を指定します。

属性を指定することで、クラス名を紐づけたりなど、様々な情報を紐づけた上アイキャッチ画像を表示することができます。

また属性とは、下記のようなHTMLの要素に付与することができる情報のことをいいます。

ここでは代表的なものを紹介していますが、他にも付与できる属性が存在します。

アイキャッチ画像に1つの属性を指定する場合

アイキャッチ画像に1つの属性を指定するには属性のパラメータを連想配列で1つ指定します。

キーに属性名を指定し、値に付与する値を指定することで、アイキャッチ画像に属性を付与して表示します。

● single.php

<article id="*****">
    
    <header class="******">
        <h1 class="entry-title" style='font-size:32px;'>the_post_thumbnail()でアイキャッチ画像を表示</h1>
	　<?php the_post_thumbnail('full', array('id' => 'icatch_id'); ?>
    </header>
	
    <div class="*****">
	<?php the_content();　?>
    </div>
	
    <footer class="*****">
	<?php get_footer(); ?>
    </footer>

</article>
<style>
#icatch_id {
    border: 3px solid red;
    opacity: 0%;
}
#icatch_id:hover {
    opacity: 100%;
}
</style>

実行結果

the_post_thumbnail()でアイキャッチ画像に1つの属性を指定してページに表示しています。

今回は、アイキャッチ画像にidを付与したため、id名で紐づかれたCSSがアイキャッチ画像に反映して表示されています。

アイキャッチ画像に複数の属性を指定する場合

アイキャッチ画像に複数の属性を指定するには属性のパラメータを連想配列の要素を複数指定します。

カンマで要素を繋げることで、複数の属性をアイキャッチ画像に付与して表示します。

● single.php

<article id="*****">
    <header class="******">
    　　<h1 class="entry-title" style='font-size:32px;'>the_post_thumbnail()でアイキャッチ画像を表示</h1>
	<?php 
	the_post_thumbnail('funll', $attr);
        $attr = array(
            'class' => 'bg_color', 
            'alt' => 'アイキャッチ画像',
            'loading'=> 'lazy'
            ) 
        ?>
    </header>
	
    <div class="*****">
	<?php the_content();　?>
    </div>
	
    <footer class="*****">
	<?php get_footer(); ?>
    </footer>

</article>
<style>
.border_sty {
    border: 3px solid blue;
    border-radius: 40px;
}
</style>

実行結果

the_post_thumbnail()でアイキャッチ画像に複数の属性を指定してページに表示しています。

そのため、アイキャッチ画像に属性が付与されて表示されています。

また、画像のHTMLを確認すると、指定したattr属性やloading属性が付与されています。

● single.php

<img width="1200" height="777" src="https://*******************************.png" class="border_sty wp-post-image" alt="アイキャッチ画像" loading="lazy" decoding="async" style="width:100%;height:64.75%;max-width:1200px;">

投稿にアイキャッチ画像が登録されているかどうか確認する場合

投稿にアイキャッチ画像が登録されているかどうか確認するには、has_post_thumbnail()を使用します。

has_post_thumbnail()とは、その投稿記事にアイキャッチ画像が登録されているかどうかを真偽値で返す関数になります。

そのため、登録されている場合は「True」を返し、登録されていない場合は「False」を返すようになります。

● single.php

<article id="*****">
    <header class="******">
        <h1 class="entry-title" style='font-size:32px;'>the_post_thumbnail()でアイキャッチ画像を表示</h1>
        <?php 
        if (has_post_thumbnail()):
            the_post_thumbnail('large');
        else: ?>
            <img src="https://****************************/wordpress_def.jpg">
        <?php endif; ?>
	</header>
	
	<div class="*****">
            <?php the_content();　?>
	</div>
	
	<footer class="*****">
            <?php get_footer(); ?>
	</footer>
</article>

実行結果(アイキャッチ画像登録あり)

実行結果(アイキャッチ画像登録なし)

has_post_thumbnail()で投稿にアイキャッチ画像が登録されているか確認しています。

そのため、アイキャッチ画像が登録されている記事にはアイキャッチ画像が表示され、登録されていない記事にはデフォルトの画像が表示されています。

まとめ

Pythonで値の絶対値を取得するにはabs()使用します。

abs()とは絶対値を求める関数であり、指定した値の絶対値を取得することができます。

しかし、値が文字列の場合は絶対値を取得することはできませんので注意してください。

また、繰り返し処理内で使用することで、リストに格納された値の絶対値を一気に求めることもできます。

Pythonをインストールしていればすぐに使用できるため、もし値の絶対値を取得したいと思った場合はabs()を使用しましょう。

今回はPythonのabs()で絶対値を求める方法について基本から応用までご紹介していきます。

この記事はこんな方におすすめ

指定した値の絶対値を求めたい場合

abs()とは

abs()とは、絶対値を求める関数になります。

そもそも、絶対値とは0からの距離を表す値のことをいいます。

そのため、符号が違っても同じ数字であれば絶対値は同じになります。

abs()の書き方

abs()の書き方は下記のようになります。

abs("対象の値")

abs()と記載し、括弧に必須のパラメータを1つ指定することで使用することができます。

abs()のパラメータ

abs()のパラメータは下記のようになります。

abs()は必須なパラメータをとして「対象の値」を指定します。

abs()の返り値

abs()の返り値は対象の値の絶対値となります。

abs()の基本的な使い方

abs()で絶対値を求めるサンプルコードをご紹介します。

ここでは下記の3パターンに対して使用します。

対象の値が数値である場合

対象の値が数値である場合にabs()を使用すると絶対値を返します。

● main.py

print('● 対象の数値-1')
num1 = 13
print(num1)

print("● abs()使用後-1")
print(abs(num1))

print('● 対象の数値-2')
num2 = -15
print(num2)

print("● abs()使用後-2")
print(abs(num2))

print('● 対象の数値-3')
num3 = -12.987
print(num3)

print("● abs()使用後-3")
print(abs(num3))

実行結果

abs()で指定した値の絶対値を取得しています。

そのため、下記のように表示されています。

対象の値が文字列である場合

対象の値が文字列である場合にabs()を使用するとエラーが発生します。

● main.py

print('● 対象の文字列')
str1 = 'abs'
print(str1)

print("● abs()使用後")
print(abs(str1))

実行結果

abs()で指定した値の絶対値を取得しています。

今回は文字列を指定した為、エラーが発生しています。

対象の値が真偽値である場合

対象の値が真偽値である場合にabs()を使用すると「0」か「1」が返されます。

● main.py

print('● 対象の真偽値-1')
bl1 = True
print(bl1)

print("● abs()使用後-1")
print(abs(bl1))

print('● 対象の真偽値-2')
bl2 = False
print(bl2)

print("● abs()使用後-2")
print(abs(bl2))

実行結果

abs()で真偽値の絶対値を取得しています。

そのため、下記のように表示されています。

abs()で複数の値の絶対値を一気に取得する場合

abs()で複数の値の絶対値を一気に取得するには、繰り返し処理を使用します。

絶対値を求めたい値をリストに格納し、繰り返し処理内でabs()使用することで複数の値の絶対値を一気に求めることができます。

● main.py

print('● 対象の値')
abs_list = [12, -3.45, 999, -93, True, False]
print(abs_list)

print("● abs()使用後")
for abs_item in abs_list:
    print(abs(abs_item))

実行結果

abs()で複数の値の絶対値を一気に取得しています。

そのため、下記のような結果となって表示されています。

abs()の応用的な使い方

先ほどまでabs()で指定した数値の絶対値を取得していましたが、複雑な数値の絶対値を取得する応用な使い方ができます。

そのため、ここではabs()の応用的な使い方についてご紹介します。

対象の値が無限大である場合

abs()を無限大の値に対して使用すると、「inf」を返します。

● main.py

print('● 対象の無限大-1')
abs_inf1 = float('inf')
print(abs_inf1)

print("● abs()使用後-1")
print(abs(abs_inf1))

print('● 対象の無限大-2')
abs_inf2 = -float('inf')
print(abs_inf2)

print("● abs()使用後-1")
print(abs(abs_inf2))

実行結果

abs()で無限大の絶対値を取得しています。

そのため、下記のような結果となって表示されています。。

対象の値が複素数である場合

abs()を複素数の値に対して使用すると、平方根で計算した値を返します。

● main.py

print('● 対象の複素数-1')
abs_comp1 = 4 + 8j
print(abs_comp1)

print("● abs()使用後-1")
print(abs(abs_comp1))

print('● 対象の複素数-2')
abs_comp2 = -3 + 4j
print(abs_comp2)

print("● abs()使用後-2")
print(abs(abs_comp2))

実行結果

abs()で複素数の値の絶対値を取得しています。

そのため、下記のような結果となって表示されています。。

abs()を使用した実際のケース

abs()を使用した実際のケースについてご紹介します。

例えば、abs()を使用して1か月の最高平均気温から一番差がある日付を求めるような処理を作成します。

● index.html

<!DOCTYPE html> 
<html lang="ja"> 
    <head> 
        <title>abs()で絶対値を取得</title>
        <meta charset="utf-8"/>
    </head>
    <body>
        <h1>東京の気温</h1>
        <div class= "mon-table">
            {% for date, temp in lists: %}
            <div id = "{{ temp }}" class ="date-cell">{{ date }}
                <p>{{ temp }}</p>
            </div>
            {% endfor %}
        </div>
        <form action="/" method="POST">
            <button type="submit">結果</button> 
        </form> 
    </body> 
    <style>
    .mon-table {
        border: 1px solid;
        display: flex;
        flex-wrap: wrap;
        width: 625px;
    }
    .date-cell {
        border: 1px solid;
        width: 100px;
        margin: 1px;
        text-align: center;
    }
    </style>
</html>

● result.html

<!DOCTYPE html> 
<html lang="ja"> 
    <head> 
        <title>abs()で絶対値を取得</title>
        <meta charset="utf-8"/>
    </head>
    <body>
        <h1>東京の気温</h1>
        <div class= "mon-table">
            {% for date, temp in lists: %}
            <div id = "{{ temp }}" class ="date-cell">{{ date }}
                <p>{{ temp }}</p>
            </div>
            {% endfor %}
        </div>
    </body>
    <style>
    .mon-table {
        border: 1px solid;
        display: flex;
        flex-wrap: wrap;
        width: 625px;
    }
    .date-cell {
        border: 1px solid;
        width: 100px;
        margin: 1px;
        text-align: center;
    }
    .accent-val {
        background:tomato;
    }
    </style>
    <script>
    window.addEventListener('load', function() {
        let max_temp = document.getElementById('{{ temp_ret }}')
        max_temp.classList.add('accent-val')
        })
    </script>
</html>

● main.py

from flask import Flask, render_template
import requests
import json

app = Flask(__name__) 

API_URL = f'https://api.open-meteo.com/v1/forecast?latitude=35.6785&longitude=139.6823&daily=temperature_2m_max&timezone=Asia%2FTokyo&past_days=31&forecast_days=1' 
headers = {"content-type": "application/json"}

response = requests.get(API_URL, headers=headers)
data = response.json()
daily = data['daily']
date_list = daily['time']
temp_list = daily['temperature_2m_max']

@app.route('/') 
def index():
    return render_template('index.html', lists = zip(date_list, temp_list)) 

@app.route('/', methods=['POST']) 
def index2(): 

    temp_sum = 0
    day_cnt = len(temp_list)
    for tempA in temp_list:
        temp_sum = temp_sum + tempA

    temp_ave = round(temp_sum / day_cnt, 1)

    def abs_diff(tempB):
        temp_diff = abs(tempB - temp_ave)
        return temp_diff
    
    temp_diff_list = list(map(abs_diff, temp_list))
    temp_diff_max = max(temp_diff_list)
    temp_idx = list(temp_diff_list).index(temp_diff_max)
    temp = temp_list[temp_idx]

    return render_template('index2.html', lists = zip(date_list, temp_list), temp_ret = str(temp)) 

if __name__ == '__main__': 
    app.run()

実行結果(登録成功時)

abs()で1か月の平均気温から一番差がある日付を求めています。

今回は下記のような処理を行い、その中でabs()を使用しています。

今回は符号有による数値の比較を避けたいため、abs()にて符号を無くして数値の比較を行っています。

そのため、「結果」を押すと、1ヶ月の最高平均気温から一番離れている「2024/04/24」の色が赤色に変化しています。

絶対値を取得する他の方法

Pythonで絶対値を取得する他の方法としてmath.fabs()があります。

math.fabs()とは、mathクラスで準備されている絶対値を求める関数となります。

そのため、返り値は絶対値になりますが、全て浮動小数点数型になります。

● main.py

import math

print('● 対象の数値-1')
num1 = 13
print(num1)

print("● abs()使用後-1")
print(math.fabs(num1))

print('● 対象の数値-1')
num2 = -13.456
print(num2)

print("● abs()使用後-2")
print(math.fabs(num2))

実行結果

math.fabs()で指定した値の絶対値を取得しています。

そのため、下記のように表示されています。

まとめ

(この記事は2024年04月13日に投稿されました。)

Pythonでリスト(List)の各要素の格納数をカウントするにはCounter使用します。

Counterとは、オブジェクト内の各値の数をカウントするcollectionsモジュールのクラスになります。

そのため、リスト(List)に対して使用すると各要素の格納数をカウントし、「要素:個数」のペアとなる辞書型で返ってきます。

また、 多次元リストに対しても使用できますが、カウントしたいリストの範囲によって方法が異なるため注意してください。

今回はPythonのCounterでリスト(List)の各要素の格納数をカウントする方法について紹介していきます。

この記事はこんな方におすすめ

リスト(List)の各要素の出現回数を調べたい場合

Counterとは

Counterとは、オブジェクトの各値の出現回数をカウントするcollectionsモジュールのクラスになります。

そのため、リスト(List)に対して使用するとリストに格納されている要素の出現回数をカウントします。

Counterの書き方

Counterの書き方は下記のようになります。

import collections

collections.Counter(対象のリスト(List))

まず、importでcollectionsクラスをインポートします。

そして、collections.Counter()の括弧にパラメータを1つ追記します。

Counterのパラメータ

Counterのパラメータは下記のようになります。

Counter()は必須なパラメータとして「対象のリスト(List)」を指定します。

Counterの返り値

Counterの返り値は「要素名: 要素数」の辞書型(dict)となります。

Counterでリスト(List)の各要素の格納数をカウントするサンプルコード

Counterでリスト(List)の各要素の格納数をカウントするサンプルコードをご紹介します。

ここでは下記の2パターンでCounterを使用します。

リスト(List)に要素が存在する場合

リスト(List)に要素が存在する場合にCounterを使用すると、リスト内の各要素の出現回数をカウントします。

● main.py

import collections

print('● 対象のリスト')
list1 = ['JavaScript', 'PHP', 'Python', 'C#', 'Java']
print(list1)

print("● Counter()使用後")
list1_counter = collections.Counter(list1)
print(list1_counter)

実行結果

Counterでリスト(List)の各要素の格納数をカウントしています。

そのため、下記のように表示されています。

リスト(List)に要素が存在しない場合

リスト(List)に要素が存在しない場合にCounterを使用すると、空を返します。

● main.py

import collections

print('● 対象のリスト')
list1 = ['JavaScript', 'PHP', 'Python', 'C#', 'Java']
print(list1)

print("● Counter()使用後")
list1_counter = collections.Counter(list1)
print(list1_counter)

実行結果

Counterでリスト(List)の各要素の格納数をカウントしています。

今回はリストに要素が存在しないため、「Counter()」が表示されています。

型の異なる同じ要素を持つリスト(List)に対してCounterを使用する場合

型の異なる同じ要素を持つリスト(List)に対してCounterを使用すると、それぞれ違う要素としてカウントするようになります。

● main.py

import collections

print('● 対象のリスト')
list1 = ['10', '20', '30', '40', '50', 10, 20, 30, 40, 50]
print(list1)

print("● Counter()使用後")
list1_counter = collections.Counter(list1)
print(list1_counter)

実行結果

Counterで型の異なる同じ要素を持つリスト(List)の各要素をカウントしています。

そのため、下記のように表示されています。

Counterで多次元リスト(List)の各要素の格納数をカウントするサンプルコード

Counterで多次元リスト(List)の各要素の格納数をカウントするサンプルコードをご紹介します。

多次元リストに対して使用する場合は、アクセスする次元が異なるためカウントしたい箇所によって処理内容が異なります。

そのためここでは、多次元リストに対してCounterを下記の3つの場合で使用します。

指定したリスト(List)の要素をカウントする場合

指定したリスト(List)の要素をカウントする場合はリスト変数の後ろにインデックスを指定します。

● main.py

import collections

print('● 対象の2次元リスト')
list1 = [
    ['JavaScript', 'C#','Python', 'Swift'],
    ['Ruby', 'Python', 'Java', 'C'],
    ['C++', 'Pyhton','Kotlin', 'JavaScript']
    ]
print(list1)

print("● Counter()使用後-1")
list1_counter = collections.Counter(list1[2])
print(list1_counter)

print('● 対象の3次元リスト')
list2 = [
    [['JavaScript', 'C#'],['Python', 'Swift']],
    [['Ruby', 'Python'], ['Java', 'C']],
    [['C++', 'Pyhton'], ['Kotlin', 'JavaScript']]
    ]
print(list2)

print("● Counter()使用後-2")
list2_counter = collections.Counter(list2[2][1])
print(list2_counter)

実行結果

Counterで指定したリスト(List)の要素をカウントしています。

今回は指定したリスト(List)の要素を対象としたため、下記のように表示されています。

各リスト(List)の要素をカウントする場合

各リスト(List)の要素をカウントする場合は繰り返し処理を使用します。

● main.py

import collections

print('● 対象の2次元リスト')
list1 = [
    ['JavaScript', 'C#','Python', 'Swift'],
    ['Ruby', 'Python', 'Java', 'C'],
    ['C++', 'Pyhton','Kotlin', 'JavaScript']
    ]
print(list1)

print("● Counter()使用後-1")
for list1_m in list1:
    list1_counter = collections.Counter(list1_m)
    print(list1_counter)

print('● 対象の3次元リスト')
list2 = [
    [['JavaScript', 'C#'],['Python', 'Swift']],
    [['Ruby', 'Python'], ['Java', 'C']],
    [['C++', 'Pyhton'], ['Kotlin', 'JavaScript']]
    ]
print(list2)

print("● Counter()使用後-2")
for list2_m in list2:
    for list2_mn in list2_m:
        list2_counter = collections.Counter(list2_mn)
        print(list2_counter)

実行結果

Counterで各リスト(List)の要素をカウントしています。

今回は各リスト(List)の要素を対象としたため、下記のように表示されています。

リスト(List)全体の要素をカウントする場合

リスト(List)全体の要素をカウントする場合は、多次元リストを単次元リストに一度変換(フラット化)します。

フラットにすることで各リストに格納されている要素が横一列となり、そのリストに対してCounter()を使用することで、全体に格納された要素をカウントすることができます。

● main.py

import collections
import itertools

print('● 対象の2次元リスト')
list1 = [
    ['JavaScript', 'C#','Python', 'Swift'],
    ['Ruby', 'Python', 'Java', 'C'],
    ['C++', 'Pyhton', 'Kotlin', 'JavaScript']
    ]
print(list1)

print("● Counter()使用後-1")
list1_flat = itertools.chain.from_iterable(list1)
list1_counter = collections.Counter(list1_flat)
print(list1_counter)

print('● 対象の3次元リスト')
list2 = [
    [['JavaScript', 'C#'],['Python', 'Swift']],
    [['Ruby', 'Python'], ['Java', 'C']],
    [['C++', 'Pyhton'], ['Kotlin', 'JavaScript']]
    ]
print(list2)

print("● Counter()使用後-2")
list2_flat_M = itertools.chain.from_iterable(list2)
list2_flat = list(itertools.chain.from_iterable(list2_flat_M))
list2_counter = collections.Counter(list2_flat)
print(list2_counter)

実行結果

Counterでリスト(List)全体の要素をカウントしています。

今回はリスト(List)全体の要素を対象としたため、下記のように表示されています。

Counterを使用した実際のケース

Counterを使用した実際のケースについてご紹介します。

例えば、Counterで登録されたユーザーとそのアカウント数の一覧を表示するようなコードを作成します。

● index.html

<!DOCTYPE html> 
<html lang="ja"> 
    <head> 
        <title>Counter()でリスト(List)の各要素の格納数をカウント</title> 
        <meta charset="utf-8"/> 
    </head> 
    <body> 
        <h1>登録者とアカウント数の一覧</h1>
        <table border="1">
            <thead>
                <tr>
                    <th scope="col">名前</th>
                    <th scope="col">電話番号</th>
                    <th scope="col">登録アカウント数</th>
                </tr>
            </thead>
            <tbody>
                {% for user, cnt in userList.items(): %} 
                <tr>
                    <th scope="row">{{ user[0] }}</th>
                    <td>{{ user[1] }}</td>
                    <td>{{ cnt }}</td>
                </tr>
                {% endfor %}
            </tbody>
        </table>
    </body> 
</html>

● main.py

from flask import Flask, render_template, request
import collections
import sqlite3

app = Flask(__name__)


@app.route('/') 
def index():
    try:
        dbname = '***.db'
        connect = sqlite3.connect(dbname)
        cur = connect.cursor()
        cur.execute('SELECT name, phone FROM usrTBL;')
        usrPhone = cur.fetchall()
        usr_counter = collections.Counter(usrPhone)
        print(usr_counter)

    except Exception as e:
        print(e)

    finally:
        return render_template('index.html', userList = usr_counter) 

if __name__ == '__main__': 
    app.run()

実行結果

Counter()で登録されたユーザーとそのアカウント数の一覧を表示しています。

今回は下記のような処理を行っています。

そのため、DBに登録されているユーザー名とデータを集計して画面に表示されています。

Counterでリスト(List)以外の各要素の格納数をカウントする場合

Counterでリスト(List)以外の各要素の格納数をカウントします。

タプル(tuple)の場合

Counterをタプル(tuple)に対して使用します。

● main.py

import collections

print('● 対象のタプル')
tuple1 = ('JavaScript', 'PHP', 'Python', 'C#', 'Java', 'PHP', 'PHP')
print(tuple1)

print("● Counter()使用後-1")
tuple1_counter = collections.Counter(tuple1)
print(tuple1_counter)

実行結果

Counter()でタプル(tuple)の各要素の格納数をカウントしています。

そのため、下記のように表示されています。

辞書(dict)の場合

Counterを辞書型(dict)型に使用します。

結論を言うと、Counterは直接、辞書型に使用できません。

しかし、item()やkeys()、values()でペアやキー、値を取り出したイテラルに対して使用することができます。

● main.py

import collections

print('● 対象の辞書')
dict1 = {'JavaScript':'ジャバスクリプト', 'PHP':'ピーエイチピー', 'Python': 'パイソン','Java': 'ジャバ'}
print(dict1)

print("● Counter()使用後-1")
doct1_item = dict1.items()
dict1_counter1 = collections.Counter(doct1_item)
print(dict1_counter1)

print("● Counter()使用後-2")
doct1_key = dict1.keys()
dict1_counter2 = collections.Counter(doct1_key)
print(dict1_counter2)

print("● Counter()使用後-3")
doct1_value = dict1.values()
dict1_counter3 = collections.Counter(doct1_value)
print(dict1_counter3)

実行結果

Counterで辞書(dict)型の各要素の格納数をカウントしています。

そのため、下記のように表示されています。

set(集合)型の場合

Counterをset(集合)型に使用します。

import collections

print('● 対象のset')
set1 = set(['JavaScript', 'PHP', 'Python', 'C#', 'Java'])
print(set1)

print("● Counter()使用後")
set1_counter = collections.Counter(set1)
print(set1_counter)

実行結果

CounterでSet(集合)型の各要素の格納数をカウントしています。

そのため、下記のように表示されています。

frozenset(不変な集合)型の場合

Counterをfrozenset(不変な集合)型に使用します。

import collections

print('● 対象のfrozenset')
fset1 = frozenset(['JavaScript', 'PHP', 'Python', 'C#', 'Java'])
print(fset1)

print("● Counter()使用後")
fset1_counter = collections.Counter(fset1)
print(fset1_counter)

実行結果

Counterでfrozenet(不変な集合)型の各要素の格納数をカウントしています。

そのため、下記のように表示されています。

range()オブジェクトの場合

Counterをrange()オブジェクトに使用します。

import collections

print('● 対象のrange()オブジェクト')
list1 = range(0,10)
print(list1)

print("● Counter()使用後")
list1_counter = collections.Counter(list1)
print(list1_counter)

実行結果

range()オブジェクトの各要素の格納数をCounterでカウントしています。

そのため、下記のように表示されています。

文字列の場合

Counterを文字列に使用します。

Counterを文字列に対して使用した場合、一文字単位でカウントするようになります。

import collections

print('● 対象の文字列')
text1 = 'JavaScript'
print(text1)

print("● Counter()使用後")
text1_counter = collections.Counter(text1)
print(text1_counter)

実行結果

文字列の各文字の出現数をCounterでカウントしています。

そのため、下記のような結果が表示されています。

リスト(List)から特定の要素の出現回数を取得する場合

リスト(List)から特定の要素の出現回数を取得するにはcount()を使用します。

count()とは、オブジェクトから指定した値の出現数をカウントする関数になります。

そのため、リストに対して使用することで特定要素の格納数をカウントすることができます。

print('● 対象のリスト')
list1 = ['JavaScript', 'PHP', 'Python', 'PHP', 'Java']
print(list1)

print("● count()使用後")
list1_cnt = list1.count('PHP')
print('PHP: ' + str(list1_cnt))

実行結果

count()でリスト(List)から特定の要素の出現回数を取得しています。

今回はPHPを指定したため、PHPの格納数である「2」が表示されています。

もし、count()で指定した要素の格納数を取得する内容ついて詳しく知りたい場合は下記の記事をご参考ください。

Sossyの助太刀ブログ

3月 24, 2024

【Python】count()でリスト(List)の指定した要素の格納数をカウント！

https://sossy-blog.com/useful/12418/

まとめ

(この記事は2024年04月10日に投稿されました。)

Pythonでリスト(List)の指定した位置に要素を追加するにはinsert()使用します。

insert()とは、リストの指定した位置に要素を追加する関数になります。

そのため、insert()で指定した要素がリスト内に何個格納されているかを調べることが可能になります。

そして、insert()は2次元List(リスト)や3次元List(リスト)のような多次元リストの指定した位置に要素を追加することもできます。

Pythonで位置を指定して要素を追加する方法はあまりないため、もしリストの指定した位置に要素を追加したい場合はinsert()を使用しましょう。

今回はPythonのinsert()でリスト(List)の指定した位置に要素を追加する方法について紹介していきます。

この記事はこんな方におすすめ

List(リスト)の指定した位置に要素を追加したい場合

insert()とは

insert()とはリストの指定した位置に要素を格納する関数になります。

リストは新しい要素が末尾に追加されていきますが、insert()を使用することで好きな箇所に要素を追加することができます。

insert()の書き方

insert()の書き方は下記のようになります。

対象のリスト.insert('追加する位置','追加する要素)

対象のリストの後ろにinsert()と追記し、括弧の中に必須のパラメータと任意のパラメータの計2つを指定します。

insert()のパラメータ

insert()のパラメータは下記のようになります。

insert()は必須なパラメータとして「追加する要素」と「追加する位置」を指定します。

そのため、合計で2つのパラメータを指定する必要があります。

insert()の返り値

insert()の返り値はありません。

insert()でリスト(List)の指定した位置に要素を追加するサンプルコード

insert()でリスト(List)の指定した位置に要素を追加するサンプルコードをご紹介します。

ここでは下記の2パターンでinsert()を使用します。

追加する要素がリテラルである場合

追加する要素がリテラルである場合にinsert()を使用すると、一つの要素としてリストの指定した位置に追加します。

● main.py

print('● 対象のリスト') 
list1 = ['JavaScript', 'PHP', 'Python', 'C#', 'Java'] 
print(list1) 

print("● insert()使用後-1")
list1.insert(2, 'Swift') 
print(list1)

print("● insert()使用後-2")
list1.insert(0, 'Kotlin') 
print(list1)

実行結果

insert()でリストの指定した位置にリテラル要素を追加しています。

「2」を指定したため、3番目に「Swift」が、「0」を指定したため、1番目に「Kotlin」が追加されています。

追加する要素がイテレータである場合

追加する要素がイテレータである場合にinsert()を使用すると、一つのイテレータ要素として指定した位置に追加します。

● main.py

print('● 対象のリスト') 
list1 = ['JavaScript', 'PHP', 'Python', 'C#', 'Java'] 
print(list1) 

print("● insert()使用後")
list1.insert(0, ['Kotlin', 'Swift']) 
print(list1)

実行結果

insert()でリストの指定した位置にイテレータ要素を追加しています。

「0」を指定したため、1番目に「Kotlin」と「Swift」が格納されたリストが追加されています。

追加する位置を変更してinsert()でリスト(List)の指定した位置に要素を追加する場合

insert()は追加する位置の指定によって要素の追加位置が異なります。

そのため、ここではinsert()の追加する位置を下記の3パターンで変更してリスト(List)の指定した位置に要素を追加します。

追加する位置が要素数未満の場合

追加する位置が要素数未満である場合は、指定したインデックスの位置に要素が追加されるようになります。

● main.py

print('● 対象のリスト') 
list1 = ['JavaScript', 'PHP', 'Python', 'C#', 'Java'] 
print(list1) 

print("● insert()使用後-1")
list1.insert(3, 'Swift') 
print(list1)

print("● insert()使用後-2")
list1.insert(5, 'Kotlin') 
print(list1)

実行結果

insert()でリストの指定した位置に要素を追加しています。

今回は要素数よりも小さい「3」と「4」を指定したため、4番目に「Swift」が、5番目に「Kotlin」が追加されています。

追加する位置が要素数以上である場合

追加する位置が要素数以上である場合は、リスト(List)の末尾に要素が追加されるようになります。

● main.py

print('● 対象のリスト') 
list1 = ['JavaScript', 'PHP', 'Python', 'C#', 'Java'] 
print(list1) 

print("● insert()使用後-1")
list1.insert(5, 'Swift') 
print(list1)

print("● insert()使用後-2")
list1.insert(10, 'Kotlin') 
print(list1)

実行結果

insert()でリスト(List)の指定した位置に要素を追加しています。

今回は要素数以上である「5」と「10」を指定したため、「Swift」と「Kotlin」がリスト(List)の末尾に追加されています。

追加する位置が負の整数である場合

追加する位置が負の整数である場合は、リストの末尾から数えたインデックスの位置に要素が追加されるようになります。

● main.py

print('● 対象のリスト') 
list1 = ['JavaScript', 'PHP', 'Python', 'C#', 'Java'] 
print(list1) 

print("● insert()使用後-1")
list1.insert(-3, 'Swift') 
print(list1)

print("● insert()使用後-2")
list1.insert(-1, 'Kotlin') 
print(list1)

実行結果

insert()でリスト(List)の指定した位置に要素を追加しています。

今回は負の整数である「-3」と「-1」を指定したため、「Swift」が3番目に、「Kotlin」が7番目に追加されています。

リスト(List)の指定した複数の位置に要素を追加する場合

insert()でリスト(List)の指定した複数の位置に要素を追加するには繰り返し処理を使用します。

追加したい位置のインデックスをリスト(List)に格納し、繰り返し処理内にinsert()を使用することで、複数の位置に要素を追加することができます。

● main.py

print('● 対象のリスト') 
list1 = ['JavaScript', 'PHP', 'Python', 'C#', 'GO'] 
print(list1) 

insert_idx = [0, 2, 4]
print("● insert()使用後-1")
for idx in insert_idx:
    list1.insert(idx, 'Java') 
print(list1)

実行結果

insert()でリスト(List)の指定した複数の位置に要素を追加しています。

今回は「0」と「2」と「4」を格納したリストに対して使用したため、1番目と3番目と5番目に「Java」が追加されています。

insert()で多次元のリスト(List)の指定した位置に要素を追加するサンプルコード

insert()で多次元のリスト(List)の指定した位置に要素を追加するサンプルコードについてご紹介します。

多次元リスト(List)に対して使用する場合は、次元が異なるため、アクセスする箇所によっては追加する要素の位置が異なります。

そのためここでは、下記の3ケースで多次元のリスト(List)の指定した位置に要素を追加します。

対象リスト(List)の指定した位置に要素を追加する場合

insert()でリスト(List)の指定した位置に要素を追加するにはリスト変数の後ろにインデックスを指定します。

2次元リストの場合は1つ、3次元リストの場合は2つ指定します。

● main.py

print('● 対象の2次元リスト')
list1 = [
    ['JavaScript', 'C#'],['Python', 'Swift'], ['Ruby', 'Kotlin']
    ]
print(list1)

print('● insert()使用後-1-1')
list1[1].insert(1,'Java')
print(list1)

print('● insert()使用後-1-2')
list1.insert(2,['Java','C++'])
print(list1)

print('● 対象の3次元リスト') 
list2 = [
    [['JavaScript', 'C#'],['Python', 'Swift']],
    [['Ruby', 'Kotlin'],['GO']]
    ]
print(list2)

print('● insert()使用後-2-1')
list2[1][1].insert(1,'Java')
print(list2)

print('● insert()使用後-2-2')
list2[1].insert(2,['PHP','C++'])
print(list2)

print('● insert()使用後-2-3')
list2.insert(2,[['Ruby','Cobol'],['Rust']])
print(list2)

実行結果

insert()で対象リスト(List)の指定した位置に要素を追加しています。

そのため、下記のような結果が表示されています。

各リスト(List)の指定した位置に要素を追加する場合

insert()で各リスト(List)の指定した位置に要素を追加するには繰り返し処理を使用します。

繰り返し処理によって多次元リスト内にアクセスでき、各リストを対象にすることができます。

また、次元によって繰り返し処理を使用する必要があるため注意してください。

● main.py

print('● 対象の2次元リスト')
list1 = [
    ['JavaScript', 'C#'],['Python', 'Swift'], ['Ruby', 'Kotlin']
    ]
print(list1)

print('● insert()使用後-1')
for list1_m in list1:
    list1_m.insert(1, 'Java')
print(list1)

print('● 対象の3次元リスト') 
list2 = [
    [['JavaScript', 'C#'],['Python', 'Swift']],
    [['Ruby', 'Kotlin'],['GO']]
    ]
print(list2)

print('● insert()使用後-2-1')
for list2_m in list2:
    for list2_mn in list2_m:
        list2_mn.insert(0, 'Java')
print(list2)

print('● insert()使用後-2-2')
for list2_m in list2:
    list2_m.insert(2,['Perl','C++'])
print(list2)

実行結果

insert()で3次元リスト(List)の指定した位置に要素を追加しています。

そのため、下記のような結果が表示されています。

リスト(List)全体の指定した位置に要素を追加する場合

insert()でリスト(List)全体の指定した位置に要素を追加するには多次元リストをフラット化します。

フラット化にすることで多次元リストが1次元リストに変換されるため、リスト(List)全体を対象にすることができます。

● main.py

import itertools

print('● 対象の2次元リスト')
list1 = [
    ['JavaScript', 'C#'],['Python', 'Swift'], ['Ruby', 'Kotlin']
    ]
print(list1)

print('● insert()使用後-1')
list1_flat = list(itertools.chain.from_iterable(list1))
list1_flat.insert(1,'Java')
print(list1_flat)

print('● 対象の3次元リスト') 
list2 = [
    [['JavaScript', 'C#'],['Python', 'Swift']],
    [['Ruby', 'Kotlin'],['GO']]
    ]
print(list2)

print('● insert()使用後-2')
list2_flat_m = itertools.chain.from_iterable(list2)
list2_flat = list(itertools.chain.from_iterable(list2_flat_m))
list2_flat.insert(6,'C++')
print(list2_flat)

実行結果

insert()でリスト(List)全体の指定した位置に要素を追加しています。

そのため、下記のような結果が表示されています。

insert()を使用した実際のケース

insert()を使用した実際のケースについてご紹介します。

例えば、insert()を使用して入力したユーザーが登録された順番に表示されるようなコードを作成します。

● index.htmlとindex2.html

<!DOCTYPE html> 
<html lang="ja"> 
    <head> 
        <title>insert()でリストの指定した位置に要素を追加</title> 
        <meta charset="utf-8"/> 
    </head> 
    <body> 
        <h1>ユーザー一覧</h1>
        <h2>ユーザーを入力</h2> 
        <form action="/" method="POST">
            <div>
                <input type="text" name="item1">
            </div>
            <button type="submit">登録</button> 
        </form>
        <h2>登録されたユーザー</h2>
        <ul>
        {% for item in item_list: %} 
        <li>{{ item }}</li>
        {% endfor %}
        </ul>
    </body> 
</html>

● main.py

from flask import Flask, render_template, request
import time

app = Flask(__name__)

item_list = ['tanaka1234', 'suzuki5678', 'sato1919']
timestamp_list = [2302677700.8515599, 1532677700.385349, 932677700.1349]

@app.route('/') 
def index():
    
    return render_template('index.html', item_list = item_list) 

@app.route('/', methods=['POST']) 
def index2(): 

    item_val = request.form.get('item1')
    in_timestamp = time.time()

    cnt = 0
    for timestamp in timestamp_list:
        if(timestamp < in_timestamp):
            break
        else:
            cnt = cnt + 1
    
    timestamp_list.insert(cnt, timestamp)
    item_list.insert(cnt, item_val)

    return render_template('index2.html', item_list = item_list) 

if __name__ == '__main__': 
    app.run()

実行結果-1

実行結果-2

insert()で登録順に入力したユーザーを表示しています。

今回は下記のような処理を行っています。

そのため、結果1の場合は「yamada5789」が2番目に表示されています。

また、結果2の場合は他のユーザー名の登録時間が「yamada5789」の登録時間よりも最新であることから、4番目に表示されています。

insert()でリスト(List)以外の指定した位置に要素を追加する場合

ここでは、insert()でリスト(List)以外の指定した位置に要素を追加します。

タプル型の場合

タプル型にinsert()を使用することはできません。

そのため、list()で一度変換したリストに対して使用する必要があります。

● main.py

print('● 対象のリスト') 
tuple1 =('JavaScript', 'PHP', 'Python', 'C#', 'Java')
print(tuple1) 

print("● insert()使用後-1")
tuple1_list = list(tuple1)
tuple1_list.insert(3, 'Swift') 
print(tuple(tuple1_list))

print("● insert()使用後-2")
tuple1_list = list(tuple1_list)
tuple1_list.insert(-1, 'Kotlin') 
print(tuple(tuple1_list))

実行結果

insert()でタプル型の指定した位置に要素を追加しています。

今回は「0」と「2」と「4」を格納したリストに対して使用したため、1番目と3番目と5番目に「Java」が追加されています。

集合(set)型の場合

集合(set)型の場合もlist()で一度リストに変換する必要があります。

● main.py

print('● 対象の集合型') 
set1 = set(['JavaScript', 'PHP', 'Python', 'C#', 'Java'])
print(set1)

set_list1 = list(set1)
print("● insert()使用後-1")
set_list1.insert(2, 'Swift')
print(set(set_list1))

print("● insert()使用後-2") 
set_list1.insert(-2, 'Kotlin')
print(set(set_list1))

実行結果

insert()で集合(Set)型の指定した位置に要素を追加しています。

集合(Set)型は順番が決まっていないため、追加はされていますが、ランダムで格納されています。

不変な集合(frozenset)型の場合

不変な集合(frozenset)型に対してもinsert()を使用することはできません。

そのため、こちらもlist()で一度リストに変換する必要があります。

● main.py

print('● 対象の不変な集合型') 
fset1 = frozenset(['JavaScript', 'PHP', 'Python', 'C#', 'Java'])
print(fset1) 

fset_list1 = list(fset1)
print("● insert()使用後-1") 
fset_list1.insert(2, 'Swift')
print(frozenset(fset_list1)) 

print("● insert()使用後-2") 
fset_list1.insert(-2, 'Kotlin')
print(frozenset(fset_list1))

実行結果

insert()で不変な集合(frozenset)型の指定した位置に要素を追加しています。

不変な集合(frozenset)型もSet型同様に順番が決まっていないため、こちらもランダムで格納されています。

リスト(List)の指定した位置に要素を追加する他の方法

リスト(List)の指定した位置に要素を追加する他の方法としてスライスがあります。

スライスとは、オブジェクトの一部を切り取る機能になります。

そのため、切り取り開始位置と終了位置を同じインデックスで指定し、別のリストを指定することでリスト(List)の指定した位置に要素を追加することができます。

● main.py

print('● 対象のリスト') 
list1 = ['JavaScript', 'PHP', 'Python', 'C#', 'Java'] 
print(list1) 

print("● スライス使用後") 
list1[2:2] = ['Swift', 'VBA', 'C++']
print(list1)

実行結果

スライスでリスト(List)の指定した位置に要素を追加しています。

そのため「Swift」、「VBA」、「C++」の要素が3番目から追加されています。

まとめ