ワードプレスのget_lastpostmodified関数の使用方法・解説

概要

get_lastpostmodified関数は、WordPressにおいて投稿記事の最終更新日時を取得するために使用される重要な関数です。主に以下のような機能を実装する際に活用されます。

1. 投稿一覧の最終更新日時を表示する
2. カスタムテンプレートでの投稿の新旧情報を表示する
3. RSSフィードでの投稿の更新情報を提供する
4. アーカイブページでの投稿の更新情報を強調する
5. 最新の更新情報に基づくキャッシュ機構を実装する
6. 管理画面での投稿の編集履歴を表示する
7. SEOの観点からのサイト更新日時のフィード提供
8. イベントの更新情報をユーザーに通知する

構文

string get_lastpostmodified( string $timezone = '' );

パラメータ

• $timezone (string) : オプションの引数で、取得する日時のタイムゾーンを指定します。空白の場合はデフォルトのタイムゾーンが使用されます。

戻り値

• 最終更新日時が文字列形式で返されます。更新日時が存在しない場合は空の文字列が返されます。

関連する関数

• get_post_modified_time
• get_post

使用可能なバージョン

この関数はWordPress 2.0.0以降で使用可能です。

コアファイルのパス

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 '最終更新日時: ' . get_lastpostmodified();
   

   このコードは、サイト上で最新の投稿の最終更新日時を表示します。

2. カスタムタイムゾーンで最終更新日時を取得

   $modified_time = get_lastpostmodified('Asia/Tokyo');
   echo '最終更新日時（東京時間）: ' . $modified_time;
   

   このコードは、東京のタイムゾーンで最終更新日時を取得し表示します。

3. 特定の投稿タイプの最終更新日時を取得

   $modified_time = get_lastpostmodified('post');
   echo '最新の投稿の最終更新日時: ' . $modified_time;
   

   このコードは、特定の投稿タイプに対する最新の投稿の最終更新日時を表示します。

4. 最終更新日時をRSSフィードで表示

   add_action('rss2_item', function() {
      echo '<lastBuildDate>' . get_lastpostmodified() . '</lastBuildDate>';
   });
   

   このコードは、RSSアイテムに最終更新日時を追加します。

5. WP Rest APIのエンドポイントに最終更新日時を追加

   add_action('rest_api_init', function() {
      register_rest_field('post', 'last_modified', [
          'get_callback' => function($data) {
              return get_lastpostmodified();
          }
      ]);
   });
   

   このコードは、投稿のREST APIエンドポイントに最終更新日時を追加します。