この記事にはプロモーションが含まれています。

【WordPress】記事情報をCSV出力するボタンを投稿一覧画面に設置する

2025-03-22

この記事ではWordpressで

記事情報をCSV出力するボタンを投稿一覧画面に設置する方法

をご紹介します。

作成するボタン（イメージ）

この記事でわかること

WordPress管理画面にボタンを設置する方法
WordPress管理画面でPOST送信を実行する方法
記事一覧情報をCSVで出力する方法
WordPress管理画面で「フォーム送信」を動かすための仕組み

ケケンタ

今回ご紹介するソースコードを利用することで、記事ごとの記事IDやURLを一覧で出力することができます！

また、今回は「記事一覧情報をCSV出力する」という具体的な目的にそった内容となっていますが、当記事の内容を理解することでWordPressの管理画面上でフォーム送信処理を安全に書くことができるようになります。

ぜひ最後までご覧いただければ幸いです！

【WordPress】WP_Query（サブループ）の使い方とパラメータ一覧を紹介

【WordPress】functions.phpを編集する「３つ」の方法と編集時の注意点

【WordPress】JavaScriptはどこに書けばいい？「３つの方法」を解説

無料テーマCocoonからSWELLに乗り換えた７つの理由【WordPress】

あわせて読みたい

PHPやWordPressを学ぶのにおすすめのプログラミングスクール【７選】僕はこれまで独学でPHPを学習してきました。結論から言えば、それでもPHPを習得することはできました。しかし、それに費やした累計学習期間は１年ほど。モチベーション…

ケケンタ

ケケンタのITブログでは、Webアプリ（PHP・Laravel）やWeb制作（WordPress・コーディング）について情報を発信しています。
学習中の方や実務をされている方など多くの方にアクセスいただいていますので、ぜひほかの記事も参考にしてみてください！

運動不足、気になっていませんか？

もしプログラミング学習やお仕事で運動不足が気になっているなら

連続屈伸運動がおすすめです！

ボタンにカーソルを合わせるだけで
カウントダウンが始まるタイマーをご用意してみました！

ケケンタ

無理のない範囲で、ぜひ隙間時間に屈伸運動を取り入れてみて下さい！

タイマースタート

3:00

1分 3分 5分 10分

※運動不足だと連続３分で取り組んでもかなり息が切れます。
（僕は加えて気分もちょっと悪くなりました……）
絶対にご無理の無い範囲でお取り組みください！

Laravelの教科書バージョン10対応【Laravel11サポートガイドあり】

created by Rinker

¥3,000 (2025/03/29 08:10:56時点 Amazon調べ-詳細)

【結論】ソースコード

今回使用するファイルはfunctions.phpのみです。

以下のソースコードをfunctions.phpに記述するだけで「記事の一覧情報をCSV出力するボタン」を投稿一覧画面に表示できます。

ソースコード（functions.php）

/**
 * CSVファイルを生成して出力する。
 */
function createCsvPostList()
{
	if (isset($_POST['csv-output']) && $_POST['csv-output'] === 'true') {
		// セキュリティチェック
		if (!isset($_POST['nonce']) || !wp_verify_nonce($_POST['nonce'], 'csv-output-action')) {
			wp_die('セキュリティチェックに失敗しました。');
		}

		// CSVファイル名
		$file_name = '記事PV出力_' . date('Ymd_His') . '.csv';

		// CSVダウンロード用のヘッダーを設定
		header('Content-Type: text/csv; charset=utf-8');
		header('Content-Disposition: attachment; filename="' . $file_name . '"');

		// 出力ストリームに接続されたファイルポインタを作成
		$output = fopen('php://output', 'w');

		// Excel互換のためにUTF-8 BOM（バイトオーダーマーク）を追加
		fwrite($output, "\xEF\xBB\xBF");

		// CSVヘッダー行
		fputcsv($output, ['記事ID', '記事タイトル', '記事URL']);

		// 公開済みの記事を全て取得
		$args = [
			'post_type'      => 'post',
			'post_status'    => 'publish',
			'posts_per_page' => -1, // 全ての記事を取得
		];
		$posts = new WP_Query($args);

		// 記事が見つからなかった場合の処理
		if (!$posts->have_posts()) {
			fputcsv($output, ['記事が見つかりませんでした。']);
			fclose($output);
			exit;
		}

		// 記事の処理件数をカウント
		$post_count = 0;

		if ($posts->have_posts()) {
			while ($posts->have_posts()) {
				$posts->the_post();

				// 記事の処理件数をカウントアップ
				$post_count++;

				// 記事IDとタイトルを取得
				$post_id    = get_the_ID();
				$post_title = get_the_title();
				$post_url = get_permalink();

				// CSVにデータを追加
				fputcsv($output, [$post_id, $post_title, $post_url]);
			}
			wp_reset_postdata();
		}

		// 処理件数をCSVに出力
		fputcsv($output, ['処理件数：' . $post_count . '件']);

		// ファイルポインタを閉じる
		fclose($output);

		// これ以上の出力を防ぐために終了
		exit;
	}
}

