説明
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
関連
お勧め
スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)
PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)
固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。
適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす(2019年5月24日 更新)
/wp-includes/template-loader.phpではリクエストされたページに応じて現在のテーマにあるテンプレートファイルの中から適切なものを選びに振り分けている。ここでは、さまざまなテンプレートファイルの種類と、テンプレートファイルが省略された場合の内部の動作についてまとめてみる。管理者ページに文言を表示する(2012年4月19日 更新)
お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。5.3の機能強化:ユーザーパスワードの表示と非表示(2019年9月30日 更新)
「WordPress 5.3 Beta 1」に記載されていた「Toggle password view」という項目。「Other Changes for Developers」の見出しの中ということもあり、ちょっと調べてみた。