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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

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

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

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。