get_the_password_form

（1.0.0以降）
get_the_password_form - パスワード保護されている投稿のパスワード入力フォームを取得する

説明

string get_the_password_form( [ int | WP_Post $post = 0 ] )
パスワード保護されている投稿のパスワード入力フォームを取得する。

パラメータ

  • $post
    投稿IDまたは投稿情報を指定（省略時は0）。

返り値

パスワード入力フォームのHTMLテキストを返す。

注意

コンテンツを取得する get_the_content関数内において、投稿情報がパスワードで保護されている場合、この関数を呼び出している。自前で投稿記事のコンテンツを表示する場合は、本関数の呼び出しを考慮する必要はあるが、標準的に the_content関数で投稿記事のコンテンツを表示しているならば、本関数を意識する必要はない。

[5.8.0]'the_password_form'フィルターにパラメータ$postが追加された。

使用例

  • 現在の投稿情報のパスワード入力フォームを表示する。
    <?php echo get_the_password_form(); ?>

フィルター

パスワード入力フォームのHTMLテキストを返す直前に'the_password_form'フィルターを呼び出す。パラメータ$outputにはHTMLテキストが格納される。[5.8.0]$postには対象の投稿情報が格納される。 
return apply_filters( 'the_password_form', $output, $post );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/post-template.php

最終更新 : 2021年07月22日 12:18

関連

参考

Code Reference: get_the_password_form

お勧め

JavaScriptテンプレートを使ってみた（2018年8月21日 更新）

「前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日 更新）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

5.3の新機能：日付とタイムゾーン（2019年10月2日 更新）

「WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。

Login rebuilderのログ表示機能を紹介（2018年5月27日 更新）

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

さくらのVPSでKUSANAGI#3（2018年5月27日 更新）

今回は「前回」の続き。http（80番）をクローズ、そのほかに行った調整作業について整理する。