post_password_required

(2.7.0以降)
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

関連

  • get_the_content - 現在の投稿情報のコンテンツを取得する
  • get_the_password_form - パスワード保護されている投稿のパスワード入力フォームを取得する
  • $post - 投稿情報

お勧めコンテンツ

dashiconsの一覧表(2017年6月26日 登録)

管理画面のメニューなどで使用されるアイコンはバージョン3.8で追加されたdashiconsは実態はWebフォントであり、cssのクラス名で容易に利用できる。これまでプラグインを作る際に個別に調べたりしていたのだが、全体をパッと見たかったので整理してみた。

ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する(2013年12月17日 登録)

管理者向けページが刷新したWordPress 3.8。そのダッシュボードページにはサイトの状況を示す「概要(At a Glance)」ウィジェットがある。この中には「投稿」や「固定ページ」の投稿件数が表示されており、同じようにカスタム投稿タイプの投稿件数を表示できないか調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2016年12月19日 登録)

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

スクリプトファイルのバージョンパラメータを変更する(2015年2月10日 登録)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

32ピクセルのサイトアイコンを別の画像ファイルに変更する(2015年8月27日 登録)

「サイトアイコン」は4.3の新機能の1つ。管理画面で適当な画像ファイルを指定するだけでサイトアイコンが適用されます。そんなサイトアイコンで、既存の favicon.ico を併用する方法を紹介します。

最終更新日時 : 2017-01-11 15:45