post_password_required

説明

bool post_password_required( [ mixed $post = null ] )
投稿ページがパスワード保護状態を調べる。

パラメータ

  • $post
    パスワード保護状態を調べる投稿情報またはその投稿IDを指定(省略時は現在の投稿情報を調べる)。

返り値

投稿ページがパスワード保護されていて利用者のクッキーにパスワードが含まれているか、パスワードが一致しない場合はtrueを返す。それ以外の場合はfalseを返す。

注意

パスワード保護は投稿情報別に設定されるもので、管理者ページの投稿編集の公開状態で変更できる(通常は一般公開)。

使用例

  • 現在の投稿ページのパスワード保護状態を調べる。
    <?php if ( post_password_required() ) { ?>

フィルター

[4.7.0]パスワードが必要かを返す前に'post_password_required'フィルターを呼び出す。パラメータ$requiredにはパスワードが必要かどうかの判定内容が、$postには対象の投稿情報(パラメータとして受け取った内容と異なる場合がある)が格納されている。
return apply_filters( 'post_password_required', $required, $post );

アクション

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

ソースファイル

/wp-includes/post-template.php

最終更新 : 2018年05月27日 10:49



お勧め

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

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

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

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。