/**
 * 管理画面の投稿一覧画面にCSV出力ボタンを追加する
 */
function addCsvExportButtonToPostList()
{
    global $pagenow;

    // 投稿一覧画面でのみ実行
    if ('edit.php' === $pagenow) {
?>
        <form method="post" action="<?php echo admin_url('admin-post.php'); ?>" style="display: inline-block; position: fixed; right: 30px; bottom: 30px;">
            <input type="hidden" name="action" value="csv_export">
            <?php wp_nonce_field('csv-output-action', 'nonce'); ?>
            <input type="hidden" name="csv-output" value="true">
            <button type="submit" class="csv-output-btn">記事情報をCSV出力</button>
        </form>
<?php
    }
}
add_action('admin_footer', 'addCsvExportButtonToPostList');

/**
 * CSV出力処理を実行
 */
add_action('admin_post_csv_export', 'createCsvPostList');
add_action('admin_post_nopriv_csv_export', 'createCsvPostList');

functions.phpの編集方法については以下の記事で詳しく解説しています。

あわせて読みたい

【WordPress】functions.phpを編集する「３つ」の方法と編集時の注意点 WordPressで機能カスタマイズをする際は、必ずと言っていいほどfunctions.phpを編集することになります。しかし、functions.phpを編集したことで何らかのエラーが発生…

解説

簡単にソースコードの解説をします。

ポイント（３つ）

① createCsvPostList(): CSVファイルの出力を行う関数
② addCsvExportButtonToPostList(): 投稿一覧画面にCSV出力処理を実行するためのボタンを設置する関数
（＝createCsvPostList()を実行するためのボタン）
③ add_action(‘admin_post_〇〇〇’, ‘●●●●●’);: WordPress管理画面内でPOST送信を実行するために必要なアクションフック

① createCsvPostList()

createCsvPostList()はCSVファイルの出力を行う関数です。この関数が実行されることで、ローカルPC上に記事一覧情報がCSVファイルでダウンロードされます。

/**
 * CSVファイルを生成して出力する。
 */
function createCsvPostList()
{
	if (isset($_POST['csv-output']) && $_POST['csv-output'] === 'true') {
		// セキュリティチェック
		if (!isset($_POST['nonce']) || !wp_verify_nonce($_POST['nonce'], 'csv-output-action')) {
			wp_die('セキュリティチェックに失敗しました。');
		}

		// CSVファイル名
		$file_name = '記事PV出力_' . date('Ymd_His') . '.csv';

		// CSVダウンロード用のヘッダーを設定
		header('Content-Type: text/csv; charset=utf-8');
		header('Content-Disposition: attachment; filename="' . $file_name . '"');

		// 出力ストリームに接続されたファイルポインタを作成
		$output = fopen('php://output', 'w');

		// Excel互換のためにUTF-8 BOM（バイトオーダーマーク）を追加
		fwrite($output, "\xEF\xBB\xBF");

		// CSVヘッダー行
		fputcsv($output, ['記事ID', '記事タイトル', '記事URL']);

		// 公開済みの記事を全て取得
		$args = [
			'post_type'      => 'post',
			'post_status'    => 'publish',
			'posts_per_page' => -1, // 全ての記事を取得
		];
		$posts = new WP_Query($args);

		// 記事が見つからなかった場合の処理
		if (!$posts->have_posts()) {
			fputcsv($output, ['記事が見つかりませんでした。']);
			fclose($output);
			exit;
		}

		// 記事の処理件数をカウント
		$post_count = 0;

		if ($posts->have_posts()) {
			while ($posts->have_posts()) {
				$posts->the_post();

				// 記事の処理件数をカウントアップ
				$post_count++;

				// 記事IDとタイトルを取得
				$post_id    = get_the_ID();
				$post_title = get_the_title();
				$post_url = get_permalink();

				// CSVにデータを追加
				fputcsv($output, [$post_id, $post_title, $post_url]);
			}
			wp_reset_postdata();
		}

		// 処理件数をCSVに出力
		fputcsv($output, ['処理件数：' . $post_count . '件']);

		// ファイルポインタを閉じる
		fclose($output);

		// これ以上の出力を防ぐために終了
		exit;
	}
}

