| [ Index ] |
WordPress Cross Reference |
[Source view] [Print] [Project Stats]
Post functions and post utility function.
| File Size: | 5076 lines (167 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| create_initial_post_types() X-Ref |
| Creates the initial post types when 'init' action is fired. |
| get_attached_file( $attachment_id, $unfiltered = false ) X-Ref |
| Retrieve attached file path based on attachment ID. By default the path will go through the 'get_attached_file' filter, but passing a true to the $unfiltered argument of get_attached_file() will return the file path unfiltered. The function works by getting the single post meta name, named '_wp_attached_file' and returning it. This is a convenience function to prevent looking up the meta name and provide a mechanism for sending the attached filename through a filter. param: int $attachment_id Attachment ID. param: bool $unfiltered Whether to apply filters. return: string|bool The file path to where the attached file should be, false otherwise. |
| update_attached_file( $attachment_id, $file ) X-Ref |
| Update attachment file path based on attachment ID. Used to update the file path of the attachment, which uses post meta name '_wp_attached_file' to store the path of the attachment. param: int $attachment_id Attachment ID param: string $file File path for the attachment return: bool True on success, false on failure. |
| _wp_relative_upload_path( $path ) X-Ref |
| Return relative path to an uploaded file. The path is relative to the current upload dir. param: string $path Full path to the file return: string relative path on success, unchanged path on failure. |
| get_children($args = '', $output = OBJECT) X-Ref |
| Retrieve all children of the post parent ID. Normally, without any enhancements, the children would apply to pages. In the context of the inner workings of WordPress, pages, posts, and attachments share the same table, so therefore the functionality could apply to any one of them. It is then noted that while this function does not work on posts, it does not mean that it won't work on posts. It is recommended that you know what context you wish to retrieve the children of. Attachments may also be made the child of a post, so if that is an accurate statement (which needs to be verified), it would then be possible to get all of the attachments for a post. Attachments have since changed since version 2.5, so this is most likely unaccurate, but serves generally as an example of what is possible. The arguments listed as defaults are for this function and also of the {@link get_posts()} function. The arguments are combined with the get_children defaults and are then passed to the {@link get_posts()} function, which accepts additional arguments. You can replace the defaults in this function, listed below and the additional arguments listed in the {@link get_posts()} function. The 'post_parent' is the most important argument and important attention needs to be paid to the $args parameter. If you pass either an object or an integer (number), then just the 'post_parent' is grabbed and everything else is lost. If you don't specify any arguments, then it is assumed that you are in The Loop and the post parent will be grabbed for from the current post. The 'post_parent' argument is the ID to get the children. The 'numberposts' is the amount of posts to retrieve that has a default of '-1', which is used to get all of the posts. Giving a number higher than 0 will only retrieve that amount of posts. The 'post_type' and 'post_status' arguments can be used to choose what criteria of posts to retrieve. The 'post_type' can be anything, but WordPress post types are 'post', 'pages', and 'attachments'. The 'post_status' argument will accept any post status within the write administration panels. param: mixed $args Optional. User defined arguments for replacing the defaults. param: string $output Optional. Constant for return type, either OBJECT (default), ARRAY_A, ARRAY_N. return: array|bool False on failure and the type will be determined by $output parameter. |
| get_extended($post) X-Ref |
| Get extended entry info (<!--more-->). There should not be any space after the second dash and before the word 'more'. There can be text or space(s) after the word 'more', but won't be referenced. The returned array has 'main', 'extended', and 'more_text' keys. Main has the text before the <code><!--more--></code>. The 'extended' key has the content after the <code><!--more--></code> comment. The 'more_text' key has the custom "Read More" text. param: string $post Post content. return: array Post before ('main'), after ('extended'), and custom readmore ('more_text'). |
| get_post( $post = null, $output = OBJECT, $filter = 'raw' ) X-Ref |
| Retrieves post data given a post ID or post object. See {@link sanitize_post()} for optional $filter values. Also, the parameter $post, must be given as a variable, since it is passed by reference. param: int|object $post Post ID or post object. Optional, default is the current post from the loop. param: string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N. param: string $filter Optional, default is raw. return: WP_Post|null WP_Post on success or null on failure |
| get_instance( $post_id ) X-Ref |
| Stores the post object's sanitization level. Does not correspond to a DB field. |
| __construct( $post ) X-Ref |
| No description |
| __isset( $key ) X-Ref |
| No description |
| __get( $key ) X-Ref |
| No description |
| filter( $filter ) X-Ref |
| No description |
| to_array() X-Ref |
| No description |
| get_post_ancestors( $post ) X-Ref |
| Retrieve ancestors of a post. param: int|object $post Post ID or post object return: array Ancestor IDs or empty array if none are found. |
| get_post_field( $field, $post, $context = 'display' ) X-Ref |
| Retrieve data from a post field based on Post ID. Examples of the post field will be, 'post_type', 'post_status', 'post_content', etc and based off of the post object property or key names. The context values are based off of the taxonomy filter functions and supported values are found within those functions. param: string $field Post field name. param: int|object $post Post ID or post object. param: string $context Optional. How to filter the field. Default is 'display'. return: string The value of the post field on success, empty string on failure. |
| get_post_mime_type($ID = '') X-Ref |
| Retrieve the mime type of an attachment based on the ID. This function can be used with any post type, but it makes more sense with attachments. param: int $ID Optional. Post ID. Default is the current post from the loop. return: string|bool The mime type on success, false on failure. |
| get_post_status($ID = '') X-Ref |
| Retrieve the post status based on the Post ID. If the post ID is of an attachment, then the parent post status will be given instead. param: int $ID Optional. Post ID. Default is the current post from the loop. return: string|bool Post status on success, false on failure. |
| get_post_statuses() X-Ref |
| Retrieve all of the WordPress supported post statuses. Posts have a limited set of valid status values, this provides the post_status values and descriptions. return: array List of post statuses. |
| get_page_statuses() X-Ref |
| Retrieve all of the WordPress support page statuses. Pages have a limited set of valid status values, this provides the post_status values and descriptions. return: array List of page statuses. |
| register_post_status($post_status, $args = array() X-Ref |
| Register a post status. Do not use before init. A simple function for creating or modifying a post status based on the parameters given. The function will accept an array (second optional parameter), along with a string for the post status name. Optional $args contents: label - A descriptive name for the post status marked for translation. Defaults to $post_status. public - Whether posts of this status should be shown in the front end of the site. Defaults to true. exclude_from_search - Whether to exclude posts with this post status from search results. Defaults to false. show_in_admin_all_list - Whether to include posts in the edit listing for their post type show_in_admin_status_list - Show in the list of statuses with post counts at the top of the edit listings, e.g. All (12) | Published (9) | My Custom Status (2) ... Arguments prefixed with an _underscore shouldn't be used by plugins and themes. param: string $post_status Name of the post status. param: array|string $args See above description. |
| get_post_status_object( $post_status ) X-Ref |
| Retrieve a post status object by name param: string $post_status The name of a registered post status return: object A post status object |
| get_post_stati( $args = array() X-Ref |
| Get a list of all registered post status objects. param: array|string $args An array of key => value arguments to match against the post status objects. param: string $output The type of output to return, either post status 'names' or 'objects'. 'names' is the default. param: string $operator The logical operation to perform. 'or' means only one element return: array A list of post status names or objects |
| is_post_type_hierarchical( $post_type ) X-Ref |
| Whether the post type is hierarchical. A false return value might also mean that the post type does not exist. param: string $post_type Post type name return: bool Whether post type is hierarchical. |
| post_type_exists( $post_type ) X-Ref |
| Checks if a post type is registered. param: string $post_type Post type name return: bool Whether post type is registered. |
| get_post_type( $post = null ) X-Ref |
| Retrieve the post type of the current post or of a given post. param: int|object $post Optional. Post ID or post object. Default is the current post from the loop. return: string|bool Post type on success, false on failure. |
| get_post_type_object( $post_type ) X-Ref |
| Retrieve a post type object by name param: string $post_type The name of a registered post type return: object A post type object |
| get_post_types( $args = array() X-Ref |
| Get a list of all registered post type objects. param: array|string $args An array of key => value arguments to match against the post type objects. param: string $output The type of output to return, either post type 'names' or 'objects'. 'names' is the default. param: string $operator The logical operation to perform. 'or' means only one element return: array A list of post type names or objects |
| register_post_type( $post_type, $args = array() X-Ref |
| Register a post type. Do not use before init. A function for creating or modifying a post type based on the parameters given. The function will accept an array (second optional parameter), along with a string for the post type name. Optional $args contents: - label - Name of the post type shown in the menu. Usually plural. If not set, labels['name'] will be used. - labels - An array of labels for this post type. * If not set, post labels are inherited for non-hierarchical types and page labels for hierarchical ones. * You can see accepted values in {@link get_post_type_labels()}. - description - A short descriptive summary of what the post type is. Defaults to blank. - public - Whether a post type is intended for use publicly either via the admin interface or by front-end users. * Defaults to false. * While the default settings of exclude_from_search, publicly_queryable, show_ui, and show_in_nav_menus are inherited from public, each does not rely on this relationship and controls a very specific intention. - hierarchical - Whether the post type is hierarchical (e.g. page). Defaults to false. - exclude_from_search - Whether to exclude posts with this post type from front end search results. * If not set, the opposite of public's current value is used. - publicly_queryable - Whether queries can be performed on the front end for the post type as part of parse_request(). * ?post_type={post_type_key} * ?{post_type_key}={single_post_slug} * ?{post_type_query_var}={single_post_slug} * If not set, the default is inherited from public. - show_ui - Whether to generate a default UI for managing this post type in the admin. * If not set, the default is inherited from public. - show_in_menu - Where to show the post type in the admin menu. * If true, the post type is shown in its own top level menu. * If false, no menu is shown * If a string of an existing top level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post type will be placed as a sub menu of that. * show_ui must be true. * If not set, the default is inherited from show_ui - show_in_nav_menus - Makes this post type available for selection in navigation menus. * If not set, the default is inherited from public. - show_in_admin_bar - Makes this post type available via the admin bar. * If not set, the default is inherited from show_in_menu - menu_position - The position in the menu order the post type should appear. * show_in_menu must be true * Defaults to null, which places it at the bottom of its area. - menu_icon - The url to the icon to be used for this menu. Defaults to use the posts icon. * Pass a base64-encoded SVG using a data URI, which will be colored to match the color scheme. This should begin with 'data:image/svg+xml;base64,'. * Pass the name of a Dashicons helper class to use a font icon, e.g. 'dashicons-piechart'. * Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS. - capability_type - The string to use to build the read, edit, and delete capabilities. Defaults to 'post'. * May be passed as an array to allow for alternative plurals when using this argument as a base to construct the capabilities, e.g. array('story', 'stories'). - capabilities - Array of capabilities for this post type. * By default the capability_type is used as a base to construct capabilities. * You can see accepted values in {@link get_post_type_capabilities()}. - map_meta_cap - Whether to use the internal default meta capability handling. Defaults to false. - supports - An alias for calling add_post_type_support() directly. Defaults to title and editor. * See {@link add_post_type_support()} for documentation. - register_meta_box_cb - Provide a callback function that sets up the meta boxes for the edit form. Do remove_meta_box() and add_meta_box() calls in the callback. - taxonomies - An array of taxonomy identifiers that will be registered for the post type. * Default is no taxonomies. * Taxonomies can be registered later with register_taxonomy() or register_taxonomy_for_object_type(). - has_archive - True to enable post type archives. Default is false. * Will generate the proper rewrite rules if rewrite is enabled. - rewrite - Triggers the handling of rewrites for this post type. Defaults to true, using $post_type as slug. * To prevent rewrite, set to false. * To specify rewrite rules, an array can be passed with any of these keys * 'slug' => string Customize the permastruct slug. Defaults to $post_type key * 'with_front' => bool Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true. * 'feeds' => bool Should a feed permastruct be built for this post type. Inherits default from has_archive. * 'pages' => bool Should the permastruct provide for pagination. Defaults to true. * 'ep_mask' => const Assign an endpoint mask. * If not specified and permalink_epmask is set, inherits from permalink_epmask. * If not specified and permalink_epmask is not set, defaults to EP_PERMALINK - query_var - Sets the query_var key for this post type. Defaults to $post_type key * If false, a post type cannot be loaded at ?{query_var}={post_slug} * If specified as a string, the query ?{query_var_string}={post_slug} will be valid. - can_export - Allows this post type to be exported. Defaults to true. - delete_with_user - Whether to delete posts of this type when deleting a user. * If true, posts of this type belonging to the user will be moved to trash when then user is deleted. * If false, posts of this type belonging to the user will *not* be trashed or deleted. * If not set (the default), posts are trashed if post_type_supports('author'). Otherwise posts are not trashed or deleted. - _builtin - true if this post type is a native or "built-in" post_type. THIS IS FOR INTERNAL USE ONLY! - _edit_link - URL segement to use for edit link of this post type. THIS IS FOR INTERNAL USE ONLY! param: string $post_type Post type key, must not exceed 20 characters. param: array|string $args See optional args description above. return: object|WP_Error the registered post type object, or an error object. |
| get_post_type_capabilities( $args ) X-Ref |
| Builds an object with all post type capabilities out of a post type object Post type capabilities use the 'capability_type' argument as a base, if the capability is not set in the 'capabilities' argument array or if the 'capabilities' argument is not supplied. The capability_type argument can optionally be registered as an array, with the first value being singular and the second plural, e.g. array('story, 'stories') Otherwise, an 's' will be added to the value for the plural form. After registration, capability_type will always be a string of the singular value. By default, seven keys are accepted as part of the capabilities array: - edit_post, read_post, and delete_post are meta capabilities, which are then generally mapped to corresponding primitive capabilities depending on the context, which would be the post being edited/read/deleted and the user or role being checked. Thus these capabilities would generally not be granted directly to users or roles. - edit_posts - Controls whether objects of this post type can be edited. - edit_others_posts - Controls whether objects of this type owned by other users can be edited. If the post type does not support an author, then this will behave like edit_posts. - publish_posts - Controls publishing objects of this post type. - read_private_posts - Controls whether private objects can be read. These four primitive capabilities are checked in core in various locations. There are also seven other primitive capabilities which are not referenced directly in core, except in map_meta_cap(), which takes the three aforementioned meta capabilities and translates them into one or more primitive capabilities that must then be checked against the user or role, depending on the context. - read - Controls whether objects of this post type can be read. - delete_posts - Controls whether objects of this post type can be deleted. - delete_private_posts - Controls whether private objects can be deleted. - delete_published_posts - Controls whether published objects can be deleted. - delete_others_posts - Controls whether objects owned by other users can be can be deleted. If the post type does not support an author, then this will behave like delete_posts. - edit_private_posts - Controls whether private objects can be edited. - edit_published_posts - Controls whether published objects can be edited. These additional capabilities are only used in map_meta_cap(). Thus, they are only assigned by default if the post type is registered with the 'map_meta_cap' argument set to true (default is false). param: object $args Post type registration arguments return: object object with all the capabilities as member variables |
| _post_type_meta_capabilities( $capabilities = null ) X-Ref |
| Stores or returns a list of post type meta caps for map_meta_cap(). |
| get_post_type_labels( $post_type_object ) X-Ref |
| Builds an object with all post type labels out of a post type object Accepted keys of the label array in the post type object: - name - general name for the post type, usually plural. The same and overridden by $post_type_object->label. Default is Posts/Pages - singular_name - name for one object of this post type. Default is Post/Page - add_new - Default is Add New for both hierarchical and non-hierarchical types. When internationalizing this string, please use a {@link http://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context gettext context} matching your post type. Example: <code>_x('Add New', 'product');</code> - add_new_item - Default is Add New Post/Add New Page - edit_item - Default is Edit Post/Edit Page - new_item - Default is New Post/New Page - view_item - Default is View Post/View Page - search_items - Default is Search Posts/Search Pages - not_found - Default is No posts found/No pages found - not_found_in_trash - Default is No posts found in Trash/No pages found in Trash - parent_item_colon - This string isn't used on non-hierarchical types. In hierarchical ones the default is Parent Page: - all_items - String for the submenu. Default is All Posts/All Pages - menu_name - Default is the same as <code>name</code> Above, the first default value is for non-hierarchical post types (like posts) and the second one is for hierarchical post types (like pages). param: object $post_type_object return: object object with all the labels as member variables |
| _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) X-Ref |
| Builds an object with custom-something object (post type, taxonomy) labels out of a custom-something object |
| _add_post_type_submenus() X-Ref |
| Adds submenus for post types. |
| add_post_type_support( $post_type, $feature ) X-Ref |
| Register support of certain features for a post type. All features are directly associated with a functional area of the edit screen, such as the editor or a meta box: 'title', 'editor', 'comments', 'revisions', 'trackbacks', 'author', 'excerpt', 'page-attributes', 'thumbnail', and 'custom-fields'. Additionally, the 'revisions' feature dictates whether the post type will store revisions, and the 'comments' feature dictates whether the comments count will show on the edit screen. param: string $post_type The post type for which to add the feature param: string|array $feature the feature being added, can be an array of feature strings or a single string |
| remove_post_type_support( $post_type, $feature ) X-Ref |
| Remove support for a feature from a post type. param: string $post_type The post type for which to remove the feature param: string $feature The feature being removed |
| get_all_post_type_supports( $post_type ) X-Ref |
| Get all the post type features param: string $post_type The post type return: array |
| post_type_supports( $post_type, $feature ) X-Ref |
| Checks a post type's support for a given feature param: string $post_type The post type being checked param: string $feature the feature being checked return: boolean |
| set_post_type( $post_id = 0, $post_type = 'post' ) X-Ref |
| Updates the post type for the post ID. The page or post cache will be cleaned for the post ID. param: int $post_id Post ID to change post type. Not actually optional. param: string $post_type Optional, default is post. Supported values are 'post' or 'page' to return: int Amount of rows changed. Should be 1 for success and 0 for failure. |
| get_posts($args = null) X-Ref |
| Retrieve list of latest posts or posts matching criteria. The defaults are as follows: 'numberposts' - Default is 5. Total number of posts to retrieve. 'offset' - Default is 0. See {@link WP_Query::query()} for more. 'category' - What category to pull the posts from. 'orderby' - Default is 'date', which orders based on post_date. How to order the posts. 'order' - Default is 'DESC'. The order to retrieve the posts. 'include' - See {@link WP_Query::query()} for more. 'exclude' - See {@link WP_Query::query()} for more. 'meta_key' - See {@link WP_Query::query()} for more. 'meta_value' - See {@link WP_Query::query()} for more. 'post_type' - Default is 'post'. Can be 'page', or 'attachment' to name a few. 'post_parent' - The parent of the post or post type. 'post_status' - Default is 'publish'. Post status to retrieve. param: array $args Optional. Overrides defaults. return: array List of posts. |
| add_post_meta($post_id, $meta_key, $meta_value, $unique = false) X-Ref |
| Add meta data field to a post. Post meta data is called "Custom Fields" on the Administration Screen. param: int $post_id Post ID. param: string $meta_key Metadata name. param: mixed $meta_value Metadata value. Must be serializable if non-scalar. param: bool $unique Optional, default is false. Whether the same key should not be added. return: int|bool Meta ID on success, false on failure. |
| delete_post_meta($post_id, $meta_key, $meta_value = '') X-Ref |
| Remove metadata matching criteria from a post. You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed. param: int $post_id post ID param: string $meta_key Metadata name. param: mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. return: bool True on success, false on failure. |
| get_post_meta($post_id, $key = '', $single = false) X-Ref |
| Retrieve post meta field for a post. param: int $post_id Post ID. param: string $key Optional. The meta key to retrieve. By default, returns data for all keys. param: bool $single Whether to return a single value. return: mixed Will be an array if $single is false. Will be value of meta data field if $single |
| update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') X-Ref |
| Update post meta field based on post ID. Use the $prev_value parameter to differentiate between meta fields with the same key and post ID. If the meta field for the post does not exist, it will be added. param: int $post_id Post ID. param: string $meta_key Metadata key. param: mixed $meta_value Metadata value. Must be serializable if non-scalar. param: mixed $prev_value Optional. Previous value to check before removing. return: bool True on success, false on failure. |
| delete_post_meta_by_key($post_meta_key) X-Ref |
| Delete everything from post meta matching meta key. param: string $post_meta_key Key to search for when deleting. return: bool Whether the post meta key was deleted from the database |
| get_post_custom( $post_id = 0 ) X-Ref |
| Retrieve post meta fields, based on post ID. The post meta fields are retrieved from the cache where possible, so the function is optimized to be called more than once. param: int $post_id Post ID. return: array |
| get_post_custom_keys( $post_id = 0 ) X-Ref |
| Retrieve meta field names for a post. If there are no meta fields, then nothing (null) will be returned. param: int $post_id post ID return: array|null Either array of the keys, or null if keys could not be retrieved. |
| get_post_custom_values( $key = '', $post_id = 0 ) X-Ref |
| Retrieve values for a custom post field. The parameters must not be considered optional. All of the post meta fields will be retrieved and only the meta field key values returned. param: string $key Meta field key. param: int $post_id Post ID return: array Meta field values. |
| is_sticky( $post_id = 0 ) X-Ref |
| Check if post is sticky. Sticky posts should remain at the top of The Loop. If the post ID is not given, then The Loop ID for the current post will be used. param: int $post_id Optional. Post ID. return: bool Whether post is sticky. |
| sanitize_post($post, $context = 'display') X-Ref |
| Sanitize every post field. If the context is 'raw', then the post object or array will get minimal santization of the int fields. param: object|WP_Post|array $post The Post Object or Array param: string $context Optional, default is 'display'. How to sanitize post fields. return: object|WP_Post|array The now sanitized Post Object or Array (will be the same type as $post) |
| sanitize_post_field($field, $value, $post_id, $context) X-Ref |
| Sanitize post field based on context. Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display' when calling filters. param: string $field The Post Object field name. param: mixed $value The Post Object value. param: int $post_id Post ID. param: string $context How to sanitize post fields. Looks for 'raw', 'edit', 'db', 'display', return: mixed Sanitized value. |
| stick_post($post_id) X-Ref |
| Make a post sticky. Sticky posts should be displayed at the top of the front page. param: int $post_id Post ID. |
| unstick_post($post_id) X-Ref |
| Unstick a post. Sticky posts should be displayed at the top of the front page. param: int $post_id Post ID. |
| wp_count_posts( $type = 'post', $perm = '' ) X-Ref |
| Count number of posts of a post type and if user has permissions to view. This function provides an efficient method of finding the amount of post's type a blog has. Another method is to count the amount of items in get_posts(), but that method has a lot of overhead with doing so. Therefore, when developing for 2.5+, use this function instead. The $perm parameter checks for 'readable' value and if the user can read private posts, it will display that for the user that is signed in. param: string $type Optional. Post type to retrieve count param: string $perm Optional. 'readable' or empty. return: object Number of posts for each status |
| wp_count_attachments( $mime_type = '' ) X-Ref |
| Count number of attachments for the mime type(s). If you set the optional mime_type parameter, then an array will still be returned, but will only have the item you are looking for. It does not give you the number of attachments that are children of a post. You can get that by counting the number of children that post has. param: string|array $mime_type Optional. Array or comma-separated list of MIME patterns. return: array Number of posts for each mime type. |
| get_post_mime_types() X-Ref |
| Get default post mime types return: array |
| wp_match_mime_types($wildcard_mime_types, $real_mime_types) X-Ref |
| Check a MIME-Type against a list. If the wildcard_mime_types parameter is a string, it must be comma separated list. If the real_mime_types is a string, it is also comma separated to create the list. param: string|array $wildcard_mime_types e.g. audio/mpeg or image (same as image/*) or param: string|array $real_mime_types post_mime_type values return: array array(wildcard=>array(real types)) |
| wp_post_mime_type_where($post_mime_types, $table_alias = '') X-Ref |
| Convert MIME types into SQL. param: string|array $post_mime_types List of mime types or comma separated string of mime types. param: string $table_alias Optional. Specify a table alias, if needed. return: string The SQL AND clause for mime searching. |
| wp_delete_post( $postid = 0, $force_delete = false ) X-Ref |
| Trashes or deletes a post or page. When the post and page is permanently deleted, everything that is tied to it is deleted also. This includes comments, post meta fields, and terms associated with the post. The post or page is moved to trash instead of permanently deleted unless trash is disabled, item is already in the trash, or $force_delete is true. param: int $postid Post ID. param: bool $force_delete Whether to bypass trash and force deletion. Defaults to false. return: mixed False on failure |
| _reset_front_page_settings_for_post( $post_id ) X-Ref |
| Resets the page_on_front, show_on_front, and page_for_post settings when a linked page is deleted or trashed. Also ensures the post is no longer sticky. param: $post_id |
| wp_trash_post($post_id = 0) X-Ref |
| Moves a post or page to the Trash If trash is disabled, the post or page is permanently deleted. param: int $post_id Post ID. return: mixed False on failure |
| wp_untrash_post($post_id = 0) X-Ref |
| Restores a post or page from the Trash param: int $post_id Post ID. return: mixed False on failure |
| wp_trash_post_comments($post = null) X-Ref |
| Moves comments for a post to the trash param: int|object $post Post ID or object. return: mixed False on failure |
| wp_untrash_post_comments($post = null) X-Ref |
| Restore comments for a post from the trash param: int|object $post Post ID or object. return: mixed False on failure |
| wp_get_post_categories( $post_id = 0, $args = array() X-Ref |
| Retrieve the list of categories for a post. Compatibility layer for themes and plugins. Also an easy layer of abstraction away from the complexity of the taxonomy layer. param: int $post_id Optional. The Post ID. param: array $args Optional. Overwrite the defaults. return: array |
| wp_get_post_tags( $post_id = 0, $args = array() X-Ref |
| Retrieve the tags for a post. There is only one default for this function, called 'fields' and by default is set to 'all'. There are other defaults that can be overridden in {@link wp_get_object_terms()}. param: int $post_id Optional. The Post ID param: array $args Optional. Overwrite the defaults return: array List of post tags. |
| wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array() X-Ref |
| Retrieve the terms for a post. There is only one default for this function, called 'fields' and by default is set to 'all'. There are other defaults that can be overridden in {@link wp_get_object_terms()}. param: int $post_id Optional. The Post ID param: string $taxonomy The taxonomy for which to retrieve terms. Defaults to post_tag. param: array $args Optional. Overwrite the defaults return: array List of post tags. |
| wp_get_recent_posts( $args = array() X-Ref |
| Retrieve number of recent posts. param: string $deprecated Deprecated. param: array $args Optional. Overrides defaults. param: string $output Optional. return: unknown. |
| wp_insert_post( $postarr, $wp_error = false ) X-Ref |
| Insert or update a post. If the $postarr parameter has 'ID' set to a value, then post will be updated. You can set the post date manually, by setting the values for 'post_date' and 'post_date_gmt' keys. You can close the comments or open the comments by setting the value for 'comment_status' key. param: array $postarr { param: bool $wp_error Optional. Allow return of WP_Error on failure. return: int|WP_Error The post ID on success. The value 0 or WP_Error on failure. |
| wp_update_post( $postarr = array() X-Ref |
| Update a post with new post data. The date does not have to be set for drafts. You can set the date and it will not be overridden. param: array|object $postarr Post data. Arrays are expected to be escaped, objects are not. param: bool $wp_error Optional. Allow return of WP_Error on failure. return: int|WP_Error The value 0 or WP_Error on failure. The post ID on success. |
| wp_publish_post( $post ) X-Ref |
| Publish a post by transitioning the post status. param: int|object $post Post ID or object. |
| check_and_publish_future_post($post_id) X-Ref |
| Publish future post and make sure post ID has future post status. Invoked by cron 'publish_future_post' event. This safeguard prevents cron from publishing drafts, etc. param: int $post_id Post ID. return: null Nothing is returned. Which can mean that no action is required or post was published. |
| wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_parent ) X-Ref |
| Computes a unique slug for the post, when given the desired slug and some post details. param: string $slug the desired slug (post_name) param: integer $post_ID param: string $post_status no uniqueness checks are made if the post is still draft or pending param: string $post_type param: integer $post_parent return: string unique slug for the post, based on $post_name (with a -1, -2, etc. suffix) |
| _truncate_post_slug( $slug, $length = 200 ) X-Ref |
| Truncates a post slug. param: string $slug The slug to truncate. param: int $length Max length of the slug. return: string The truncated slug. |
| wp_add_post_tags($post_id = 0, $tags = '') X-Ref |
| Adds tags to a post. param: int $post_id Post ID param: string $tags The tags to set for the post, separated by commas. return: bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise |
| wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) X-Ref |
| Set the tags for a post. param: int $post_id Post ID. param: string $tags The tags to set for the post, separated by commas. param: bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags. return: mixed Array of affected term IDs. WP_Error or false on failure. |
| wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $append = false ) X-Ref |
| Set the terms for a post. param: int $post_id Post ID. param: string $tags The tags to set for the post, separated by commas. param: string $taxonomy Taxonomy name. Defaults to 'post_tag'. param: bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags. return: mixed Array of affected term IDs. WP_Error or false on failure. |
| wp_set_post_categories( $post_ID = 0, $post_categories = array() X-Ref |
| Set categories for a post. If the post categories parameter is not set, then the default category is going used. param: int $post_ID Post ID. param: array|int $post_categories Optional. List of categories or ID of category. param: bool $append If true, don't delete existing categories, just add on. If false, replace the categories with the new categories. return: bool|mixed |
| wp_transition_post_status($new_status, $old_status, $post) X-Ref |
| Transition the post status of a post. Calls hooks to transition post status. The first is 'transition_post_status' with new status, old status, and post data. The next action called is 'OLDSTATUS_to_NEWSTATUS' the 'NEWSTATUS' is the $new_status parameter and the 'OLDSTATUS' is $old_status parameter; it has the post data. The final action is named 'NEWSTATUS_POSTTYPE', 'NEWSTATUS' is from the $new_status parameter and POSTTYPE is post_type post data. param: string $new_status Transition to this post status. param: string $old_status Previous post status. param: object $post Post data. |
| add_ping($post_id, $uri) X-Ref |
| Add a URL to those already pung. param: int $post_id Post ID. param: string $uri Ping URI. return: int How many rows were updated. |
| get_enclosed($post_id) X-Ref |
| Retrieve enclosures already enclosed for a post. param: int $post_id Post ID. return: array List of enclosures |
| get_pung($post_id) X-Ref |
| Retrieve URLs already pinged for a post. param: int $post_id Post ID. return: array |
| get_to_ping($post_id) X-Ref |
| Retrieve URLs that need to be pinged. param: int $post_id Post ID return: array |
| trackback_url_list($tb_list, $post_id) X-Ref |
| Do trackbacks for a list of URLs. param: string $tb_list Comma separated list of URLs param: int $post_id Post ID |
| get_all_page_ids() X-Ref |
| Get a list of page IDs. return: array List of page IDs. |
| get_page( $page, $output = OBJECT, $filter = 'raw') X-Ref |
| Retrieves page data given a page ID or page object. Use get_post() instead of get_page(). param: mixed $page Page object or page ID. Passed by reference. param: string $output What to output. OBJECT, ARRAY_A, or ARRAY_N. param: string $filter How the return value should be filtered. return: WP_Post|null WP_Post on success or null on failure |
| get_page_by_path($page_path, $output = OBJECT, $post_type = 'page') X-Ref |
| Retrieves a page given its path. param: string $page_path Page path param: string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT. param: string $post_type Optional. Post type. Default page. return: WP_Post|null WP_Post on success or null on failure |
| get_page_by_title($page_title, $output = OBJECT, $post_type = 'page' ) X-Ref |
| Retrieve a page given its title. param: string $page_title Page title param: string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT. param: string $post_type Optional. Post type. Default page. return: WP_Post|null WP_Post on success or null on failure |
| get_page_children($page_id, $pages) X-Ref |
| Retrieve child pages from list of pages matching page ID. Matches against the pages parameter against the page ID. Also matches all children for the same to retrieve all children of a page. Does not make any SQL queries to get the children. param: int $page_id Page ID. param: array $pages List of pages' objects. return: array |
| get_page_hierarchy( &$pages, $page_id = 0 ) X-Ref |
| Order the pages with children under parents in a flat list. It uses auxiliary structure to hold parent-children relationships and runs in O(N) complexity param: array $pages Posts array. param: int $page_id Parent page ID. return: array A list arranged by hierarchy. Children immediately follow their parents. |
| _page_traverse_name( $page_id, &$children, &$result ) X-Ref |
| function to traverse and return all the nested children post names of a root page. $children contains parent-children relations |
| get_page_uri( $page ) X-Ref |
| Builds URI for a page. Sub pages will be in the "directory" under the parent page post name. param: mixed $page Page object or page ID. return: string|false Page URI, false on error. |
| get_pages( $args = array() X-Ref |
| Retrieve a list of pages. param: mixed $args { return: array List of pages matching defaults or $args. |
| is_local_attachment($url) X-Ref |
| Check if the attachment URI is local one and is really an attachment. param: string $url URL to check return: bool True on success, false on failure. |
| wp_insert_attachment($object, $file = false, $parent = 0) X-Ref |
| Insert an attachment. If you set the 'ID' in the $object parameter, it will mean that you are updating and attempt to update the attachment. You can also set the attachment name or title by setting the key 'post_name' or 'post_title'. You can set the dates for the attachment manually by setting the 'post_date' and 'post_date_gmt' keys' values. By default, the comments will use the default settings for whether the comments are allowed. You can close them manually or keep them open by setting the value for the 'comment_status' key. The $object parameter can have the following: 'post_status' - Default is 'draft'. Can not be overridden, set the same as parent post. 'post_type' - Default is 'post', will be set to attachment. Can not override. 'post_author' - Default is current user ID. The ID of the user, who added the attachment. 'ping_status' - Default is the value in default ping status option. Whether the attachment can accept pings. 'post_parent' - Default is 0. Can use $parent parameter or set this for the post it belongs to, if any. 'menu_order' - Default is 0. The order it is displayed. 'to_ping' - Whether to ping. 'pinged' - Default is empty string. 'post_password' - Default is empty string. The password to access the attachment. 'guid' - Global Unique ID for referencing the attachment. 'post_content_filtered' - Attachment post content filtered. 'post_excerpt' - Attachment excerpt. param: string|array $object Arguments to override defaults. param: string $file Optional filename. param: int $parent Parent post ID. return: int Attachment ID. |
| wp_delete_attachment( $post_id, $force_delete = false ) X-Ref |
| Trashes or deletes an attachment. When an attachment is permanently deleted, the file will also be removed. Deletion removes all post meta fields, taxonomy, comments, etc. associated with the attachment (except the main post). The attachment is moved to the trash instead of permanently deleted unless trash for media is disabled, item is already in the trash, or $force_delete is true. param: int $post_id Attachment ID. param: bool $force_delete Whether to bypass trash and force deletion. Defaults to false. return: mixed False on failure. Post data on success. |
| wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) X-Ref |
| Retrieve attachment meta field for attachment ID. param: int $post_id Attachment ID param: bool $unfiltered Optional, default is false. If true, filters are not run. return: string|bool Attachment meta field. False on failure. |
| wp_update_attachment_metadata( $post_id, $data ) X-Ref |
| Update metadata for an attachment. param: int $post_id Attachment ID. param: array $data Attachment data. return: int |
| wp_get_attachment_url( $post_id = 0 ) X-Ref |
| Retrieve the URL for an attachment. param: int $post_id Attachment ID. return: string |
| wp_get_attachment_thumb_file( $post_id = 0 ) X-Ref |
| Retrieve thumbnail for an attachment. param: int $post_id Attachment ID. return: mixed False on failure. Thumbnail file path on success. |
| wp_get_attachment_thumb_url( $post_id = 0 ) X-Ref |
| Retrieve URL for an attachment thumbnail. param: int $post_id Attachment ID return: string|bool False on failure. Thumbnail URL on success. |
| wp_attachment_is_image( $post_id = 0 ) X-Ref |
| Check if the attachment is an image. param: int $post_id Attachment ID return: bool |
| wp_mime_type_icon( $mime = 0 ) X-Ref |
| Retrieve the icon for a MIME type. param: string|int $mime MIME type or attachment ID. return: string|bool |
| wp_check_for_changed_slugs($post_id, $post, $post_before) X-Ref |
| Checked for changed slugs for published post objects and save the old slug. The function is used when a post object of any type is updated, by comparing the current and previous post objects. If the slug was changed and not already part of the old slugs then it will be added to the post meta field ('_wp_old_slug') for storing old slugs for that post. The most logically usage of this function is redirecting changed post objects, so that those that linked to an changed post will be redirected to the new post. param: int $post_id Post ID. param: object $post The Post Object param: object $post_before The Previous Post Object return: int Same as $post_id |
| get_private_posts_cap_sql( $post_type ) X-Ref |
| Retrieve the private post SQL based on capability. This function provides a standardized way to appropriately select on the post_status of a post type. The function will return a piece of SQL code that can be added to a WHERE clause; this SQL is constructed to allow all published posts, and all private posts to which the user has access. param: string $post_type currently only supports 'post' or 'page'. return: string SQL code that can be added to a where clause. |
| get_posts_by_author_sql( $post_type, $full = true, $post_author = null, $public_only = false ) X-Ref |
| Retrieve the post SQL based on capability, author, and type. param: string $post_type Post type. param: bool $full Optional. Returns a full WHERE statement instead of just an 'andalso' term. param: int $post_author Optional. Query posts having a single author ID. param: bool $public_only Optional. Only return public posts. Skips cap checks for $current_user. Default is false. return: string SQL WHERE code that can be added to a query. |
| get_lastpostdate($timezone = 'server') X-Ref |
| Retrieve the date that the last post was published. The server timezone is the default and is the difference between GMT and server time. The 'blog' value is the date when the last post was posted. The 'gmt' is when the last post was posted in GMT formatted date. param: string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'. return: string The date of the last post. |
| get_lastpostmodified($timezone = 'server') X-Ref |
| Retrieve last post modified date depending on timezone. The server timezone is the default and is the difference between GMT and server time. The 'blog' value is just when the last post was modified. The 'gmt' is when the last post was modified in GMT time. param: string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'. return: string The date the post was last modified. |
| _get_last_post_time( $timezone, $field ) X-Ref |
| Retrieve latest post date data based on timezone. param: string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'. param: string $field Field to check. Can be 'date' or 'modified'. return: string The date. |
| update_post_cache( &$posts ) X-Ref |
| Updates posts in cache. param: array $posts Array of post objects |
| clean_post_cache( $post ) X-Ref |
| Will clean the post in the cache. Cleaning means delete from the cache of the post. Will call to clean the term object cache associated with the post ID. This function not run if $_wp_suspend_cache_invalidation is not empty. See wp_suspend_cache_invalidation(). param: int|object $post Post ID or object to remove from the cache |
| update_post_caches(&$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true) X-Ref |
| Call major cache updating functions for list of Post objects. param: array $posts Array of Post objects param: string $post_type The post type of the posts in $posts. Default is 'post'. param: bool $update_term_cache Whether to update the term cache. Default is true. param: bool $update_meta_cache Whether to update the meta cache. Default is true. |
| update_postmeta_cache($post_ids) X-Ref |
| Updates metadata cache for list of post IDs. Performs SQL query to retrieve the metadata for the post IDs and updates the metadata cache for the posts. Therefore, the functions, which call this function, do not need to perform SQL queries on their own. param: array $post_ids List of post IDs. return: bool|array Returns false if there is nothing to update or an array of metadata. |
| clean_attachment_cache($id, $clean_terms = false) X-Ref |
| Will clean the attachment in the cache. Cleaning means delete from the cache. Optionally will clean the term object cache associated with the attachment ID. This function will not run if $_wp_suspend_cache_invalidation is not empty. See wp_suspend_cache_invalidation(). param: int $id The attachment ID in the cache to clean param: bool $clean_terms optional. Whether to clean terms cache |
| _transition_post_status($new_status, $old_status, $post) X-Ref |
| Hook for managing future post transitions to published. param: string $new_status New post status param: string $old_status Previous post status param: object $post Object type containing the post information |
| _future_post_hook( $deprecated, $post ) X-Ref |
| Hook used to schedule publication for a post marked for the future. The $post properties used and must exist are 'ID' and 'post_date_gmt'. param: int $deprecated Not used. Can be set to null. Never implemented. param: object $post Object type containing the post information |
| _publish_post_hook($post_id) X-Ref |
| Hook to schedule pings and enclosures when a post is published. param: int $post_id The ID in the database table of the post being published |
| wp_get_post_parent_id( $post_ID ) X-Ref |
| Returns the post's parent's post_ID param: int $post_id return: int|bool false on error |
| wp_check_post_hierarchy_for_loops( $post_parent, $post_ID ) X-Ref |
| Checks the given subset of the post hierarchy for hierarchy loops. Prevents loops from forming and breaks those that it finds. Attached to the wp_insert_post_parent filter. param: int $post_parent ID of the parent for the post we're checking. param: int $post_ID ID of the post we're checking. return: int The new post_parent for the post. |
| set_post_thumbnail( $post, $thumbnail_id ) X-Ref |
| Sets a post thumbnail. param: int|object $post Post ID or object where thumbnail should be attached. param: int $thumbnail_id Thumbnail to attach. return: bool True on success, false on failure. |
| delete_post_thumbnail( $post ) X-Ref |
| Removes a post thumbnail. param: int|object $post Post ID or object where thumbnail should be removed from. return: bool True on success, false on failure. |
| wp_delete_auto_drafts() X-Ref |
| Deletes auto-drafts for new posts that are > 7 days old |
| _update_term_count_on_transition_post_status( $new_status, $old_status, $post ) X-Ref |
| Update the custom taxonomies' term counts when a post's status is changed. For example, default posts term counts (for custom taxonomies) don't include private / draft posts. param: string $new_status param: string $old_status param: object $post |
| _prime_post_caches( $ids, $update_term_cache = true, $update_meta_cache = true ) X-Ref |
| Adds any posts from the given ids to the cache that do not already exist in cache param: array $post_ids ID list param: bool $update_term_cache Whether to update the term cache. Default is true. param: bool $update_meta_cache Whether to update the meta cache. Default is true. |
| Generated: Tue Mar 25 01:41:18 2014 | WordPress honlapkészítés: online1.hu |