get_post_meta( int $post_id, string $key = '', bool $single = false )
Retrieves a post meta field for the given post ID.
Parameters
- $post_id
-
(Required) Post ID.
- $key
-
(Optional) The meta key to retrieve. By default, returns data for all keys.
Default value: ''
- $single
-
(Optional) Whether to return a single value.<br> This parameter has no effect if
$keyis not specified.<br>Default value: false
Return
(mixed) An array of values if $single is false.<br> The value of the meta field if $single is true.<br> False for an invalid $post_id (non-numeric, zero, or negative value).<br> An empty string if a valid but non-existing post ID is passed.
Source
File: wp-includes/post.php
function get_post_meta( $post_id, $key = '', $single = false ) {
return get_metadata('post', $post_id, $key, $single);
}
Related
Uses
| Uses | Description |
|---|---|
| wp-includes/meta.php: get_metadata() |
Retrieves the value of a metadata field for the specified object type and ID. |
Used By
| Used By | Description |
|---|---|
| wp-admin/includes/template.php: get_media_states() |
Retrieves an array of media states from an attachment. |
| wp-admin/includes/template.php: get_post_states() |
Retrieves an array of post states from a post. |
| wp-admin/includes/class-wp-media-list-table.php: WP_Media_List_Table::column_alt() |
Handles the alt text column output. |
| wp-admin/includes/ajax-actions.php: wp_ajax_quick_edit_attachment() |
Ajax handler for updating attachment values and attributes. |
| wp-includes/nav-menu.php: update_menu_item_cache() |
Updates post and term caches for all linked objects for a list of menu items. |
| wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php: WP_REST_Attachments_Controller::edit_media_item() |
Applies edits to a media item and creates a new attachment record. |
| wp-includes/author-template.php: get_the_modified_author() |
Retrieves the author who last edited the current post. |
| wp-includes/general-template.php: get_login_image_html() |
Return the HTML for the image on the login screen. This is either a link showing the ClassicPress logo (the default) or the site’s custom login image (if enabled). |
| wp-includes/general-template.php: get_custom_logo() |
Returns a custom logo, linked to home unless the theme supports removing the link on the home page. |
| wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php: WP_REST_Attachments_Controller::prepare_item_for_response() |
Prepares a single attachment output for response. |
| wp-includes/class-wp-post.php: WP_Post::__get() |
Getter. |
| wp-includes/nav-menu.php: wp_update_nav_menu_item() |
Saves the properties of a menu item or create a new one. |
| wp-includes/nav-menu.php: wp_setup_nav_menu_item() |
Decorates a menu item object with the shared navigation menu item properties. |
| wp-includes/nav-menu.php: wp_get_associated_nav_menu_items() |
Returns the menu items associated with a particular object. |
| wp-includes/nav-menu-template.php: _wp_menu_item_classes_by_context() |
Adds the class property classes for the current context, if applicable. |
| wp-includes/class-wp-embed.php: WP_Embed::shortcode() |
The do_shortcode() callback function. |
| wp-includes/capabilities.php: map_meta_cap() |
Maps a capability to the primitive capabilities required of the given user to satisfy the capability being checked. |
| wp-includes/class-wp-user-request.php: WP_User_Request::__construct() |
Constructor. |
| wp-includes/user.php: _wp_privacy_send_request_confirmation_notification() |
Notifies the site administrator via email when a request is confirmed. |
| wp-includes/user.php: _wp_privacy_send_erasure_fulfillment_notification() |
Notifies the user when their erasure request is fulfilled. |
| wp-includes/theme.php: get_header_image_tag() |
Creates image tag markup for a custom header image. |
| wp-includes/theme.php: get_uploaded_header_images() |
Gets the header images uploaded for the active theme. |
| wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::add_enclosure_if_new() |
Adds an enclosure to a post if it’s new. |
| wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_post() |
Prepares post data for return in an XML-RPC object. |
| wp-includes/post-thumbnail-template.php: get_post_thumbnail_id() |
Retrieves the post thumbnail ID. |
| wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::import_theme_starter_content() |
Imports theme starter content into the customized state. |
| wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::set_changeset_lock() |
Marks the changeset post as being currently edited by the current user. |
| wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::refresh_changeset_lock() |
Refreshes changeset lock with the current time if current user edited the changeset before. |
| wp-includes/post-template.php: get_page_template_slug() |
Gets the specific template filename for a given post. |
| wp-includes/post.php: wp_check_for_changed_slugs() |
Checks for changed slugs for published post objects and save the old slug. |
| wp-includes/post.php: wp_check_for_changed_dates() |
Checks for changed dates for published post objects and save the old date. |
| wp-includes/post.php: wp_delete_attachment() |
Trashes or deletes an attachment. |
| wp-includes/post.php: wp_get_attachment_metadata() |
Retrieves attachment metadata for attachment ID. |
| wp-includes/post.php: wp_get_attachment_url() |
Retrieves the URL for an attachment. |
| wp-includes/post.php: wp_untrash_post() |
Restores a post from the Trash. |
| wp-includes/post.php: wp_untrash_post_comments() |
Restores comments for a post from the Trash. |
| wp-includes/post.php: wp_insert_post() |
Inserts or update a post. |
| wp-includes/post.php: get_post_custom() |
Retrieves post meta fields, based on post ID. |
| wp-includes/post.php: get_post_status() |
Retrieves the post status based on the post ID. |
| wp-includes/post.php: get_attached_file() |
Retrieves attached file path based on attachment ID. |
| wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::save_nav_menus_created_posts() |
Publishes the auto-draft posts that were created for nav menu items. |
| wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::get_uploaded_header_images() |
Gets the previously uploaded header images. |
| wp-admin/includes/class-wp-privacy-policy-content.php: WP_Privacy_Policy_Content::text_change_check() |
Quick check if any privacy info has changed. |
| wp-admin/includes/class-wp-privacy-policy-content.php: WP_Privacy_Policy_Content::_policy_page_updated() |
Update the cached policy info when the policy page is updated. |
| wp-admin/includes/class-wp-privacy-policy-content.php: WP_Privacy_Policy_Content::get_suggested_policy_text() |
Check for updated, added or removed privacy policy information from plugins. |
| wp-admin/includes/media.php: edit_form_image_editor() |
Displays the image and editor in the post editor |
| wp-admin/includes/media.php: get_attachment_fields_to_edit() |
Retrieves the attachment fields to edit form fields. |
| wp-admin/includes/media.php: media_upload_form_handler() |
Handles form submissions for the legacy media uploader. |
| wp-admin/includes/image-edit.php: wp_save_image() |
Saves image to post, along with enqueued changes in |
| wp-admin/includes/image-edit.php: wp_image_editor() |
Loads the WP image-editing interface. |
| wp-admin/includes/image-edit.php: wp_restore_image() |
Restores the metadata for a given attachment. |
| wp-admin/includes/ajax-actions.php: wp_ajax_crop_image() |
Ajax handler for cropping an image. |
| wp-admin/includes/ajax-actions.php: wp_ajax_wp_fullscreen_save_post() |
Ajax handler for saving posts from the fullscreen editor. |
| wp-admin/includes/ajax-actions.php: wp_ajax_save_attachment() |
Ajax handler for updating attachment attributes. |
| wp-admin/includes/meta-boxes.php: post_thumbnail_meta_box() |
Displays post thumbnail meta box. |
| wp-admin/includes/meta-boxes.php: post_submit_meta_box() |
Displays post submit form fields. |
| wp-admin/includes/privacy-tools.php: wp_privacy_generate_personal_data_export_file() |
Generate the personal data export file. |
| wp-admin/includes/privacy-tools.php: wp_privacy_send_personal_data_export_email() |
Send an email to the user with a link to the personal data export file |
| wp-admin/includes/privacy-tools.php: wp_privacy_process_personal_data_export_page() |
Intercept personal data exporter page Ajax responses in order to assemble the personal data export file. |
| wp-admin/includes/post.php: wp_check_post_lock() |
Determines whether the post is currently being edited by another user. |
| wp-admin/includes/post.php: edit_post() |
Updates an existing post with values provided in |
Changelog
| Version | Description |
|---|---|
| 1.5.0 | Introduced. |