get_the_password_form

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

説明

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

パラメータ

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

返り値

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

注意

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

使用例

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

フィルター

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

アクション

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

ソースファイル

/wp-includes/post-template.php

関連

参考

Code Reference: get_the_password_form

お勧めコンテンツ

カレンダーウィジェットをAjaxで切り替える（2011年8月22日 登録）

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

常時SSL接続に変更しました（2017年3月3日 登録）

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」（CentOS 6系、Apache 2.2系）上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

4.4では投稿ページも専用テンプレートが適用できる（2015年11月7日 登録）

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

投稿情報を連想配列で参照する（2014年11月16日 登録）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

RSSフィードの抜粋をさらに抜粋（2011年7月21日 登録）

RSSフィードはデフォルトでは「全文（HTMLタグを含む）」になっているが、管理画面の「表示設定」では「抜粋のみ（HTMLタグは除外）」を選択できる。それでも投稿記事が長いと、その抜粋テキストも長くなってしまう。ここではそんなRSSフィードの抜粋テキストを調整する方法を紹介する。

最終更新日時 : 2014-03-03 19:21