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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

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

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。