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



お勧め

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

ブロックエディターをちょっとだけカスタマイズしてみる(2021年11月3日 更新)

ブロックエディターで投稿を編集していると「ここは〇〇だったらいいのにな」と思うところがある。今回は、そんな気になるところをいくつか(自分好みに)調整してみた。

Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 更新)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。