概要
get_the_modified_time関数は、投稿の更新時刻を取得するための関数です。この関数は、主にWordPressの投稿またはページの更新日時を表示する際に使用されます。以下に挙げる機能の実装時にもよく利用されます。
- 投稿一覧に更新日時を表示する
- 個別投稿ページに更新情報を表示する
- RSSフィードに更新日時を追加する
- カスタム投稿タイプの更新日時を表示する
- 更新情報を表示するウィジェットを作成する
- コメントセクションに更新日時を表示する
- メタデータに更新日を表示する
- セマンティックHTMLでのマークアップに利用する
構文
get_the_modified_time( $format, $gmt );
パラメータ
$format(string): 日付フォーマットを指定する（例: ‘Y-m-d H:i:s’）。$gmt(bool): UTC時間を取得するかどうかを指定する（デフォルトはfalse）。
戻り値
- (string): 指定された形式でフォーマットされた更新日時を返します。
関連する関数
ワードプレスのバージョン
- この関数は、WordPressバージョン 1.5 以降で使用可能です。
- 現在までに非推奨または削除されたバージョンはありません。
コアファイルのパス
wp-includes/post.php
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head | 〇 |
サンプルコード
サンプル1: 更新時刻の表示
// 投稿の更新時刻を表示する
echo 'Last updated on: ' . get_the_modified_time('Y-m-d H:i:s');
このコードは、投稿の更新時刻を指定したフォーマットで表示します。
サンプル2: カスタムフォーマットでの表示
// 投稿の更新時刻をカスタムフォーマットで表示する
$modified_time = get_the_modified_time('F j, Y');
echo 'Updated on: ' . $modified_time;
このコードは、更新時刻を「月 日, 年」の形式で表示します。
サンプル3: GMTでの更新時刻取得
// 投稿のGMT更新時刻を取得
$gmt_modified_time = get_the_modified_time('Y-m-d H:i:s', true);
echo 'GMT Updated: ' . $gmt_modified_time;
このコードは、投稿のGMT更新時刻をフォーマットして表示します。
サンプル4: 投稿のメタデータとして更新時刻
// 投稿のメタデータに更新時刻を追加
function add_modified_time_meta() {
echo '<meta name="modified_time" content="' . get_the_modified_time('Y-m-d H:i:s') . '">';
}
add_action('wp_head', 'add_modified_time_meta');
このコードは、投稿のヘッダーに更新時刻をメタデータとして追加します。
サンプル5: RSSフィードに更新時刻を追加
// RSSフィードに更新時刻を追加
function add_modified_time_to_rss() {
if (is_feed()) {
echo '<lastBuildDate>' . get_the_modified_time('D, d M Y H:i:s O') . '</lastBuildDate>';
}
}
add_action('ws_feed', 'add_modified_time_to_rss');
このコードは、RSSフィードに投稿の更新時刻を追加します。