上から順番に、主要なソースコードの解説をします。

if (isset($_POST['csv-output']) && $_POST['csv-output'] === 'true'){
    ～省略～
}

name属性がcsv-outputでvalue属性がtrueとなっているボタンからPOST送信があった場合にのみ、CSV出力処理が実行されるよう制御しています。

// セキュリティチェック
if (!isset($_POST['nonce']) || !wp_verify_nonce($_POST['nonce'], 'csv-output-action')) {
	wp_die('セキュリティチェックに失敗しました。');
}

WordPressにはnonceという仕組みが用意されています。いわゆるCSRF攻撃対策のために、上記のセキュリティチェック処理が必須です。

CSRF対策については以下の記事で詳しく解説しています。

あわせて読みたい

【CSRF】攻撃の流れやPHPでの対策方法を解説【クロスサイトリクエストフォージェリ】 Webサイトへのセキュリティ攻撃の１つにCSRF（クロスサイトリクエストフォージェリ）というものがあります。この記事では、 CSRFの攻撃の流れ攻撃による影響・被害 PH…

具体的には、ボタンをクリックしたときにトークン（ランダムな文字列）も一緒にPOST送信し、上記のソースコードで「このPOST送信は受け取って問題のないものか？（攻撃者によるリクエストではないか？）」を判定しています。

POST送信を行うようなWebアプリでは、必ずこのようにトークンを用いて正規のリクエストかどうかを判定する必要があります。

ケケンタ

CSRF対策をしておかないと、例えば、「アクセス情報を改ざん → 不正にアクセスされる」といった被害が発生する可能性があります！

// CSVファイル名
$file_name = '記事PV出力_' . date('Ymd_His') . '.csv';

コメントにもあるように、ここでCSVファイルの名前を設定しています。ファイルの上書きを防ぐためにも、基本的には日時情報を含めることで、ファイル名が必ず一意となるようにすることをオススメします。

// CSVダウンロード用のヘッダーを設定
header('Content-Type: text/csv; charset=utf-8');
header('Content-Disposition: attachment; filename="' . $fileName . '"');

ここではヘッダー情報を設定しています。

Content-Type: text/csv;　……　ファイル形式をCSVに設定
Content-Disposition: attachment;　……　attachmentを指定することで、「このファイルがダウンロードするべきもの」ということをブラウザへ伝えています。

// CSVヘッダー行
fputcsv($output, ['記事ID', '記事タイトル', '記事URL']);

CSVファイルに出力する各列の項目名を設定しています。出力する情報や出力する順番などに応じてご調整ください。

// 公開済みの記事を全て取得
$args = [
	'post_type'      => 'post',
	'post_status'    => 'publish',
	'posts_per_page' => -1, // 全ての記事を取得
];
$posts = new WP_Query($args);

ここではすべての記事情報を取得しています。行っていることは、サブループの生成とまったく同じです。

上記のソースコードでは「公開済み」の記事を対象としていますが、別のオプションや複数のオプションを同時に指定することも可能です。

サブループ（WP_Query）については以下の記事で詳しく解説しています。
※「投稿状態のオプション」については下記記事の投稿の状態（公開・下書きなど）の章をご覧ください。

あわせて読みたい

【WordPress】WP_Query（サブループ）の使い方とパラメータ一覧を紹介 WordPressでサイト制作をしているとメインの記事一覧以外に「別の記事一覧も出力したい！」となることが多々あります。今回はそこで深く関係してくるメインループ、サ…

if ($posts->have_posts()) {
	while ($posts->have_posts()) {
		$posts->the_post();

		// 記事の処理件数をカウントアップ
		$post_count++;

		// 記事IDとタイトルを取得
		$post_id    = get_the_ID();
		$post_title = get_the_title();
		$post_url = get_permalink();

		// CSVにデータを追加
		fputcsv($output, [$post_id, $post_title, $post_url]);
	}
	wp_reset_postdata();
}

サブループを利用したことがある方ならお馴染みのループ処理です。ページ制作のときはここでHTMLタグを使用して記事情報を出力しますが、今回はCSVファイルへ出力するデータとして、記事情報をピックアップしています。

