ワードプレスのis_post_publicly_viewable関数の使用方法・解説

概要

is_post_publicly_viewable関数は、特定の投稿が一般公開されているかどうかを確認するために使用される関数です。この関数は、投稿のステータスやその可視性に基づいて、ユーザーが投稿を見ることができるかどうかを判断する際に役立ちます。この関数は、以下のような機能を実装する際によく使用されます。

1. ページや投稿の認可確認
2. カスタムテンプレートの条件分岐
3. 短縮コードのアクセス制御
4. ユーザーごとのコンテンツ表示の管理
5. プライベート投稿の扱いに関する条件判断
6. 投稿リストにおけるフィルタリング
7. パスワード保護された投稿の確認
8. ユーザーがログインしているかどうかの検証

構文

is_post_publicly_viewable( $post = null );

パラメータ

• $post (mixed): (オプショナル) 投稿オブジェクトまたは投稿ID。指定しない場合は、グローバル $post が使用されます。

戻り値

• (bool): 投稿が一般公開されている場合は true、そうでない場合は false を返します。

関連する関数

• get_post()
• post_type_supports()

使用可能なバージョン

is_post_publicly_viewable関数はWordPress 4.7.0以降で使用可能です。

コアファイルパス

is_post_publicly_viewable関数は、wp-includes/post.phpに含まれています。

この関数のアクションでの使用可能性

アクション	使用例
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp	〇
template_redirect
get_header
wp_head

非推奨または削除されたバージョン

この関数は、特定のバージョンで非推奨または削除されたという情報はありません。