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

最終更新 : 2014年03月03日 19:21



お勧め

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

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

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。