もしカテゴリーやタグ情報も必要な場合は、この処理内でget_the_category()などのテンプレートタグを使用してご自由にカスタマイズ可能です。

② addCsvExportButtonToPostList()

続いて、投稿一覧画面にCSV出力処理を実行するためのボタンを表示するソースコードの解説です。

/**
 * 管理画面の投稿一覧画面にCSV出力ボタンを追加する
 */
function addCsvExportButtonToPostList()
{
    global $pagenow;

    // 投稿一覧画面でのみ実行
    if ('edit.php' === $pagenow) {
?>
        <form method="post" action="<?php echo admin_url('admin-post.php'); ?>" style="display: inline-block; position: fixed; right: 30px; bottom: 30px;">
            <input type="hidden" name="action" value="csv_export">
            <?php wp_nonce_field('csv-output-action', 'nonce'); ?>
            <input type="hidden" name="csv-output" value="true">
            <button type="submit" class="csv-output-btn">記事情報をCSV出力</button>
        </form>
<?php
    }
}
add_action('admin_footer', 'addCsvExportButtonToPostList');

global $pagenow;

// 投稿一覧画面でのみ実行
if ('edit.php' === $pagenow) {
    ～省略～
}

global $pagenow;により、「現在表示中のページ情報」を取得することができます。また、「投稿一覧画面＝edit.php」のため、if分でいまいるページが投稿一覧画面かどうかを判定しています。

<!-- ボタンは画面右下に固定表示する -->
<form method="post" action="<?php echo admin_url('admin-post.php'); ?>" style="display: inline-block; position: fixed; bottom: 30px; right: 30px;">
	<input type="hidden" name="action" value="csv_export">
	<?php wp_nonce_field('csv-output-action', 'nonce'); ?>
	<input type="hidden" name="csv-output" value="true">
	<button type="submit" class="csv-output-btn">PV数をCSV出力</button>
</form>

ここで投稿一覧画面に表示するボタンのHTMLを記述しています。

action=”<?php echo admin_url(‘admin-post.php’); ?>”でPOST送信先URLを自動生成
ハイライト行でWordpressのwp_nonce_field関数を利用し、トークンを生成
formタグに直接style属性を持たせ、position: fixed;で固定表示

WordPressでは管理画面内でフォーム送信を処理するためのファイルとしてadmin-post.phpが準備されています。action属性では、admin_url()関数を使用することで、admin-post.phpへPOST送信するためのURLを生成しています。

また、wp_nonce_field関数によって、自動的にトークンを持つinputタグが生成されます。

wp_nonce_field関数によって自動生成されるinputタグ

add_action('admin_footer', 'addCsvExportButtonToPostList');

最後に、アクションフックadmin_footerにaddCsvExportButtonToPostList()関数をフックすることで、投稿一覧画面のフッター部分（</body>タグの直前）でボタンのHTMLが出力されるよう設定しています。

admin_footerフックを使用した場合、HTMLの出力箇所をCSSで調整する必要があります。今回はわかりやすくする意味でposition: fixed;による固定配置としました。

③ add_action(‘admin_post_〇〇〇’, ‘●●●●●’);

３つ目のポイントとなるソースコードは、以下の２行です。

/**
 * CSV出力処理を実行
 */
add_action('admin_post_csv_export', 'createCsvPostList');
add_action('admin_post_nopriv_csv_export', 'createCsvPostList');

先ほどadmin-post.phpについて触れました。

上記２行のソースコードは、admin-post.phpで実行するための関数を登録するためのものです。admin-post.phpは、フォーム送信されたデータに含まれる「action属性の値」にもとづき、登録されているアクション（関数）を実行します。

具体的にはadmin_post_{action} というアクションフックに登録された関数が実行されるという仕組みになっています。

例えば今回のソースコードを見ると、formタグ内にあるinputタグのひとつにvalue="csv_export"が設定されています。（つまりフォームデータにcsv_exportが含まれる）

一方、アクションフックではadd_action('admin_post_csv_export', 'createCsvPostList'); のように、createCsvPostList()関数をフックしています。

これにより、投稿一覧画面のボタンを押すことでcreateCsvPostList()＝CSV出力処理が実行されるという仕組みになっています。

なお、admin_post_nopriv_csv_exportアクションフックについては、本来は非ログインユーザー向けのものです。一見すると不要にも思えますが、セキュリティの互換性から、admin_post_{action}とadmin_post_nopriv_{action}は併記することが推奨されています。