Created
August 25, 2014 15:31
-
-
Save brasofilo/22a17c0625a0bea6cf18 to your computer and use it in GitHub Desktop.
Codex function reference to Apple Dictionary
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?xml version="1.0" encoding="utf-8"?> | |
| <d:dictionary xmlns="http://www.w3.org/1999/xhtml" xmlns:d="http://www.apple.com/DTDs/DictionaryService-1.0.rng"> | |
| <d:entry id="get_usernumposts" d:title="get usernumposts"> | |
| <d:index d:value="get usernumposts"/> | |
| <h1>get usernumposts</h1> | |
| <p>{{Deprecated}} | |
| == Description == | |
| Returns the post count for the user whose ID is passed to it. Properties map directly to the wp_posts table in the database (see [[Database Description#Table:_wp_posts|Database Description]]). | |
| == Replace With == | |
| [[Function_Reference/count_user_posts|count_user_posts()]] | |
| == Usage == | |
| <?php get_usernumposts(userid); ?> | |
| == Parameters == | |
| {{Parameter|$userid|integer|The ID of the user whose post count should be retrieved.}} | |
| == Example == | |
| === Default Usage === | |
| The call to <tt>get_usernumposts</tt> returns the number of posts made by the user. | |
| <?php echo 'Posts made: ' . get_usernumposts(1); ?> | |
| <div style="border:1px solid blue; width:50%; padding:10px">Posts made: 143</div> | |
| == Change Log == | |
| * Since: 0.71 | |
| * Deprecated: 3.0.0 | |
| ==Source File== | |
| <tt>get usernumposts()</tt> is located in {{Trac|wp-includes/deprecated.php}}. Formerly, {{Trac|wp-includes/user.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="do_action" d:title="do action"> | |
| <d:index d:value="do action"/> | |
| <h1>do action</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/do_action}} | |
| {{fax|Function_Reference/do_action}} | |
| {{ru|Справочник по функциям/do_action}} | |
| {{ja|関数リファレンス/do_action}} | |
| }} | |
| == Description == | |
| Execute functions hooked on a specific action hook. | |
| This function invokes all functions attached to action hook <tt>$tag</tt>. It is possible to create new action hooks by simply calling this function, specifying the name of the new hook using the <tt>$tag</tt> parameter. You can pass extra arguments to the hooks, much like you can with <tt>[[Function_Reference/apply_filters | apply_filters()]]</tt>. This function works similar to <tt>apply_filters()</tt> with the exception that nothing is returned and only the functions or methods are called. | |
| You can hook a function to an action hook using <tt>[[Function Reference/add_action|add_action()]]</tt>. | |
| == Usage == | |
| %%% <?php do_action( $tag, $arg ); ?> %%% | |
| Multiple Arguments: | |
| %%% <?php do_action( $tag, $arg_a, $arg_b, $etc ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$tag|string|The name of the hook you wish to execute.}} | |
| {{Parameter|$arg|mixed|The list of arguments to send to this hook.|optional|Empty string}} | |
| == Return Values == | |
| This function does not return a value. | |
| == Example == | |
| <pre> | |
| <?php | |
| # ======= Somewhere in a (mu-)plugin, theme or the core ======= # | |
| /** | |
| * You can have as many arguments as you want, | |
| * but your callback function and the add_action call need to agree in number of arguments. | |
| * Note: `add_action` above has 2 and 'i_am_hook' accepts 2. | |
| * You will find action hooks like these in a lot of themes & plugins and in many place @core | |
| * @see: http://codex.wordpress.org/Plugin_API/Action_Reference | |
| */ | |
| # ======= e.g., inside your functions.php file ======= # | |
| /** | |
| * Define callback function | |
| * Inside this function you can do whatever you can imagine | |
| * with the variables that are loaded in the do_action() call above. | |
| */ | |
| function who_is_hook( $a, $b ) | |
| { | |
| echo '<code>'; | |
| print_r( $a ); // `print_r` the array data inside the 1st argument | |
| echo '</code>'; | |
| echo '<br />'.$b; // echo linebreak and value of 2nd argument | |
| } | |
| // then add it to the action hook, matching the defined number (2) of arguments in do_action | |
| // see [http://codex.wordpress.org/Function_Reference/add_action] in the Codex | |
| // add_action( $tag, $function_to_add, $priority, $accepted_args ); | |
| add_action( 'i_am_hook', 'who_is_hook', 10, 2 ); | |
| // Define the arguments for the action hook | |
| $a = array( | |
| 'eye patch' => 'yes' | |
| ,'parrot' => true | |
| ,'wooden leg' => (int) 1 | |
| ); | |
| $b = 'And Hook said: "I ate ice cream with Peter Pan."'; | |
| // Executes the action hook named 'i_am_hook' | |
| do_action( 'i_am_hook', $a, $b ); | |
| # ======= output that you see in the browser ======= # | |
| Array ( | |
| ['eye patch'] => 'yes' | |
| ['parrot'] => true | |
| ['wooden leg'] => 1 | |
| ) | |
| And hook said: "I ate ice cream with Peter Pan." | |
| </pre> | |
| == Notes == | |
| * Uses: [[Global_Variables | global]] <tt>$wp_filter</tt> - Stores all of the filters and actions. | |
| * Uses: [[Global_Variables | global]] <tt>$wp_actions</tt> - Increments the amount of times the action was triggered. | |
| == Change Log == | |
| Since: [[Version_1.2|1.2.0]] | |
| == Source File == | |
| <tt>do_action()</tt> is located in {{Trac|wp-includes/plugin.php}}. | |
| == Related == | |
| {{Action Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="timer_stop" d:title="timer stop"> | |
| <d:index d:value="timer stop"/> | |
| <h1>timer stop</h1> | |
| <p>== Description == | |
| This function returns the amount of time (in seconds) to generate the page. | |
| == Usage == | |
| %%% <?php timer_stop( $display = 0, $precision = 3 ); ?> %%% | |
| == Example == | |
| === Usage === | |
| Determine length of time to render page with a precision of 3, 5 and 10 digits. | |
| <pre> | |
| <?php echo('Seconds: '.timer_stop( 0 ).'<br />'); ?> | |
| <?php echo('Seconds: '.timer_stop( 0, 5 ).'<br />'); ?> | |
| <?php echo('Seconds: '.timer_stop( 0, 10 ).'<br />'; ?> | |
| </pre> | |
| <div style="border:1px solid blue; width:50%; padding:10px"> | |
| Seconds: 0.815<br /> | |
| Seconds: 0.81551<br /> | |
| Seconds: 0.8155429363 | |
| </div> | |
| == Parameters == | |
| ; display : (''integer'') Possible values: 0 or 1. Defaults to 0. | |
| ; precision : (''integer'') Possible values: 0 or 1. Defaults to 3. | |
| [[Category:Functions]] | |
| == Related Functions == | |
| [[timer_start]] | |
| == Further Reading == | |
| For a comprehensive list of functions, take a look at the [http://codex.wordpress.org/Category:Functions category Functions] | |
| Also, see [[Function_Reference]]</p> | |
| </d:entry> | |
| <d:entry id="get_approved_comments" d:title="get approved comments"> | |
| <d:index d:value="get approved comments"/> | |
| <h1>get approved comments</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_approved_comments}} | |
| {{it|Riferimento funzioni/get_approved_comments}} | |
| }} | |
| ==Description== | |
| Takes post ID and returns an array of objects that represent comments that have been submitted ''and'' approved. | |
| == Usage == | |
| %%%<?php | |
| $comment_array = get_approved_comments($post_id); | |
| ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|The ID of the post|required}} | |
| == Return Values == | |
| {{Return|$comments|array|The approved comments}} | |
| ==Example== | |
| In this example we will output a simple list of comment IDs and corresponding post IDs. | |
| <pre> | |
| <?php | |
| $postID = 1; | |
| $comment_array = get_approved_comments($postID); | |
| foreach($comment_array as $comment){ | |
| echo $comment->comment_ID." => ".$comment->comment_post_ID."\n"; | |
| } | |
| ?> | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: [[Version 2.0|2.0.0]] | |
| == Source File == | |
| current_user_can_for_blog() is located in {{Trac|wp-includes/capabilities.php}} | |
| == Related == | |
| &nbsp; | |
| {{Tag Footer}} | |
| {{Copyedit}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="add_option" d:title="add option"> | |
| <d:index d:value="add option"/> | |
| <h1>add option</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/add_option}} | |
| {{ru|Справочник_по_функциям/add_option}} | |
| }} | |
| == Description == | |
| A safe way of adding a named option/value pair to the options database table. It does nothing if the option already exists. After the option is saved, it can be accessed with [[Function_Reference/get_option|get_option()]], changed with [[Function_Reference/update_option|update_option()]], and deleted with [[Function_Reference/delete_option|delete_option()]]. | |
| You do not need to serialize values. If the value needs to be serialized, then it will be serialized before it is inserted into the database. You can create options without values and then add values later. | |
| Calling <tt>add_option</tt> first checks whether the option has already been added, and returns false if an option with the same name exists. Next, it checks to make sure the option name is not one of the protected names ''alloptions'' or ''notoptions'', and dies with an error message if attempting to overwrite a protected option. If the option name is not protected, and does not already exist, the option will be created. | |
| '''''Note:''''' ''<tt>add_option</tt> uses <tt>get_option</tt> to determine whether the option already exists, and since <tt>get_option</tt> returns '''false''' as the default value, if you set an option to '''false''' in the database (e.g. via <tt>update_option($option_name, false)</tt>), then a subsequent call to <tt>add_option</tt> will change the value, because it will seem to <tt>add_option</tt> that the option does '''not''' exist.'' | |
| === vs. update_option() === | |
| If you are trying to ensure that a given option is created, use [[Function_Reference/update_option|update_option()]] instead, which bypasses the option name check and updates the option with the desired value whether or not it exists. | |
| NB: you cannot specify autoload='no' if you use update_option(). If you need to specify autoload='no', and you are not sure whether the option already exists, then call delete_option() first before calling add_option(). | |
| == Usage == | |
| %%%<?php add_option( $option, $value, $deprecated, $autoload ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$option|string|Name of the option to be added. Must not exceed 64 characters. Use underscores to separate words, and do not use uppercase—this is going to be placed into the database.}} | |
| {{Parameter|$value|mixed|Value for this option name. Limited to 2^32 bytes of data|optional|''Empty string''}} | |
| {{Parameter|$deprecated|string|Deprecated in WordPress [[Version 2.3]].|optional|''Empty string''}} | |
| {{Parameter|$autoload|string|Should this option be automatically loaded by the function [[Function Reference/wp_load_alloptions|wp_load_alloptions()]] (puts options into object cache on each page load)? Valid values: '''yes''' or '''no'''.|optional|yes}} | |
| == Return Value == | |
| {{Return||boolean|False if option was not added and true if option was added}} | |
| == Example == | |
| <pre> | |
| <?php add_option( 'myhack_extraction_length', '255', '', 'yes' ); ?> | |
| </pre> | |
| == Change Log == | |
| Since: [[Version 1.0|1.0.0]] | |
| == Source File == | |
| <tt>add_option()</tt> is located in {{Trac|wp-includes/option.php}}. | |
| == Related == | |
| {{Option Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="delete_option" d:title="delete option"> | |
| <d:index d:value="delete option"/> | |
| <h1>delete option</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/delete_option}} | |
| {{ru|Справочник_по_функциям/delete_option}} | |
| }} | |
| == Description == | |
| A safe way of removing a named option/value pair from the options database table. | |
| == Usage == | |
| %%%<?php delete_option( $option ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$option|string|Name of the option to be deleted. A list of valid default options can be found at the [[Option Reference]].}} | |
| == Return Value == | |
| {{Return||boolean|True, if option is successfully deleted. False on failure, or option does not exist.}} | |
| == Example == | |
| === Delete a single option === | |
| This will delete 'my_option' from the options table within your MySQL database. | |
| <pre> | |
| <?php delete_option( 'my_option' ); ?> | |
| </pre> | |
| == Change Log == | |
| Since: [[Version 1.2|1.2.0]] | |
| == Source File == | |
| <code>delete_option()</code> is located in {{Trac|wp-includes/option.php}}. | |
| == Related == | |
| {{Option Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| {{Copyedit}}</p> | |
| </d:entry> | |
| <d:entry id="get_rss" d:title="get rss"> | |
| <d:index d:value="get rss"/> | |
| <h1>get rss</h1> | |
| <p>{{Deprecated}} | |
| ==Description== | |
| Retrieves an RSS feed and parses it, then displays it as a list of links. The get_rss() function only outputs the list items, not the surrounding list tags itself. | |
| Uses the [http://magpierss.sourceforge.net/ MagpieRSS and RSSCache] functions for parsing and automatic caching and the [http://sourceforge.net/projects/snoopy/ Snoopy HTTP client] for the actual retrieval. | |
| Deprecated note: Switch to using [[Function_Reference/fetch_feed|fetch_feed]] instead. | |
| ==Usage== | |
| %%%<?php | |
| require_once(ABSPATH . WPINC . '/rss-functions.php'); | |
| get_rss($uri, $num = 5); | |
| ?>%%% | |
| ==Parameters== | |
| {{Parameter|$uri|URI|The URI of the RSS feed you want to retrieve. The resulting parsed feed is returned, with the more interesting and useful bits in the items array.}} | |
| {{Parameter|$num|integer|The number of items to display.|optional|5}} | |
| [[Category:Functions]] | |
| ==Example== | |
| The get_rss() function only outputs the list items, not the surrounding list tags itself. So, to get and display an ordered list of 5 links from an existing RSS feed: | |
| %%%<?php | |
| require_once(ABSPATH . WPINC . '/rss-functions.php'); | |
| echo '<ol>'; | |
| get_rss('http://example.com/rss/feed/goes/here'); | |
| echo '</ol>'; | |
| ?>%%% | |
| ==Output== | |
| The output from the above example will look like the following: | |
| %%%<ol> | |
| <li><a href='LINK FROM FEED' title='DESCRIPTION FROM FEED'>TITLE FROM FEED</a><br /></li> | |
| (repeat for number of links specified) | |
| </ol>%%% | |
| ==Related== | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="User:JHodgdon/Function_Reference_2.1" d:title="User:JHodgdon/Function Reference 2.1"> | |
| <d:index d:value="User:JHodgdon/Function Reference 2.1"/> | |
| <h1>User:JHodgdon/Function Reference 2.1</h1> | |
| <p>__NOTOC__ | |
| NOTE: This has now been moved to [[Function Reference]]... but I could not do it as a move.... | |
| The files of WordPress define many useful PHP functions. Some of the functions, known as [[Template Tags]], are defined especially for use in WordPress themes. There are also some functions related to actions and filters (the [[Plugin API]]), which are therefore used primarily for developing plugins. The rest are used to create the core WordPress functionality. | |
| Many of the core WordPress functions may also be useful to plugin developers, and to a lesser extent, possibly theme developers as well. So, this article lists most of the core functions, by category; some of the function names are also links to more detailed documentation in separate pages. Each category also lists the files where its functions can be found (the files are in the <tt>wp-includes</tt> directory of WordPress). | |
| '''Note''': This reference applies to Version 2.1 of WordPress, and does not include functions that have been deprecated as of that version of WordPress. An incomplete page for the 2.0.x versions of WordPress can be found at [[Function Reference 2.0.x]]. | |
| '''Note''': Functions specifically for templates, which are listed in the [[Template Tags]] article, and contained in files <tt>wp-includes/*_template.php</tt>, are not listed here. | |
| <div style="border:blue 1px solid;padding:10px; background: #E6CCFF"> | |
| '''You can help make this page more complete!''' | |
| Here are some things you can do to help: | |
| * Add documentation to un-documented functions, by creating sub-pages or at least by adding short comments in the lists below. If you create a subpage for a function, please include information and examples of usage of that function, if possible, per the examples found in [[Template Tags]]. | |
| * List more functions here, following the category structure. | |
| * Remove functions from the list, if you think they could not possibly be useful to plugin developers, or if they have been deprecated. | |
| * Correct errors by moving functions to better categories where appropriate, and of course fixing typos. Note that it is OK for a function to appear in more than one category. | |
| Read [[Contributing to WordPress]] to find out more about how you can contribute to the effort! | |
| </div> | |
| <!-- remove the DIV above after there's enough example content --> | |
| ==Functions by category== | |
| {| cellspacing="10" width="100%" | |
| |- valign="top" | |
| |bgcolor="#fbfbef" style="border:1px solid #ffc9c9;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Post, Page, and Attachment Functions == | |
| These functions are contained in <tt>formatting.php</tt>, <tt>post.php</tt>. See also [[Template Functions]]. | |
| * <tt>wp_trim_excerpt</tt> | |
| * <tt>get_attached_file</tt> | |
| * <tt>update_attached_file</tt> | |
| * <tt>get_children</tt> | |
| * <tt>get_extended</tt> | |
| * [[Function Reference/get_post|get_post]] - get information on a specific post | |
| * [[Function Reference/get_post_mime_type|get_post_mime_type($ID = "")]] - takes a post ID, returns its MIME type | |
| * <tt>get_post_status</tt> | |
| * <tt>get_post_type</tt> | |
| * <tt>get_posts</tt> | |
| * <tt>add_post_meta</tt> | |
| * <tt>delete_post_meta</tt> | |
| * <tt>get_post_meta</tt> | |
| * <tt>update_post_meta</tt> | |
| * <tt>get_post_custom</tt> | |
| * <tt>get_post_custom_keys</tt> | |
| * <tt>get_post_custom_values</tt> | |
| * [[Function Reference/wp_delete_post|wp_delete_post($postid)]] - A generic function to delete a post in the post table | |
| * <tt>get_post_categories</tt> | |
| * <tt>get_recent_posts</tt> | |
| * <tt>get_single_post</tt> | |
| * [[Function Reference/wp_insert_post|wp_insert_post($postarr=array())]] - A generic function for inserting data into the post table | |
| * [[Function Reference/wp_update_post|wp_update_post($postarr=array())]] - A generic function to update data in the post table | |
| * [[Function Reference/wp_publish_post|wp_publish_post($post_id)]] - Set a post's post_status to published. Calls <tt>wp_update_post</tt>. | |
| * <tt>wp_set_post_categories</tt> | |
| * <tt>get_all_page_ids</tt> | |
| * <tt>get_page</tt> | |
| * <tt>get_page_by_path</tt> | |
| * <tt>get_page_by_title</tt> | |
| * <tt>get_page_children</tt> | |
| * <tt>get_page_hierarchy</tt> | |
| * <tt>get_page_uri</tt> | |
| * <tt>get_pages</tt> | |
| * <tt>generate_page_uri_index</tt> | |
| * <tt>is_local_attachment</tt> | |
| * <tt>wp_insert_attachment</tt> | |
| * <tt>wp_delete_attachment</tt> | |
| * <tt>wp_get_attachment_metadata</tt> | |
| * <tt>wp_update_attachment_metadata</tt> | |
| * <tt>wp_get_attachment_url</tt> | |
| * <tt>wp_get_attachment_thumb_file</tt> | |
| * <tt>wp_get_attachment_thumb_url</tt> | |
| * <tt>wp_attachment_is_image</tt> | |
| * <tt>wp_mime_type_icon</tt> | |
| * <tt>wp_check_for_changed_slugs</tt> | |
| |valign="top" bgcolor="#f0f0ff" style="border:1px solid #c6c9ff;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Category Functions == | |
| These functions are contained in <tt>category.php</tt>. See also [[Template Functions]]. | |
| * <tt>get_all_category_ids</tt> | |
| * <tt>get_categories</tt> | |
| * <tt>get_category</tt> | |
| * <tt>get_category_by_path</tt> | |
| * [[Function Reference/get_cat_ID|get_cat_ID($cat_name='General')]] - get category ID for given category name | |
| * [[Function Reference/get_cat_name|get_cat_name($cat_id)]] - get category name for given ID | |
| * <tt>cat_is_ancestor_of</tt> | |
| |- valign="top" | |
| |bgcolor="#fbfbef" style="border:1px solid #ffc9c9;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| ==User and Author Functions== | |
| These functions are in <tt>user.php, pluggable.php, registration.php</tt>. See also [[Template Functions]]. | |
| * <tt>get_profile</tt> | |
| * [[Function_Reference/get_usernumposts|get_usernumposts]] &mdash; get post count for a specific user | |
| * <tt>delete_usermeta</tt> | |
| * [[Function_Reference/get_usermeta|get_usermeta]] &mdash; get meta data for a specific user | |
| * <tt>update_usermeta</tt> | |
| * <tt>set_current_user</tt> | |
| * <tt>wp_set_current_user</tt> | |
| * <tt>wp_get_current_user</tt> | |
| * [[Function Reference/get_currentuserinfo|get_currentuserinfo]] &mdash; get information on the current user | |
| * [[Function Reference/get_userdata|get_userdata]] &mdash; get information on any user | |
| * <tt>get_userdatabylogin</tt> | |
| * <tt>wp_login</tt> | |
| * <tt>is_user_logged_in</tt> | |
| * <tt>auth_redirect</tt> | |
| * <tt>username_exists</tt> | |
| * <tt>email_exists</tt> | |
| * <tt>validate_username</tt> | |
| * <tt>wp_insert_user</tt> | |
| * <tt>wp_update_user</tt> | |
| * [[Function_Reference/wp_create_user|wp_create_user]] &mdash; Create a user and add it to the user database. | |
| |valign="top" bgcolor="#f0f0ff" style="border:1px solid #c6c9ff;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Feed Functions == | |
| These functions are in <tt>functions.php</tt>, <tt>feed.php</tt>, <tt>rss.php</tt> | |
| * [[Function_Reference/fetch_rss|fetch_rss]] -- retrieve an RSS feed from a URL with automatic caching (included in rss_functions.php) | |
| * [[Function_Reference/wp_rss|wp_rss]] -- retrieve and display an RSS feed as an unordered list (included in rss_functions.php) | |
| * [[Function_Reference/get_rss|get_rss]] -- retrieve and display an RSS feed as a list (ordering optional) (included in rss_functions.php) | |
| * <tt>do_feed</tt> | |
| * <tt>do_feed_rdf</tt> | |
| * <tt>do_feed_rss</tt> | |
| * <tt>do_feed_rss2</tt> | |
| * <tt>do_feed_atom</tt> | |
| * <tt>get_bloginfo_rss</tt> | |
| * <tt>bloginfo_rss</tt> | |
| * <tt>get_the_title_rss</tt> | |
| * <tt>the_title_rss</tt> | |
| * <tt>the_content_rss</tt> | |
| * <tt>the_excerpt_rss</tt> | |
| * <tt>permalink_single_rss</tt> | |
| * <tt>comment_link</tt> | |
| * <tt>get_comment_author_rss</tt> | |
| * <tt>comment_author_rss</tt> | |
| * <tt>comment_text_rss</tt> | |
| * <tt>comments_rss_link</tt> | |
| * <tt>comments_rss</tt> | |
| * <tt>get_author_rss_link</tt> | |
| * <tt>get_category_rss_link</tt> | |
| * <tt>get_the_category_rss</tt> | |
| * <tt>the_category_rss</tt> | |
| * <tt>rss_enclosure</tt> | |
| |- valign="top" | |
| |bgcolor="#fbfbef" style="border:1px solid #ffc9c9;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Comment, Ping, and Trackback Functions == | |
| These functions are found in <tt>comment.php</tt>, <tt>functions.php</tt>, <tt>post.php</tt>. See also [[Template Functions]]. | |
| * <tt>check_comment</tt> | |
| * [[Function Reference/get_approved_comments|get_approved_comments]] | |
| * <tt>get_comment</tt> | |
| * <tt>get_lastcommentmodified</tt> | |
| * <tt>sanitize_comment_cookies</tt> | |
| * <tt>wp_allow_comment</tt> | |
| * <tt>wp_delete_comment</tt> | |
| * <tt>wp_get_comment_status</tt> | |
| * <tt>wp_get_current_commenter</tt> | |
| * <tt>wp_insert_comment</tt> | |
| * <tt>wp_filter_comment</tt> | |
| * <tt>wp_throttle_comment_flood</tt> | |
| * <tt>wp_new_comment</tt> | |
| * <tt>wp_set_comment_status</tt> | |
| * <tt>wp_update_comment</tt> | |
| * <tt>wp_update_comment_count</tt> | |
| * <tt>discover_pingback_server_uri</tt> | |
| * <tt>do_all_pings</tt> | |
| * <tt>do_trackbacks</tt> | |
| * <tt>generic_ping</tt> | |
| * <tt>pingback</tt> | |
| * <tt>privacy_ping_filter</tt> | |
| * <tt>trackback</tt> | |
| * <tt>weblog_ping</tt> | |
| * <tt>do_enclose</tt> | |
| * <tt>add_ping</tt> | |
| * <tt>get_enclosed</tt> | |
| * <tt>get_pung</tt> | |
| * <tt>get_to_ping</tt> | |
| * <tt>trackback_url_list</tt> | |
| |valign="top" bgcolor="#f0f0ff" style="border:1px solid #c6c9ff;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Action, Filter, and Plugin Functions == | |
| These functions are contained in <tt>plugin.php</tt>. See also [[Plugin API]]. | |
| * <tt>add_filter</tt> | |
| * <tt>apply_filters</tt> | |
| * <tt>merge_filters</tt> | |
| * <tt>remove_filter</tt> | |
| * [[Function Reference/add_action|add_action]] | |
| * [[Function Reference/do_action|do_action]] | |
| * <tt>did_action</tt> | |
| * <tt>do_action_ref_array</tt> | |
| * <tt>remove_action</tt> | |
| * <tt>plugin_basename</tt> | |
| * <tt>register_activation_hook</tt> | |
| * <tt>register_deactivation_hook</tt> | |
| |- valign="top" | |
| |bgcolor="#fbfbef" style="border:1px solid #ffc9c9;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Theme-Related Functions == | |
| These functions are found in <tt>theme.php</tt>. | |
| * <tt>get_stylesheet</tt> | |
| * <tt>get_stylesheet_directory</tt> | |
| * <tt>get_stylesheet_directory_uri</tt> | |
| * <tt>get_stylesheet_uri</tt> | |
| * <tt>get_locale_stylesheet_uri</tt> | |
| * <tt>get_template</tt> | |
| * <tt>get_template_directory</tt> | |
| * <tt>get_template_directory_uri</tt> | |
| * [[Function Reference/get_theme_data|get_theme_data]] | |
| * <tt>get_themes</tt> | |
| * <tt>get_theme</tt> | |
| * <tt>get_current_theme</tt> | |
| * <tt>get_theme_root</tt> | |
| * <tt>get_theme_root_uri</tt> | |
| * <tt>get_query_template</tt> | |
| * <tt>get_404_template</tt> | |
| * <tt>get_archive_template</tt> | |
| * <tt>get_author_template</tt> | |
| * <tt>get_category_template</tt> | |
| * <tt>get_date_template</tt> | |
| * <tt>get_home_template</tt> | |
| * <tt>get_page_template</tt> | |
| * <tt>get_paged_template</tt> | |
| * <tt>get_search_template</tt> | |
| * <tt>get_single_template</tt> | |
| * <tt>get_attachment_template</tt> | |
| * <tt>get_comments_popup_template</tt> | |
| * <tt>load_template</tt> | |
| * <tt>locale_stylesheet</tt> | |
| * <tt>validate_current_theme</tt> | |
| * <tt>get_theme_mod</tt> | |
| * <tt>set_theme_mod</tt> | |
| * <tt>get_header_textcolor</tt> | |
| * <tt>get_header_image</tt> | |
| * <tt>header_image</tt> | |
| * <tt>add_custom_image_header</tt> | |
| |valign="top" bgcolor="#f0f0ff" style="border:1px solid #c6c9ff;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Formatting Functions == | |
| These functions are contained in <tt>formatting.php</tt>, <tt>functions.php</tt>, <tt>kses.php</tt>. | |
| * [[Function_Reference/wptexturize|wptexturize( $text )]] | |
| * [[Function_Reference/clean_pre|clean_pre( $text )]] - Returns the text without BR tags, and with P tags turned into line-breaks | |
| * [[Function_Reference/wpautop|wpautop( $pee, $br = 1 )]] - Returns the text with HTML formatting for paragraphs | |
| * [[Function_Reference/seems_utf8|seems_utf8($Str)]] - Returns true if given string seems like it is UTF8-encoded | |
| * [[Function_Reference/wp_specialchars|wp_specialchars( $text, $quotes = 0 )]] - Like the PHP function htmlspecialchars except it doesn't double-encode HTML entities | |
| * <tt>utf8_uri_encode</tt> | |
| * [[Function_Reference/remove_accents|remove_accents($string)]] - Returns a string with accents or umlauts without these | |
| * <tt>sanitize_file_name</tt> | |
| * [[Function_Reference/sanitize_user|sanitize_user( $username, $strict = false )]] - Makes the username more machine-readable. Strict option for pure ASCII only. | |
| * [[Function_Reference/sanitize_title|sanitize_title($title, $fallback_title = '')]] | |
| * [[Function_Reference/sanitize_title_with_dashes|sanitize_title_with_dashes($title)]] | |
| * [[Function_Reference/convert_chars|convert_chars($content, $flag = 'obsolete')]] - Translation of invalid Unicode references range to valid range | |
| * <tt>funky_javascript_fix</tt> | |
| * [[Function_Reference/balanceTags|balanceTags($text, $is_comment = 0)]] - Balances Tags of string using a modified stack. Can be disabled by configuration. | |
| * <tt>force_balance_tags</tt> | |
| * <tt>format_to_edit</tt> | |
| * <tt>format_to_post</tt> | |
| * [[Function_Reference/zeroise|zeroise($number,$threshold)]] - Adds leading zeros when necessary | |
| * <tt>backslashit</tt> | |
| * <tt>trailingslashit</tt> | |
| * <tt>addslashes_gpc</tt> | |
| * <tt>stripslashes_deep</tt> | |
| * <tt>antispambot</tt> - converts email address to anti-spam version | |
| * <tt>make_clickable</tt> | |
| * <tt>wp_rel_nofollow</tt> | |
| * <tt>convert_smilies</tt> | |
| * <tt>is_email</tt> | |
| * <tt>wp_iso_descrambler</tt> | |
| * <tt>popuplinks</tt> - converts a link into a popup link that will open in a different window | |
| * <tt>sanitize_email</tt> | |
| * [[Function_Reference/ent2ncr|ent2ncr($text)]] - Returns HTML entity as its number representation. | |
| * <tt>wp_richedit_pre</tt> | |
| * <tt>clean_url</tt> | |
| * <tt>htmlentities2</tt> | |
| * <tt>js_escape</tt> | |
| * <tt>attribute_escape</tt> | |
| * <tt>wp_make_link_relative</tt> - makes an absolute link into a relative link | |
| * <tt>add_magic_quotes</tt> | |
| * <tt>wp_kses</tt> | |
| * <tt>wp_kses_hook</tt> | |
| * <tt>wp_kses_version</tt> | |
| * <tt>wp_kses_split</tt> | |
| * <tt>wp_kses_split2</tt> | |
| * <tt>wp_kses_attr</tt> | |
| * <tt>wp_kses_hair</tt> | |
| * <tt>wp_kses_check_attr_val</tt> | |
| * <tt>wp_kses_bad_protocol</tt> | |
| * <tt>wp_kses_no_null</tt> | |
| * <tt>wp_kses_strip_slashes</tt> | |
| * <tt>wp_kses_array_lc</tt> | |
| * <tt>wp_kses_js_entities</tt> | |
| * <tt>wp_kses_html_error</tt> | |
| * <tt>wp_kses_bad_protocol_once</tt> | |
| * <tt>wp_kses_bad_protocol_once2</tt> | |
| * <tt>wp_kses_normalize_entities</tt> | |
| * <tt>wp_kses_normalize_entities2</tt> | |
| * <tt>wp_kses_decode_entities</tt> | |
| * <tt>wp_filter_kses</tt> | |
| * <tt>wp_filter_post_kses</tt> | |
| * <tt>wp_filter_nohtml_kses</tt> | |
| |- valign="top" | |
| |bgcolor="#fbfbef" style="border:1px solid #ffc9c9;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Miscellanous Functions == | |
| These functions are contained in <tt>formatting.php</tt>, <tt>functions.php</tt>, <tt>bookmarks.php</tt>, <tt>cron.php</tt>, <tt>l10n.php</tt>, <tt>user.php</tt>, <tt>pluggable.php</tt> | |
| Time/Date Functions | |
| * <tt>get_gmt_from_date</tt> | |
| * <tt>get_date_from_gmt</tt> | |
| * <tt>iso8601_timezone_to_offset</tt> | |
| * <tt>iso8601_to_datetime</tt> | |
| * <tt>human_time_diff</tt> | |
| * <tt>mysql2date</tt> | |
| * [[Function Reference/current time|current_time]] | |
| * <tt>date_i18n</tt> | |
| * <tt>get_weekendstartend</tt> | |
| * <tt>get_lastpostdate</tt> | |
| * <tt>get_lastpostmodified</tt> | |
| * <tt>is_new_day</tt> | |
| Serialization | |
| * <tt>maybe_serialize</tt> | |
| * <tt>maybe_unserialize</tt> | |
| * <tt>is_serialized</tt> | |
| * <tt>is_serialized_string</tt> | |
| Options | |
| * <tt>get_option</tt> | |
| * <tt>form_option</tt> -- like <tt>get_option</tt>, but removes attributes from result</tt> | |
| * <tt>get_alloptions</tt> | |
| * <tt>update_option</tt> -- given option name and new value, it makes a safe update of given option's database row. | |
| * [[Function Reference/add option|add_option]] | |
| * [[Function Reference/delete option|delete_option]] -- removes row of given option name from the options database table. | |
| * <tt>get_user_option</tt> | |
| * <tt>update_user_option</tt> | |
| XMLRPC | |
| * <tt>xmlrpc_getposttitle</tt> | |
| * <tt>xmlrpc_getpostcategory</tt> | |
| * <tt>xmlrpc_removepostdata</tt> | |
| * <tt>user_pass_ok</tt> | |
| Localization | |
| See also [[Translating WordPress]]. | |
| * <tt>get_locale</tt> | |
| * <tt>__</tt> | |
| * <tt>_e</tt> | |
| * <tt>_ngettext</tt> | |
| * <tt>load_textdomain</tt> | |
| * <tt>load_default_textdomain</tt> | |
| * <tt>load_plugin_textdomain</tt> | |
| * <tt>load_theme_textdomain</tt> | |
| Cron (Scheduling) | |
| * <tt>wp_schedule_single_event</tt> | |
| * <tt>wp_schedule_event</tt> | |
| * <tt>wp_reschedule_event</tt> | |
| * <tt>wp_unschedule_event</tt> | |
| * <tt>wp_clear_scheduled_hook</tt> | |
| * <tt>wp_next_scheduled</tt> | |
| * <tt>spawn_cron</tt> | |
| * <tt>wp_cron</tt> | |
| * <tt>wp_get_schedules</tt> | |
| * <tt>wp_get_schedule</tt> | |
| Miscellaneous | |
| * <tt>gzip_compression</tt> | |
| * <tt>make_url_footnote</tt> | |
| * <tt>wp_get_http_headers</tt> | |
| * <tt>add_query_arg</tt> | |
| * <tt>remove_query_arg</tt> | |
| * <tt>wp_remote_fopen</tt> | |
| * <tt>wp</tt> | |
| * <tt>status_header</tt> | |
| * <tt>nocache_headers</tt> | |
| * <tt>cache_javascript_headers</tt> | |
| * <tt>get_num_queries</tt> | |
| * <tt>bool_from_yn</tt> - converts a "Y/N" variable into boolean true/false | |
| * <tt>do_robots</tt> | |
| * <tt>is_blog_installed</tt> | |
| * <tt>wp_nonce_url</tt> | |
| * <tt>wp_nonce_field</tt> | |
| * <tt>wp_referer_field</tt> | |
| * <tt>wp_original_referer_field</tt> | |
| * <tt>wp_get_referer</tt> | |
| * <tt>wp_get_original_referer</tt> | |
| * <tt>wp_mkdir_p</tt> | |
| * <tt>wp_upload_dir</tt> | |
| * <tt>wp_upload_bits</tt> | |
| * <tt>wp_check_filetype</tt> | |
| * <tt>wp_explain_nonce</tt> | |
| * <tt>wp_nonce_ays</tt> | |
| * <tt>wp_die</tt> | |
| * <tt>get_bookmark</tt> | |
| * <tt>get_bookmarks</tt> | |
| * <tt>wp_mail</tt> | |
| * <tt>check_admin_referer</tt> | |
| * <tt>check_ajax_referer</tt> | |
| * <tt>wp_redirect</tt> | |
| * <tt>wp_get_cookie_login</tt> | |
| * <tt>wp_setcookie</tt> | |
| * <tt>wp_clearcookie</tt> | |
| * <tt>wp_notify_postauthor</tt> | |
| * <tt>wp_notify_moderator</tt> | |
| * <tt>wp_new_user_notification</tt> | |
| * <tt>wp_verify_nonce</tt> | |
| * <tt>wp_create_nonce</tt> | |
| * <tt>wp_salt</tt> | |
| * <tt>wp_hash</tt> | |
| |valign="top" bgcolor="#f0f0ff" style="border:1px solid #c6c9ff;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Classes == | |
| The following classes were created by WordPress developers, and are found in files <tt>capabilities.php</tt>, | |
| <tt>classes.php</tt>, <tt>class-snoopy.php</tt>, <tt>locale.php</tt>, <tt>query.php</tt>, <tt>rewrite.php</tt>, <tt>script-loader.php</tt>, <tt>wp-db.php</tt>: | |
| * WP - general request handling | |
| * WP_Ajax_Response - AJAX handling | |
| * [[Function_Reference/WP_Cache|WP_Object_Cache]] (formerly <tt>WP_Cache</tt>) - Object cache (and functions <tt>wp_cache_add, wp_cache_close, wp_cache_delete, wp_cache_flush, wp_cache_get, wp_cache_init, wp_cache_replace, wp_cache_set</tt>) | |
| * WP_Error - error handling (and function <tt>is_wp_error</tt>) | |
| * <tt>WP_Locale</tt> - handles date and time locales | |
| * [[Function_Reference/WP_Query|WP_Query]] - Request parsing and manipulation, posts fetching (with functions <tt>get_query_var, query_posts, have_posts, in_the_loop, rewind_posts, the_post, wp_old_slug_redirect, setup_postdata</tt>, as well as the [[Conditional Tags]] <tt>is_*</tt>) | |
| * [[Function_Reference/WP_Rewrite|WP_Rewrite]] - Rewrite rules (and functions <tt>add_rewrite_rule, add_rewrite_tag, add_feed, add_rewrite_endpoint, url_to_postid</tt>) | |
| * WP_Roles, WP_Role, WP_User - Users and capabilities (and functions <tt>map_meta_cap, current_user_can, get_role, add_role, remove_role</tt>) | |
| * WP_Scripts - JavaScript loading (and functions <tt>wp_print_scripts, wp_register_script, wp_deregister_script, wp_enqueue_script</tt>) | |
| * Walker, Walker_Page, Walker_PageDropdown, Walker_Category, Walker_CategoryDropdown - Display tree-like data | |
| * [[Function_Reference/wpdb Class|wpdb]] - Database interface | |
| The following classes were created by outside developers, and are found in files <tt>class-IXR.php</tt>, <tt>class-pop3.php</tt>, <tt>class-snoopy.php</tt>, <tt>gettext.php</tt>, <tt>rss.php</tt>, <tt>streams.php</tt>: | |
| * [http://scripts.incutio.com/xmlrpc/ IXR] - XML-RPC Classes, including IXR_Value, IXR_Message, IXR_Server, IXR_IntrospectionServer, IXR_Request, IXR_Client, IXR_ClientMulticall, IXR_Error, IXR_Date, IXR_Base64 | |
| * [http://sourceforge.net/projects/snoopy/ Snoopy] - HTTP client | |
| * gettext_reader (part of [http://savannah.nongnu.org/projects/php-gettext/ PHP-gettext]) - Localization Class | |
| * [http://magpierss.sourceforge.net/ RSS Classes (MagpieRSS and RSSCache)] (and functions <tt>fetch_rss, is_info, is_success, is_redirect, is_error, is_client_error, is_server_error, parse_w3cdtf, wp_rss, get_rss</tt>) | |
| * POP3: SquirrelMail wrapper | |
| * <tt>StreamReader, StringReader, FileReader, CachedFileReader</tt> | |
| |} | |
| [[Category:Advanced Topics]] | |
| [[Category:Functions]] | |
| [[Category:WordPress Development]]</p> | |
| </d:entry> | |
| <d:entry id="get_theme_data" d:title="get theme data"> | |
| <d:index d:value="get theme data"/> | |
| <h1>get theme data</h1> | |
| <p>{{Deprecated|new_function=wp_get_theme}} | |
| == Description == | |
| Returns an array of information about a theme file. | |
| This function has been replaced with [[Function Reference/wp_get_theme|wp_get_theme]] in WordPress 3.4 | |
| == Usage == | |
| %%% <?php get_theme_data( $theme_filename ); ?> %%% | |
| Use [[Function Reference/wp_get_theme|wp_get_theme]] instead. | |
| == Parameters == | |
| {{Parameter|$theme_filename|string|Path and filename of the theme's <tt>style.css</tt>.}} | |
| == Return values == | |
| ;(array) | |
| : The function returns an array containing the following keyed information: | |
| ; 'Name' : (''string'') The Themes name. | |
| ; 'Title' : (''string'') Either the Theme's name or a HTML fragment containg the Theme's name linked to the Theme's URI if the Theme's URI is defined. | |
| ; 'URI' : (''string'') The Themes URI. | |
| ; 'Description' : (''string'') A HTML fragment containg the Themes description after it has passed through [[Function_Reference/wptexturize|wptexturize]]. | |
| ; 'AuthorURI' : (''string'') The Theme's Author URI. | |
| ; 'Template' : (''string'') The name of the parent Theme if one exists. | |
| ; 'Version' : (''string'') The Theme's version number. | |
| ; 'Status' : (''string'') the Theme's Status (defaults to 'publish') | |
| ; 'Tags' : (''string'') the Theme's Tags | |
| ; 'Author' : (''string'') Either the Author's name or a HTML fragment containing the Author's name linked to the Author's URI if the Author's URI is defined. | |
| == Example == | |
| === Usage === | |
| Get the information from the theme's style.css and display the Theme Name and Author. | |
| <pre> | |
| <?php | |
| /* | |
| * Assign theme folder name that you want to get information. | |
| * make sure theme exist in wp-content/themes/ folder. | |
| */ | |
| $theme_name = 'twentyeleven'; | |
| /* | |
| * Do not use get_stylesheet_uri() as $theme_filename, | |
| * it will result in PHP fopen error if allow_url_fopen is set to Off in php.ini, | |
| * which is what most shared hosting does. You can use get_stylesheet_directory() | |
| * or get_template_directory() though, because they return local paths. | |
| */ | |
| $theme_data = get_theme_data( get_theme_root() . '/' . $theme_name . '/style.css' ); | |
| echo $theme_data['Title']; | |
| echo $theme_data['Author']; | |
| ?> | |
| </pre> | |
| == Source File == | |
| <tt>get_theme_data()</tt> is located in {{Trac|wp-includes/deprecated.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:File Header API]]</p> | |
| </d:entry> | |
| <d:entry id="update_option" d:title="update option"> | |
| <d:index d:value="update option"/> | |
| <h1>update option</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/update_option}} | |
| {{ru|Справочник_по_функциям/update_option}} | |
| }} | |
| == Description == | |
| Use the function <tt>update_option()</tt> to update a named option/value pair to the options database table. The <tt>$option</tt> (option name) value is escaped with <tt>$wpdb->prepare</tt> before the INSERT statement but not the option value, this value should always be properly sanitized. | |
| This function may be used in place of [[Function Reference/add option|<tt>add_option</tt>]], although it is not as flexible. <tt>update_option</tt> will check to see if the option already exists. If it does not, it will be added with <tt>add_option('option_name', 'option_value')</tt>. Unless you need to specify the optional arguments of <tt>add_option()</tt>, <tt>update_option()</tt> is a useful catch-all for both adding and updating options. | |
| '''Note:''' This function cannot be used to change whether an option is to be loaded (or not loaded) by <tt>[[Function_Reference/wp_load_alloptions | wp_load_alloptions()]]</tt>. In that case, a [[Function_Reference/delete_option|<tt>delete_option()</tt>]] should be followed by use of the [[Function_Reference/add_option|<tt>add_option()</tt>]] function. | |
| == Usage == | |
| %%%<?php update_option( $option, $new_value ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$option|string|Name of the option to update. Must not exceed 64 characters. A list of valid default options to update can be found at the [[Option Reference]].}} | |
| {{Parameter|$newvalue|mixed|The NEW value for this option name. This value can be an integer, string, array, or object.}} | |
| == Return Value == | |
| {{Return||boolean|True if option value has changed, false if not or if update failed.}} | |
| == Example == | |
| === Updating Core Options === | |
| Set the default comment status to 'closed': | |
| update_option( 'default_comment_status', 'closed' ); | |
| This option is usually set by from the Settings > Discussion administration panel. See the [[Option Reference]] for a full list of options used by WordPress Core. | |
| === Updating Custom Options === | |
| You can also create your own custom options. To update the option <tt>'myhack_extraction_length'</tt> with the value 255, we would do this: | |
| update_option( 'myhack_extraction_length', 255 ); | |
| This will automatically add the option if it does not exist. However, if we don't want this option to be autoloaded, we have to add it with a<tt>dd_option()</tt>. In this example, we update the option if it already exists, and if it does not exist we use <tt>add_option()</tt> and set <tt>$autoload</tt> to "no". | |
| <pre> | |
| <?php | |
| $option_name = 'myhack_extraction_length' ; | |
| $new_value = '255' ; | |
| if ( get_option( $option_name ) !== false ) { | |
| // The option already exists, so we just update it. | |
| update_option( $option_name, $new_value ); | |
| } else { | |
| // The option hasn't been added yet. We'll add it with $autoload set to 'no'. | |
| $deprecated = null; | |
| $autoload = 'no'; | |
| add_option( $option_name, $new_value, $deprecated, $autoload ); | |
| } | |
| ?> | |
| </pre> | |
| == Change Log == | |
| Since: [[Version 1.0|1.0.0]] | |
| == Source File == | |
| <tt>update_option()</tt> is located in {{Trac|wp-includes/option.php}}. | |
| == Related == | |
| {{Option Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="Function_Reference_2.0.x" d:title="Function Reference 2.0.x"> | |
| <d:index d:value="Function Reference 2.0.x"/> | |
| <h1>Function Reference 2.0.x</h1> | |
| <p>__NOTOC__ | |
| '''Note: This page applies to versions of WordPress prior to WordPress 2.1, and is also incomplete. The current WordPress function reference is at [[Function Reference]]'''. | |
| <div style="border:blue 1px solid;padding:10px; text-align:center; background: #E6CCFF"> | |
| '''EDITORS AND CONTRIBUTORS''' | |
| The layout and structure of this page will follow [[Template Tags]]. Please create pages for these functions as subpages of this page. If you create a subpage for a function, please include information and examples of usage of that function, if possible, per the examples found in [[Template Tags]]. | |
| For example: <nowiki>[[Function_Reference/wpdb_Class|wpdb_Class]]</nowiki>. | |
| </div> | |
| WordPress defines many useful functions. Rather than reinventing the wheel, you should take advantage of the core functions whenever possible. Of course, if the slick new plugin you are designing needs a better wheel, you are on your own, but at least you can take inspiration from the following functions. | |
| Please check out the [[Mailing Lists#Documentation|wp-docs mailing list]] to find out how you can contribute to this section. And it needs ''your'' help!. | |
| <!-- remove this after there's enough example content --> | |
| ==Functions by category== | |
| {| cellspacing="10" width="100%" | |
| |- valign="top" | |
| |bgcolor="#fbfbef" style="border:1px solid #ffc9c9;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == General Functions == | |
| '''[[Function Reference|functions.php:]]''' | |
| * profile | |
| * time/date | |
| ** [[Function Reference/current time|current_time]] | |
| * options | |
| ** [[Function Reference/add option|add_option]] | |
| ** [[Function Reference/delete option|delete_option]] -- removes row of given option name from the options database table. | |
| ** form_option -- does a [[Function_Reference/get_settings|get_settings]] on given string and returns info for an option. Before calling get_settings, the indata is passed through htmlspecialchars(). | |
| ** get_alloptions - no parameters | |
| ** [[Function Reference/get settings|get_settings]] (alias: get_option) | |
| ** update_option -- given option name and new value, it makes a safe update of given option's database row. | |
| * meta | |
| * trackpack/ping | |
| * xmlrpc | |
| * filters | |
| * actions | |
| * is_single,page,archive,time/data | |
| * themes/templates | |
| * htmlentities2 | |
| * cookies | |
| * plugins | |
| * mail (pop) access | |
| '''[[Function Reference|complete list]]''' | |
| |valign="top" bgcolor="#f0f0ff" style="border:1px solid #c6c9ff;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Formatting Functions == | |
| This list is incomplete, please contribute. | |
| * [[Function_Reference/wptexturize|wptexturize( $text )]] | |
| * [[Function_Reference/clean_pre|clean_pre( $text )]] - Returns the text without BR tags, and with P tags turned into line-breaks | |
| * [[Function_Reference/wpautop|wpautop( $pee, $br = 1 )]] - Returns the text with HTML formatting for paragraphs | |
| * [[Function_Reference/seems_utf8|seems_utf8($Str)]] - Returns true if given string seems like it is UTF8-encoded | |
| * [[Function_Reference/wp_specialchars|wp_specialchars( $text, $quotes = 0 )]] - Like the PHP function htmlspecialchars except it doesn't double-encode HTML entities | |
| * [[Function_Reference/remove_accents|remove_accents($string)]] - Returns a string with accents or umlauts without these | |
| * [[Function_Reference/sanitize_user|sanitize_user( $username, $strict = false )]] - Makes the username more machine-readable. Strict option for pure ASCII only. | |
| * [[Function_Reference/sanitize_title|sanitize_title($title, $fallback_title = '')]] | |
| * [[Function_Reference/sanitize_title_with_dashes|sanitize_title_with_dashes($title)]] | |
| * [[Function_Reference/convert_chars|convert_chars($content, $flag = 'obsolete')]] - Translation of invalid Unicode references range to valid range | |
| * [[Function_Reference/balanceTags|balanceTags($text, $is_comment = 0)]] - Balances Tags of string using a modified stack. Can be disabled by configuration. | |
| * [[Function_Reference/zeroise|zeroise($number,$threshold)]] - Adds leading zeros when necessary | |
| * [[Function_Reference/ent2ncr|ent2ncr($text)]] - Returns HTML entity as its number representation. | |
| |- valign="top" | |
| |bgcolor="#fbfbef" style="border:1px solid #ffc9c9;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Post Functions == | |
| * [[Function Reference/get_post|get_post]] - get information on a specific post | |
| * [[Function Reference/get_cat_name|get_cat_name($cat_id)]] - get category name for given ID | |
| * [[Function Reference/get_cat_ID|get_cat_ID($cat_name='General')]] - get category ID for given category name | |
| * [[Function Reference/get_author_name|get_author_name( $auth_id )]] - get author's preferred display name | |
| * [[Function Reference/get_post_mime_type|get_post_mime_type($ID = "")]] - takes a post ID, returns its MIME type | |
| * [[Function Reference/wp_insert_post|wp_insert_post($postarr=array())]] - A generic function for inserting data into the post table | |
| * [[Function Reference/wp_update_post|wp_update_post($postarr=array())]] - A generic function to update data in the post table | |
| * [[Function Reference/wp_publish_post|wp_publish_post($post_id)]] - Set a post's post_status to 'publish'ed. Calls wp_update_post. | |
| * [[Function Reference/wp_delete_post|wp_delete_post($postid)]] - A generic function to delete a post in the post table | |
| |valign="top" bgcolor="#f0f0ff" style="border:1px solid #c6c9ff;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Comment Functions == | |
| * [[Function Reference/get_approved_comments|get_approved_comments]] | |
| |- valign="top" | |
| |bgcolor="#fbfbef" style="border:1px solid #ffc9c9;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Feed Functions == | |
| * is_feed -- returns a Boolean, true if the current context is within a feed (wrapper for $WP_Query->is_feed) | |
| * [[Function_Reference/fetch_rss|fetch_rss]] -- retrieve an RSS feed from a URL with automatic caching (included in rss_functions.php) | |
| * [[Function_Reference/wp_rss|wp_rss]] -- retrieve and display an RSS feed as an unordered list (included in rss_functions.php) | |
| * [[Function_Reference/get_rss|get_rss]] -- retrieve and display an RSS feed as a list (ordering optional) (included in rss_functions.php) | |
| |valign="top" bgcolor="#f0f0ff" style="border:1px solid #c6c9ff;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Link Functions == | |
| [[Function Reference/get category link|get_category_link]] | |
| |- valign="top" | |
| |bgcolor="#fbfbef" style="border:1px solid #ffc9c9;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Administration Functions == | |
| * [[Function_Reference/insert_with_markers|insert_with_markers]] -- Writes a string (e.g. rewrite rules for the .htaccess file) to a given file namne between two markers, BEGIN and END. | |
| *Please Contribute more... | |
| |valign="top" bgcolor="#f0f0ff" style="border:1px solid #c6c9ff;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| == Classes == | |
| ===WordPress classes=== | |
| * [[Function_Reference/WP_Cache|Object Cache]] | |
| * [[Function_Reference/wpdb Class|wpdb]] - Database Interface | |
| * [[Function_Reference/WP_Query|WP_Query]] - Request parsing and manipulation, posts fetching | |
| * [[Function_Reference/WP_Rewrite|WP_Rewrite]] - Rewrite rules | |
| * retrospam_mgr - Spam management | |
| * WP - general request handling (in [[Version 1.6]]) | |
| * Capabilities Classes (WP_Roles, WP_Role, WP_User) (in [[Version 2.0]]) | |
| ===External classes=== | |
| * [http://scripts.incutio.com/xmlrpc/ IXR] - XML-RPC Classes | |
| * [http://sourceforge.net/projects/snoopy/ Snoopy] - HTTP client | |
| * gettext_reader (part of [http://savannah.nongnu.org/projects/php-gettext/ PHP-gettext]) - Localization Class | |
| * [http://magpierss.sourceforge.net/ RSS Classes (Magpie and RSSCache)] | |
| |- valign="top" | |
| |bgcolor="#fbfbef" style="border:1px solid #ffc9c9;padding:1em;padding-top:0.5em; color: black;" width="50%"| | |
| ==User Functions== | |
| * [[Function Reference/get_currentuserinfo|get_currentuserinfo]] &mdash; get information on the current user | |
| * [[Function Reference/get_userdata|get_userdata]] &mdash; get information on any user | |
| * [[Function_Reference/get_usernumposts|get_usernumposts]] &mdash; get post count for a specific user | |
| * [[Function_Reference/get_usermeta|get_usermeta]] &mdash; get meta data for a specific user | |
| * [[Function_Reference/wp_create_user|wp_create_user]] &mdash; Create a user and add it to the user database. | |
| |} | |
| ==Functions by file== | |
| The functions are defined in several PHP files, nearly all residing in the <tt>wp-includes</tt> directory: | |
| ; <tt>classes.php</tt>, <tt>class-IXR.php</tt>, <tt>class-pop3.php</tt>, <tt>class-snoopy.php</tt>, <tt>gettext.php</tt>, <tt>wp-db.php</tt> : [[#Classes|Classes]]. | |
| ; <tt>comment-functions.php</tt> : [[#Comment_Functions|Comment functions]]. | |
| ; <tt>feed-functions.php</tt>, <tt>rss-functions.php</tt> : [[#Feed_Functions|Feed functions]]. | |
| ; <tt>functions-compat.php</tt> : Compatibility functions for those running lower PHP versions. | |
| ; <tt>functions-formatting.php</tt> : [[#Formatting_Functions|Formatting functions]]. | |
| ; <tt>functions.php</tt> : [[#Basic_Functions|Basic functions]]. | |
| ; <tt>functions-post.php</tt> : [[#Post_Functions|Post functions]]. | |
| ; <tt>links.php</tt> : [[#Link_Functions|Link functions]]. | |
| ; <tt>pluggable-functions.php</tt> : Pluggable functions (1.5.1+). | |
| ; <tt>template-functions-*.php</tt> : [[Template Tags]]. | |
| ; <tt>registration-functions.php</tt>, <tt>wp-admin/admin-functions.php</tt> : [[#Administration_Functions|Administration functions]]. | |
| == DRAFT == | |
| The following functions are to be moved into their appropriate categories above. | |
| * [[Function Reference/add_action|add_action]] | |
| * add_filter | |
| * add_magic_quotes | |
| * add_post_meta | |
| * add_query_arg | |
| * apply_filters | |
| * auth_redirect | |
| * date_i18n | |
| * debug_fclose | |
| * debug_fopen | |
| * delete_post_meta | |
| * [[Function Reference/do_action|do_action]] | |
| * do_enclose | |
| * generic_ping | |
| * get_404_template | |
| * get_archive_template | |
| * [[Function Reference/get_approved_comments|get_approved_comments]] | |
| * get_author_template | |
| * get_category_template | |
| * get_catname | |
| * get_comments_popup_template | |
| * get_current_theme | |
| * get_date_template | |
| * get_home_template | |
| * get_lastpostdate | |
| * get_lastpostmodified | |
| * get_page_template | |
| * get_page_uri | |
| * get_paged_template | |
| * get_post_meta | |
| * get_postdata | |
| * get_posts | |
| * get_profile | |
| * get_query_template | |
| * get_query_var | |
| * get_search_template | |
| * get_single_template | |
| * get_stylesheet | |
| * get_stylesheet_directory | |
| * get_stylesheet_directory_uri | |
| * get_stylesheet_uri | |
| * get_template | |
| * get_template_directory | |
| * get_template_directory_uri | |
| * get_theme | |
| * [[Function Reference/get_theme_data|get_theme_data]] | |
| * get_theme_root | |
| * get_theme_root_uri | |
| * get_themes | |
| * get_userdatabylogin | |
| * get_userid | |
| * get_weekstartend | |
| * gzip_compression | |
| * have_posts | |
| * htmlentities2 | |
| * is_404 | |
| * is_archive | |
| * is_author | |
| * is_category | |
| * is_comments_popup | |
| * is_date | |
| * is_day | |
| * is_home | |
| * is_month | |
| * is_new_day | |
| * is_page | |
| * is_paged | |
| * is_plugn_page | |
| * is_search | |
| * is_single | |
| * is_time | |
| * is_trackback | |
| * is_year | |
| * load_template | |
| * make_url_footnote | |
| * merge_filters | |
| * mysql2date | |
| * query_posts | |
| * remove_action | |
| * remove_filter | |
| * remove_query_arg | |
| * rewind_posts | |
| * setup_postdata | |
| * start_wp | |
| * the_post | |
| * [[Function Reference/timer_stop|timer_stop]] | |
| * trackback | |
| * update_category_cache | |
| * update_post_caches | |
| * update_post_meta | |
| * update_user_cache | |
| * url_to_postid | |
| * user_pass_ok | |
| * weblog_ping | |
| * wp_clearcookie | |
| * wp_head | |
| * wp_insert_post | |
| * wp_login | |
| * wp_mail | |
| * wp_setcookie | |
| * xmlrpc_getpostcategory | |
| * xmlrpc_getposttitle | |
| * xmlrpc_removepostdata | |
| [[Category:Advanced Topics]] | |
| [[Category:Functions]] | |
| [[Category:WordPress Development]] | |
| [[Category:Redundant]]</p> | |
| </d:entry> | |
| <d:entry id="get_settings" d:title="get settings"> | |
| <d:index d:value="get settings"/> | |
| <h1>get settings</h1> | |
| <p>{{Deprecated}} | |
| == Description == | |
| * '''NB:''' instead of get_settings, use [[Function_Reference/get_option|get_option($optionname)]] | |
| A safe way of getting values for a named option from the options database table. | |
| === Note === | |
| For a complete list of all options available through this function, go to | |
| <nowiki> http://www.yoursite.com/wp-admin/options.php </nowiki> | |
| '''Also:''' You can modify any/all of the options from the same page. | |
| === Aliases === | |
| %%% get_option($optionname) %%% | |
| This is a wrapper around the get_settings function, added for readability and a more humane interface. | |
| == Usage == | |
| %%% <?php echo get_settings('show'); ?> %%% | |
| or | |
| %%% <?php echo get_option('show'); ?> %%% | |
| == Examples == | |
| === Show Blog Title === | |
| Displays your blog's title in a &lt;h1&gt; tag. | |
| %%% <h1><?php echo get_settings('blogname'); ?></h1> %%% | |
| or | |
| %%% <h1><?php echo get_option('blogname'); ?></h1> %%% | |
| === Show Character Set === | |
| Displays the character set your blog is using (ex: UTF-8) | |
| %%% <p>Character set: <?php echo get_settings('blog_charset'); ?> </p> %%% | |
| or | |
| %%% <p>Character set: <?php echo get_option('blog_charset'); ?> </p> %%% | |
| ===Retrieve Administrator E-mail=== | |
| Retrieve the e-mail of the blog administrator, storing it in a variable. | |
| %%%<?php $admin_email = get_settings('admin_email'); ?>%%% | |
| or | |
| %%% <?php $admin_email = get_option('admin_email'); ?> %%% | |
| == Parameters == | |
| ; show : (''string'') Name of the option. Underscores separate words, lowercase only - this is going to be in a database. Valid values: | |
| :* <tt>'admin_email'</tt> - E-mail address of blog administrator. | |
| :* <tt>'blogname'</tt> - Weblog title; set in General Options. | |
| :* <tt>'blogdescription'</tt> - Tagline for your blog; set in General Options. | |
| :* <tt>'blog_charset'</tt> - Character encoding for your blog; set in Reading Options. | |
| :* <tt>'date_format'</tt> - Default date format; set in General Options. | |
| :* <tt>'default_category'</tt> - Default post category; set in Writing Options. | |
| :* <tt>'home'</tt> - The blog's home web address; set in General Options. | |
| :* <tt>'siteurl'</tt> - WordPress web address; set in General Options.<br />'''Warning:''' This is not the same as get_bloginfo('siteurl'); which will return the homepage url. Use get_bloginfo('wpurl'), get_settings() has been deprecated. | |
| :* <tt>'template'</tt> - The current theme's name; set in Presentation. | |
| :* <tt>'start_of_week'</tt> - Day of week calendar should start on; set in General Options. | |
| :* <tt>'upload_path'</tt> - Default upload location; set in Miscellaneous Options. | |
| :* <tt>'posts_per_page'</tt> - Maximum number of posts to show on a page; set in Reading Options. | |
| :* <tt>'posts_per_rss'</tt> - Maximum number of most recent posts to show in the syndication feed; set in Reading Options. | |
| :There are many more options available, a lot of which depend on what plugins you have installed. Visit the /wp-admin/options.php page for a complete list. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="form_option" d:title="form option"> | |
| <d:index d:value="form option"/> | |
| <h1>form option</h1> | |
| <p>== Description == | |
| Echo option value after sanitizing for forms. | |
| == Usage == | |
| %%%<?php form_option( $option ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$option|string|Option name.}} | |
| == Return Values == | |
| ; (Echo) : '''echos''' the value in a get_option after its passed through esc_attr() | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/esc_attr|<tt>esc_attr()</tt>]] to sanitize option value. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>form_option()</tt> is located in {{Trac|wp-includes/option.php}}. | |
| == Related == | |
| {{Option Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_create_user" d:title="wp create user"> | |
| <d:index d:value="wp create user"/> | |
| <h1>wp create user</h1> | |
| <p>== Description == | |
| The [[Function_Reference/wp_create_user|wp_create_user]] function allows you to insert a new user into the WordPress database. It uses the $wpdb class to escape the variable values, preparing it for insertion into the database. Then the [http://php.net/compact PHP compact() function] is used to create an array with these values. To create a user with additional parameters, use [[Function_Reference/wp_insert_user|wp_insert_user()]]. | |
| == Usage == | |
| %%% <?php wp_create_user( $username, $password, $email ); ?> %%% | |
| == Example == | |
| As used in wp-admin/upgrade-functions.php: | |
| <pre> | |
| $user_id = username_exists( $user_name ); | |
| if ( !$user_id and email_exists($user_email) == false ) { | |
| $random_password = wp_generate_password( $length=12, $include_standard_special_chars=false ); | |
| $user_id = wp_create_user( $user_name, $random_password, $user_email ); | |
| } else { | |
| $random_password = __('User already exists. Password inherited.'); | |
| } | |
| </pre> | |
| == Parameters == | |
| {{Parameter|$username|string|The username of the user to be created.}} | |
| {{Parameter|$password|string|The password of the user to be created.}} | |
| {{Parameter|$email|string|The email address of the user to be created.|optional}} | |
| == Returns == | |
| When successful - this function returns the user ID of the created user. | |
| In case of failure (username or email already exists) the function returns an [[Class_Reference/WP_Error|error object]], with these possible values and messages; | |
| * ''empty_user_login'', Cannot create a user with an empty login name. | |
| * ''existing_user_login'', This username is already registered. | |
| * ''existing_user_email'', This email address is already registered. | |
| == Source File == | |
| <tt>wp_create_user()</tt> is located in {{Trac|wp-includes/user.php}}. | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_userdata" d:title="get userdata"> | |
| <d:index d:value="get userdata"/> | |
| <h1>get userdata</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/get_userdata}} | |
| {{ko|Function_Reference/get_userdata}} | |
| {{tr|Fonksiyon Listesi/get_userdata}} | |
| }} | |
| == Description == | |
| Returns a [[Class_Reference/WP_User|WP_User]] object with the information pertaining to the user whose ID is passed to it. Properties de-referenced with "-&gt;" map directly to wp_users and wp_usermeta tables in the database (see [[Database Description#Table:_wp_users|Database Description]]). | |
| If the user does not exist, the function returns <code>false</code>. | |
| An alias of [[Function_Reference/get_user_by|get_user_by('id')]]. | |
| == Usage == | |
| %%% <?php get_userdata( $userid ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$userid|integer|The ID of the user whose data should be retrieved.}} | |
| == Return Values == | |
| ; <tt>(bool|object)</tt> : False on failure, <tt>[[Class_Reference/WP_User | WP_User]]</tt> object on success. | |
| == Examples == | |
| === Basic Usage === | |
| The <tt>get_userdata()</tt> function returns an object of the user's data. You can echo various parts of the returned object or loop through the data to display it all. | |
| Example displaying certain parts: | |
| <?php $user_info = get_userdata(1); | |
| echo 'Username: ' . $user_info->user_login . "\n"; | |
| echo 'User roles: ' . implode(', ', $user_info->roles) . "\n"; | |
| echo 'User ID: ' . $user_info->ID . "\n"; | |
| ?> | |
| Results in: <div style="border:1px solid lightblue; display_inline-block; margin: 1em; padding: 1em;">Username: admin<br />User roles: administrator<br />User ID: 1</div> | |
| You can also assign certain parts into individual variables for displaying later or in multiple places. | |
| Example for extracting certain parts: | |
| <?php $user_info = get_userdata(1); | |
| $username = $user_info->user_login; | |
| $first_name = $user_info->first_name; | |
| $last_name = $user_info->last_name; | |
| echo "$first_name $last_name logs into her WordPress site with the user name of $username."; | |
| ?> | |
| Results in: <div style="border:1px solid lightblue; display_inline-block; margin: 1em; padding: 1em;">Harriet Smith logs into her WordPress site with the user name of mrssmith.</div> | |
| === Accessing Usermeta Data === | |
| <?php $user_info = get_userdata(1); | |
| echo $user_info->last_name . ", " . $user_info->first_name . "\n"; | |
| ?> | |
| Results in: <div style="border:1px solid lightblue; display_inline-block; margin: 1em; padding: 1em;">Doe, John</div> | |
| == Notes == | |
| Here are some of the useful values in the <tt>wp_users</tt> and <tt>wp_usermeta</tt> tables you can access with this function for use in your theme or plugin: | |
| * '''users''' | |
| ** ID | |
| ** user_login | |
| ** user_pass | |
| ** user_nicename | |
| ** user_email | |
| ** user_url | |
| ** user_registered | |
| ** display_name | |
| * '''user_meta''' | |
| ** user_firstname | |
| ** user_lastname | |
| ** nickname | |
| ** description | |
| ** wp_capabilities (array) | |
| ** admin_color (Theme of your admin page. Default is fresh.) | |
| ** closedpostboxes_page | |
| ** primary_blog | |
| ** rich_editing | |
| ** source_domain | |
| <b>Note:</b> the WP_User object uses PHP 5 "magic" methods to provide some of its properties. For example:<br/> | |
| <tt>$user_info->user_login</tt> is shorthand for <tt>$user_info->data->user_login</tt>, and<br/> | |
| <tt>$user_info->rich_editing</tt> is shorthand for <tt>get_user_meta($user_info->ID, 'rich_editing', true)</tt>. | |
| == Source File == | |
| <tt>get_userdata()</tt> is located in {{Trac|wp-includes/pluggable.php}}. | |
| == See Also == | |
| * [[Author Templates]] | |
| == Related == | |
| {{Get User Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="add_filter" d:title="add filter"> | |
| <d:index d:value="add filter"/> | |
| <h1>add filter</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/add_filter}} | |
| {{it|Function_Reference/it:add_filter}} | |
| {{ja|関数リファレンス/add_filter}} | |
| {{ru|Справочник_по_функциям/add_filter}} | |
| }} | |
| == Description == | |
| Hook a function to a specific filter action. | |
| * Glossary: [http://codex.wordpress.org/Glossary#Filter Filters] | |
| == Usage == | |
| %%% <?php add_filter( $tag, $function_to_add, $priority, $accepted_args ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$tag|string|The name of the existing Filter to Hook the <tt>$function_to_add</tt> argument to. You can find a [http://codex.wordpress.org/Plugin_API/Filter_Reference list of Filter Hooks here].}} | |
| {{Parameter|$function_to_add|callback|The name of the function to be called when the custom Filter is [[Function Reference/apply_filters|applied]].}} | |
| {{Parameter|$priority|integer|Used to specify the order in which the functions associated with a particular action are executed. Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the filter.|optional|10}} | |
| {{Parameter|$accepted_args|integer|The number of arguments the function(s) accept(s). In WordPress 1.5.1 and newer hooked functions can take extra arguments that are set when the matching apply_filters() call is run.|optional|1}} | |
| == Return == | |
| The function returns true if the attempted function hook succeeds or false if not. There is no test that the function exists nor whether the <tt>$function_to_add</tt> is even a string. It is up to you to take care. | |
| This is done for optimization purposes, so everything is as quick as possible. | |
| == Example == | |
| The filter <tt>img_caption_shortcode</tt> is applied in <tt>media.php</tt> using the following call: | |
| <pre> | |
| // Allow plugins/themes to override the default caption template. | |
| $output = apply_filters('img_caption_shortcode', '', $attr, $content); | |
| if ( $output != '' ) | |
| return $output; | |
| </pre> | |
| The target filter function will be called with three arguments: | |
| * &#39;&#39; &lt;= This is normally the value the filter will be modifying | |
| * $attr | |
| * $content | |
| In order for the filter function to actually receive the full argument list, the call to <tt>add_filter()</tt> must | |
| be modified to specify there are 3 arguments on the parameter list. | |
| <pre> | |
| add_filter('img_caption_shortcode', 'my_img_caption_shortcode_filter',10,3); | |
| /** | |
| * Filter to replace the [caption] shortcode text with HTML5 compliant code | |
| * | |
| * @return text HTML content describing embedded figure | |
| **/ | |
| function my_img_caption_shortcode_filter($val, $attr, $content = null) | |
| { | |
| extract(shortcode_atts(array( | |
| 'id' => '', | |
| 'align' => '', | |
| 'width' => '', | |
| 'caption' => '' | |
| ), $attr)); | |
| if ( 1 > (int) $width || empty($caption) ) | |
| return $val; | |
| $capid = ''; | |
| if ( $id ) { | |
| $id = esc_attr($id); | |
| $capid = 'id="figcaption_'. $id . '" '; | |
| $id = 'id="' . $id . '" aria-labelledby="figcaption_' . $id . '" '; | |
| } | |
| return '<figure ' . $id . 'class="wp-caption ' . esc_attr($align) . '" style="width: ' | |
| . (10 + (int) $width) . 'px">' . do_shortcode( $content ) . '<figcaption ' . $capid | |
| . 'class="wp-caption-text">' . $caption . '</figcaption></figure>'; | |
| } | |
| </pre> | |
| == Notes == | |
| * Hooked functions can take extra arguments that are set when the matching <tt>[[Function_Reference/do_action | do_action()]]</tt> or <tt>[[Function_Reference/apply_filters | apply_filters()]]</tt> call is run. For example, the action <tt>[[Plugin_API/Action_Reference/comment_id_not_found | 'comment_id_not_found']]</tt> will pass the comment ID to each callback. | |
| * Although you can pass the number of <tt>$accepted_args</tt>, you can only manipulate the <tt>[http://codex.wordpress.org/Function_Reference/apply_filters#Parameters $value]</tt>. The other arguments are only to provide context, and their values cannot be changed by the filter function. | |
| * You can also pass a class method as a callback. | |
| :Static class method: | |
| :<pre>add_filter( 'media_upload_newtab', array( 'My_Class', 'media_upload_callback' ) );</pre> | |
| :Instance method: | |
| :<pre>add_filter( 'media_upload_newtab', array( $this, 'media_upload_callback' ) );</pre> | |
| * You can also pass an an anonymous function as a callback. For example: | |
| :<pre>add_filter( 'the_title', function( $title ) { return '<b>' . $title . '</b>'; } );</pre> | |
| :[http://www.php.net/manual/functions.anonymous.php Anonymous functions] were introduced in PHP 5.3.0. Check [[Hosting WordPress]] requirements and double check your PHP version before using them. | |
| :If your version of PHP is older than 5.3.0, you can use <tt>[http://www.php.net/manual/function.create-function.php create_function()]</tt> instead. But keep in mind that lambda functions created by <tt>create_function()</tt> are not [http://framework.zend.com/issues/browse/ZF-7646 cached by APC or any other optimizer]. So don't use <tt>create_function()</tt> if callback is supposed to be used more than few times or it has complex logic. | |
| == Change Log == | |
| * Since: 0.71 | |
| == Source File == | |
| <tt>add_filter()</tt> is located in {{Trac|wp-includes/plugin.php}}. | |
| == See Also == | |
| * [http://stackoverflow.com/questions/13797313/wordpress-how-to-return-value-when-use-add-filter/13797597#13797597 A good explanation on Filter hooks on stackoverflow.com] (2012-12-10) | |
| == Related == | |
| {{Filter Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_currentuserinfo" d:title="get currentuserinfo"> | |
| <d:index d:value="get currentuserinfo"/> | |
| <h1>get currentuserinfo</h1> | |
| <p>== Description == | |
| Retrieves the information pertaining to the currently logged in user, and places it in the global variable <tt>$current_user</tt>. Properties map directly to the wp_users table in the database (see [[Database Description#Table:_wp_users|Database Description]]). | |
| Also places the individual attributes into the following separate global variables: | |
| :* <tt>$user_login</tt> | |
| :* <tt>$user_ID</tt> (Equal $current_user->ID, not $current_user->user_ID) | |
| :* <tt>$user_email</tt> | |
| :* <tt>$user_url</tt> (User's website, as entered in the user's Profile) | |
| :* <tt>$user_pass</tt> (The phpass hash of the user password - useful for comparing input at a password prompt with the actual user password.) | |
| :* <tt>$display_name</tt> (User's name, displayed according to the 'How to display name' User option) | |
| :* <tt>$user_identity</tt> (User's name, displayed according to the 'How to display name' User option (since 3.0)) | |
| == Usage == | |
| %%% <?php get_currentuserinfo(); ?> %%% | |
| == Examples == | |
| === Default Usage === | |
| The call to <tt>get_currentuserinfo()</tt> places the current user's info into <tt>$current_user</tt>, where it can be retrieved using member variables. | |
| <?php global $current_user; | |
| get_currentuserinfo(); | |
| echo 'Username: ' . $current_user->user_login . "\n"; | |
| echo 'User email: ' . $current_user->user_email . "\n"; | |
| echo 'User first name: ' . $current_user->user_firstname . "\n"; | |
| echo 'User last name: ' . $current_user->user_lastname . "\n"; | |
| echo 'User display name: ' . $current_user->display_name . "\n"; | |
| echo 'User ID: ' . $current_user->ID . "\n"; | |
| ?> | |
| <div style="border:1px solid blue; width:70%; padding:10px">Username: Zedd<br /> | |
| User email: my@email.com<br /> | |
| User first name: John<br /> | |
| User last name: Doe<br /> | |
| User display name: John Doe<br /> | |
| User ID: 1</div> | |
| === Using Separate Globals === | |
| Much of the user data is placed in separate global variables, which can be accessed directly. | |
| <?php global $display_name , $user_email; | |
| get_currentuserinfo(); | |
| echo $display_name . "'s email address is: " . $user_email; | |
| ?> | |
| <div style="border:1px solid blue; width:50%; padding:10px">Zedd's email address is: john@example.com</div> | |
| ''' NOTE:''' $display_name does not appear to work in 2.5+? Use $user_identity | |
| <?php global $user_login , $user_email; | |
| get_currentuserinfo(); | |
| echo($user_login . "'s email address is: " . $user_email; | |
| ?> | |
| == Parameters == | |
| This function does not accept any parameters. | |
| To determine if there is a user currently logged in, do this: | |
| <?php | |
| if(!is_user_logged_in()) { | |
| //no user logged in | |
| } | |
| ?> | |
| Here is another example: | |
| <pre> | |
| <?php if ( is_user_logged_in() ) { ?> | |
| <!-- text that logged in users will see --> | |
| <?php } else { ?> | |
| <!-- here is a paragraph that is shown to anyone not logged in --> | |
| <p>By <a href="<?php home_url(); ?>/wp-register.php">registering</a>, you can save your favorite posts for future reference.</p> | |
| <?php } ?> | |
| </pre> | |
| Here is yet another example using logical conditionals to restrict access to pages: | |
| <pre> | |
| <?php if ($current_user->user_login == 'the_username') { ?> | |
| <!-- Welcome the user or show the page content --> | |
| <h1>Welcome <?php echo $current_user->user_firstname ?></h1> | |
| <?php } else { ?> | |
| <!-- Let the visitor know access is denied --> | |
| <h1>Go away!</h1> | |
| <?php } ?> | |
| </pre> | |
| == Source File == | |
| <tt>get_currentuserinfo()</tt> is located in {{Trac|wp-includes/pluggable.php}}. | |
| == Related == | |
| {{Get User Tags}} | |
| {{Current User Tags}} | |
| {{Tag Footer}} | |
| {{Copyedit}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_all_category_ids" d:title="get all category ids"> | |
| <d:index d:value="get all category ids"/> | |
| <h1>get all category ids</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_all_category_ids}} | |
| {{it|Riferimento_funzioni/get_all_category_ids}} | |
| }} | |
| == Description == | |
| Retrieves all category IDs. | |
| == Usage == | |
| %%%<?php get_all_category_ids() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (array) : A list of all of the category IDs. | |
| == Examples == | |
| To print a list of categories by id: name | |
| <pre><?php | |
| $category_ids = get_all_category_ids(); | |
| foreach($category_ids as $cat_id) { | |
| $cat_name = get_cat_name($cat_id); | |
| echo $cat_id . ': ' . $cat_name; | |
| } | |
| ?></pre> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_all_category_ids()</tt> is located in {{Trac|wp-includes/category.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="Category:Template_Tags" d:title="Category:Template Tags"> | |
| <d:index d:value="Category:Template Tags"/> | |
| <h1>Category:Template Tags</h1> | |
| <p>Articles in the Template Tags Category document the proper use and syntax of the Template Tags used in WordPress | |
| [[Category:Advanced Topics]] | |
| [[Category:Design and Layout]] | |
| [[Category:WordPress Development]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="fetch_rss" d:title="fetch rss"> | |
| <d:index d:value="fetch rss"/> | |
| <h1>fetch rss</h1> | |
| <p>{{Deprecated}} | |
| ==Description== | |
| Retrieves an RSS feed and parses it. Uses the [http://magpierss.sourceforge.net/ MagpieRSS and RSSCache] functions for parsing and automatic caching and the [http://sourceforge.net/projects/snoopy/ Snoopy HTTP client] for the actual retrieval. | |
| Deprecated note: Switch to using [[Function_Reference/fetch_feed|fetch_feed]] instead. | |
| ==Usage== | |
| %%% <?php | |
| include_once(ABSPATH . WPINC . '/rss.php'); | |
| $rss = fetch_rss($uri); | |
| ?> %%% | |
| ==Parameters== | |
| {{Parameter|$uri|URI|The URI of the RSS feed you want to retrieve. The resulting parsed feed is returned, with the more interesting and useful bits in the items array.}}rray. | |
| ==Example== | |
| To get and display a list of links for an existing RSS feed, limiting the selection to the most recent 5 items: | |
| %%% | |
| <h2><?php _e('Headlines from AP News'); ?></h2> | |
| <?php // Get RSS Feed(s) | |
| include_once(ABSPATH . WPINC . '/rss.php'); | |
| $rss = fetch_rss('http://example.com/rss/feed/goes/here'); | |
| $maxitems = 5; | |
| $items = array_slice($rss->items, 0, $maxitems); | |
| ?> | |
| <ul> | |
| <?php if (empty($items)): ?> | |
| <li>No items</li> | |
| <?php else: | |
| foreach ( $items as $item ): | |
| ?> | |
| <li> | |
| <a href='<?php echo $item['link']; ?>' title='<?php echo $item['title']; ?>'> | |
| <?php echo $item['title']; ?> | |
| </a> | |
| </li> | |
| <?php | |
| endforeach; | |
| endif; | |
| ?> | |
| </ul> | |
| %%% | |
| == Change Log == | |
| * Since [[Version 1.5]] | |
| * Deprecated in [[Version 3.0]] | |
| == Source File == | |
| <code>fetch_rss</code> is defined in {{Trac|wp-includes/rss.php}}. | |
| == Related == | |
| * [[Function_Reference/fetch_feed|fetch_feed]] | |
| * [[Function_Reference/wp_rss|wp_rss()]] | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="add_action" d:title="add action"> | |
| <d:index d:value="add action"/> | |
| <h1>add action</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/add_action}} | |
| {{ja|関数リファレンス/add_action}} | |
| {{zh-hans|函数参考/add_action}} | |
| {{ko|한국어/add_action}} | |
| }} | |
| == Description == | |
| Hooks a function on to a specific [http://codex.wordpress.org/Glossary#Action action]. | |
| More specifically, this function will run the function <tt>$function_to_add</tt> when the event <tt>$hook</tt> occurs. | |
| This function is an alias to [[Function_Reference/add_filter|add_filter()]]. | |
| See [[Plugin_API/Action_Reference|Plugin API/Action Reference]] for a list of action hooks. Actions are (usually) triggered when the WordPress core calls [[Function_Reference/do_action|do_action()]]. | |
| == Usage == | |
| %%%<?php add_action( $hook, $function_to_add, $priority, $accepted_args ); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$hook|string|The name of the action to which $function_to_add is hooked. (See [[Plugin_API/Action_Reference|Plugin API/Action Reference]] for a list of action hooks). Can also be the name of an action inside a theme or plugin file, or the special tag "all", in which case the function will be called for all hooks)}} | |
| {{Parameter|$function_to_add|callback|The name of the function you wish to be hooked.}} | |
| {{Parameter|$priority|int|Used to specify the order in which the functions associated with a particular action are executed. Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action.|optional|10}} | |
| {{Parameter|$accepted_args|int|The number of arguments the hooked function accepts. In WordPress 1.5.1+, hooked functions can take extra arguments that are set when the matching [[Function_Reference/do_action|do_action()]] or [[Function_Reference/apply_filters|apply_filters()]] call is run. For example, the action <tt>comment_id_not_found</tt> will pass any functions that hook onto it the ID of the requested comment.|optional|1}} | |
| == Return Values == | |
| ; <tt>(boolean)</tt> : Always True. | |
| == Examples == | |
| === Simple Hook === | |
| To email some friends whenever an entry is posted on your blog: | |
| <pre> | |
| function email_friends( $post_ID ) { | |
| $friends = 'bob@example.org, susie@example.org'; | |
| wp_mail( $friends, "sally's blog updated", 'I just put something on my blog: http://blog.example.com' ); | |
| return $post_ID; | |
| } | |
| add_action( 'publish_post', 'email_friends' ); | |
| </pre> | |
| === Accepted Arguments === | |
| A hooked function can optionally accept arguments from the action call, if any are set to be passed. In this simplistic example, the <tt>echo_comment_id</tt> function takes the <tt>$comment_id</tt> argument, which is automatically passed to when the [[Function_Reference/do_action|do_action()]] call using the <tt>comment_id_not_found</tt> filter hook is run. | |
| <pre> | |
| function echo_comment_id( $comment_id ) { | |
| echo 'Comment ID ' . $comment_id . ' could not be found'; | |
| } | |
| add_action( 'comment_id_not_found', 'echo_comment_id', 10, 1 ); | |
| </pre> | |
| === Using with a Class === | |
| To use <tt>add_action()</tt> when your plugin or theme is built using classes, you need to use [http://www.php.net/manual/en/language.types.callable.php#language.types.callable.passing the array callable syntax]. You would pass the function to <tt>add_action()</tt> as an array, with $this as the first element, then the name of the class method, like so: | |
| <pre> | |
| class MyPluginClass { | |
| public function __construct() { | |
| add_action( 'save_post', array( $this, 'myplugin_save_posts' ) ); | |
| } | |
| public function myplugin_save_posts() { | |
| // do stuff here... | |
| } | |
| } | |
| </pre> | |
| == Notes == | |
| To find out the number and name of arguments for an action, simply search the code base for the matching do_action() call. For example, if you are hooking into 'save_post', you would find it in post.php: | |
| %%% <?php do_action( 'save_post', $post_ID, $post, $update ); ?> %%% | |
| Your add_action call would look like: | |
| %%% <?php add_action( 'save_post', 'my_save_post', 10, 3 ); ?> %%% | |
| And your function would be: | |
| <pre> | |
| function my_save_post( $post_ID, $post, $update ) { | |
| // do stuff here | |
| } | |
| </pre> | |
| == Change Log == | |
| Since [[Version 1.2|1.2.0]] | |
| == Source File == | |
| <tt>add_action()</tt> is located in {{Trac|wp-includes/plugin.php}}. | |
| == Related == | |
| {{Action Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| {{Copyedit}}</p> | |
| </d:entry> | |
| <d:entry id="wp_rss" d:title="wp rss"> | |
| <d:index d:value="wp rss"/> | |
| <h1>wp rss</h1> | |
| <p>{{Deprecated}} | |
| ==Description== | |
| Retrieves an RSS feed and parses it, then displays it as an unordered list of links. Uses the [http://magpierss.sourceforge.net/ MagpieRSS and RSSCache] functions for parsing and automatic caching and the [http://sourceforge.net/projects/snoopy/ Snoopy HTTP client] for the actual retrieval. | |
| Deprecated note: Switch to using [[Function_Reference/fetch_feed|fetch_feed]] instead. | |
| ==Usage== | |
| %%%<?php | |
| include_once(ABSPATH . WPINC . '/rss.php'); | |
| wp_rss($uri, $num); | |
| ?>%%% | |
| ==Parameters== | |
| {{Parameter|$uri|URI|The URI of the RSS feed you want to retrieve. The resulting parsed feed is returned, with the more interesting and useful bits in the items array.}} | |
| {{Parameter|$num|integer|The number of items to display.}} | |
| ==Output== | |
| The output will look like the following: | |
| %%%<ul> | |
| <li> | |
| <a href='LINK FROM FEED' title='DESCRIPTION FROM FEED'>TITLE FROM FEED</a> | |
| </li> | |
| (repeat for number of links specified) | |
| </ul>%%% | |
| ==Example== | |
| To get and display a list of 5 links from an existing RSS feed: | |
| %%%<?php | |
| include_once(ABSPATH . WPINC . '/rss.php'); | |
| wp_rss('http://example.com/rss/feed/goes/here', 5); | |
| ?>%%% | |
| == Related == | |
| [[Function_Reference/fetch_rss|fetch_rss]], [[Function_Reference/get_rss|get_rss]] | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wptexturize" d:title="wptexturize"> | |
| <d:index d:value="wptexturize"/> | |
| <h1>wptexturize</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wptexturize}} | |
| {{it|Riferimento funzioni/wptexturize}} | |
| }} | |
| {{Stub}} | |
| == Description == | |
| This returns given text with transformations of quotes to smart quotes, apostrophes, dashes, ellipses, the trademark symbol, and the multiplication symbol. Text enclosed in the tags <tt><nowiki><pre></nowiki></tt>, <tt><nowiki><code></nowiki></tt>, <tt><nowiki><kbd></nowiki></tt>, <tt><nowiki><style></nowiki></tt>, <tt><nowiki><script></nowiki></tt>, <tt><nowiki> and <tt></nowiki></tt> will be skipped. | |
| == Usage == | |
| %%% <?php wptexturize( $text ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$text|string|The text to be formatted.}} | |
| == Return Values == | |
| ; (string) : The string replaced with html numeric character references. | |
| == Notes == | |
| Opening and closing quotes can be customized in a WordPress translation file. Here are some of the text transformations: | |
| {| | |
| ! source text !! transformed text !! symbol name | |
| |- | |
| | "---" || "&#8212;" || em-dash | |
| |- | |
| | " -- " || "&#8212;" || em-dash | |
| |- | |
| | "--" || "&#8211;" || en-dash | |
| |- | |
| | " - " || "&#8211;" || en-dash | |
| |- | |
| | "xn&#8211;" || "xn--" || | |
| |- | |
| | "..." || "&#8230;" || ellipsis | |
| |- | |
| | `` || &#8220; || opening quote | |
| |- | |
| | <nowiki>''</nowiki> || &#8221; || closing quote | |
| |- | |
| | " (tm)" || " &#8482;" || trademark symbol | |
| |- | |
| | 1234" || 1234&#8243; || double prime symbol | |
| |- | |
| | 1234' || 1234&#8242; || prime symbol | |
| |- | |
| | 1234x1234 || 1234&#215;1234 || multiplication symbol | |
| |- | |
| |} | |
| There is a small "cockney" list of transformations, as well. They can be replaced if the variable <tt>$wp_cockneyreplace</tt> is defined and contains an associative array with the keys containing the source strings and the values containing the transformed strings. By default the following strings will be transformed: | |
| * 'tain't | |
| * 'twere | |
| * 'twas | |
| * 'tis | |
| * 'twill | |
| * 'til | |
| * 'bout | |
| * 'nuff | |
| * 'round | |
| * 'cause | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>wptexturize()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| * Function: [[Function_Reference/wpautop|wpautop()]] | |
| * Filter: [[Plugin API/Filter Reference/no_texturize_shortcodes|no_texturize_shortcodes]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="wpautop" d:title="wpautop"> | |
| <d:index d:value="wpautop"/> | |
| <h1>wpautop</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wpautop}} | |
| {{it|Riferimento funzioni/wpautop}} | |
| }} | |
| == Description == | |
| Changes double line-breaks in the text into HTML paragraphs (<tt><nowiki><p>...</p></nowiki></tt>). | |
| WordPress uses it to filter [[Template_Tags/the_content|the content]] and [[Template_Tags/the_excerpt|the excerpt]]. | |
| == Usage == | |
| %%% <?php wpautop( $foo, $br ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$foo|string|The text to be formatted.}} | |
| {{Parameter|$br|boolean| Preserve line breaks. When set to true, any line breaks remaining after paragraph conversion are converted to HTML <tt><nowiki><br /></nowiki></tt>. Line breaks within <tt>script</tt> and <tt>style</tt> sections are not affected.|optional|true}} | |
| == Return Values == | |
| ; (string) : Text which has been converted into correct paragraph tags. | |
| == Examples == | |
| === Basic usage === | |
| <?php | |
| $some_long_text = // Start Text | |
| Some long text | |
| that has many lines | |
| and paragraphs in it. | |
| // end text | |
| echo wpautop( $some_long_text ); | |
| ?> | |
| This should echo the string with <nowiki><p></nowiki> tags around the paragraphs, like this: | |
| <nowiki><p>Some long text<br/> | |
| that has many lines</p> | |
| <p>and paragraphs in it.</p></nowiki> | |
| == Notes == | |
| === Disabling the filter === | |
| Some people choose to disable the wpautop filter from within their theme's <tt>functions.php</tt>: | |
| <pre> | |
| remove_filter( 'the_content', 'wpautop' ); | |
| remove_filter( 'the_excerpt', 'wpautop' ); | |
| </pre> | |
| There's also a [http://wordpress.org/extend/plugins/wpautop-control/ plugin] available to enable/disable the filter on a post-by-post basis. | |
| == Changelog == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>wpautop()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Resources == | |
| http://ma.tt/scripts/autop/ | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_reschedule_event" d:title="wp reschedule event"> | |
| <d:index d:value="wp reschedule event"/> | |
| <h1>wp reschedule event</h1> | |
| <p>== Description == | |
| This function is used internally by WordPress to reschedule a recurring event. You'll likely never need to use this function manually, it is documented here for completeness. | |
| == Usage == | |
| %%% <?php wp_reschedule_event( $timestamp, $recurrence, $hook, $args); ?>%%% | |
| == Parameters == | |
| {{Parameter|$timestamp|integer|The time the scheduled event will occur (unix timestamp)|required}} | |
| {{Parameter|$recurrence|string|How often the event recurs, either 'hourly' or 'daily'|required}} | |
| {{Parameter|$hook|string|Name of action hook to fire (string)|required}} | |
| {{Parameter|$args|array|Arguments to pass into the hook function(s)|optional|array()}} | |
| == Return Value == | |
| {{Return||boolean&#124;null|False on failure. Null when event is rescheduled.}} | |
| == Examples == | |
| == Notes == | |
| == Change Log == | |
| Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>wp_reschedule_event()</tt> is located in {{Trac|wp-includes/cron.php}} | |
| == Related == | |
| For a comprehensive list of functions, take a look at the [http://codex.wordpress.org/Category:Functions category Functions] | |
| * [[Function_Reference]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]] | |
| [[Category:WP-Cron Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_insert_post" d:title="wp insert post"> | |
| <d:index d:value="wp insert post"/> | |
| <h1>wp insert post</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/wp_insert_post}} | |
| {{ru|Справочник по функциям/wp insert post}} | |
| {{ja|関数リファレンス/wp insert post}} | |
| {{tr|Fonksiyon Listesi/wp insert post}} | |
| {{zh-cn|函数参考/wp_insert_post}} | |
| }} | |
| ==Description== | |
| This function inserts posts (and pages) in the database. It sanitizes variables, does some checks, fills in missing variables like date/time, etc. It takes an array as its argument and returns the post ID of the created post (or <tt>0</tt> if there is an error). | |
| == Usage == | |
| %%% <?php wp_insert_post( $post, $wp_error ); ?> %%% | |
| ==Parameters== | |
| {{Parameter|$post|array|An array representing the elements that make up a post. There is a one-to-one relationship between these elements and the names of columns in the wp_posts table in the database.}} | |
| '''IMPORTANT''': Setting a value for $post['ID'] WILL NOT create a post with that ID number. Setting this value will cause the function to update the post with that ID number with the other values specified in $post. In short, to insert a new post, $post['ID'] must be blank or not set at all. | |
| The contents of the post array can depend on how much (or little) you want to trust the defaults. Here is a list with a short description of all the keys you can set for a post: | |
| <pre> | |
| $post = array( | |
| 'ID' => [ <post id> ] // Are you updating an existing post? | |
| 'post_content' => [ <string> ] // The full text of the post. | |
| 'post_name' => [ <string> ] // The name (slug) for your post | |
| 'post_title' => [ <string> ] // The title of your post. | |
| 'post_status' => [ 'draft' | 'publish' | 'pending'| 'future' | 'private' | custom registered status ] // Default 'draft'. | |
| 'post_type' => [ 'post' | 'page' | 'link' | 'nav_menu_item' | custom post type ] // Default 'post'. | |
| 'post_author' => [ <user ID> ] // The user ID number of the author. Default is the current user ID. | |
| 'ping_status' => [ 'closed' | 'open' ] // Pingbacks or trackbacks allowed. Default is the option 'default_ping_status'. | |
| 'post_parent' => [ <post ID> ] // Sets the parent of the new post, if any. Default 0. | |
| 'menu_order' => [ <order> ] // If new post is a page, sets the order in which it should appear in supported menus. Default 0. | |
| 'to_ping' => // Space or carriage return-separated list of URLs to ping. Default empty string. | |
| 'pinged' => // Space or carriage return-separated list of URLs that have been pinged. Default empty string. | |
| 'post_password' => [ <string> ] // Password for post, if any. Default empty string. | |
| 'guid' => // Skip this and let Wordpress handle it, usually. | |
| 'post_content_filtered' => // Skip this and let Wordpress handle it, usually. | |
| 'post_excerpt' => [ <string> ] // For all your post excerpt needs. | |
| 'post_date' => [ Y-m-d H:i:s ] // The time post was made. | |
| 'post_date_gmt' => [ Y-m-d H:i:s ] // The time post was made, in GMT. | |
| 'comment_status' => [ 'closed' | 'open' ] // Default is the option 'default_comment_status', or 'closed'. | |
| 'post_category' => [ array(<category id>, ...) ] // Default empty. | |
| 'tags_input' => [ '<tag>, <tag>, ...' | array ] // Default empty. | |
| 'tax_input' => [ array( <taxonomy> => <array | string> ) ] // For custom taxonomies. Default empty. | |
| 'page_template' => [ <string> ] // Requires name of template file, eg template.php. Default empty. | |
| ); | |
| </pre> | |
| '''Notes''' | |
| * 'post_status': If providing a post_status of 'future' you must specify the post_date in order for WordPress to know when to publish your post. See also [[Post Status Transitions]]. | |
| * 'post_category': Equivalent to calling [[Function Reference/wp_set_post_categories|wp_set_post_categories()]]. | |
| * 'tags_input': Equivalent to calling [[Function Reference/wp_set_post_tags|wp_set_post_tags()]]. | |
| * 'tax_input': Equivalent to calling [[Function Reference/wp_set_post_terms|wp_set_post_terms()]] for each custom taxonomy in the array. If the current user doesn't have the capability to work a taxonomy, the you must use wp_set_object_terms() instead. | |
| * 'page_template': If post_type is 'page', will attempt to set the [[Page_Templates|page template]]. On failure, the function will return either a WP_Error or 0, and stop before the final actions are called. If the post_type is not 'page', the parameter is ignored. You can set the page template for a non-page by calling [[Function Reference/update_post_meta|update_post_meta()]] with a key of '_wp_page_template'. | |
| {{Parameter|$wp_error|bool|Allow return of [[Class Reference/WP_Error|WP_Error]] object on failure|optional|false}} | |
| ==Return== | |
| The ID of the post if the post is successfully added to the database. On failure, it returns <tt>0</tt> if $wp_error is set to false, or a [[Class Reference/WP_Error|WP_Error]] object if $wp_error is set to true. | |
| ==Usage== | |
| %%% <?php wp_insert_post( $post, $wp_error ); ?> %%% | |
| ==Example== | |
| Before calling wp_insert_post() it is necessary to create an array to pass the necessary elements that make up a post. The wp_insert_post() will fill out a default list of these but the user is required to provide the title and content otherwise the database write will fail. | |
| The next example shows the post title, content, status, author, and post categories being set. You can add further key-value pairs, making sure the keys match the names of the columns in the wp_posts table in the database. | |
| <pre> | |
| // Create post object | |
| $my_post = array( | |
| 'post_title' => 'My post', | |
| 'post_content' => 'This is my post.', | |
| 'post_status' => 'publish', | |
| 'post_author' => 1, | |
| 'post_category' => array(8,39) | |
| ); | |
| // Insert the post into the database | |
| wp_insert_post( $my_post ); | |
| </pre> | |
| Insert a new post and return the new post id. | |
| <pre> | |
| $post_id = wp_insert_post( $post, $wp_error ); | |
| //now you can use $post_id withing add_post_meta or update_post_meta | |
| </pre> | |
| The default list referred to above is defined in the function body. It is as follows: | |
| <pre> | |
| $defaults = array( | |
| 'post_status' => 'draft', | |
| 'post_type' => 'post', | |
| 'post_author' => $user_ID, | |
| 'ping_status' => get_option('default_ping_status'), | |
| 'post_parent' => 0, | |
| 'menu_order' => 0, | |
| 'to_ping' => '', | |
| 'pinged' => '', | |
| 'post_password' => '', | |
| 'guid' => '', | |
| 'post_content_filtered' => '', | |
| 'post_excerpt' => '', | |
| 'import_id' => 0 | |
| ); | |
| </pre> | |
| ===Categories=== | |
| Categories need to be passed as an array of integers that match the category IDs in the database. This is the case even where only one category is assigned to the post. | |
| See also: [[Function_Reference/wp_set_post_terms|wp_set_post_terms()]] | |
| ==Security== | |
| <tt>wp_insert_post()</tt> passes data through sanitize_post(), which itself handles all necessary sanitization and validation (kses, etc.). | |
| As such, you don't need to worry about that. | |
| You may wish, however, to remove HTML, JavaScript, and PHP tags from the post_title and any other fields. Surprisingly, WordPress does not do this automatically. This can be easily done by using the wp_strip_all_tags() function (as of 2.9) and is especially useful when building front-end post submission forms. | |
| <pre> | |
| // Create post object | |
| $my_post = array( | |
| 'post_title' => wp_strip_all_tags( $_POST['post_title'] ), | |
| 'post_content' => $_POST['post_content'], | |
| 'post_status' => 'publish', | |
| 'post_author' => 1, | |
| 'post_category' => array( 8,39 ) | |
| ); | |
| // Insert the post into the database | |
| wp_insert_post( $my_post ); | |
| </pre> | |
| ==Change Log== | |
| * Since: [[Version 1.0|1.0]] | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_insert_post()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| ==Related== | |
| [[Function Reference/wp update post|wp_update_post()]], | |
| [[Function Reference/wp delete post|wp_delete_post()]], | |
| [[Function Reference/wp publish post|wp_publish_post()]], | |
| [[Function Reference/wp delete attachment|wp_delete_attachment()]], | |
| [[Function Reference/wp get attachment url|wp_get_attachment_url()]], | |
| [[Function Reference/wp insert attachment|wp_insert_attachment()]], | |
| [[Plugin API/Filter Reference/wp insert post data|wp_insert_post_data()]] | |
| {{Tag Footer}} | |
| {{Copyedit}} | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_clear_scheduled_hook" d:title="wp clear scheduled hook"> | |
| <d:index d:value="wp clear scheduled hook"/> | |
| <h1>wp clear scheduled hook</h1> | |
| <p>== Description == | |
| Un-schedules all previously-scheduled cron jobs using a particular hook name or a specific combination of hook name and arguments. | |
| == Usage == | |
| %%% <?php wp_clear_scheduled_hook( $hook, $args ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$hook|string|The name of an action hook to execute.}} | |
| {{Parameter|$args|array|Arguments to pass to the hook function(s)|optional}} | |
| == Return Value == | |
| No value is returned by this function. | |
| == Examples == | |
| === Clear a scheduled event === | |
| <pre> | |
| // If you previously added for example | |
| // wp_schedule_single_event( time() + 3600, 'my_new_event' ); | |
| wp_clear_scheduled_hook( 'my_new_event' ); | |
| // or this if you created something like | |
| // wp_schedule_single_event( time() + 3600, 'my_new_event', array( 'some_arg' ) ); | |
| wp_clear_scheduled_hook( 'my_new_event', array( 'some_arg' ) ); | |
| </pre> | |
| == Notes == | |
| If you created a scheduled job using a hook and arguments you cannot delete it by supplying only the hook. Similarly if you created a set of scheduled jobs that share a hook but have different arguments you cannot delete them using only the hook name, you have to delete them all individually using the hook name and arguments. | |
| == Change Log == | |
| Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>wp_clear_scheduled_hook()</tt> is located in {{Trac|wp-includes/cron.php}} | |
| == Related == | |
| {{Cron Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_unschedule_event" d:title="wp unschedule event"> | |
| <d:index d:value="wp unschedule event"/> | |
| <h1>wp unschedule event</h1> | |
| <p>== Description == | |
| Unschedules a previously-scheduled cron job. | |
| Note that you need to know the exact time of the next occurrence when scheduled hook was set to run, and the function arguments it was supposed to have, in order to unschedule it. All future occurrences are unscheduled by calling this function. | |
| == Usage == | |
| %%% <?php wp_unschedule_event( $timestamp, $hook, $args ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$timestamp|integer|Timestamp originally provided for when to run the event.|required}} | |
| {{Parameter|$hook|string|Action hook originally provided, the execution of which will be unscheduled.|required}} | |
| {{Parameter|$args|array|Arguments to pass to the hook's callback function. These arguments are used to uniquely identify the scheduled event, so they must be the same as those used when originally scheduling the event.|optional|<tt>array()</tt>}} | |
| == Return Value == | |
| This function does not return a value. | |
| == Example == | |
| <pre> | |
| <?php | |
| // Get the timestamp for the next event. | |
| $timestamp = wp_next_scheduled( 'my_schedule_hook' ); | |
| // If this event was created with any special arguments, you need to get those too. | |
| $original_args = array(); | |
| wp_unschedule_event( $timestamp, 'my_schedule_hook', $original_args ); | |
| ?> | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>wp_unschedule_event()</tt> is located in {{Trac|wp-includes/cron.php}} | |
| == Related == | |
| * [[Function_Reference/wp_schedule_event|wp_schedule_event]] | |
| * [[Function_Reference/wp_reschedule_event | wp_reschedule_event]] | |
| * [[Function_Reference/wp_schedule_single_event|wp_schedule_single_event]] | |
| * [[Function_Reference/wp_clear_scheduled_hook|wp_clear_scheduled_hook]] | |
| * [[Function_Reference/wp_next_scheduled|wp_next_scheduled]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:WP-Cron Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_next_scheduled" d:title="wp next scheduled"> | |
| <d:index d:value="wp next scheduled"/> | |
| <h1>wp next scheduled</h1> | |
| <p>== Description == | |
| Returns the next timestamp for a cron event. | |
| == Usage == | |
| %%%<?php $timestamp = wp_next_scheduled( $hook, $args ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$hook|string|Name of the action hook for event.}} | |
| {{Parameter|$args|array|Arguments to pass to the hook function(s).|optional}} | |
| == Return Value == | |
| {{Return||string&#124;boolean|Timestamp, the time the scheduled event will next occur (unix timestamp). False, if the event isn't scheduled.}} | |
| == Notes == | |
| * Cron is named after a unix program which runs unattended scheduled tasks. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>wp_next_scheduled()</tt> is located in {{Trac|wp-includes/cron.php}} | |
| == Related == | |
| * [[Function_Reference/wp_schedule_event|wp_schedule_event]] | |
| * [[Function_Reference/wp_schedule_single_event|wp_schedule_single_event]] | |
| * [[Function_Reference/wp_clear_scheduled_hook|wp_clear_scheduled_hook]] | |
| * [[Function_Reference/wp_unschedule_event|wp_unschedule_event]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]] | |
| [[Category:WP-Cron Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_schedule_event" d:title="wp schedule event"> | |
| <d:index d:value="wp schedule event"/> | |
| <h1>wp schedule event</h1> | |
| <p>== Description == | |
| Schedules a hook which will be executed by the WordPress actions core on a specific interval, specified by you. The action will trigger when someone visits your WordPress site, if the scheduled time has passed. See the [[Plugin API]] for a list of hooks. | |
| == Usage == | |
| %%% <?php wp_schedule_event($timestamp, $recurrence, $hook, $args); ?> %%% | |
| == Parameters == | |
| {{Parameter|$timestamp|integer|The first time that you want the event to occur. This must be in a UNIX timestamp format. WP cron uses UTC/GMT time, not local time. Use <tt>[http://php.net/manual/en/function.time.php time()]</tt>, which is always GMT in WordPress. (<tt>[[Function_Reference/current_time|current_time( 'timestamp' )]]</tt> is local time in WordPress.)}} | |
| {{Parameter|$recurrence|string|How often the event should reoccur. Valid values are below. You can create custom intervals using the <tt>cron_schedules</tt> filter in <tt>[[Function_Reference/wp_get_schedules|wp_get_schedules()]]</tt>. <ul><li><tt>hourly</tt></li><li><tt>twicedaily</tt></li><li><tt>daily</tt></li></ul>}} | |
| {{Parameter|$hook|string|The name of an action hook to execute. For some reason there seems to be a problem on some systems where the hook must not contain underscores or uppercase characters.}} | |
| {{Parameter|$args|array|Arguments to pass to the hook function(s).|optional}} | |
| == Return Value == | |
| {{Return||boolean&#124;null|False on failure, null when complete with scheduling event.}} | |
| == Examples == | |
| === Schedule an hourly event === | |
| To schedule an hourly event in a plugin, call <tt>wp_schedule_event</tt> on activation (otherwise you will end up with a lot of scheduled events!): | |
| <pre> | |
| register_activation_hook( __FILE__, 'prefix_activation' ); | |
| /** | |
| * On activation, set a time, frequency and name of an action hook to be scheduled. | |
| */ | |
| function prefix_activation() { | |
| wp_schedule_event( time(), 'hourly', 'prefix_hourly_event_hook' ); | |
| } | |
| add_action( 'prefix_hourly_event_hook', 'prefix_do_this_hourly' ); | |
| /** | |
| * On the scheduled action hook, run the function. | |
| */ | |
| function prefix_do_this_hourly() { | |
| // do something every hour | |
| } | |
| </pre> | |
| Don't forget to clean the scheduler on deactivation: | |
| <pre> | |
| register_deactivation_hook( __FILE__, 'prefix_deactivation' ); | |
| /** | |
| * On deactivation, remove all functions from the scheduled action hook. | |
| */ | |
| function prefix_deactivation() { | |
| wp_clear_scheduled_hook( 'prefix_hourly_event_hook' ); | |
| } | |
| </pre> | |
| === A simple way to schedule an hourly event === | |
| This example doesn't rely on plugin activation (via the plugins directory) rather it simply adds the event if it is missing. | |
| <pre> | |
| add_action( 'wp', 'prefix_setup_schedule' ); | |
| /** | |
| * On an early action hook, check if the hook is scheduled - if not, schedule it. | |
| */ | |
| function prefix_setup_schedule() { | |
| if ( ! wp_next_scheduled( 'prefix_hourly_event' ) ) { | |
| wp_schedule_event( time(), 'hourly', 'prefix_hourly_event'); | |
| } | |
| } | |
| add_action( 'prefix_hourly_event', 'prefix_do_this_hourly' ); | |
| /** | |
| * On the scheduled action hook, run a function. | |
| */ | |
| function prefix_do_this_hourly() { | |
| // do something every hour | |
| } | |
| </pre> | |
| == Notes == | |
| The array passed as the <tt>$args</tt> parameter needs to be an indexed array. Each element in the array is sliced into a separate argument in the <tt>do_action_ref_array()</tt> call. Despite the name, your array is not passed by reference. | |
| When you add the action that calls your scheduled function, you must specify a priority and the number of elements in the array. Your scheduled function declaration must accept each array element as individual parameters | |
| Example passing multiple arguments | |
| <pre>add_action('wp', 'prefix_setup_schedule'); | |
| function prefix_setup_schedule() { | |
| if ( ! wp_next_scheduled('prefix_hourly_event')) { | |
| wp_schedule_event( time(), 'hourly', 'prefix_hourly_event', | |
| array( 'example', 'values') | |
| ); | |
| } | |
| } | |
| add_action('prefix_hourly_event', 'prefix_do_this_hourly', 10 ,2 ); | |
| function prefix_do_this_hourly( $parm1, $parm2 ) { | |
| error_log("Function prefix_do_this_hourly() received '$parm1' and '$parm2' as parameters."); | |
| } | |
| // PHP error log will have this line entered every hour: | |
| // Function prefix_do_this_hourly() received 'example' and 'values' as parameters.</pre> | |
| = Cron Data = | |
| Cron data is saved to the options table. Use <tt>get_option('cron');</tt> to get the cron array from the database. | |
| == Change Log == | |
| Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>wp_schedule_event()</tt> is located in {{Trac|wp-includes/cron.php}} | |
| == Related == | |
| * [[Function_Reference/wp_schedule_event|wp_schedule_event]] | |
| * [[Function_Reference/wp_schedule_single_event|wp_schedule_single_event]] | |
| * [[Function_Reference/wp_clear_scheduled_hook|wp_clear_scheduled_hook]] | |
| * [[Function_Reference/wp_next_scheduled|wp_next_scheduled]] | |
| * [[Function_Reference/wp_unschedule_event|wp_unschedule_event]] | |
| * [[Function_Reference/wp_get_schedule|wp_get_schedule]] | |
| == Further Reading == | |
| For a comprehensive list of functions, take a look at the [http://codex.wordpress.org/Category:Functions category Functions] | |
| Also, see [[Function_Reference]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]] | |
| [[Category:WP-Cron Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_schedule_single_event" d:title="wp schedule single event"> | |
| <d:index d:value="wp schedule single event"/> | |
| <h1>wp schedule single event</h1> | |
| <p>== Description == | |
| Schedules a hook which will be executed once by the WordPress actions core at a time which you specify. The action will fire off when someone visits your WordPress site, if the schedule time has passed. | |
| == Usage == | |
| %%% <?php wp_schedule_single_event( $timestamp, $hook, $args ); ?> %%% | |
| Note that scheduling an event to occur before 10 minutes after an existing event of the same name will be ignored, unless you pass unique values for <tt>$args</tt> to each scheduled event. See <tt>[[Function_Reference/wp_next_scheduled | wp_next_scheduled()]]</tt> for more information. | |
| <i>This behavior is subject to change, as the [https://core.trac.wordpress.org/ticket/6966 original intention] of the code was to prevent scheduling two identical events within ten minutes of each other, not preventing scheduling of identical events until ten minutes after the next scheduled occurrence.</i> | |
| Attempts to schedule an event after an event of the same name and <tt>$args</tt> will also be ignored. | |
| == Parameters == | |
| {{Parameter|$timestamp|integer|The time you want the event to occur. This must be in a UNIX timestamp format.}} | |
| {{Parameter|$hook|string|The name of an action hook to execute.}} | |
| {{Parameter|$args|array|Arguments to pass to the hook function(s)|optional|<tt>array()</tt>}} | |
| == Return Value == | |
| {{Return||boolean&#124;null|False if the event was cancelled by a plugin, <tt>null</tt> otherwise.}} | |
| == Examples == | |
| === Schedule an event one hour from now === | |
| <pre> | |
| function do_this_in_an_hour() { | |
| // do something | |
| } | |
| add_action( 'my_new_event','do_this_in_an_hour' ); | |
| // put this line inside a function, | |
| // presumably in response to something the user does | |
| // otherwise it will schedule a new event on every page visit | |
| wp_schedule_single_event( time() + 3600, 'my_new_event' ); | |
| // time() + 3600 = one hour from now. | |
| </pre> | |
| === Schedule an event one hour from now with arguments === | |
| <pre> | |
| function do_this_in_an_hour( $arg1, $arg2, $arg3 ) { | |
| // do something | |
| } | |
| add_action( 'my_new_event', 'do_this_in_an_hour', 10, 3 ); | |
| // put this line inside a function, | |
| // presumably in response to something the user does | |
| // otherwise it will schedule a new event on every page visit | |
| wp_schedule_single_event( time() + 3600, 'my_new_event', array( $arg1, $arg2, $arg3 ) ); | |
| // time() + 3600 = one hour from now. | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>wp_schedule_single_event()</tt> is located in {{Trac|wp-includes/cron.php}} | |
| == Related == | |
| {{Cron Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:WP-Cron Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_tag_link" d:title="get tag link"> | |
| <d:index d:value="get tag link"/> | |
| <h1>get tag link</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_tag_link}} | |
| {{it|Riferimento funzioni/get_tag_link}} | |
| {{ja|関数リファレンス/get_tag_link}} | |
| }} | |
| == Description == | |
| Returns the correct link url for a given Tag ID. | |
| == Usage == | |
| <a href="<?php echo get_tag_link($tag_id); ?>">tag name</a> | |
| == Parameters == | |
| {{Parameter|$tag_id|integer|The Tag ID.}} | |
| == Return Values == | |
| {{Return|URL|string|URL with a link to the tag.}} | |
| == Filters == | |
| Output from this function is [[Plugin_API/Filter_Reference | filtered]] by the 'tag_link' filter. The first argument ($taglink) is the url as the function would normally output it, the second is the ID passed into the function. | |
| [[Function Reference/apply_filters|apply_filters]]('tag_link', $taglink, $tag_id); | |
| == Source File == | |
| <tt>get_tag_link()</tt> is located in {{Trac|wp-includes/category-template.php}}. | |
| == Related == | |
| {{Tag Tags}} | |
| [[Function_Reference/get_the_terms|get_the_terms()]], | |
| [[Function_Reference/get_term_link|get_term_link()]], | |
| [[Function_Reference/wp_get_object_terms|wp_get_object_terms()]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| {{Copyedit}}</p> | |
| </d:entry> | |
| <d:entry id="get_categories" d:title="get categories"> | |
| <d:index d:value="get categories"/> | |
| <h1>get categories</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_categories}} | |
| {{ja|関数リファレンス/get_categories}} | |
| }} | |
| == Description == | |
| Returns an array of category objects matching the query parameters. | |
| Arguments are pretty much the same as [[Template_Tags/wp_list_categories|wp_list_categories]] and can be passed as either array or in query syntax. <!--The array returned seems to be always flat (no nesting for subcategories) but I'm not sure yet.--> | |
| == Usage == | |
| %%% <?php $categories = get_categories( $args ); ?> %%% | |
| === Default Usage === | |
| <pre><?php | |
| $args = array( | |
| 'type' => 'post', | |
| 'child_of' => 0, | |
| 'parent' => '', | |
| 'orderby' => 'name', | |
| 'order' => 'ASC', | |
| 'hide_empty' => 1, | |
| 'hierarchical' => 1, | |
| 'exclude' => '', | |
| 'include' => '', | |
| 'number' => '', | |
| 'taxonomy' => 'category', | |
| 'pad_counts' => false | |
| ); | |
| ?></pre> | |
| == Parameters == | |
| ; '''type''' : (''string'') Type of category to retrieve | |
| :* <tt>post</tt> - default | |
| :* <tt>link</tt> | |
| ''<span style="color:red;">Note:</span>'' '''<tt>type=link</tt>''' has been deprecated from WordPress 3.0 onwards. Use '''<tt>taxonomy=link_category</tt>''' instead. | |
| ; '''child_of''' : (''integer'') Display all categories that are descendants (i.e. children & grandchildren) of the category identified by its ID. There is no default for this parameter. If the parameter is used, the '''hide_empty''' parameter is set to ''false''. | |
| ; '''parent''' : (''integer'') Display only categories that are direct descendants (i.e. children only) of the category identified by its ID. This does NOT work like the 'child_of' parameter. There is no default for this parameter. [In 2.8.4] | |
| ; '''orderby''' : (''string'') Sort categories alphabetically or by unique category ID. The default is ''sort by name''. Valid values: | |
| :* <tt>id</tt> | |
| :* <tt>name</tt> - default | |
| :* <tt>slug</tt> | |
| :* <tt>count</tt> | |
| :* <tt>term_group</tt> | |
| ; '''order''' : (''string'') Sort order for categories (either ascending or descending). The default is ''ascending''. Valid values: | |
| :* <tt>asc</tt> - default | |
| :* <tt>desc</tt> | |
| ; '''hide_empty''' : (''boolean'') Toggles the display of categories with no posts. The default is ''1'' for true or you can add '0' for false (show empty categories). Valid values: | |
| :* <tt>1</tt> - default | |
| :* <tt>0</tt> | |
| ; '''hierarchical''' : (''boolean'') When ''true'', the results will include sub-categories that are empty, as long as those sub-categories have sub-categories that are not empty. The default is ''true''. Valid values: | |
| :* <tt>1 (true)</tt> - default | |
| :* <tt>0 (false)</tt> | |
| ; '''exclude''' : (''string'') Excludes one or more categories from the list generated by ''wp_list_categories''. This parameter takes a comma-separated list of categories by unique ID, in ascending order. See [[Template_Tags/wp_list_categories#Include_or_Exclude_Categories|the example]]. | |
| ; '''include''' : (''string'') Only include certain categories in the list generated by ''wp_list_categories''. This parameter takes a comma-separated list of categories by unique ID, in ascending order. See [[Template_Tags/wp_list_categories#Include_or_Exclude_Categories|the example]]. | |
| :* <tt>list</tt> - default. | |
| :* <tt>none</tt> | |
| ; '''number''' : (''string'') The number of categories to return | |
| ; '''taxonomy''' : (''string or array'') Taxonomy to return. This parameter added at [[Version 3.0]] Valid values: | |
| :* <tt>category</tt> - default | |
| :* <tt>taxonomy</tt> - or any registered taxonomy | |
| ; '''pad_counts''' : (''boolean'') Calculates link or post counts by including items from child categories. Valid values: | |
| :* <tt>1 (true)</tt> | |
| :* <tt>0 (false)</tt> - default | |
| == Return values == | |
| ; (array) : Returns an array of category objects matching the query parameters. | |
| The complete content of $category is: | |
| <pre> | |
| $category->term_id | |
| $category->name | |
| $category->slug | |
| $category->term_group | |
| $category->term_taxonomy_id | |
| $category->taxonomy | |
| $category->description | |
| $category->parent | |
| $category->count | |
| $category->cat_ID | |
| $category->category_count | |
| $category->category_description | |
| $category->cat_name | |
| $category->category_nicename | |
| $category->category_parent | |
| </pre> | |
| == Examples == | |
| === Dropdown Box as used in Parent category at post category page === | |
| This is the code used in the build in category page. | |
| Code from 3.0.1 | |
| <pre> | |
| wp_dropdown_categories(array('hide_empty' => 0, 'name' => 'category_parent', 'orderby' => 'name', 'selected' => $category->parent, 'hierarchical' => true, 'show_option_none' => __('None')));</pre> | |
| This slightly altered code will grab all categories and display them with indent for a new level (child category). The select box will have a name= and id= called 'select_name'. | |
| This select will not display a default "none" as the original code was used to attach a category as a child to another category (or none). | |
| <pre> | |
| wp_dropdown_categories(array('hide_empty' => 0, 'name' => 'select_name', 'hierarchical' => true)); | |
| </pre> | |
| === Dropdown Box === | |
| Here's how to create a dropdown box of the subcategories of, say, a category that archives information on past events. This mirrors the example of the dropdown example of [[Template_Tags/wp_get_archives | wp_get_archives]] which shows how to create a dropdown box for monthly archives. | |
| Suppose the category whose subcategories you want to show is category 10, and that its category "nicename" is "archives". | |
| <pre> | |
| <select name="event-dropdown" onchange='document.location.href=this.options[this.selectedIndex].value;'> | |
| <option value=""><?php echo esc_attr(__('Select Event')); ?></option> | |
| <?php | |
| $categories = get_categories('child_of=10'); | |
| foreach ($categories as $category) { | |
| $option = '<option value="/category/archives/'.$category->category_nicename.'">'; | |
| $option .= $category->cat_name; | |
| $option .= ' ('.$category->category_count.')'; | |
| $option .= '</option>'; | |
| echo $option; | |
| } | |
| ?> | |
| </select> | |
| </pre> | |
| ===List Categories and Descriptions=== | |
| This example will list in alphabetic order, all categories presented as links to the corresponding category archive. Each category descripition is listed after the category link. | |
| <pre> | |
| <?php | |
| $args = array( | |
| 'orderby' => 'name', | |
| 'order' => 'ASC' | |
| ); | |
| $categories = get_categories($args); | |
| foreach($categories as $category) { | |
| echo '<p>Category: <a href="' . get_category_link( $category->term_id ) . '" title="' . sprintf( __( "View all posts in %s" ), $category->name ) . '" ' . '>' . $category->name.'</a> </p> '; | |
| echo '<p> Description:'. $category->description . '</p>'; | |
| echo '<p> Post Count: '. $category->count . '</p>'; } | |
| ?> | |
| </pre> | |
| ===Get only top level categories === | |
| To get the top level categories only, set parent value to zero. This example gets link and name of top level categories. | |
| <pre> | |
| <?php | |
| $args = array( | |
| 'orderby' => 'name', | |
| 'parent' => 0 | |
| ); | |
| $categories = get_categories( $args ); | |
| foreach ( $categories as $category ) { | |
| echo '<a href="' . get_category_link( $category->term_id ) . '">' . $category->name . '</a><br/>'; | |
| } | |
| ?> | |
| </pre> | |
| == Source File == | |
| <tt>get_categories()</tt> is located in {{Trac|wp-includes/category.php}}. | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_enqueue_script" d:title="wp enqueue script"> | |
| <d:index d:value="wp enqueue script"/> | |
| <h1>wp enqueue script</h1> | |
| <p>__TOC__ | |
| {{Languages| | |
| {{en|Function Reference/wp_enqueue_script}} | |
| {{es|Referencia de Funciones/wp_enqueue_script}} | |
| {{ja|関数リファレンス/wp_enqueue_script}} | |
| {{ko|Function Reference/wp_enqueue_script}} | |
| {{ru|Справочник по функциям/wp_enqueue_script}} | |
| {{zh-cn|函数参考/wp_enqueue_script}} | |
| }} | |
| == Description == | |
| Links a script file to the generated page at the right time according to the script dependencies, if the script has not been already included and if all the dependencies have been registered. You could either link a script with a handle previously registered using the <tt>[[Function Reference/wp_register_script|wp_register_script()]]</tt> function, or provide this function with all the parameters necessary to link a script. | |
| This is the recommended method of linking JavaScript to a WordPress generated page. | |
| == Usage == | |
| %%%<?php wp_enqueue_script( $handle, $src, $deps, $ver, $in_footer ); ?>%%% | |
| See [[#Notes|Notes]] for information about what action [[Glossary#Hook|hooks]] should be used to call the function. | |
| == Parameters == | |
| {{Parameter|$handle|string|Name used as a handle for the script. As a special case, if the string contains a '?' character, the preceding part of the string refers to the registered handle, and the succeeding part is appended to the URL as a query string. A version must be used with this special case.}} | |
| {{Parameter|$src|string|URL to the script, e.g. ''http://<nowiki/>example.com/wp-content/themes/my-theme/my-theme-script.js''. You should never hardcode URLs to local scripts. To get a proper URL to local scripts, use <tt>[[Function Reference/plugins_url|plugins_url()]]</tt> for [[Glossary#Plugin|plugins]] and <tt>[[Function Reference/get_template_directory_uri|get_template_directory_uri()]]</tt> for [[Glossary#Themes|themes]]. Remote scripts can be specified with a protocol-agnostic URL, e.g. ''//otherdomain.com/js/their-script.js''. This parameter is only required when the script with the given <tt>$handle</tt> has not been already registered using <tt>[[Function Reference/wp_register_script|wp_register_script()]]</tt>. See [[#Default Scripts Included and Registered by WordPress|Default Scripts Included and Registered by WordPress]].|optional|false}} | |
| {{Parameter|$deps|array|Array of the handles of all the registered scripts that this script depends on, that is the scripts that must be loaded before this script. This parameter is only required when the script with the given <tt>$handle</tt> has not been already registered using <tt>[[Function Reference/wp_register_script|wp_register_script()]]</tt>. Default handles are all in lower case.|optional|array()}} | |
| {{Parameter|$ver|string|String specifying the script version number, if it has one, which is concatenated to the end of the path as a query string. If no version is specified or set to ''false'', then WordPress automatically adds a version number equal to the current version of WordPress you are running. If set to ''null'' no version is added. This parameter is used to ensure that the correct version is sent to the client regardless of caching, and so should be included if a version number is available and makes sense for the script.|optional|false}} | |
| {{Parameter|$in_footer|boolean|Normally, scripts are placed in <tt><head></tt> of the HTML document. If this parameter is ''true'', the script is placed before the <tt></body></tt> end tag. This requires the theme to have the <tt>[[Plugin API/Action Reference/wp footer|wp_footer()]]</tt> template tag in the appropriate place.|optional|false}} | |
| == Return Values == | |
| {{Return||void|This function does not return a value.}} | |
| == Examples == | |
| == Using a Hook == | |
| Scripts and styles from a single action hook | |
| <pre> | |
| /** | |
| * Proper way to enqueue scripts and styles | |
| */ | |
| function theme_name_scripts() { | |
| wp_enqueue_style( 'style-name', get_stylesheet_uri() ); | |
| wp_enqueue_script( 'script-name', get_template_directory_uri() . '/js/example.js', array(), '1.0.0', true ); | |
| } | |
| add_action( 'wp_enqueue_scripts', 'theme_name_scripts' ); | |
| </pre> | |
| === Link the script.aculo.us Library === | |
| The following is an example of basic usage which links the script.aculo.us library [[#Default_Scripts_Included_and_Registered_by_WordPress|already included and registered]] by WordPress with the ''scriptaculous'' handle. | |
| <pre> | |
| <?php | |
| function my_scripts_method() { | |
| wp_enqueue_script( 'scriptaculous' ); | |
| } | |
| add_action( 'wp_enqueue_scripts', 'my_scripts_method' ); // wp_enqueue_scripts action hook to link only on the front-end | |
| ?> | |
| </pre> | |
| The above example links the script.aculo.us library only on the front-end. If the library was needed within the [[Administration Screens|administration screens]], you could use the [[Plugin_API/Action_Reference/admin_enqueue_scripts|admin_enqueue_scripts]] action [[Glossary#Hook|hook]] instead, however, this would enqueue it on ''all'' the administration screens, which often leads to plugin/core conflicts, ultimately breaking the WordPress administration screens experience. Instead, you should only link it on the individual screens you need it, see the [[#Link_Scripts_Only_on_a_Plugin_Administration_Screen|Link Scripts Only on a Plugin Administration Screen]] section for an example of that. | |
| === Link a Theme Script Which Depends on jQuery === | |
| JavaScript files included in themes often require another JavaScript file to be loaded in advance to use its functions or variables. [[#Parameters|Using the <tt>$deps</tt> parameter]], the <tt>wp_enqueue_script()</tt> and <tt>[[Function Reference/wp_register_script|wp_register_script()]]</tt> functions allows you to mark dependencies when registering a new script. This will cause WordPress to automatically link these dependencies to the HTML page before the new script is linked. If the [[#Default_Scripts_Included_and_Registered_by_WordPress|handles]] of these dependencies are [[Function Reference/wp_deregister_script|not registered]], WordPress will not link the new script. This example requires the jQuery library for the ''custom_script.js'' theme script: | |
| <pre> | |
| <?php | |
| function my_scripts_method() { | |
| wp_enqueue_script( | |
| 'custom-script', | |
| get_stylesheet_directory_uri() . '/js/custom_script.js', | |
| array( 'jquery' ) | |
| ); | |
| } | |
| add_action( 'wp_enqueue_scripts', 'my_scripts_method' ); | |
| ?> | |
| </pre> | |
| === Link a Plugin Script That Depends on script.aculo.us === | |
| This example is intended to be used within a [[Writing a Plugin#Plugin_Files|plugin file]] to register and link a new plugin script that depends on the script.aculo.us library. See the [[#Link_a_Theme_Script_Which_Depends_on_jQuery|example above]] for information about dependencies. | |
| <pre> | |
| <?php | |
| function my_scripts_method() { | |
| wp_enqueue_script( | |
| 'newscript', | |
| plugins_url( '/js/newscript.js' , __FILE__ ), | |
| array( 'scriptaculous' ) | |
| ); | |
| } | |
| add_action( 'wp_enqueue_scripts', 'my_scripts_method' ); | |
| ?> | |
| </pre> | |
| === Link Scripts Only on a Plugin Administration Screen === | |
| This example links a script only on a specific [[Administration Screens|administration screen]], as opposed to the scenario described in the paragraph below the code of the [[#Link_the_script.aculo.us_Library|first example]]. | |
| <pre> | |
| <?php | |
| add_action( 'admin_init', 'my_plugin_admin_init' ); | |
| add_action( 'admin_menu', 'my_plugin_admin_menu' ); | |
| function my_plugin_admin_init() { | |
| /* Register our script. */ | |
| wp_register_script( 'my-plugin-script', plugins_url( '/script.js', __FILE__ ) ); | |
| } | |
| function my_plugin_admin_menu() { | |
| /* Add our plugin submenu and administration screen */ | |
| $page_hook_suffix = add_submenu_page( 'edit.php', // The parent page of this submenu | |
| __( 'My Plugin', 'myPlugin' ), // The submenu title | |
| __( 'My Plugin', 'myPlugin' ), // The screen title | |
| 'manage_options', // The capability required for access to this submenu | |
| 'my_plugin-options', // The slug to use in the URL of the screen | |
| 'my_plugin_manage_menu' // The function to call to display the screen | |
| ); | |
| /* | |
| * Use the retrieved $page_hook_suffix to hook the function that links our script. | |
| * This hook invokes the function only on our plugin administration screen, | |
| * see: http://codex.wordpress.org/Administration_Menus#Page_Hook_Suffix | |
| */ | |
| add_action('admin_print_scripts-' . $page_hook_suffix, 'my_plugin_admin_scripts'); | |
| } | |
| function my_plugin_admin_scripts() { | |
| /* Link our already registered script to a page */ | |
| wp_enqueue_script( 'my-plugin-script' ); | |
| } | |
| function my_plugin_manage_menu() { | |
| /* Display our administration screen */ | |
| } | |
| ?> | |
| </pre> | |
| === Load a Script from a Child Theme without Dependencies === | |
| Register and enqueue the script in the same callback function with no dependencies, in the footer. See [[Function_Reference/wp_register_script|wp_register_script()]] for details. In this example, <tt>google_analytics_object.js</tt> is the Google Analytics tracking code (provided by Google) in a file. | |
| <pre> | |
| <?php | |
| add_action( 'wp_enqueue_scripts', 'child_add_scripts' ); | |
| /** | |
| * Register and enqueue a script that does not depend on a JavaScript library. | |
| */ | |
| function child_add_scripts() { | |
| wp_register_script( | |
| 'google-analytics', | |
| get_stylesheet_directory_uri() . '/google_analytics_object.js', | |
| false, | |
| '1.0', | |
| true | |
| ); | |
| wp_enqueue_script( 'google-analytics' ); | |
| } | |
| </pre> | |
| == jQuery noConflict Wrappers == | |
| The jQuery library included with WordPress is set to the [http://docs.jquery.com/Using_jQuery_with_Other_Libraries ''noConflict()''] mode (see {{Trac|wp-includes/js/jquery/jquery.js|tags/{{CurrentVersion}}|3}}). This is to prevent compatibility problems with other JavaScript libraries that WordPress can link. | |
| In the ''noConflict()'' mode, the global <tt>$</tt> shortcut for <tt>jQuery</tt> is not available, so you can still use: | |
| <pre> | |
| jQuery(document).ready(function(){ | |
| jQuery(#somefunction) ... | |
| }); | |
| </pre> | |
| but the following will either throw an error, or use the <tt>$</tt> shortcut as assigned by other library. | |
| <pre> | |
| $(document).ready(function(){ | |
| $(#somefunction) ... | |
| }); | |
| </pre> | |
| However, if you really like the short <tt>$</tt> instead of <tt>jQuery</tt>, you can use the following wrapper around your code: | |
| <pre> | |
| jQuery(document).ready(function($) { | |
| // Inside of this function, $() will work as an alias for jQuery() | |
| // and other libraries also using $ will not be accessible under this shortcut | |
| }); | |
| </pre> | |
| That wrapper will cause your code to be executed when the DOM is fully constructed. If, for some reason, you want your code to execute immediately instead of waiting for the [http://api.jquery.com/ready/ DOM ready] event, then you can use this wrapper method instead: | |
| <pre> | |
| (function($) { | |
| // Inside of this function, $() will work as an alias for jQuery() | |
| // and other libraries also using $ will not be accessible under this shortcut | |
| })(jQuery); | |
| </pre> | |
| Alternatively, you can always reasign <tt>jQuery</tt> to another shortcut of your choice and leave the <tt>$</tt> shorcut to other libraries: | |
| <pre> | |
| var $j = jQuery; | |
| </pre> | |
| == Default Scripts Included and Registered by WordPress == | |
| By default, WordPress installation includes many popular scripts commonly used by web developers besides the scripts used by WordPress itself. Some of them are listed in the table below. | |
| For a detailed list of names that can be used in place of the <code>$handle</code> parameter, see [[Function Reference/wp_register_script#Handles and Their Script Paths Registered by WordPress|Handles and Their Script Paths Registered by WordPress]]. | |
| Note that in [[Version 3.5]], WordPress changed its naming convention for minified scripts and styles. Before, minified scripts and styles had the ''.js'' and ''.css'' extensions, unminified had ''.dev.js'' and ''.dev.css''. However, following the change, the extensions are ''.min.js'' and ''.min.css'' for minified files, ''.js'' and ''.css'' for unminified, respectively. | |
| {| class="wikitable" style="width:100%;" | |
| |- | |
| ! width="25%" | '''Script Name''' | |
| ! width="35%" | '''Handle''' | |
| ! width="40%" | '''Needed Dependency *''' | |
| |- | |
| | [http://www.defusion.org.uk/ Image Cropper] | |
| | Image cropper (not used in core, see jcrop) | |
| |- | |
| | [http://deepliquid.com/content/Jcrop.html Jcrop] | |
| | jcrop | |
| |- | |
| | [http://code.google.com/p/swfobject/ SWFObject] | |
| | swfobject | |
| |- | |
| | [http://swfupload.org/ SWFUpload] | |
| | swfupload | |
| |- | |
| | [http://swfupload.org/ SWFUpload Degrade] | |
| | swfupload-degrade | |
| |- | |
| | [http://swfupload.org/ SWFUpload Queue] | |
| | swfupload-queue | |
| |- | |
| | [http://swfupload.org/ SWFUpload Handlers] | |
| | swfupload-handlers | |
| |- | |
| | [http://jquery.com/ jQuery] | |
| | jquery | |
| | json2 (for AJAX calls) | |
| |- | |
| | [http://plugins.jquery.com/project/form/ jQuery Form] | |
| | jquery-form | |
| | jquery | |
| |- | |
| | [http://plugins.jquery.com/project/color/ jQuery Color] | |
| | jquery-color | |
| | jquery | |
| |- | |
| | [http://masonry.desandro.com/ jQuery Masonry] | |
| | jquery-masonry | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/ jQuery UI Core] | |
| | jquery-ui-core | |
| | jquery | |
| |- | |
| | jQuery UI Widget | |
| | jquery-ui-widget | |
| | jquery | |
| |- | |
| | jQuery UI Mouse | |
| | jquery-ui-mouse | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/accordion/ jQuery UI Accordion] | |
| | jquery-ui-accordion | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/autocomplete/ jQuery UI Autocomplete] | |
| | jquery-ui-autocomplete | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/slider/ jQuery UI Slider] | |
| | jquery-ui-slider | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/progressbar/ jQuery UI Progressbar] | |
| | jquery-ui-progressbar | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/tabs/ jQuery UI Tabs] | |
| | jquery-ui-tabs | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/sortable/ jQuery UI Sortable] | |
| | jquery-ui-sortable | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/draggable/ jQuery UI Draggable] | |
| | jquery-ui-draggable | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/droppable/ jQuery UI Droppable] | |
| | jquery-ui-droppable | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/selectable/ jQuery UI Selectable] | |
| | jquery-ui-selectable | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/position/ jQuery UI Position] | |
| | jquery-ui-position | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/datepicker/ jQuery UI Datepicker] | |
| | jquery-ui-datepicker | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/tooltip/ jQuery UI Tooltips] | |
| | jquery-ui-tooltip | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/resizable/ jQuery UI Resizable] | |
| | jquery-ui-resizable | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/dialog/ jQuery UI Dialog] | |
| | jquery-ui-dialog | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/demos/button/ jQuery UI Button] | |
| | jquery-ui-button | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects] | |
| | jquery-effects-core | |
| | jquery | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Blind] | |
| | jquery-effects-blind | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Bounce] | |
| | jquery-effects-bounce | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Clip] | |
| | jquery-effects-clip | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Drop] | |
| | jquery-effects-drop | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Explode] | |
| | jquery-effects-explode | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Fade] | |
| | jquery-effects-fade | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Fold] | |
| | jquery-effects-fold | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Highlight] | |
| | jquery-effects-highlight | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Pulsate] | |
| | jquery-effects-pulsate | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Scale] | |
| | jquery-effects-scale | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Shake] | |
| | jquery-effects-shake | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Slide] | |
| | jquery-effects-slide | |
| | jquery-effects-core | |
| |- | |
| | [http://jqueryui.com/effect/ jQuery UI Effects - Transfer] | |
| | jquery-effects-transfer | |
| | jquery-effects-core | |
| |- | |
| | [http://mediaelementjs.com/ MediaElement.js (WP 3.6+)] | |
| | wp-mediaelement | |
| | jquery | |
| |- | |
| | [http://trainofthoughts.org/blog/2007/02/15/jquery-plugin-scheduler/ jQuery Schedule] | |
| | schedule | |
| | jquery | |
| |- | |
| | [https://web.archive.org/web/20111017233444/http://plugins.jquery.com/project/suggest jQuery Suggest] | |
| | suggest | |
| | jquery | |
| |- | |
| | [http://codex.wordpress.org/ThickBox ThickBox] | |
| | thickbox | |
| |- | |
| | [http://cherne.net/brian/resources/jquery.hoverIntent.html jQuery HoverIntent] | |
| | hoverIntent | |
| | jquery | |
| |- | |
| | [http://plugins.jquery.com/project/hotkeys jQuery Hotkeys] | |
| | jquery-hotkeys | |
| | jquery | |
| |- | |
| | [http://code.google.com/p/tw-sack/ Simple AJAX Code-Kit] | |
| | sack | |
| |- | |
| | [http://www.alexking.org QuickTags] | |
| | quicktags | |
| |- | |
| | [https://github.com/automattic/Iris Iris (Colour picker)] | |
| | iris | |
| | jquery | |
| |- | |
| | [http://acko.net/dev/farbtastic Farbtastic (deprecated)] | |
| | farbtastic | |
| | jquery | |
| |- | |
| | [http://mattkruse.com ColorPicker (deprecated)] | |
| | colorpicker | |
| | jquery | |
| |- | |
| | [http://tinymce.moxiecode.com/ Tiny MCE] | |
| | tiny_mce | |
| |- | |
| | Autosave | |
| | autosave | |
| |- | |
| | WordPress AJAX Response | |
| | wp-ajax-response | |
| |- | |
| | List Manipulation | |
| | wp-lists | |
| |- | |
| | WP Common | |
| | common | |
| |- | |
| | WP Editor | |
| | editorremov | |
| |- | |
| | WP Editor Functions | |
| | editor-functions | |
| |- | |
| | AJAX Cat | |
| | ajaxcat | |
| |- | |
| | Admin Categories | |
| | admin-categories | |
| |- | |
| | Admin Tags | |
| | admin-tags | |
| |- | |
| | Admin custom fields | |
| | admin-custom-fields | |
| |- | |
| | Password Strength Meter | |
| | password-strength-meter | |
| |- | |
| | Admin Comments | |
| | admin-comments | |
| |- | |
| | Admin Users | |
| | admin-users | |
| |- | |
| | Admin Forms | |
| | admin-forms | |
| |- | |
| | XFN | |
| | xfn | |
| |- | |
| | Upload | |
| | upload | |
| |- | |
| | PostBox | |
| | postbox | |
| |- | |
| | Slug | |
| | slug | |
| |- | |
| | Post | |
| | post | |
| |- | |
| | Page | |
| | page | |
| |- | |
| | Link | |
| | link | |
| |- | |
| | Comment | |
| | comment | |
| |- | |
| | Threaded Comments | |
| | comment-reply | |
| |- | |
| | Admin Gallery | |
| | admin-gallery | |
| |- | |
| | Media Upload | |
| | media-upload | |
| |- | |
| | Admin widgets | |
| | admin-widgets | |
| |- | |
| | Word Count | |
| | word-count | |
| |- | |
| | Theme Preview | |
| | theme-preview | |
| |- | |
| | [https://github.com/douglascrockford/JSON-js JSON for JS] | |
| | json2 | |
| |- | |
| | [http://www.plupload.com/ Plupload Core] | |
| | plupload | |
| |- | |
| | [http://www.plupload.com/example_all_runtimes.php Plupload All Runtimes] | |
| | plupload-all | |
| |- | |
| | [http://www.plupload.com/example_all_runtimes.php Plupload HTML4] | |
| | plupload-html4 | |
| |- | |
| | [http://www.plupload.com/example_all_runtimes.php Plupload HTML5] | |
| | plupload-html5 | |
| |- | |
| | [http://www.plupload.com/example_all_runtimes.php Plupload Flash] | |
| | plupload-flash | |
| |- | |
| | [http://www.plupload.com/example_all_runtimes.php Plupload Silverlight] | |
| | plupload-silverlight | |
| |- | |
| | [http://underscorejs.org/ Underscore js] | |
| | underscore | |
| |- | |
| | [http://backbonejs.org/ Backbone js] | |
| | backbone | |
| |} | |
| {| class="wikitable" style="width:100%;" | |
| |- | |
| ! colspan=4 | '''Removed from Core''' | |
| |- | |
| ! width="25%" | '''Script Name''' | |
| ! width="30%" | '''Handle''' | |
| ! width="20%" | '''Removed Version''' | |
| ! width="25%" | '''Replaced With''' | |
| |- | |
| | [http://script.aculo.us Scriptaculous Root] | |
| | scriptaculous-root | |
| | WP 3.5 | |
| | Google Version | |
| |- | |
| | [http://script.aculo.us Scriptaculous Builder] | |
| | scriptaculous-builder | |
| | WP 3.5 | |
| | Google Version | |
| |- | |
| | [http://script.aculo.us Scriptaculous Drag &amp; Drop] | |
| | scriptaculous-dragdrop | |
| | WP 3.5 | |
| | Google Version | |
| |- | |
| | [http://script.aculo.us Scriptaculous Effects] | |
| | scriptaculous-effects | |
| | WP 3.5 | |
| | Google Version | |
| |- | |
| | [http://script.aculo.us Scriptaculous Slider] | |
| | scriptaculous-slider | |
| | WP 3.5 | |
| | Google Version | |
| |- | |
| | [http://script.aculo.us/ Scriptaculous] Sound | |
| | scriptaculous-sound | |
| | WP 3.5 | |
| | Google Version | |
| |- | |
| | [http://script.aculo.us Scriptaculous Controls] | |
| | scriptaculous-controls | |
| | WP 3.5 | |
| | Google Version | |
| |- | |
| | [http://script.aculo.us Scriptaculous] | |
| | scriptaculous | |
| | WP 3.5 | |
| | Google Version | |
| |- | |
| | [http://www.prototypejs.org/ Prototype Framework] | |
| | prototype | |
| | WP 3.5 | |
| | Google Version | |
| |- | |
| |} | |
| '''The list is far from complete.''' For a complete list of registered files inspect <tt>$GLOBALS['wp_scripts']</tt> in the admin UI. Registered scripts might change per requested page. | |
| -------- | |
| ''* The listed dependencies are not complete.'' | |
| == Notes == | |
| * The function should be called using the [[Plugin API/Action Reference/wp_enqueue_scripts|wp_enqueue_scripts]] action [[Glossary#Hook|hook]] if you want to call it on the front-end of the site, like in the [[#Examples|examples above]]. To call it on the [[Administration Screens|administration screens]], use the [[Plugin_API/Action_Reference/admin_enqueue_scripts|admin_enqueue_scripts]] action hook. For the [[Login Screen|login screen]], use the [[Plugin_API/Action_Reference/login_enqueue_scripts|login_enqueue_scripts]] action hook. Calling it outside of an action hook can lead to problems, see the [http://core.trac.wordpress.org/ticket/11526 ticket #11526] for details. | |
| * Prior to [[Version 3.3]], the function will have no effect if it is called using the [[Plugin_API/Action_Reference/wp_head|wp_head]] or [[Plugin_API/Action_Reference/wp_print_scripts|wp_print_scripts]] action hooks or later, as this is too late to enqueue the files even if the <tt>$in_footer</tt> parameter is set to ''true''. | |
| * As of [[Version 3.3]], the function can be called mid-page (before the <tt>[[Plugin API/Action Reference/wp footer|wp_footer()]]</tt> template tag) or using the [[Plugin_API/Action_Reference/wp_head|wp_head]] action hook. This will place the script in the footer as if the <tt>$in_footer</tt> parameter was set to ''true''. | |
| * If you try to register or enqueue an already registered handle with different parameters, the new parameters will be ignored. Instead, use <tt>[[Function_Reference/wp_deregister_script|wp_deregister_script()]]</tt> and register the script again with the new parameters. | |
| * jQuery UI Effects is '''not''' included with the ''jquery-ui-core'' handle. | |
| * Uses: <tt>WP_Scripts::add()</tt>, <tt>WP_Scripts::add_data()</tt> and <tt>WP_Scripts::enqueue()</tt>. | |
| * Uses global: (<tt>unknown type</tt>) <tt>$wp_scripts</tt>. | |
| == Change Log == | |
| * Since: [[Version 2.6|2.6]] (BackPress version: r16) | |
| == Source File == | |
| <tt>wp_enqueue_script()</tt> is located in {{Trac|wp-includes/functions.wp-scripts.php}}. | |
| ==Resources== | |
| * [http://www.prelovac.com/vladimir/best-practice-for-adding-javascript-code-to-wordpress-plugin Best practice for adding JavaScript code to WordPress plugins] | |
| *[http://planetozh.com/blog/2008/04/how-to-load-javascript-with-your-wordpress-plugin/ How To: Load Javascript With Your WordPress Plugin] | |
| *[http://noteslog.com/post/how-to-load-javascript-in-wordpress-plugins/ How to load JavaScript in WordPress plugins] | |
| *[http://themocracy.com/2009/04/using-jquery-with-wordpress/ Using jQuery with WordPress] | |
| *[http://www.devlounge.net/articles/using-javascript-and-css-with-your-wordpress-plugin Using JavaScript and CSS with your WordPress Plugin] | |
| * [http://www.lost-in-code.com/platforms/wordpress/wordpress-using-javascript-libraries-with-your-plugin-or-theme/ Using Javascript libraries with your Wordpress plugin or theme] | |
| * [http://www.ericmmartin.com/5-tips-for-using-jquery-with-wordpress/ 5 Tips For Using jQuery with WordPress] | |
| * [http://beerpla.net/2010/01/13/wordpress-plugin-development-how-to-include-css-and-javascript-conditionally-and-only-when-needed-by-the-posts/ How to Include CSS and JavaScript Conditionally, and Only When Needed by the Posts] | |
| * [http://fusi0n.org/coding/make-your-wordpress-plugins-use-a-different-version-of-a-bundled-javascript-library Make Your WordPress Plugins Use a Different Version of a Bundled JavaScript Library] Replacing built-in JavaScript libraries is usually a bad idea. Do this only on sites you administer personally. | |
| * [http://scribu.net/wordpress/optimal-script-loading.html How to load JavaScript like a WordPress Master] Highly recommended. | |
| * [http://justintadlock.com/archives/2009/08/06/how-to-disable-scripts-and-styles How to disable scripts and styles] | |
| * [http://twentyfiveautumn.com/2012/03/14/loading-javascript-on-the-frontend-with-your-wordpress-plugin/ Loading javascript on the frontend with your WordPress plugin] | |
| * [http://www.cybersprocket.com/?s=wordpress+javascript JavaScript Tips and Tricks for WordPress 3.x] | |
| * [[ThickBox|Developing for WordPress's customized version of ThickBox]] | |
| * [http://generatewp.com/register_script/ WordPress Script Registration Generator] | |
| == Related == | |
| {{Enqueue Functions Related}} | |
| {{Tag Footer}} | |
| {{Copyedit}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_option" d:title="get option"> | |
| <d:index d:value="get option"/> | |
| <h1>get option</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get option}} | |
| {{es|Referencia de Funciones/get option}} | |
| {{it|Riferimento funzioni/get_option}} | |
| {{ja|関数リファレンス/get_option}} | |
| {{ru|Справочник_по_функциям/get option}} | |
| {{vi|Tham Khảo Các Hàm/get option}} | |
| {{zh-cn|get_option}} | |
| }} | |
| == Description == | |
| A safe way of getting values for a named [[Option_Reference|option]] from the options database table. If the desired option does not exist, or no value is associated with it, <tt>FALSE</tt> will be returned. | |
| == Usage == | |
| %%% <?php echo get_option( $option, $default ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$option|string|Name of the option to retrieve. A concise list of valid options is below, but a more complete one can be found at the [[Option Reference]]. Matches <tt>$option_name</tt> in <tt>[[Function Reference/register setting|register_setting()]]</tt> for custom options.}} | |
| :* <tt>'admin_email'</tt> - E-mail address of blog administrator. | |
| :* <tt>'blogname'</tt> - Weblog title; set in General Options. | |
| :* <tt>'blogdescription'</tt> - Tagline for your blog; set in General Options. | |
| :* <tt>'blog_charset'</tt> - Character encoding for your blog; set in Reading Options. | |
| :* <tt>'date_format'</tt> - Default date format; set in General Options. | |
| :* <tt>'default_category'</tt> - Default post category; set in Writing Options. | |
| :* <tt>'home'</tt> - The blog's home web address; set in General Options. | |
| :* <tt>'siteurl'</tt> - WordPress web address; set in General Options.<br />'''Warning:''' This is not the same as <tt>get_bloginfo('siteurl')</tt> (which will return the homepage url), but as <tt>get_bloginfo('wpurl')</tt>. | |
| :* <tt>'template'</tt> - The current theme's name; set in Presentation. | |
| :* <tt>'start_of_week'</tt> - Day of week calendar should start on; set in General Options. | |
| :* <tt>'upload_path'</tt> - Default upload location; set in Miscellaneous Options. | |
| :* <tt>'posts_per_page'</tt> - Maximum number of posts to show on a page; set in Reading Options. | |
| :* <tt>'posts_per_rss'</tt> - Maximum number of most recent posts to show in the syndication feed; set in Reading Options. | |
| :There are many more options available, a lot of which depend on what plugins you have installed. Visit the <tt>[[Settings_General_Screen | /wp-admin/options.php]]</tt> page for a complete list. | |
| Underscores separate words, lowercase only - this is going to be in a database. | |
| {{Parameter|$default|mixed|The default value to return if no value is returned (ie. the option is not in the database).|optional|<tt>false</tt>}} | |
| == Return Values == | |
| ; (mixed) : Current value for the specified option. If the specified option does not exist, returns boolean <tt>FALSE</tt>. | |
| == Examples == | |
| %%%<?php | |
| $no_exists_value = get_option( 'no_exists_value' ); | |
| var_dump( $no_exists_value ); /* outputs false */ | |
| $no_exists_value = get_option( 'no_exists_value', 'default_value' ); | |
| var_dump( $no_exists_value ); /* outputs 'default_value' */ | |
| ?>%%% | |
| === Show Blog Title === | |
| Displays your blog's title in a <tt>&lt;h1&gt;</tt> tag. | |
| %%% <h1><?php echo get_option( 'blogname' ); ?></h1> %%% | |
| === Show Character Set === | |
| Displays the character set your blog is using (ex: UTF-8) | |
| %%% <p>Character set: <?php echo get_option( 'blog_charset' ); ?> </p> %%% | |
| ===Retrieve Administrator E-mail=== | |
| Retrieve the e-mail of the blog administrator, storing it in a variable. | |
| %%% <?php $admin_email = get_option( 'admin_email' ); ?> %%% | |
| == Notes == | |
| * Uses: <tt>[[Function_Reference/apply_filters | apply_filters()]]</tt> | |
| ** Calls <tt>[[Plugin_API/Filter_Reference/pre_option_$option | 'pre_option_$option']]</tt> before checking the option. Any value other than <tt>false</tt> will "short-circuit" the retrieval of the option and return the returned value. You should not try to override special options, but you will not be prevented from doing so. | |
| ** Calls <tt>[[Plugin_API/Filter_Reference/'option_$option' | 'option_$option']]</tt>, after checking the option, with the option value. | |
| ** Calls <tt>[[Plugin_API/Filter_Reference/default_option_$option | 'default_option_$option']]</tt> to filter <tt>$default</tt> before returning it if it is set and the value doesn't exist. | |
| * Uses: <tt>[[Function_Reference/maybe_unserialize | maybe_unserialize()]]</tt> to unserialize the value before returning it. | |
| == Changelog == | |
| * Since 1.5.0 | |
| == Source File == | |
| <code>get_option()</code> is located in {{Trac|wp-includes/option.php}}. | |
| == Related == | |
| {{Option Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_taxonomy" d:title="is taxonomy"> | |
| <d:index d:value="is taxonomy"/> | |
| <h1>is taxonomy</h1> | |
| <p>[[Function Reference|''&larr; Return to function reference.'']] | |
| {{Deprecated}} | |
| == Description == | |
| '''This function is deprecated as of [[Version 3.0]]. Please use [[Function_Reference/is_tax]] instead.''' | |
| This [[Conditional Tags|Conditional Tag]] checks if the taxonomy name exists by passing a taxonomy name as an argument to it. This is a boolean function uses a global <tt>$wp_taxonomies</tt> variable for checking if taxonomy name existence, meaning it returns either TRUE if the taxonomy name exist or FALSE if it doesn't exist. | |
| ==Usage== | |
| %%%<?php is_taxonomy($taxonomy); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$taxonomy|string|The name of the taxonomy}} | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| $taxonomy_exist = is_taxonomy('category'); | |
| //returns true | |
| $taxonomy_exist = is_taxonomy('post_tag'); | |
| //returns true | |
| $taxonomy_exist = is_taxonomy('link_category'); | |
| //returns true | |
| $taxonomy_exist = is_taxonomy('my_taxonomy'); | |
| //returns false if global $wp_taxonomies['my_taxonomy'] is not set | |
| ==Notes== | |
| * See Also: [[WordPress_Taxonomy]]. | |
| ==Change Log== | |
| Since: 2.3.0 | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_taxonomy()</tt> is located in {{Trac|wp-includes/taxonomy.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_post" d:title="get post"> | |
| <d:index d:value="get post"/> | |
| <h1>get post</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get post}} | |
| {{it|Riferimento_funzioni/get_post}} | |
| {{ja|関数リファレンス/get post}} | |
| {{ru|Справочник_по_функциям/get_post}} | |
| {{tr|Fonksiyon Referans/get post}} | |
| }} | |
| ==Description== | |
| Takes a post ID and returns the database record for that post. You can specify, by means of the <tt>$output</tt> parameter, how you would like the results returned. | |
| ==Usage== | |
| %%%<?php get_post( $id, $output, $filter ); ?> %%% | |
| ==Parameters== | |
| {{Parameter|$id|integer or object|The ID of the post you'd like to fetch, or an object that specifies the post. By default the current post is fetched.|optional|null}} | |
| {{Parameter|$output|string|How you'd like the result. <ul><li>''OBJECT'' - (''default'') returns a <tt>[[Class_Reference/WP_Post|WP_Post]]</tt> object</li><li>''ARRAY_A'' - Returns an associative array of field names to values</li><li>''ARRAY_N'' - returns a numeric array of field values</li></ul>|optional|OBJECT}} | |
| {{Parameter|$filter|string|Filter the post. See [[Function_Reference/sanitize_post_field | sanitize_post_field()]] for a full list of values. <ul><li>''raw'' - (''default'')</li></ul>|optional|raw}} | |
| ==Return Values== | |
| Returns a <tt><b>[[Class_Reference/WP_Post|WP_Post]]</b></tt> object, or <tt><b>null</b></tt> if the post doesnt exist or an error occurred. | |
| ==Example== | |
| To get the title for a post with ID 7: | |
| %%%<?php | |
| $post_7 = get_post(7); | |
| $title = $post_7->post_title; | |
| ?> %%% | |
| Alternatively, specify the <tt>$output</tt> parameter: | |
| %%%<?php | |
| $post_7 = get_post(7, ARRAY_A); | |
| $title = $post_7['post_title']; | |
| ?> %%% | |
| == Notes == | |
| Before version 3.5, the first parameter <tt>$post</tt> was required to be a variable. For example, <tt>get_post(7)</tt> would cause a fatal error. | |
| == Source File == | |
| <tt>get_post()</tt> is located in {{Trac|wp-includes/post.php}} and {{Trac|wp-includes/class-wp-atom-server.php}}. | |
| == Change Log == | |
| *Since [[Version_1.5.1 | 1.5.1]] | |
| *[[Version_3.5 | 3.5.0]] - the <tt>$post</tt> parameter is no longer passed by reference. | |
| == Related == | |
| * <tt>[[Function_Reference/get_post_field | get_post_field()]]</tt> - Retrieve data from a post field based on post ID. | |
| {{Tag Footer}} | |
| {{Copyedit}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_user_logged_in" d:title="is user logged in"> | |
| <d:index d:value="is user logged in"/> | |
| <h1>is user logged in</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/is_user_logged_in}} | |
| {{it|Riferimento funzioni/is_user_logged_in}} | |
| {{ja|関数リファレンス/is_user_logged_in}} | |
| }} | |
| == Description == | |
| This [[Conditional Tags|Conditional Tag]] checks if the current visitor is logged in. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| == Usage == | |
| %%% <?php if ( is_user_logged_in() ) { ... } ?> %%% | |
| == Parameters == | |
| This function does not accept any parameters. | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True if user is logged in, false if not logged in. | |
| == Examples == | |
| Display different output depending on whether the user is logged in or not. | |
| <pre><?php | |
| if ( is_user_logged_in() ) { | |
| echo 'Welcome, registered user!'; | |
| } else { | |
| echo 'Welcome, visitor!'; | |
| } | |
| ?></pre> | |
| From your functions file, this code displays a personal message for logged in users. | |
| <pre>add_action( 'loop_start', 'personal_message_when_logged_in' ); | |
| function personal_message_when_logged_in() { | |
| if ( is_user_logged_in() ) : | |
| $current_user = wp_get_current_user(); | |
| echo 'Personal Message For ' . $current_user->user_firstname . '!'; | |
| else : | |
| echo 'Non Personalized Message!'; | |
| endif; | |
| }</pre> | |
| == Change Log == | |
| Since: [[Version 2.0|2.0.0]] | |
| == Source File == | |
| <tt>is_user_logged_in()</tt> is located in {{Trac|wp-includes/pluggable.php}}. | |
| == Related == | |
| {{Conditional Tags}} | |
| {{Login Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="Pluggable_Functions" d:title="Pluggable Functions"> | |
| <d:index d:value="Pluggable Functions"/> | |
| <h1>Pluggable Functions</h1> | |
| <p>Pluggable functions were introduced in [[Version 1.5.1|WordPress 1.5.1]] These functions let you override certain core functions via [[Plugin API|plugins]]. The most up-to-date list of core functions that WordPress allows plugins to override is available at {{Trac|wp-includes/pluggable.php}}. WordPress loads the built-in functions only if they are undefined after all plugins have been loaded. | |
| Pluggable functions are no longer being added to WordPress core. All new functions instead use filters on their output to allow for similar overriding of their functionality. | |
| '''Note:''' A function can only be reassigned this way once, so you can’t install two plugins that plug the same function for different reasons. For safety, it is best to always wrap your functions with <code>if ( !function_exists() )</code>, otherwise you '''will''' produce fatal errors on plugin activation. | |
| == Full list of Pluggable Functions: == | |
| {| class="widefat" | |
| |- style="background:#464646; color:#d7d7d7;" | |
| ! width="100%" | '''Version 3.5''' | |
| |- | |
| | | |
| *wp-includes\pluggable.php | |
| ** [[Function Reference/auth_redirect|auth_redirect]] | |
| ** [[Function Reference/cache_users|cache_users]] | |
| ** [[Function Reference/check_admin_referer|check_admin_referer]] | |
| ** [[Function Reference/check_ajax_referer|check_ajax_referer]] | |
| ** [[Function Reference/get_avatar|get_avatar]] | |
| ** [[Function Reference/get_currentuserinfo|get_currentuserinfo]] | |
| ** [[Function Reference/get_user_by_email|get_user_by_email]] (deprecated) | |
| ** [[Function Reference/get_user_by|get_user_by]] | |
| ** [[Function Reference/get_userdatabylogin|get_userdatabylogin]] (deprecated) | |
| ** [[Function Reference/get_userdata|get_userdata]] | |
| ** [[Function Reference/is_user_logged_in|is_user_logged_in]] | |
| ** [[Function Reference/wp_authenticate|wp_authenticate]] | |
| ** [[Function Reference/wp_check_password|wp_check_password]] | |
| ** [[Function Reference/wp_clear_auth_cookie|wp_clear_auth_cookie]] | |
| ** [[Function Reference/wp_create_nonce|wp_create_nonce]] | |
| ** [[Function Reference/wp_generate_auth_cookie|wp_generate_auth_cookie]] | |
| ** [[Function Reference/wp_generate_password|wp_generate_password]] | |
| ** [[Function Reference/wp_get_current_user|wp_get_current_user]] | |
| ** [[Function Reference/wp_hash_password|wp_hash_password]] | |
| ** [[Function Reference/wp_hash|wp_hash]] | |
| ** [[Function Reference/wp_logout|wp_logout]] | |
| ** [[Function Reference/wp_mail|wp_mail]] | |
| ** [[Function Reference/wp_new_user_notification|wp_new_user_notification]] | |
| ** [[Function Reference/wp_nonce_tick|wp_nonce_tick]] | |
| ** [[Function Reference/wp_notify_moderator|wp_notify_moderator]] | |
| ** [[Function Reference/wp_notify_postauthor|wp_notify_postauthor]] | |
| ** [[Function Reference/wp_parse_auth_cookie|wp_parse_auth_cookie]] | |
| ** [[Function Reference/wp_password_change_notification|wp_password_change_notification]] | |
| ** [[Function Reference/wp_rand|wp_rand]] | |
| ** [[Function Reference/wp_redirect|wp_redirect]] | |
| ** [[Function Reference/wp_safe_redirect|wp_safe_redirect]] | |
| ** [[Function Reference/wp_salt|wp_salt]] | |
| ** [[Function Reference/wp_sanitize_redirect|wp_sanitize_redirect]] | |
| ** [[Function Reference/wp_set_auth_cookie|wp_set_auth_cookie]] | |
| ** [[Function Reference/wp_set_current_user|wp_set_current_user]] | |
| ** [[Function Reference/wp_set_password|wp_set_password]] | |
| ** [[Function Reference/wp_text_diff|wp_text_diff]] | |
| ** [[Function Reference/wp_validate_auth_cookie|wp_validate_auth_cookie]] | |
| ** [[Function Reference/wp_validate_redirect|wp_validate_redirect]] | |
| ** [[Function Reference/wp_verify_nonce|wp_verify_nonce]] | |
| |} | |
| == Reference == | |
| ; [[Function_Reference/get_currentuserinfo|<tt>get_currentuserinfo()</tt>]] : Grabs the information of the current logged in user, if there is one. Essentially a wrapper for get_userdata(), but it also stores information in global variables. | |
| ; [[Function_Reference/get_userdata|<tt>get_userdata($userid)</tt>]] : Pulls user information for the specified user from the database. | |
| ; [[Function Reference/wp_mail|<tt>wp_mail($to, $subject, $message, $headers = <nowiki>''</nowiki>)</tt>]] : A convenient wrapper for PHP's mail function. | |
| ; <tt>wp_login($username, $password, $already_md5 = false)</tt> : Returns <tt>true</tt> if the specified username and password correspond to a registered user. | |
| ; <tt>auth_redirect()</tt> : If a user is not logged in, he or she will be redirected to WordPress' login page before being allowed to access content on the page from which this function was called. Upon successfully logging in, the user is sent back to the page in question. | |
| ; [[Function Reference/wp_redirect|<tt>wp_redirect($location)</tt>]] : Redirects a browser to the ''absolute URI'' specified by the <tt>$location</tt> parameter. | |
| ; <tt><nowiki>wp_notify_postauthor($comment_id, $comment_type='')</nowiki></tt>: Emails the author of the comment's post the content of the comment specified. | |
| ; <tt>wp_notify_moderator($comment_id)</tt> : Informs the administrative email account that the comment specified needs to be moderated. See [[Administration_Panels|Administration]] > [[Administration_Panels#General|Settings]] > [[Settings_General_SubPanel|General]]. | |
| == Example == | |
| An example of what you can do with a pluggable function is replace the default email handler. To do this, you'd need to write a plugin that defines a <tt>wp_mail()</tt> function. The default <tt>wp_mail()</tt> function looks like this: | |
| <pre> | |
| function wp_mail( $to, $subject, $message, $headers = '' ) { | |
| if( $headers == '' ) { | |
| $headers = "MIME-Version: 1.0\n" . | |
| "From: " . get_settings('admin_email') . "\n" . | |
| "Content-Type: text/plain; charset=\"" . get_settings('blog_charset') . "\"\n"; | |
| } | |
| return @mail( $to, $subject, $message, $headers ); | |
| } | |
| </pre> | |
| But, for example, if you wanted to CC all your mail to another address, you could use this code in a plugin: | |
| <pre> | |
| if( ! function_exists('wp_mail') ) { | |
| function wp_mail( $to, $subject, $message, $headers = '' ) { | |
| if( $headers == '' ) { | |
| $headers = "MIME-Version: 1.0\n" . | |
| "From: " . get_settings('admin_email') . "\n" . | |
| "Cc: dummy@example.com\n" . | |
| "Content-Type: text/plain; charset=\"" . get_settings('blog_charset') . "\"\n"; | |
| } | |
| return @mail($to, $subject, $message, $headers); | |
| } | |
| } | |
| </pre> | |
| Notice that if you plug a core function like this the original is no longer available. I.e., the elegant solution here would have been to write a function that tacks our Cc header on the end of the exising <tt>$headers</tt> string then call the original <tt>wp_mail()</tt> with the extra header. However this would not work as the original <tt>wp_mail()</tt> does not exist if you plug it. | |
| [[Category:Functions]] | |
| [[Category:Pluggable Functions]]</p> | |
| </d:entry> | |
| <d:entry id="plugin_basename" d:title="plugin basename"> | |
| <d:index d:value="plugin basename"/> | |
| <h1>plugin basename</h1> | |
| <p>== Description == | |
| Gets the path to a plugin file or directory, relative to the [[Glossary#Plugin|plugins]] directory, without the leading and trailing slashes. | |
| == Usage == | |
| %%% <?php plugin_basename($file); ?> %%% | |
| == Parameters == | |
| {{Parameter|$file|string|Absolute path to a plugin file or directory within the plugins directory.}} | |
| == Return == | |
| {{Return||string| Path to a plugin file or directory, relative to the plugins directory (without the leading and trailing slashes).}} | |
| == Example == | |
| If your plugin file is located at ''/home/www/wp-content/plugins/<b>my-plugin/my-plugin.php</b>'', and you call: | |
| $x = plugin_basename(__FILE__); | |
| The <tt>$x</tt> variable will equal to "''<b>my-plugin/my-plugin.php</b>''". | |
| == Notes == | |
| * Uses both the <tt>WP_PLUGIN_DIR</tt> and <tt>WPMU_PLUGIN_DIR</tt> constants internally, to test for and strip the plugins directory path from the <tt>$file</tt> path. Note that the direct usage of WordPress internal constants [[Determining Plugin and Content Directories|is not recommended]]. | |
| == Change Log == | |
| * Since: [[Version 1.5|1.5]] | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>plugin_basename()</tt> is located in {{Trac|wp-includes/plugin.php}}. | |
| == Related == | |
| {{Tag Plugin Paths}} | |
| {{Directory URL Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_mail" d:title="wp mail"> | |
| <d:index d:value="wp mail"/> | |
| <h1>wp mail</h1> | |
| <p>== Description == | |
| Send mail, similar to PHP's <tt>[http://php.net/manual/en/function.mail.php mail()]</tt>. | |
| The default sender name is "WordPress" and the default sender email address is wordpress@yoursite.com. These may be overridden by including a header like: | |
| <pre>From: "Example User" <email@example.com></pre> | |
| Then, the optional hooks <tt>[[Plugin_API/Filter_Reference/wp_mail_from | 'wp_mail_from']]</tt> and <tt>[[Plugin_API/Filter_Reference/wp_mail_from_name | 'wp_mail_from_name']]</tt> are run on the sender email address and name. The return values are reassembled into a 'from' address like <tt>'"Example User" <email@address.com>'</tt> If only <tt>'wp_mail_from'</tt> returns a value, then just the email address will be used with no name. | |
| The default content type is <tt>'text/plain'</tt> which does not allow using HTML. You can set the content type of the email either by using the <tt>[[Plugin_API/Filter_Reference/wp_mail_content_type | 'wp_mail_content_type']]</tt> filter (see example below), or by including a header like <tt>"Content-type: text/html"</tt>. Be careful to reset <tt>'wp_mail_content_type'</tt> back to <tt>'text/plain'</tt> after you send your message, though, because [http://core.trac.wordpress.org/ticket/23578 failing to do so could lead to unexpected problems with e-mails from WP or plugins/themes]. | |
| The default charset is based on the charset used on the blog. The charset can be set using the <tt>[[Plugin_API/Filter_Reference/wp_mail_charset | 'wp_mail_charset']]</tt> filter. | |
| == Usage == | |
| %%% <?php wp_mail( $to, $subject, $message, $headers, $attachments ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$to|string or array|The intended recipient(s). Multiple recipients may be specified using an array or a comma-separated string.}} | |
| {{Parameter|$subject|string|The subject of the message.}} | |
| {{Parameter|$message|string|Message content.}} | |
| {{Parameter|$headers|string or array|Mail headers to send with the message. For the string version, each header line (beginning with From:, Cc:, etc.) is delimited with a newline ("\r\n") (advanced)|optional|''Empty''}} | |
| {{Parameter|$attachments|string or array|Files to attach: a single filename, an array of filenames, or a newline-delimited string list of multiple filenames. (advanced)|optional|''Empty''}} | |
| == Return == | |
| ; (bool) : Whether the email contents were sent successfully. | |
| A <tt>true</tt> return value does not automatically mean that the user received the email successfully. It just only means that the method used was able to process the request without any errors. | |
| == Valid Address Formats == | |
| All email addresses supplied to <tt>wp_mail()</tt> as the <tt>$to</tt> parameter must comply with [http://www.faqs.org/rfcs/rfc2822.html RFC 2822]. Some valid examples: | |
| *user@example.com | |
| *user@example.com, anotheruser@example.com | |
| *User <user@example.com> | |
| *User <user@example.com>, Another User <anotheruser@example.com> | |
| The same applies to Cc: and Bcc: fields in <tt>$headers</tt>, but as noted in the next section, it's better to push multiple addresses into an array instead of listing them on a single line. Either address format, with or without the user name, may be used. | |
| == Using $headers To Set "From:", "Cc:" and "Bcc:" Parameters == | |
| To set the "From:" email address to something other than the WordPress default sender (see [[#Description]] above), or to add "Cc:" and/or "Bcc:" recipients, you must use the <tt>$headers</tt> argument. | |
| <tt>$headers</tt> can be a string or an array, but is probably easiest to use in its array form. To use it, push a string onto the array, starting with "From:", "Bcc:" or "Cc:" (note the use of the ":"), followed by a valid email address. | |
| When you're using the array form, you do not need to supply linebreaks (<tt>"\n"</tt> or <tt>"\r\n"</tt>). Although the function can handle multiple emails per line, it may simply be easier to push each email address separately onto the <tt>$headers</tt> array. The function will figure it out and will build the proper Mime header automagically. Just don't forget that each string you push must have the header type as the first part of the string ("From:", "Cc:" or "Bcc:") | |
| == Examples == | |
| <pre> <?php wp_mail( 'me@example.net', 'The subject', 'The message' ); ?> </pre> | |
| <pre> | |
| <?php | |
| $attachments = array( WP_CONTENT_DIR . '/uploads/file_to_attach.zip' ); | |
| $headers = 'From: My Name <myname@example.com>' . "\r\n"; | |
| wp_mail('test@example.org', 'subject', 'message', $headers, $attachments ); | |
| ?> | |
| </pre> | |
| <pre> | |
| <?php | |
| $multiple_to_recipients = array( | |
| 'recipient1@example.com', | |
| 'recipient2@foo.example.com' | |
| ); | |
| add_filter( 'wp_mail_content_type', 'set_html_content_type' ); | |
| wp_mail( $multiple_to_recipients, 'The subject', '<p>The <em>HTML</em> message</p>' ); | |
| // Reset content-type to avoid conflicts -- http://core.trac.wordpress.org/ticket/23578 | |
| remove_filter( 'wp_mail_content_type', 'set_html_content_type' ); | |
| function set_html_content_type() { | |
| return 'text/html'; | |
| } | |
| ?> | |
| </pre> | |
| <pre> | |
| <?php | |
| // Example using the array form of $headers | |
| // assumes $to, $subject, $message have already been defined earlier... | |
| $headers[] = 'From: Me Myself <me@example.net>'; | |
| $headers[] = 'Cc: John Q Codex <jqc@wordpress.org>'; | |
| $headers[] = 'Cc: iluvwp@wordpress.org'; // note you can just use a simple email address | |
| wp_mail( $to, $subject, $message, $headers ); | |
| ?> | |
| </pre> | |
| == Notes == | |
| * A <tt>true</tt> return value does not automatically mean that the user received the email successfully. | |
| * For this function to work, the settings <code>SMTP</code> and <code>smtp_port</code> (default: 25) need to be set in your php.ini file. | |
| * The function is available after the hook [[Plugin_API/Action_Reference/plugins_loaded|<code>'plugins_loaded'</code>]]. | |
| * The filenames in the <code>$attachments</code> attribute have to be filesystem paths. | |
| * The example to add_filter to set the html content type, send the email (wp_mail) and remove the filter did not work. I had to set the content type header with the $headers = array('Content-Type: text/html; charset=UTF-8'); | |
| == Change Log == | |
| Since: [[Version 1.2.1|1.2.1]] | |
| == Source File == | |
| <tt>wp_mail()</tt> is located in {{Trac|wp-includes/pluggable.php}}. | |
| == Related == | |
| * Function: [[Function_Reference/wp_mail|wp_mail]] | |
| * Filter: [[Plugin API/Filter Reference/wp_mail|wp_mail]] | |
| * Filter: [[Plugin API/Filter Reference/wp_mail_from|wp_mail_from]] | |
| * Filter: [[Plugin API/Filter Reference/wp_mail_from_name|wp_mail_from_name]] | |
| * Filter: [[Plugin API/Filter Reference/wp_mail_content_type|wp_mail_content_type]] | |
| * Filter: [[Plugin API/Filter Reference/wp_mail_charset|wp_mail_charset]] | |
| * Action: [[Plugin_API/Action_Reference/phpmailer_init|phpmailer_init]] | |
| [[Category:Functions]] | |
| {{Copyedit}}</p> | |
| </d:entry> | |
| <d:entry id="remove_action" d:title="remove action"> | |
| <d:index d:value="remove action"/> | |
| <h1>remove action</h1> | |
| <p>== Description == | |
| This function is an alias to [[Function Reference/remove filter|remove_filter()]]. | |
| This function removes a function attached to a specified action hook. This method can be used to remove default functions attached to a specific action hook and possibly replace them with a substitute. See also [[Function Reference/remove filter|remove_filter()]], [[Function Reference/add action|add_action()]] and [[Function Reference/add filter|add_filter()]]. | |
| '''''Important:''' To remove a hook, the <tt>$function_to_remove</tt> and <tt>$priority</tt> arguments must match when the hook was added. This goes for both filters and actions. No warning will be given on removal failure.'' | |
| == Usage == | |
| %%%<?php remove_action( $tag, $function_to_remove, $priority ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$tag|string|The action hook to which the function to be removed is hooked.}} | |
| {{Parameter|$function_to_remove|callable|The name of the function which should be removed.}} | |
| {{Parameter|$priority|int|The priority of the function (as defined when the function was originally hooked).|optional|10}} | |
| == Return == | |
| ; (''boolean'') : Whether the function is removed. | |
| :* <tt>True</tt> - The function was successfully removed. | |
| :* <tt>False</tt> - The function could not be removed. | |
| == Example == | |
| This function is identical to the [[Function Reference/remove filter|remove_filter()]] function. | |
| %%% <?php remove_action( $tag, $function_to_remove, $priority ); ?> %%% | |
| If an action has been added from within a <em>class</em>, for example by a plugin, removing it will require accessing the class variable. | |
| <pre> | |
| global $my_class; | |
| remove_action( 'the_content', array( $my_class, 'class_filter_function' ) ); | |
| </pre> | |
| It is also worth noting that you may need to prioritise the removal of the action to a hook that occurs after the action is added. You cannot successfully remove the action before it has been added. | |
| == Notes == | |
| == Change Log == | |
| Since: 1.2.0 | |
| == Source File == | |
| <tt>remove_action()</tt> is located in {{Trac|wp-includes/plugin.php}}. | |
| == Related == | |
| {{Action Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="do_action_ref_array" d:title="do action ref array"> | |
| <d:index d:value="do action ref array"/> | |
| <h1>do action ref array</h1> | |
| <p>{{Languages| | |
| {{ja|関数リファレンス/do_action_ref_array}} | |
| }} | |
| == Description == | |
| Execute functions hooked on a specific action hook, specifying arguments in an array. | |
| This function is identical to <tt>[[Function Reference/do_action|do_action]]</tt>, but the arguments passed to the functions hooked to <tt>$tag</tt> are supplied using an array. | |
| == Usage == | |
| %%% <?php do_action_ref_array( $tag, $args ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$tag|string|The name of the action to be executed.}} | |
| {{Parameter|$args|array|The arguments supplied to the functions hooked to <tt>$tag</tt>}} | |
| == Example == | |
| Call an action and pass an array of arguments: | |
| <pre> | |
| $args = array( 'arg_1', true, 'foo', 'arg_4' ); | |
| do_action_ref_array( 'my_action', $args ); | |
| </pre> | |
| This is the same as: | |
| do_action( 'my_action', 'arg_1', true, 'foo', 'arg_4' ); | |
| == Notes == | |
| * This function can be useful when your arguments are already in an array, and/or when there are many arguments to pass. Just make sure that your arguments are in the proper order! | |
| * Before PHP 5.4, your callback is passed a reference pointer to the array. Your callback can use this pointer to access all the array elements. Adding an action and declaring a call back that hooks the above example action could look like this: | |
| <pre>add_action('my_action', 'my_callback'); | |
| function my_callback( $args ) { | |
| //access values with $args[0], $args[1] etc. | |
| }</pre> | |
| Because the array was passed by reference, any changes to the array elements are applied to the original array outside of the function's scope. | |
| * Regardless of PHP version, you can specify the number of array elements when adding the action, and receive each element in a separate parameter in the callback function declaration like so: | |
| <pre>add_action('my_action', 'my_callback', 10, 4 ); | |
| function my_callback( $arg1, $arg2, $arg3, $arg4 ) { | |
| //access values with $args1, $args2 etc. | |
| }</pre> | |
| This method copies the array elements into the parameter variables. Any changes to the parameter variables do not affect the original array. | |
| * As of PHP 5.4, the array is no longer passed by reference despite the function's name. You cannot even use the reference sign '&' because call time pass by reference now throws an error. What you can do is pass the reference pointer as an array element. Doing so does require all callbacks added to the action to expect a reference pointer. This is not something you will see in WordPress actions. This technique is provided for informational purposes only. | |
| <pre>do_action_ref_array( 'my_action', array( &$args )); | |
| add_action('my_action', 'my_callback'); | |
| function my_callback( &$args ) { | |
| //access values with $args[0], $args[1] etc. | |
| }</pre> | |
| Because the original array was passed by reference, any changes to the array elements are applied to the original array outside of the function's scope. | |
| == Change Log == | |
| Since: [[Version 2.1 | 2.1.0]] | |
| == Source File == | |
| <tt>do_action_ref_array()</tt> is located in {{Trac|wp-includes/plugin.php}}. | |
| == Related == | |
| {{Action Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| {{Copyedit}}</p> | |
| </d:entry> | |
| <d:entry id="did_action" d:title="did action"> | |
| <d:index d:value="did action"/> | |
| <h1>did action</h1> | |
| <p>== Description == | |
| Retrieve the number of times an action is fired. | |
| == Usage == | |
| %%%<?php did_action( $tag ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$tag|string|The name of the action hook.}} | |
| == Return Values == | |
| ; (integer) : The number of times action hook <tt>$tag</tt> is fired | |
| == Examples == | |
| Using did_action() function to make sure custom meta field is only added during the first run since it can run multiple times. | |
| <pre> | |
| function my_sticky_option() | |
| { | |
| global $post; | |
| // if the post is a custom post type and only during the first execution of the action quick_edit_custom_box | |
| if ( $post->post_type == 'custom_post_type' && did_action( 'quick_edit_custom_box' ) === 1 ) | |
| { | |
| ?> | |
| <fieldset class="inline-edit-col-right"> | |
| <div class="inline-edit-col"> | |
| <label class="alignleft"> | |
| <input type="checkbox" name="sticky" value="sticky" /> | |
| <span class="checkbox-title"> | |
| <?php _e( 'Featured (sticky)', 'textdomain_string' ); ?> | |
| </span> | |
| </label> | |
| </div> | |
| </fieldset> | |
| <?php | |
| } // endif; | |
| } | |
| // add the sticky option to the quick edit area | |
| add_action( 'quick_edit_custom_box', 'my_sticky_option' ); | |
| </pre> | |
| == Notes == | |
| * Uses global: (<tt>unknown type</tt>) <tt>$wp_actions</tt> | |
| == Change Log == | |
| Since: 2.1 | |
| == Source File == | |
| <tt>did_action()</tt> is located in {{Trac|wp-includes/plugin.php}}. | |
| == Related == | |
| {{Action Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="remove_filter" d:title="remove filter"> | |
| <d:index d:value="remove filter"/> | |
| <h1>remove filter</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/remove filter}} | |
| {{ja|関数リファレンス/remove_filter}} | |
| }} | |
| == Description == | |
| This function removes a function attached to a specified filter hook. This method can be used to remove default functions attached to a specific filter hook and possibly replace them with a substitute. See also [[Function Reference/remove action|remove_action()]], [[Function Reference/add filter|add_filter()]] and [[Function Reference/add action|add_action()]]. | |
| '''''Important:''' To remove a hook, the <tt>$function_to_remove</tt> and <tt>$priority</tt> arguments must match when the hook was added. This goes for both filters and actions. No warning will be given on removal failure.'' | |
| == Usage == | |
| %%%<?php remove_filter( $tag, $function_to_remove, $priority ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$tag|string|The action hook to which the function to be removed is hooked.}} | |
| {{Parameter|$function_to_remove|callback|The callback for the function which should be removed.}} | |
| {{Parameter|$priority|int|The priority of the function (as defined when the function was originally hooked).|optional|10}} | |
| == Return == | |
| ; (''boolean'') : Whether the function is removed. | |
| :* <tt>True</tt> - The function was successfully removed. | |
| :* <tt>False</tt> - The function could not be removed. | |
| == Example == | |
| <pre> | |
| remove_filter( 'the_content', 'wpautop' ); | |
| </pre> | |
| <pre> | |
| foreach ( array( 'the_content', 'the_title', 'comment_text' ) as $hook ) | |
| remove_filter( $hook, 'capital_P_dangit' ); | |
| </pre> | |
| If a filter has been added from within a class, for example by a plugin, removing it will require accessing the class variable. | |
| <pre> | |
| global $my_class; | |
| remove_filter( 'the_content', array($my_class, 'class_filter_function') ); | |
| </pre> | |
| It is also worth noting that you may need to prioritise the removal of the filter to a hook that occurs after the filter is added. You cannot successfully remove the filter before it has been added. | |
| == Notes == | |
| When using filters passed with objects, you most often need to pass the exact same object back to the remove filter call, not just another instance of that object.(read _wp_filter_build_unique_id() for the gory details) | |
| == Change Log == | |
| * Since: 1.2.0 | |
| == Source File == | |
| <tt>remove_filter()</tt> is located in {{Trac|wp-includes/plugin.php}}. | |
| == Related == | |
| {{Filter Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="merge_filters" d:title="merge filters"> | |
| <d:index d:value="merge filters"/> | |
| <h1>merge filters</h1> | |
| <p>== Description == | |
| !!! THIS FUNCTION DOES NOT EXISTS ANYMORE !!! | |
| Old documentation : | |
| Merge the filter functions of a specific filter hook with generic filter functions. | |
| It is possible to defined generic filter functions using the filter hook ''all''. These functions are called for every filter tag. This function merges the functions attached to the ''all'' hook with the functions of a specific hook defined by <tt>$tag</tt>. | |
| == Usage == | |
| %%% <?php merge_filters($tag); ?> %%% | |
| == Parameters == | |
| {{Parameter|$tag|string|The filter hook of which the functions should be merged.}} | |
| == Examples == | |
| == Notes == | |
| == Change Log == | |
| Since: ? | |
| == Source File == | |
| <tt>merge_filters()</tt> is located in {{Trac|wp-includes/plugin.php}}. | |
| == Related == | |
| {{Filter Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="apply_filters" d:title="apply filters"> | |
| <d:index d:value="apply filters"/> | |
| <h1>apply filters</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/apply_filters}} | |
| {{it|Riferimento funzioni/apply_filters}} | |
| {{ja|関数リファレンス/apply_filters}} | |
| }} | |
| == Description == | |
| Call the functions added to a filter hook. See the [[Plugin API]] for a list of filter hooks. | |
| The callback functions attached to filter hook <tt>$tag</tt> are invoked by calling this function. This function can be used to create a new filter hook by simply calling this function with the name of the new hook specified using the <tt>$tag</tt> parameter. | |
| == Usage == | |
| %%% <?php apply_filters( $tag, $value, $var ... ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$tag|string|The name of the filter hook.}} | |
| {{Parameter|$value|mixed|The value which can be modified by filters hooked to <tt>$tag</tt>}} | |
| {{Parameter|$var|mixed|One or more additional variables passed to the filter functions. You can use this parameter in your function but it will not be returned. This parameter is available since [[Version 1.5.1]].|optional}} | |
| == Return == | |
| ; (''mixed'') : The result of <tt>$value</tt> after all hooked functions are applied to it. | |
| '''Note:''' The type of return should be the same as the type of $value: a string or an array, for example. | |
| == Examples == | |
| === Echo after Filtering === | |
| echo apply_filters( $tag, $value ); | |
| === Get Filtered === | |
| $myvar = apply_filters( $tag, $value ); | |
| === Additional Filter Arguments === | |
| $myvar = apply_filters( $tag, $value, $param, $otherparam ); | |
| For example: | |
| $myvar = apply_filters( 'example_filter', 'filter me', 'arg1', 'arg2 '); | |
| === With the_title filter === | |
| $my_custom_title = apply_filters('the_title', ' My Custom Title (tm) '); | |
| $my_custom_title will now contain 'My Custom Title ™', since [[Plugin API/Filter Reference/the title|the_title]] filter applies [[Function Reference/wptexturize|wptexturize()]] and [http://www.php.net/manual/en/function.trim.php trim()], among others. | |
| == Notes == | |
| == Change Log == | |
| * Since: 0.71 | |
| == Source File == | |
| <tt>apply_filters()</tt> is located in {{Trac|wp-includes/plugin.php}}. | |
| == Related == | |
| {{Filter Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="force_balance_tags" d:title="force balance tags"> | |
| <d:index d:value="force balance tags"/> | |
| <h1>force balance tags</h1> | |
| <p>== Description == | |
| Balances tags of string using a modified stack. | |
| Ignores the '<tt>use_balanceTags</tt>' option. | |
| == Usage == | |
| %%%<?php force_balance_tags( $text ) ?>%%% | |
| This function is used in the short post excerpt list, to prevent unmatched elements. | |
| For example, it makes | |
| %%%<div><b>This is an excerpt. <!--more--> and this is more text... </b></div>%%% | |
| not break, when the html after the more tag is cut off. | |
| == Parameters == | |
| {{Parameter|$text|string|Text to be balanced.}} | |
| == Return Values == | |
| ; (string) : Balanced text. | |
| == Examples == | |
| In the example above, | |
| %%%<div><b>This is an excerpt. %%% | |
| should be changed to: | |
| %%%<div><b>This is an excerpt. </b></div>%%% | |
| by the force_balance_tags function. | |
| == Notes == | |
| * See [[Function_Reference/balanceTags|<tt>balanceTags()</tt>]] | |
| * This is not used for all html, since there are some bugs and performance issues: http://wordpress.stackexchange.com/questions/89121/why-doesnt-default-wordpress-page-view-use-force-balance-tags | |
| == Change Log == | |
| Since: 2.0.4 | |
| == Source File == | |
| <tt>force_balance_tags()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_redirect" d:title="wp redirect"> | |
| <d:index d:value="wp redirect"/> | |
| <h1>wp redirect</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_redirect}} | |
| {{it|Riferimento funzioni/wp_redirect}} | |
| }} | |
| == Description == | |
| Redirects the user to a specified [[Glossary#Absolute_URI|''absolute'' URI]]. | |
| == Usage == | |
| <code>wp_redirect()</code> does not exit automatically and should almost always be followed by <code>exit</code>. | |
| <pre><?php | |
| wp_redirect( $location, $status ); | |
| exit; | |
| ?></pre> | |
| == Parameters == | |
| {{Parameter|$location|string|The '''absolute''' URI which the user will be redirected to.}} | |
| {{Parameter|$status|integer|The status code to use.|optional|302}} | |
| == Return Values == | |
| ; <tt>(bool|void)</tt> : False if $location is not set, returns nothing otherwise. | |
| == Examples == | |
| <?php wp_redirect( home_url() ); exit; ?> | |
| Redirects can also be external, and/or use a "Moved Permanently" code : | |
| <pre><nowiki><?php wp_redirect( 'http://www.example.com', 301 ); exit; ?></nowiki></pre> | |
| The code below redirects to the parent post URL which can be used to redirect attachment pages back to the parent. | |
| <pre><?php wp_redirect( get_permalink( $post->post_parent )); exit; ?></pre> | |
| ==Notes== | |
| The HTTP/1.1 status code 302 is a temporary redirect. If the page has moved permanently, use the HTTP status code 301. | |
| wp_redirect() is a [[Pluggable Functions|Pluggable Function]] | |
| ==Change Log== | |
| * Since: 1.5.1 | |
| ==Source File== | |
| <tt>wp_redirect()</tt> is located in {{Trac|wp-includes/pluggable.php}}. | |
| ==Related== | |
| * See Also: [[Function_Reference/wp_safe_redirect|wp_safe_redirect()]], [[Plugin_API/Filter_Reference/wp_redirect|wp_redirect (filter)]], [[Plugin_API/Filter_Reference/wp_redirect_status|wp_redirect_status (filter)]], [[Pluggable Functions|Pluggable Functions]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="register_activation_hook" d:title="register activation hook"> | |
| <d:index d:value="register activation hook"/> | |
| <h1>register activation hook</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/register_activation_hook}} | |
| {{ja|関数リファレンス/register_activation_hook}} | |
| }} | |
| == Description == | |
| The '''register_activation_hook''' function registers a plugin function to be run [[Managing_Plugins#Installing_Plugins|when the plugin is activated]]. | |
| When a plugin is activated, the action <tt>'activate_PLUGINNAME'</tt> hook is called. In the name of this hook, <tt>PLUGINNAME</tt> is replaced with the name of the plugin, including the optional subdirectory. For example, when the plugin is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then the name of this hook will become <tt>'activate_sampleplugin/sample.php'</tt>. When the plugin consists of only one file and is (as by default) located at <tt>wp-content/plugin/sample.php</tt> the name of this hook will be <tt>'activate_sample.php'</tt>. | |
| This function is a wrapper for the <tt>'activate_PLUGINNAME'</tt> action, and is easier to use. | |
| == Usage == | |
| %%% <?php register_activation_hook( $file, $function ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$file|string|Path to the [[Writing_a_Plugin#Plugin_Files|main plugin file]] inside the <tt>wp-content/plugins</tt> directory. A full path will work.}} | |
| {{Parameter|$function|callback|The function to be run when the plugin is activated. Any of [http://us2.php.net/manual/en/language.pseudo-types.php#language.types.callback PHP's callback pseudo-types] will work.}} | |
| == Examples == | |
| If you have a function called <tt>myplugin_activate()</tt> in the [[Writing_a_Plugin#Plugin_Files|main plugin file]] at either | |
| * <tt>wp-content/plugins/<var>myplugin</var>.php</tt> or | |
| * <tt>wp-content/plugins/<var>myplugin</var>/<var>myplugin</var>.php</tt> | |
| use this code: | |
| <pre> | |
| function myplugin_activate() { | |
| // Activation code here... | |
| } | |
| register_activation_hook( __FILE__, 'myplugin_activate' ); | |
| </pre> | |
| This will call the <tt>myplugin_activate()</tt> function on activation of the plugin. | |
| If your plugin uses the singleton class pattern, add the activation hook like so: | |
| class MyPlugin { | |
| static function install() { | |
| // do not generate any output here | |
| } | |
| } | |
| register_activation_hook( __FILE__, array( 'MyPlugin', 'install' ) ); | |
| If the class that holds your activation function/method is in some additional file, register your activation function like this: | |
| <pre> | |
| include_once dirname( __FILE__ ) . '/your_additional_file.php'; | |
| register_activation_hook( __FILE__, array( 'YourAdditionalClass', 'on_activate_function' ) ); | |
| </pre> | |
| Or if you're inside of a <tt>__construct()</tt>: | |
| <pre>register_activation_hook( __FILE__, array( $this, 'YOUR_METHOD_NAME' ) );</pre> | |
| == Notes == | |
| * Related discussion with another sample of working code: http://wordpress.org/support/topic/312342 | |
| * <strong>Registering the hook inside the 'plugins_loaded' hook will not work.</strong> You can't call <tt>register_activation_hook()</tt> inside a function hooked to the <tt>[[Plugin_API/Action_Reference/plugins_loaded | 'plugins_loaded']]</tt> or <tt>[[Plugin_API/Action_Reference/init | 'init']]</tt> hooks (or any other hook). These hooks are called ''before'' the plugin is loaded or activated. | |
| * When a plugin is activated, all active plugins are loaded, then the plugin being activated. The plugin's activation hook is run and then the page is immediately redirected (see [[#Process_Flow|below]]). | |
| === Process Flow === | |
| If you are interested in doing something just after a plugin has been activated it is important to note that the hook process performs an instant redirect after it fires. So it is impossible to use <tt>[[Function_Reference/add_action | add_action()]]</tt> or <tt>[[Function_Reference/add_filter | add_filter()]]</tt> type calls until the redirect has occurred (e.g., only two hooks are fired after the plugin's activation hook: <tt>[[Plugin_API/Action_Reference/activated_plugin | 'activated_plugin']]</tt> and <tt>[[Plugin_API/Action_Reference/shutdown | 'shutdown']]</tt>). A quick workaround to this quirk is to use <tt>[[Function_Reference/add_option | add_option()]]</tt> like so: | |
| <pre> | |
| /* Main Plugin File */ | |
| ... | |
| function my_plugin_activate() { | |
| add_option( 'Activated_Plugin', 'Plugin-Slug' ); | |
| /* activation code here */ | |
| } | |
| register_activation_hook( __FILE__, 'my_plugin_activate' ); | |
| function load_plugin() { | |
| if ( is_admin() && get_option( 'Activated_Plugin' ) == 'Plugin-Slug' ) { | |
| delete_option( 'Activated_Plugin' ); | |
| /* do stuff once right after activation */ | |
| // example: add_action( 'init', 'my_init_function' ); | |
| } | |
| } | |
| add_action( 'admin_init', 'load_plugin' ); | |
| </pre> | |
| You can check out the full post @ http://stackoverflow.com/questions/7738953/is-there-a-way-to-determine-if-a-wordpress-plugin-is-just-installed/13927297#13927297. | |
| However, it '''is''' possible to use <tt>[[Function_Reference/do_action | do_action()]]</tt>, like this: | |
| <pre> | |
| function my_plugin_activate() { | |
| do_action( 'my_plugin_activate' ); | |
| } | |
| register_activation_hook( __FILE__, 'my_plugin_activate' ); | |
| </pre> | |
| Included plugin files and even other plugins ''will'' be able to hook into this action. | |
| === A Note on Variable Scope === | |
| If you're using global variables, you may find that the function you pass to <tt>register_activation_hook()</tt> does not have access to global variables at the point when it is called, even though you state their global scope within the function like this: | |
| <pre> | |
| $myvar = 'whatever'; | |
| function myplugin_activate() { | |
| global $myvar; | |
| echo $myvar; // this will NOT be 'whatever'! | |
| } | |
| register_activation_hook( __FILE__, 'myplugin_activate' ); | |
| </pre> | |
| This is because on that very first include, your plugin is NOT included within the global scope. It's included in the <tt>[[Function_Reference/activate_plugin | activate_plugin()]]</tt> function, and so its "main body" is not automatically in the global scope. | |
| This is why you should ''always'' be explicit. If you want a variable to be global, then you need to declare it as such, and that means anywhere and everywhere you use it. If you use it in the main body of the plugin, then you need to declare it global there too. | |
| When activation occurs, your plugin is included from another function and then your <tt>myplugin_activate()</tt> is called from within that function (specifically, within the <tt>activate_plugin()</tt> function) at the point where your plugin is activated. The main body variables are therefore in the scope of the <tt>activate_plugin()</tt> function and are not global, unless you explicitly declare their global scope: | |
| <pre> | |
| global $myvar; | |
| $myvar = 'whatever'; | |
| function myplugin_activate() { | |
| global $myvar; | |
| echo $myvar; // this will be 'whatever' | |
| } | |
| register_activation_hook( __FILE__, 'myplugin_activate' ); | |
| </pre> | |
| More information on this is available here: http://wordpress.org/support/topic/201309 | |
| == Discussions - External Resources == | |
| * [http://solislab.com/blog/plugin-activation-checklist/ Activation checklist for WordPress plugin developers]: A tutorial that explains not only the activation hook, but also other topics related to plugin activation such as how to manage updates, rewrite rules, welcome screen etc. | |
| * A good example for a basic activation/deactivation/uninstall class by "kaiser" can be found here on WPSE: http://wordpress.stackexchange.com/questions/25910/uninstall-a-plugin-method-typical-features-how-to/25979#25979 | |
| == Changelog == | |
| * [[Version 3.1|3.1]] : This hook is now fired only when the user activates the plugin and not when an automatic plugin update occurs ([http://core.trac.wordpress.org/ticket/14915 #14915]). | |
| ** [http://wpdevel.wordpress.com/2010/10/27/plugin-activation-hooks-no-longer-fire-for-updates/ Plugin activation hooks no longer fire for updates « WordPress Development Updates] (2010-10-28) | |
| ** [http://wpdevel.wordpress.com/2010/10/27/plugin-activation-hooks/ Plugin activation hooks « WordPress Development Updates] (2010-10-27) | |
| * since [[Version 2.0|2.0]] | |
| == Source File == | |
| <tt>register_activation_hook()</tt> is located in {{Trac|wp-includes/plugin.php}} | |
| == Related == | |
| * See also [[Function_Reference/register_deactivation_hook|register_deactivation_hook()]], [[Function_Reference/register_uninstall_hook|register_uninstall_hook()]] | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="register_deactivation_hook" d:title="register deactivation hook"> | |
| <d:index d:value="register deactivation hook"/> | |
| <h1>register deactivation hook</h1> | |
| <p>== Description == | |
| The function '''register_deactivation_hook''' (introduced in WordPress 2.0) registers a plugin function to be run when the plugin is deactivated. | |
| == Usage == | |
| %%% <?php register_deactivation_hook($file, $function); ?> %%% | |
| == Parameters == | |
| {{Parameter|$file|string|Path to the [[Writing_a_Plugin#Plugin_Files|main plugin file]] inside the <tt>wp-content/plugins</tt> directory. A full path will work.}} | |
| {{Parameter|$function|callback|The function to be run when the plugin is deactivated. Any of [http://us2.php.net/manual/en/language.pseudo-types.php#language.types.callback PHP's callback pseudo-types] will work.}} | |
| == Examples == | |
| If you have a function called <tt>myplugin_deactivate()</tt> in the [[Writing_a_Plugin#Plugin_Files|main plugin file]] at either | |
| * <tt>wp-content/plugins/<var>myplugin</var>.php</tt> or | |
| * <tt>wp-content/plugins/<var>myplugin</var>/<var>myplugin</var>.php</tt> | |
| use this code: | |
| register_deactivation_hook( __FILE__, 'myplugin_deactivate' ); | |
| This will call the <tt>myplugin_deactivate()</tt> function on deactivation of the plugin. | |
| == Discussions == | |
| A good example for a basic activation/deactivation/uninstall class by "kaiser" can be found here on WPSE: http://wordpress.stackexchange.com/questions/25910/uninstall-a-plugin-method-typical-features-how-to/25979#25979 | |
| == Change Log == | |
| Since: [[Version 2.0|2.0]] | |
| == Source File == | |
| <tt>register_deactivation_hook()</tt> is located in {{Trac|wp-includes/plugin.php}} | |
| == Related == | |
| * See also [[Function_Reference/register_activation_hook|register_activation_hook()]], [[Function_Reference/register_uninstall_hook|register_uninstall_hook()]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="Option_Reference" d:title="Option Reference"> | |
| <d:index d:value="Option Reference"/> | |
| <h1>Option Reference</h1> | |
| <p>{{Languages| | |
| {{en|Option_Reference}} | |
| {{es|Referencia de Opciones}} | |
| {{ja|Option_Reference}} | |
| {{tr|Secenek Listesi}} | |
| }} | |
| __TOC__ | |
| [[Option Reference|Options]] are pieces of data that WordPress uses to store various preferences and configuration settings. Listed below are the options, along with some of the default values from the current WordPress install. By using the appropriate function, options can be [[Function Reference/add_option|added]], [[Function Reference/update_option|changed]], [[Function Reference/delete_option|removed]], and [[Function_Reference/get_option|retrieved]], from the [[Database_Description#Table:_wp_options|wp_options table]]. This list reflects the WordPress 2.9 release, and does not include options that were deprecated by that version. | |
| Definitions are normally typed, possible option-values are bolded, and option-value definitions are italicized. Data types are given after the possible values (if those are given) like this: | |
| ''Data type:'' '''Integer''' | |
| <div style="border:blue 1px solid;padding:10px; background: #E6CCFF"> | |
| '''You can help make this page more complete!''' | |
| Here are some things you can do to help: | |
| * Add documentation to un-documented options, by adding a description, possible values, and the option's data type. | |
| * List more options here, following the category structure (if they are not already listed). | |
| * Correct errors by moving functions to better categories where appropriate, and of course fixing typos. | |
| Read [[Contributing to WordPress]] to find out more about how you can contribute to the effort! | |
| </div> | |
| {{Copyedit}} | |
| == View By Category == | |
| === Discussion === | |
| ; <tt>blacklist_keys</tt> : When a comment contains any of these words in its content, name, URL, e-mail, or IP, it will be marked as spam. One word or IP per line. It will match inside words, so "press" will match "WordPress." | |
| : Default: NULL | |
| : ''Data type:'' '''String (possibly multi-line)''' | |
| ; <tt>comment_max_links</tt> : Hold a comment in the queue if it contains the value of this option or more. | |
| : Default: 2 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>comment_moderation</tt> : Before a comment appears, an administrator must always approve the comment. | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''False'' (default) | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>comments_notify</tt> : E-mail me when anyone posts a comment. | |
| : '''1''' : ''Yes'' (default) | |
| : '''0''' : ''No'' | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>default_comment_status</tt> : Allow comments (can be overridden with individual posts) | |
| : '''open''' : ''Allow comments'' (default) | |
| : '''closed''' : ''Disallow comments'' | |
| : ''Data type:'' '''String''' | |
| ; <tt>default_ping_status</tt> : Allow link notifications from other blogs (pingbacks and trackbacks). | |
| : '''open''' : ''Allow pingbacks and trackbacks from other blogs'' (default) | |
| : '''closed''' : ''Disallow pingbacks and trackbacks from other blogs'' | |
| : ''Data type:'' '''String''' | |
| ; <tt>default_pingback_flag</tt> : Attempt to notify any blogs linked to from the article (slows down posting). | |
| : '''1''' : ''Yes'' (default) | |
| : '''0''' : ''No'' | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>moderation_keys</tt> : When a comment contains any of these words in its content, name, URL, e-mail, or IP, it will be held in the moderation queue. One word or IP per line. It will match inside words, so "press" will match "WordPress." | |
| : Default: NULL | |
| : ''Data type:'' '''String (possibly multi-line)''' | |
| ; <tt>moderation_notify</tt> : E-mail me when a comment is held for moderation. | |
| : '''1''' : ''Yes'' (default) | |
| : '''0''' : ''No'' | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>require_name_email</tt> : Before a comment appears, the comment author must fill out his/her name and email. | |
| : '''1''' : ''Yes'' (default) | |
| : '''0''' : ''No'' | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>thread_comments</tt> : Enable WP-native threaded (nested) comments. | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>thread_comments_depth</tt> : Set the number of threading levels for comments. | |
| : '''1''' thru '''10''' : levels | |
| : Default: 5 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>show_avatars</tt> | |
| : Avatar Display | |
| : '''1''' : ''Yes'' - (default) Show Avatars | |
| : '''0''' : ''No'' - Don’t show Avatars | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>avatar_rating</tt> | |
| : Maximum Rating | |
| : '''G''' : (default) ''Suitable for all audiences'' | |
| : '''PG''' : ''Possibly offensive, usually for audiences 13 and above'' | |
| : '''R''' : ''Intended for adult audiences above 17'' | |
| : '''X''' : ''Even more mature than above'' | |
| : ''Data type:'' '''String''' | |
| ; <tt>avatar_default</tt> | |
| : Default Avatar | |
| : '''mystery''' : (default) ''Mystery Man'' | |
| : '''blank''' : ''Blank'' | |
| : '''gravatar_default''' : ''Gravatar Logo'' | |
| : '''identicon''' : ''Identicon (Generated)'' | |
| : '''wavatar''' : ''Wavatar (Generated)'' | |
| : '''monsterid''' : ''MonsterID (Generated)'' | |
| : ''Data type:'' '''String''' | |
| ; <tt>close_comments_for_old_posts</tt> | |
| : Automatically close comments on old articles | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>close_comments_days_old</tt> | |
| : Automatically close comments on articles older than x days | |
| : Default: 14 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>page_comments</tt> | |
| : Break comments into pages | |
| : '''1''' : ''Yes'' (default) | |
| : '''0''' : ''No'' | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>comments_per_page</tt> | |
| : Default: 50 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>default_comments_page</tt> | |
| : Default: 'newest' | |
| : ''Data type:'' '''String''' | |
| ; <tt>comment_order</tt> | |
| : '''asc''' : (default) | |
| : '''desc''' : | |
| : ''Data type:'' '''String''' | |
| ; <tt>comment_whitelist</tt> | |
| : Comment author must have a previously approved comment | |
| : '''1''' : ''Yes'' (default) | |
| : '''0''' : ''No'' | |
| : ''Data type:'' | |
| === General === | |
| ; <tt>admin_email</tt> : Administrator email | |
| : Default: 'you@example.com' | |
| : ''Data type:'' '''String''' | |
| ; <tt>blogdescription</tt> : Blog tagline | |
| : Default: '__('Just another WordPress weblog')' | |
| : ''Data type:'' '''String''' | |
| ; <tt>blogname</tt> : Blog title | |
| : Default: '__('My Blog')' | |
| : ''Data type:'' '''String''' | |
| ; <tt>comment_registration</tt> : Users must be registered and logged in to comment | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>date_format</tt> : Default date format (see [[Formatting Date and Time]]) | |
| : Default: '__('F j, Y')' | |
| : ''Data type:'' '''String''' | |
| ; <tt>default_role</tt> : The default [[Roles and Capabilities|role of users]] who register at the blog. | |
| : '''subscriber''' : (default) | |
| : '''administrator''' : | |
| : '''editor''' : | |
| : '''author''' : | |
| : '''contributor''' : | |
| : ''Data type:'' '''String''' | |
| ; <tt>gmt_offset</tt> : Times in the blog should differ by this value. | |
| : '''-6''' : ''GMT -6 (aka Central Time, USA)'' | |
| : '''0''' : ''GMT (aka Greenwich Mean Time)'' | |
| : Default: [http://www.php.net/manual/en/function.date.php date]('Z') / 3600 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>home</tt> : Blog address (URL) | |
| : Default: wp_guess_url() | |
| : ''Data type:'' '''String (URI)''' | |
| ; <tt>siteurl</tt> : WordPress address (URL) | |
| : Default: wp_guess_url() | |
| : ''Data type:'' '''String (URI)''' | |
| ; <tt>start_of_week</tt> : The starting day of the week. | |
| : '''0''' : ''Sunday'' | |
| : '''1''' : ''Monday'' (default) | |
| : '''2''' : ''Tuesday'' | |
| : '''3''' : ''Wednesday'' | |
| : '''4''' : ''Thursday'' | |
| : '''5''' : ''Friday'' | |
| : '''6''' : ''Saturday'' | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>time_format</tt> : Default time format (see [[Formatting Date and Time]]) | |
| : Default: '__('g:i a')' | |
| : ''Data type:'' '''String''' | |
| ; <tt>timezone_string</tt> | |
| : Timezone | |
| : Default: NULL | |
| : ''Data type:'' '''String''' | |
| ; <tt>users_can_register</tt> : Anyone can register | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| : ''Data type:'' '''Integer''' | |
| === Links === | |
| ; <tt>links_updated_date_format</tt> | |
| : Default: '__('F j, Y g:i a')' | |
| : ''Data type:'' '''String''' | |
| ; <tt>links_recently_updated_prepend</tt> | |
| : Default: '<em>' | |
| : ''Data type:'' '''String''' | |
| ; <tt>links_recently_updated_append</tt> | |
| : Default: '</em>' | |
| : ''Data type:'' '''String''' | |
| ; <tt>links_recently_updated_time</tt> | |
| : Default: 120 | |
| : ''Data type:'' '''Integer''' | |
| === Media === | |
| ; <tt>thumbnail_size_w</tt> | |
| : Default: 150 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>thumbnail_size_h</tt> | |
| : Default: 150 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>thumbnail_crop</tt> | |
| : Crop thumbnail to exact dimensions (normally thumbnails are proportional) | |
| : '''1''' : ''Yes'' (default) | |
| : '''0''' : ''No'' | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>medium_size_w</tt> | |
| : Default: 300 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>medium_size_h</tt> | |
| : Default: 300 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>large_size_w</tt> | |
| : Default: 1024 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>large_size_h</tt> | |
| : Default: 1024 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>embed_autourls</tt> | |
| : Attempt to automatically embed all plain text URLs | |
| : Default: 1 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>embed_size_w</tt> | |
| : Default: NULL | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>embed_size_h</tt> | |
| : Default: 600 | |
| : ''Data type:'' '''Integer''' | |
| === Miscellaneous === | |
| ; <tt>hack_file</tt> : Use legacy <tt>my-hacks.php</tt> file support | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>html_type</tt> : Default MIME type for blog pages (<tt>text/html</tt>, <tt>text/xml+html</tt>, etc.) | |
| : Default: 'text/html' | |
| : ''Data type:'' '''String (MIME type)''' | |
| ; <tt>secret</tt> : Secret value created during installation used with salting, etc. | |
| : Default: wp_generate_password(64) | |
| : ''Data type:'' '''String (MD5)''' | |
| ; <tt>upload_path</tt> : Store uploads in this folder (relative to the WordPress root) | |
| : Default: NULL | |
| : ''Data type:'' '''String (relative path)''' | |
| ; <tt>upload_url_path</tt> : URL path to upload folder (will be blank by default - Editable in Settings -> Miscellaneous) | |
| : ''Data type:'' '''String (url path)''' | |
| ; <tt>uploads_use_yearmonth_folders</tt> : Organize my uploads into month- and year-based folders | |
| : '''1''' : ''Yes'' (default) | |
| : '''0''' : ''No'' (default for safe mode) | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>use_linksupdate</tt> : Track links' update times | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| : ''Data type:'' '''Integer''' | |
| === Permalinks === | |
| ; <tt>permalink_structure</tt> : The desired structure of your blog's permalinks. Some examples: | |
| : ''/%year%/%monthnum%/%day%/%postname%/'' : Date and name based | |
| : ''/archives/%post_id%/'' : Numeric | |
| : ''/%postname%/'' : Post name-based | |
| : You can see more examples by viewing [[Using Permalinks]]. | |
| : Default: NULL | |
| : ''Data type:'' '''String''' | |
| ; <tt>category_base</tt> | |
| : The default category base of your blog categories permalink. | |
| : Default: NULL | |
| : ''Data type:'' '''String''' | |
| ; <tt>tag_base</tt> | |
| : The default tag base for your blog tags permalink. | |
| : Default: NULL | |
| : ''Data type:'' '''String''' | |
| === Privacy === | |
| ; <tt>blog_public</tt> | |
| : '''1''' : ''I would like my blog to be visible to everyone, including search engines (like Google, Sphere, Technorati) and archivers.'' (default) | |
| : '''0''' : ''I would like to block search engines, but allow normal visitors.'' | |
| : ''Data type:'' '''Integer''' | |
| === Reading === | |
| ; <tt>blog_charset</tt> : Encoding for pages and feeds. The character encoding you write your blog in (UTF-8 is recommended). | |
| : Default: 'UTF-8' | |
| : ''Data type:'' '''String''' | |
| ; <tt>gzipcompression</tt> : WordPress should compress articles (with gzip) if browsers ask for them. | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>page_on_front</tt> : The ID of the page that should be displayed on the front page. Requires ''show_on_front'''s value to be '''page'''. | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>page_for_posts</tt> : The ID of the page that displays posts. Useful when ''show_on_front'''s value is '''page'''. | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>posts_per_page</tt> : Show at most '''x''' many posts on blog pages. | |
| : Default: 10 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>posts_per_rss</tt> : Show at most '''x''' many posts in RSS feeds. | |
| : Default: 10 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>rss_language</tt> : Language for RSS feeds (metadata purposes only) | |
| : Default: 'en' | |
| : ''Data type:'' '''String (ISO two-letter language code)''' | |
| ; <tt>rss_use_excerpt</tt> : Show an excerpt instead of the full text of a post in RSS feeds | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>show_on_front</tt> : What to show on the front page | |
| : '''posts''' : ''Your latest posts'' (default) | |
| : '''page''' : ''A static page (see page_on_front)'' | |
| : ''Data type:'' '''String''' | |
| === Themes === | |
| ; <tt>template</tt> : The slug of the currently activated theme (how it is accessed by path, ex. ''/wp-content/themes/'''''some-theme''': some-theme would be the value) | |
| : Default: 'default' | |
| : ''Data type:'' '''String''' | |
| ; <tt>stylesheet</tt> : The slug of the currently activated stylesheet (style.css) (how it is accessed by path, ex. ''/wp-content/themes/'''''some-theme''': some-theme would be the value) | |
| : Default: 'default' | |
| : ''Data type:'' '''String''' | |
| === Writing === | |
| ; <tt>default_category</tt> : ID of the category that posts will be put in by default | |
| : Default: 1 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>default_email_category</tt> : ID of the category that posts will be put in by default when written via e-mail | |
| : Default: 1 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>default_link_category</tt> : ID of the category that links will be put in by default | |
| : Default: 2 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>default_post_edit_rows</tt> : Size of the post box (in lines) | |
| : Default: 10 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>mailserver_login</tt> : Mail server username for posting to WordPress by e-mail | |
| : Default: 'login@example.com' | |
| : ''Data type:'' '''String''' | |
| ; <tt>mailserver_pass</tt> : Mail server password for posting to WordPress by e-mail | |
| : Default: 'password' | |
| : ''Data type:'' '''String''' | |
| ; <tt>mailserver_port</tt> : Mail server port for posting to WordPress by e-mail | |
| : Default: 110 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>mailserver_url</tt> : Mail server for posting to WordPress by e-mail | |
| : Default: 'mail.example.com' | |
| : ''Data type:'' '''String''' | |
| ; <tt>ping_sites</tt> : When you publish a new post, WordPress automatically notifies the following site update services. For more about this, see [[Update Services]]. Separate multiple service URLs with line breaks. Requires ''blog_public'' to have a value of '''1'''. | |
| : Default: 'http://rpc.pingomatic.com/' | |
| : ''Data type:'' '''String (possibly multi-line)''' | |
| ; <tt>use_balanceTags</tt> : Correct invalidly-nested XHTML automatically | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>use_smilies</tt> : Convert emoticons like <tt>:-)</tt> and <tt>:P</tt> to graphics when displayed | |
| : '''1''' : ''Yes'' (default) | |
| : '''0''' : ''No'' | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>use_trackback</tt> : Enable sending and receiving of trackbacks | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| ; <tt>enable_app</tt> | |
| : Enable the Atom Publishing Protocol | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>enable_xmlrpc</tt> | |
| : Enable the WordPress, Movable Type, MetaWeblog and Blogger XML-RPC publishing protocols | |
| : '''1''' : ''Yes'' | |
| : '''0''' : ''No'' (default) | |
| : ''Data type:'' '''Integer''' | |
| === Uncategorized === | |
| ; <tt>active_plugins</tt> : Returns an array of strings containing the path of the ''main'' php file of the plugin. The path is relative to the ''plugins'' folder. An example of path in the array : 'myplugin/mainpage.php'. | |
| : Default: array() | |
| : ''Data type:'' '''Array''' | |
| ; <tt>advanced_edit</tt> | |
| : Default: 0 | |
| : ''Data type:'' '''Integer''' | |
| ; <tt>recently_edited</tt> | |
| : Default: NULL | |
| : ''Data type:'' | |
| ; <tt>image_default_link_type</tt> | |
| : Default: 'file' | |
| : ''Data type:'' | |
| ; <tt>image_default_size</tt> | |
| : Default: NULL | |
| : ''Data type:'' | |
| ; <tt>image_default_align</tt> | |
| : Default: NULL | |
| : ''Data type:'' | |
| ; <tt>sidebars_widgets</tt> : Returns array of sidebar states (list of active and inactive widgets). | |
| : Default: | |
| : ''Data type:'' '''Array''' | |
| ; <tt>sticky_posts</tt> | |
| : Default: array() | |
| : ''Data type:'' | |
| ; <tt>widget_categories</tt> | |
| : Default: array() | |
| : ''Data type:'' | |
| ; <tt>widget_text</tt> | |
| : Default: array() | |
| : ''Data type:'' | |
| ; <tt>widget_rss</tt> | |
| : Default: array() | |
| : ''Data type:'' | |
| == Source Code == | |
| * <tt>populate_options()</tt> is located in {{Trac|wp-admin/includes/schema.php}}. | |
| == Changelog == | |
| * [[Version 2.9|2.9]] : Deleted <tt>rss_excerpt_length</tt>. | |
| [[Category:Plugins]] | |
| [[Category:Functions]] | |
| [[Category:Advanced Topics]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_attachment_url" d:title="wp get attachment url"> | |
| <d:index d:value="wp get attachment url"/> | |
| <h1>wp get attachment url</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_get_attachment_url}} | |
| {{it|Riferimento funzioni/wp_get_attachment_url}} | |
| {{ja|関数リファレンス/wp_get_attachment_url}} | |
| }} | |
| == Description == | |
| Returns a full URI for an [[Using_Image_and_File_Attachments|attachment file]] or <var>false</var> on failure. | |
| <!-- Wordpress uses this function to generate a link when you insert an attachment into a post and choose <tt>Linked to file</tt>. --> | |
| == Usage == | |
| %%%<?php wp_get_attachment_url( $id ); ?>%%% | |
| == Default Usage == | |
| <?php echo wp_get_attachment_url( 12 ); ?> | |
| outputs something like <tt><nowiki>http://example.net</nowiki>/wp-content/uploads/<var>filename</var></tt> | |
| == Parameters == | |
| {{Parameter|$id|integer|The ID of the desired attachment|required}} | |
| == Return Value == | |
| {{Return||string/boolean|Returns URI to uploaded attachment or "false" on failure.}} | |
| == Notes == | |
| You can change the output of this function through the <tt>[[Plugin_API/Filter_Reference#Link_Filters|wp get attachment url]]</tt> filter. | |
| If you want a URI for the [[Templates_Hierarchy#Attachment_display|attachment page]], not the attachment file itself, you can use [[Function_Reference/get_attachment_link|get_attachment_link]]. | |
| Also refer: | |
| [[Function Reference/wp_insert_attachment|wp_insert_attachment]], [[Function Reference/wp_upload_dir|wp_upload_dir]], [[Function Reference/wp_get_attachment_image_src|wp_get_attachment_image_src]] | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>wp_get_attachment_url()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Attachment Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]] | |
| [[Category:Attachments]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses" d:title="wp kses"> | |
| <d:index d:value="wp kses"/> | |
| <h1>wp kses</h1> | |
| <p>== Description == | |
| This function makes sure that only the allowed HTML element names, attribute names and attribute values plus only sane HTML entities will occur in $string. You have to remove any slashes from PHP's magic quotes before you call this function. | |
| == Usage == | |
| %%% <?php wp_kses($string, $allowed_html, $allowed_protocols); ?> %%% | |
| == Parameters == | |
| {{Parameter|$string|string|Content to filter through kses}} | |
| {{Parameter|$allowed_html|array|List of allowed HTML elements}} | |
| {{Parameter|$allowed_protocols|array|Allow links in <tt>$string</tt> to these protocols.|optional|The default allowed protocols are '''http''', '''https''', '''ftp''', '''mailto''', '''news''', '''irc''', '''gopher''', '''nntp''', '''feed''', and '''telnet'''. This covers all common link protocols, except for '''javascript''', which should not be allowed for untrusted users.}} | |
| == Return == | |
| ; (string) : Filtered string of HTML. | |
| == Examples == | |
| === Allowed HTML Tags Array === | |
| This is an example of how to format an array of allowed HTML tags and attributes. | |
| array( | |
| 'a' => array( | |
| 'href' => array(), | |
| 'title' => array() | |
| ), | |
| 'br' => array(), | |
| 'em' => array(), | |
| 'strong' => array(), | |
| ); | |
| == Notes == | |
| * KSES is an iterative acronym and stands for “KSES Strips Evil Scripts". | |
| == Change Log == | |
| * Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| * http://codex.wordpress.org/Function_Reference/wp_kses_post | |
| * http://codex.wordpress.org/Function_Reference/wp_kses_allowed_html | |
| See: [[Data_Validation|Data Validation]] article for an in-depth discussion of input and output sanitization. | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="cat_is_ancestor_of" d:title="cat is ancestor of"> | |
| <d:index d:value="cat is ancestor of"/> | |
| <h1>cat is ancestor of</h1> | |
| <p>== Description == | |
| This [[Conditional Tags|Conditional Tag]] Check if a category is an ancestor of another category. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| == Usage == | |
| %%% <?php cat_is_ancestor_of( $cat1, $cat2 ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$cat1|int/object|ID or object to check if this is the parent category.}} | |
| {{Parameter|$cat2|int/object|The child category.}} | |
| == Return Values == | |
| ; <tt>(boolean)</tt> : True if cat1 is an ancestor of cat2, False if not. | |
| == Examples == | |
| This example, placed in a theme's archive.php, uses [[Conditional Tags]] to show different content depending on the category being displayed. This is helpful when it is necessary to include something for any child category of a given category, instead of using ''category-slug.php'' method where you'd have to create ''category-slug.php'' files for each and every category. | |
| The code snip below checks to see if the category called 'Music' (ID 4) is being processed, and if so, presents a [[Function Reference/wp_nav_menu|wp_nav_menu]] for the Music archive page, and any subcategories of Music (e.g. jazz, classical.) | |
| <pre> | |
| <?php | |
| // if the category is music or a music SUBcategory, | |
| if (cat_is_ancestor_of(4, $cat) or is_category(4)): ?> | |
| <div id="music_subnav_menu" class="subnav_menu"> | |
| <?php wp_nav_menu( array('menu' => 'Music' )); ?> | |
| </div> | |
| <? endif; ?> | |
| </pre> | |
| == Notes == | |
| * The function evaluates if the second category is a child of the first category. | |
| * Any level of ancestry will return True. | |
| * Arguments should be either integer or objects, If arguments are string representations of integers and not true integers '''cat_is_ancestor_of''' will return False. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>cat_is_ancestor_of()</tt> is located in {{Trac|wp-includes/category.php}}. | |
| == Related == | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_category_feed_link" d:title="get category feed link"> | |
| <d:index d:value="get category feed link"/> | |
| <h1>get category feed link</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_category_feed_link}} | |
| {{it|Riferimento funzioni/get_category_feed_link}} | |
| }} | |
| ==Description== | |
| This function returns a link to the feed for all posts in the specified category. A particular feed can be requested, but if the feed parameter is left blank, it returns the 'rss2' feed link. | |
| == Usage == | |
| %%% <?php get_category_feed_link( $cat_id, $feed ); ?> %%% | |
| === Parameters === | |
| {{Parameter|$cat_id|string|Category ID of feed link to return.}} | |
| {{Parameter|$feed|string|Type of feed, accepts 'rss2' or 'atom'.|optional|rss2}} | |
| == Examples == | |
| Return the rss2 feed link for post in category 2 | |
| <pre> | |
| <?php get_category_feed_link('2', ''); ?> | |
| </pre> | |
| Display an rss link automatically when viewing a category. Insert this code on the category.php or archive.php page template. | |
| <pre> | |
| if ( is_category() ) { | |
| $category = get_category( get_query_var('cat') ); | |
| if ( ! empty( $category ) ) | |
| echo '<div class="category-feed"><a href="' . get_category_feed_link( $category->cat_ID ) . '" title="' . sprintf( __( 'Subscribe to this category', 'appthemes' ), $category->name ) . '" rel="nofollow">' . __( 'Subscribe!', 'appthemes' ) . '</a></div>'; | |
| } | |
| </pre> | |
| == Notes== | |
| == Resources == | |
| == Change Log == | |
| * Since: [[Version 2.5|2.5.0]] | |
| * This function replaces the deprecated '''get_category_rss_link''' function. | |
| == Source File == | |
| <tt>get_category_feed_link()</tt> is located in {{Trac|wp-includes/link-template.php}}. | |
| == Related== | |
| &nbsp; | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="username_exists" d:title="username exists"> | |
| <d:index d:value="username exists"/> | |
| <h1>username exists</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/username_exists}} | |
| {{it|Riferimento funzioni/username_exists}} | |
| }} | |
| == Description == | |
| Returns the user ID if the user exists or <tt>null</tt> if the user doesn't exist. | |
| == Usage == | |
| %%%<?php username_exists( $username ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$username|string|a string representing the username to check for existence.}} | |
| == Return Values == | |
| ; (mixed) : This function returns the user ID if the user exists or <tt>null</tt> if the user does not exist. | |
| == Examples == | |
| Use <tt>username_exists()</tt> in your scripts to decide whether the given username exists. | |
| <?php | |
| $username = $_POST['username']; | |
| if ( username_exists( $username ) ) | |
| echo "Username In Use!"; | |
| else | |
| echo "Username Not In Use!"; | |
| ?> | |
| == Notes == | |
| == Change Log == | |
| == Source File == | |
| <tt>username_exists()</tt> is located in {{Trac|wp-includes/user.php}}. | |
| == Related == | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Conditional Tags]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="get_comment" d:title="get comment"> | |
| <d:index d:value="get comment"/> | |
| <h1>get comment</h1> | |
| <p>== Description == | |
| Retrieves comment data given a comment ID or comment object. You can specify, by means of the <tt>$output</tt> parameter, how you would like the results returned. | |
| If an object is passed then the comment data will be cached and then returned after being passed through a filter. If the comment is empty, then the global comment variable will be used, if it is set. | |
| ==Usage== | |
| %%%<?php get_comment( $id, $output ); ?> %%% | |
| ==Parameters== | |
| {{Parameter|$comment|integer|The ID of the comment you'd like to fetch. '''You must pass a variable containing an integer''' (e.g. <tt>$id</tt>). A literal integer (e.g. <tt>7</tt>) will cause a fatal error (''Only variables can be passed for reference'' or ''Cannot pass parameter 1 by reference'').}} | |
| {{Parameter|$output|string|How you'd like the result. ''OBJECT'' <nowiki>=</nowiki> an object, ''ARRAY_A'' <nowiki>=</nowiki> an associative array of keys to values, and ''ARRAY_N'' <nowiki>=</nowiki> a numerically indexed array of values.|optional|OBJECT}} | |
| == Return == | |
| {{Return||object&#124;array|On success, it returns the database fields for this comment from the <tt>[[Database_Description#Table:_wp_comments | wp_comments]]</tt> table, in the format specified. On failure, <tt>null</tt> is returned. The fields returned are:}} | |
| ; <tt>comment_ID</tt> : (''integer'') The comment ID | |
| ; <tt>comment_post_ID</tt> : (''integer'') The post ID of the associated post | |
| ; <tt>comment_author</tt> : (''string'') The comment author's name | |
| ; <tt>comment_author_email</tt> : (''string'') The comment author's email | |
| ; <tt>comment_author_url</tt> : (''string'') The comment author's webpage | |
| ; <tt>comment_author_IP</tt> : (''string'') The comment author's IP | |
| ; <tt>comment_date</tt> : (''string'') The datetime of the comment (<tt>YYYY-MM-DD HH:MM:SS</tt>) | |
| ; <tt>comment_date_gmt</tt> : (''string'') The GMT datetime of the comment (<tt>YYYY-MM-DD HH:MM:SS</tt>) | |
| ; <tt>comment_content</tt> : (''string'') The comment's contents | |
| ; <tt>comment_karma</tt> : (''integer'') The comment's karma | |
| ; <tt>comment_approved</tt> : (''string'') The comment approbation (0, 1 or 'spam') | |
| ; <tt>comment_agent</tt> : (''string'') The comment's agent (browser, Operating System, etc.) | |
| ; <tt>comment_type</tt> : (''string'') The comment's type if meaningfull (<tt>pingback|trackback</tt>), and empty for normal comments | |
| ; <tt>comment_parent</tt> : (''string'') The parent comment's ID | |
| ; <tt>user_id</tt> : (''integer'') The comment author's ID if he is registered (0 otherwise) | |
| ==Example== | |
| To get the author's name of a comment with ID 7: | |
| <pre><?php | |
| $my_id = 7; | |
| $comment_id_7 = get_comment( $my_id ); | |
| $name = $comment_id_7->comment_author; | |
| ?> </pre> | |
| Alternatively, specify the <tt>$output</tt> parameter: | |
| <pre><?php | |
| $my_id = 7; | |
| $comment_id_7 = get_comment( $my_id, ARRAY_A ); | |
| $name = $comment_id_7['comment_author']; | |
| ?></pre> | |
| <pre><?php | |
| // Correct: pass a dummy variable as post_id | |
| $the_comment = & get_comment( $dummy_id = 7 ); | |
| // Incorrect: literal integer as post_id | |
| $the_comment = & get_comment( 7 ); | |
| // Fatal error: 'Only variables can be passed for reference' or 'Cannot pass parameter 1 by reference' | |
| ?></pre> | |
| == Notes == | |
| * Uses: <tt>[[Class_Reference/wpdb | $wpdb]]</tt> | |
| == Change Log == | |
| Since: [[Version 2.0|2.0.0]] | |
| == Source File == | |
| <tt>get_comment()</tt> is located in {{Trac|wp-includes/comment.php}} | |
| == Related == | |
| &nbsp; | |
| {{Tag Footer}} | |
| {{Copyedit}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_post_custom_keys" d:title="get post custom keys"> | |
| <d:index d:value="get post custom keys"/> | |
| <h1>get post custom keys</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get post custom keys}} | |
| {{ja|関数リファレンス/get post custom keys}} | |
| }} | |
| == Description == | |
| Returns an array containing the keys of all custom fields of a particular post or page. See also [[Function_Reference/get_post_custom|get_post_custom()]] and [[Function_Reference/get_post_custom_values|get_post_custom_values()]] | |
| == Usage == | |
| %%% <?php get_post_custom_keys($post_id); ?> %%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|The post ID whose custom field keys will be retrieved.|optional|Current post}} | |
| == Examples == | |
| === Default Usage === | |
| The following example will set a variable (<tt>$custom_field_keys</tt>) as an array containing the keys of all custom fields in the current post, and then print it. Note: the '''if''' test excludes values for WordPress internally maintained custom keys such as ''_edit_last'' and ''_edit_lock''. | |
| <pre><?php | |
| $custom_field_keys = get_post_custom_keys(); | |
| foreach ( $custom_field_keys as $key => $value ) { | |
| $valuet = trim($value); | |
| if ( '_' == $valuet{0} ) | |
| continue; | |
| echo $key . " => " . $value . "<br />"; | |
| } | |
| ?></pre> | |
| If the post contains custom fields with the keys ''mykey'' and ''yourkey'', the output would be something like: | |
| <div style="border:1px solid blue; width:50%; margin: 20px; padding:20px"> | |
| 0 => mykey<br /> | |
| 1 => yourkey | |
| </div> | |
| '''''Note:''' Regardless of how many values (custom fields) are assigned to one key, that key will only appear once in this array.'' | |
| == Source File == | |
| <tt>get_post_custom_keys()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Post Meta Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_post_custom" d:title="get post custom"> | |
| <d:index d:value="get post custom"/> | |
| <h1>get post custom</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get post custom}} | |
| {{ru|Справочник_по_функциям/get post custom}} | |
| {{ja|関数リファレンス/get post custom}} | |
| }} | |
| == Description == | |
| Returns a multidimensional array with all custom fields of a particular post or page. See also [[Function_Reference/get_post_custom_keys|get_post_custom_keys()]] and [[Function_Reference/get_post_custom_values|get_post_custom_values()]] | |
| == Usage == | |
| %%% <?php get_post_custom($post_id); ?> %%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|The post ID whose custom fields will be retrieved.|optional|Current post}} | |
| == Examples == | |
| === Default Usage === | |
| Use the following example to set a variable (<tt>$custom_fields</tt>) as a multidimensional array containing all custom fields of the '''current''' post. | |
| <?php $custom_fields = get_post_custom(); ?> | |
| === Retrieving data from the array === | |
| The following example will retrieve all custom field values with the key ''my_custom_field'' from post ID ''72'' (assuming there are three custom fields with this key, and the values are "dogs", "47" and "This is another value"). | |
| <pre><?php | |
| $custom_fields = get_post_custom(72); | |
| $my_custom_field = $custom_fields['my_custom_field']; | |
| foreach ( $my_custom_field as $key => $value ) { | |
| echo $key . " => " . $value . "<br />"; | |
| } | |
| ?> | |
| </pre> | |
| <div style="border:1px solid blue; width:50%; margin: 20px; padding:20px"> | |
| 0 => dogs<br/> | |
| 1 => 47<br/> | |
| 2 => This is another value | |
| </div> | |
| Note: not only does the function return a multi-dimensional array (ie: always be prepared to deal with an array of arrays, even if expecting array of single values), but it also returns serialized values of any arrays stored as meta values. | |
| If you expect that possibly an array may be stored as a metavalue, then be prepared to <tt>[[Function Reference/maybe unserialize | maybe_unserialize]]</tt>. | |
| == Source Code == | |
| <tt>get_post_custom()</tt> is located in {{Trac|wp-includes/post.php}} | |
| == Changelog == | |
| * since [[Version 1.5|1.5.0]] | |
| == Related == | |
| {{Post Meta Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:UI Link]]</p> | |
| </d:entry> | |
| <d:entry id="get_post_custom_values" d:title="get post custom values"> | |
| <d:index d:value="get post custom values"/> | |
| <h1>get post custom values</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get post custom values}} | |
| {{ja|関数リファレンス/get post custom values}} | |
| }} | |
| == Description == | |
| This function is useful if you wish to access a custom field that is not unique, i.e. has more than 1 value associated with it. Otherwise, you might wish to look at [[Function_Reference/get_post_meta|get_post_meta()]]. | |
| Returns an array containing all the values of the custom fields with a particular key (<tt>$key</tt>) of a post with ID <tt>$post_id</tt> (defaults to the current post if unspecified). | |
| Returns nothing if no such key exists, or none is entered. | |
| See also [[Function_Reference/get_post_custom|get_post_custom()]] and [[Function_Reference/get_post_custom_keys|get_post_custom_keys()]]. | |
| == Usage == | |
| %%% <?php get_post_custom_values($key, $post_id); ?> %%% | |
| == Parameters == | |
| {{Parameter|$key|string|The key whose values you want returned.|required}} | |
| {{Parameter|$post_id|integer|The post ID whose custom fields will be retrieved.|optional|Current post}} | |
| == Examples == | |
| === Default Usage === | |
| Let's assume the current post has 3 values associated with the (custom) field <tt>my_key</tt>. | |
| You could show them through: | |
| <pre><?php | |
| $mykey_values = get_post_custom_values( 'my_key' ); | |
| foreach ( $mykey_values as $key => $value ) { | |
| echo "$key => $value ( 'my_key' )<br />"; | |
| } | |
| ?></pre> | |
| 0 => First value ( 'my_key' ) | |
| 1 => Second value ( 'my_key' ) | |
| 2 => Third value ( 'my_key' ) | |
| == Source File == | |
| <tt>get_post_custom_values()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Post Meta Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="auth_redirect" d:title="auth redirect"> | |
| <d:index d:value="auth redirect"/> | |
| <h1>auth redirect</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/auth_redirect}} | |
| {{it|Riferimento_funzioni/auth_redirect}} | |
| }} | |
| ==Description== | |
| Checks user is logged in, if not it redirects them to login page. | |
| When this code is called from a page, it checks to see if the user viewing the page is logged in. If the user is not logged in, they are redirected to the login page. The user is redirected in such a way that, upon logging in, they will be sent directly to the page they were originally trying to access. | |
| == Usage == | |
| %%%<?php auth_redirect(); ?>%%% | |
| ==Parameters== | |
| This function accepts no parameters. | |
| == Return Values == | |
| Function redirects or exits, does not return | |
| == Examples == | |
| == Notes == | |
| As a pluggable function, you can redefine it and your version will be used instead. | |
| == Change Log == | |
| Since: [[Version 1.5|1.5]] | |
| == Source File == | |
| auth_redirect() is located in {{Trac|wp-includes/pluggable.php}} | |
| ==Related== | |
| [[Function Reference/is user logged in|is_user_logged_in()]], [[Function Reference/wp redirect|wp_redirect()]] | |
| {{Tag Footer}} | |
| [[Category:Needs Review]] | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="email_exists" d:title="email exists"> | |
| <d:index d:value="email exists"/> | |
| <h1>email exists</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/email_exists}} | |
| {{it|Riferimento funzioni/email_exists}} | |
| }} | |
| ==Description== | |
| This function will check whether or not a given email address (<tt>$email</tt>) has already been registered to a username, and returns that users ID (or <tt>false</tt> if none exists). See also [[Function Reference/username exists|username_exists]]. | |
| This function is normally used when a user is registering, to ensure that the E-mail address the user is attempting to register with has not already been registered. | |
| == Usage == | |
| %%%<?php | |
| if( email_exists( $email )) { | |
| /* stuff to do when mail exists */ | |
| } | |
| ?>%%% | |
| == Parameter == | |
| {{Parameter|$email|string|The E-mail address to check|required}} | |
| == Return == | |
| * If the E-mail exists, function returns the ID of the user to whom the E-mail is registered. | |
| * If the E-mail does not exist, function returns <tt>false</tt>. | |
| == Examples == | |
| If the E-mail exists, echo the ID number to which the E-mail is registered. Otherwise, tell the viewer that it does not exist. | |
| <pre><?php | |
| $email = 'myemail@example.com'; | |
| $exists = email_exists($email); | |
| if ( $exists ) | |
| echo "That E-mail is registered to user number " . $exists; | |
| else | |
| echo "That E-mail doesn't belong to any registered users on this site"; | |
| ?></pre> | |
| == Notes == | |
| == Change Log == | |
| Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| email_exists() is located in {{Trac|wp-includes/user.php}} | |
| == Related == | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]] | |
| [[Category:Needs Review]]</p> | |
| </d:entry> | |
| <d:entry id="add_post_meta" d:title="add post meta"> | |
| <d:index d:value="add post meta"/> | |
| <h1>add post meta</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/add_post_meta}} | |
| {{ru|Справочник_по_функциям/add_post_meta}} | |
| {{es|Referencia de Funciones/add_post_meta}} | |
| {{ja|関数リファレンス/add_post_meta}} | |
| {{pt-br|Funções e Referências/add_post_meta}} | |
| }} | |
| ==Description== | |
| Adds a [[Custom Fields|custom field]] (also called ''meta-data'') to a specified post which could be of any [[Post Types|post type]]. A custom field is effectively a key–value pair. | |
| Note that if the given key already exists among custom fields of the specified post, another custom field with the same key is added unless the <tt>$unique</tt> argument is set to <tt>true</tt>, in which case, no changes are made. If you want to update the value of an existing key, use the <tt>[[Function Reference/update_post_meta|update_post_meta()]]</tt> function instead. | |
| ==Usage== | |
| %%% <?php add_post_meta($post_id, $meta_key, $meta_value, $unique); ?> %%% | |
| ==Parameters== | |
| {{Parameter|$post_id|integer|The ID of the post to which a custom field should be added.}} | |
| {{Parameter|$meta_key|string|The key of the custom field which should be added.}} | |
| {{Parameter|$meta_value|mixed|The value of the custom field which should be added. If an array is given, it will be serialized into a string.}} | |
| {{Parameter|$unique|boolean|Whether or not you want the key to stay unique. When set to <tt>true</tt>, the custom field will not be added if the given key already exists among custom fields of the specified post.|optional|false}} | |
| ==Return== | |
| {{Return||boolean|Boolean <tt>true</tt>, except if the <tt>$unique</tt> argument was set to <tt>true</tt> and a custom field with the given key already exists, in which case <tt>false</tt> is returned.}} | |
| ==Examples== | |
| ===Default Usage=== | |
| <?php add_post_meta( 68, 'my_key', 47 ); ?> | |
| ===Adding or Updating a Unique Custom Field=== | |
| Adds a new custom field if the key does not already exist, or updates the value of the custom field with that key otherwise. | |
| <?php add_post_meta( 7, 'fruit', 'banana', true ) || update_post_meta( 7, 'fruit', 'banana' ); ?> | |
| The following will have the same effect: | |
| <?php | |
| // Add or Update the meta field in the database. | |
| if ( ! update_post_meta (7, 'fruit', 'banana') ) { | |
| add_post_meta(7, 'fruit', 'banana', true ); | |
| }; | |
| ?> | |
| ===Other Examples=== | |
| Adds a new custom field only if a custom field with the given key does not already exists: | |
| <?php add_post_meta( 68, 'my_key', '47', true ); ?> | |
| Adds several custom fields with different values but with the same key <tt>'my_key'</tt>: | |
| <pre> | |
| <?php add_post_meta( 68, 'my_key', '47' ); ?> | |
| <?php add_post_meta( 68, 'my_key', '682' ); ?> | |
| <?php add_post_meta( 68, 'my_key', 'The quick, brown fox jumped over the lazy dog.' ); ?> | |
| ...</pre> | |
| For a more detailed example, see the [[Function Reference/post_meta Function Examples|post_meta Functions Examples]] page. | |
| === Hidden Custom Fields === | |
| If you are a plugin or theme developer and you are planning to use custom fields to store parameters related to your plugin or template, it is interesting to note that WordPress will not show custom fields which have keys starting with an <tt>"_"</tt> (underscore) in the custom fields list on the [[Writing Posts | post edit]] screen or when using the <tt>[[Function Reference/the_meta | the_meta()]]</tt> template function. This can be for example used to show these custom fields in an unusual way by using the <tt>[[Function Reference/add_meta_box | add_meta_box()]]</tt> function. | |
| The following example: | |
| <?php add_post_meta( 68, '_color', 'red', true ); ?> | |
| will add a unique custom field with the key name <tt>'_color'</tt> and the value <tt>'red'</tt> but this custom field will not display in the post edit screen. | |
| ==== Hidden Arrays ==== | |
| In addition, if the <tt>$meta_value</tt> argument is an array, it will <strong>not</strong> be displayed on the page edit screen, even if you don't prefix the key name with an underscore. | |
| == Notes == | |
| * Uses <tt>[[Function_Reference/add_metadata | add_metadata()]]</tt>. | |
| === Character Escaping === | |
| Because meta values are passed through the <tt>[http://php.net/stripslashes stripslashes()]</tt> function, you need to be careful about content escaped with <tt>\</tt> characters. You can read more about the behavior, and a workaround example, in the <tt>[[Function_Reference/update_post_meta#Character_Escaping | update_post_meta()]]</tt> documentation. | |
| == Source Code == | |
| <tt>add_post_meta()</tt> is located in {{Trac|wp-includes/post.php}} | |
| == Change Log == | |
| Since [[Version 1.5|1.5.0]] | |
| ==Related== | |
| {{Post Meta Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="update_post_meta" d:title="update post meta"> | |
| <d:index d:value="update post meta"/> | |
| <h1>update post meta</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/update post meta}} | |
| {{ja|関数リファレンス/update post meta}} | |
| }} | |
| ==Description== | |
| The function <tt>update_post_meta()</tt> updates the value of an existing meta key (custom field) for the specified post. | |
| This may be used in place of <tt>[[Function Reference/add post meta | add_post_meta()]]</tt> function. The first thing this function will do is make sure that <tt>$meta_key</tt> already exists on <tt>$post_id</tt>. If it does not, <tt>add_post_meta($post_id, $meta_key, $meta_value)</tt> is called instead and its result is returned. | |
| Returns <tt>meta_id</tt> if the meta doesn't exist, otherwise returns <tt>true</tt> on success and <tt>false</tt> on failure. It also returns <tt>false</tt> if the value submitted is the same as the value that is already in the database. | |
| Please note that if your database collation is case insensitive (has with suffix <tt>_ci</tt>) then <tt>update_post_meta</tt> and <tt>[[Function_Reference/delete_post_meta | delete_post_meta]]</tt> and <tt>[[Function_Reference/get_posts | get_posts]]</tt> will update/delete/query the meta records with keys that are upper or lower case. However <tt>[[Function_Reference/get_post_meta | get_post_meta]]</tt> will apparently be case sensitive due to [[Class_Reference/WP_Object_Cache | WordPress caching]]. See https://core.trac.wordpress.org/ticket/18210 for more info. | |
| ==Usage== | |
| %%% <?php update_post_meta($post_id, $meta_key, $meta_value, $prev_value); ?> %%% | |
| ==Parameters== | |
| {{Parameter|$post_id|integer|The ID of the post which contains the field you will edit.}} | |
| {{Parameter|$meta_key|string|The key of the custom field you will edit. (this should be raw as opposed to sanitized for database queries)}} | |
| {{Parameter|$meta_value|mixed|The new value of the custom field. A passed array will be serialized into a string.(this should be raw as opposed to sanitized for database queries)}} | |
| {{Parameter|$prev_value|mixed|The old value of the custom field you wish to change. This is to differentiate between several fields with the same key. If omitted, and there are multiple rows for this post and meta key, all meta values will be updated.|optional|''Empty''}} | |
| == Return Values == | |
| ; (mixed) : Returns meta_id if the meta doesn't exist, otherwise returns true on success and false on failure. NOTE: If the meta_value passed to this function is the same as the value that is already in the database, this function returns false. | |
| ==Examples== | |
| ===Default Usage=== | |
| <?php update_post_meta(76, 'my_key', 'Steve'); ?> | |
| ===Other Examples=== | |
| Assuming a post has an ID of 76, and the following 4 custom fields: | |
| <div style="border:1px solid blue; width:50%; margin: 20px; padding:20px"> | |
| [key_1] => 'Happy'<br/> | |
| [key_1] => 'Sad'<br/> | |
| [key_2] => 'Gregory'<br/> | |
| [my_key] => 'Steve'<br/> | |
| </div> | |
| To change <tt>key_2</tt>'s value to ''Hans'': | |
| <?php update_post_meta( 76, 'key_2', 'Hans' ); ?> | |
| To change <tt>key_1</tt>'s value from ''Sad'' to ''Happy'': | |
| <?php update_post_meta( 76, 'key_1', 'Happy', 'Sad' ); ?> | |
| The fields would now look like this: | |
| <div style="border:1px solid blue; width:50%; margin: 20px; padding:20px"> | |
| [key_1] => 'Happy'<br/> | |
| [key_1] => 'Happy'<br/> | |
| [key_2] => 'Hans'<br/> | |
| [my_key] => 'Steve'<br/> | |
| </div> | |
| '''''Note:''' This function will update only the first field that matches the criteria.'' | |
| To change the first <tt>key_1</tt>'s value from ''Happy'' to ''Excited'': | |
| <pre><?php | |
| update_post_meta( 76, 'key_1', 'Excited', 'Happy' ); | |
| //Or | |
| update_post_meta( 76, 'key_1', 'Excited' ); | |
| //To change all fields with the key "key_1": | |
| $key1_values = get_post_custom_values( 'key_1', 76 ); | |
| foreach ( $key1_values as $value ) | |
| update_post_meta( 76, 'key_1', 'Excited', $value ); | |
| ?></pre> | |
| Edit Page template | |
| <pre><?php | |
| update_post_meta( $id, '_wp_page_template', 'new_template.php' ); | |
| ?></pre> | |
| For a more detailed example, go to the [[Function Reference/post meta Function Examples|post_meta Functions Examples]] page. | |
| ==Character Escaping== | |
| Post meta values are passed through the <tt>[http://www.php.net/stripslashes stripslashes()]</tt> function upon being stored, so you will need to be careful when passing in values (such as JSON) that might include <tt>\</tt> escaped characters. | |
| ===Do not store escaped values=== | |
| Consider the JSON value <tt>{"key":"value with \"escaped quotes\""}</tt>: | |
| <pre><?php | |
| $escaped_json = '{"key":"value with \\"escaped quotes\\""}'; | |
| update_post_meta( $id, 'escaped_json', $escaped_json ); | |
| $broken = get_post_meta( $id, 'escaped_json', true ); | |
| /* | |
| $broken, after passing through stripslashes() ends up unparsable: | |
| {"key":"value with "escaped quotes""} | |
| */ | |
| ?></pre> | |
| ===Workaround=== | |
| By adding one more level of <tt>\</tt> escaping using function <tt>wp_slash</tt> (introduced in WP 3.6), you can compensate for the call to <tt>stripslashes()</tt>: | |
| <pre><?php | |
| $escaped_json = '{"key":"value with \\"escaped quotes\\""}'; | |
| update_post_meta( $id, 'double_escaped_json', wp_slash($escaped_json) ); | |
| $fixed = get_post_meta( $id, 'double_escaped_json', true ); | |
| /* | |
| $fixed, after stripslashes(), ends up being stored as desired: | |
| {"key":"value with \"escaped quotes\""} | |
| */ | |
| ?></pre> | |
| == Notes == | |
| * This function uses <tt>[[Function_Reference/update_metadata | update_metadata()]]</tt>. | |
| == Source Code == | |
| <tt>update_post_meta()</tt> is located in {{Trac|wp-includes/post.php}} | |
| == Change Log == | |
| Since [[Version 1.5|1.5.0]] | |
| ==Related== | |
| {{Post Meta Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="delete_post_meta" d:title="delete post meta"> | |
| <d:index d:value="delete post meta"/> | |
| <h1>delete post meta</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/delete post meta}} | |
| {{ru|Справочник_по_функциям/delete post meta}} | |
| {{ja|関数リファレンス/delete post meta}} | |
| }} | |
| ==Description== | |
| This function deletes all custom fields with the specified key, or key and value, from the specified post. See also [[Function Reference/update post meta|update_post_meta()]], [[Function Reference/get post meta|get_post_meta()]] and [[Function Reference/add post meta|add_post_meta()]]. | |
| ==Usage== | |
| %%% <?php delete_post_meta($post_id, $meta_key, $meta_value); ?> %%% | |
| ==Parameters== | |
| {{Parameter|$post_id|integer|The ID of the post from which you will delete a field.}} | |
| {{Parameter|$meta_key|string|The key of the field you will delete.}} | |
| {{Parameter|$meta_value|mixed|The value of the field you will delete. This is used to differentiate between several fields with the same key. If left blank, all fields with the given key will be deleted.|optional|''Empty''}} | |
| ==Return values== | |
| ; (boolean) : False for failure. True for success. | |
| ==Examples== | |
| ===Default Usage=== | |
| <?php delete_post_meta(76, 'my_key', 'Steve'); ?> | |
| ===Other Examples=== | |
| Let's assume we had a plugin that added some meta values to posts, but now when we are uninstalling the plugin, we want to delete all the post meta keys that the plugin added. Assuming the plugin added the keys <tt>related_posts</tt> and <tt>post_inspiration</tt>. | |
| To delete all the keys use delete_post_meta_by_key( $post_meta_key ). This would be added to the "uninstall" function: | |
| <pre><?php delete_post_meta_by_key( 'related_posts' ); ?></pre> | |
| Or, if you wanted to delete all the keys except where <tt>post_inspiration</tt> was "Sherlock Holmes": | |
| <pre><?php | |
| $allposts = get_posts( 'numberposts=-1&post_type=post&post_status=any' ); | |
| foreach( $allposts as $postinfo ) { | |
| delete_post_meta( $postinfo->ID, 'related_posts' ); | |
| $inspiration = get_post_meta( $postinfo->ID, 'post_inspiration' ); | |
| foreach( $inspiration as $value ) { | |
| if( 'Sherlock Holmes' !== $value ) | |
| delete_post_meta( $postinfo->ID, 'post_inspiration', $value ); | |
| } | |
| } | |
| ?></pre> | |
| Or maybe post number 185 was just deleted, and you want to remove all <tt>related_posts</tt> keys that reference it: | |
| <pre><?php | |
| $allposts = get_posts( 'numberposts=-1&post_type=post&post_status=any' ); | |
| foreach( $allposts as $postinfo ) { | |
| delete_post_meta( $postinfo->ID, 'related_posts', '185' ); | |
| } | |
| ?></pre> | |
| For a more detailed example, go to the [[Function Reference/post meta Function Examples|post_meta Functions Examples]] page. | |
| '''''Note:''' Unlike [[Function Reference/update post meta|update_post_meta()]], This function will delete '''all''' fields that match the criteria.'' | |
| == Source File == | |
| <tt>delete_post_meta()</tt> is located in {{Trac|wp-includes/post.php}} | |
| == Change Log == | |
| Since [[Version 1.5|1.5.0]] | |
| ==Related== | |
| {{Post Meta Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_post_meta" d:title="get post meta"> | |
| <d:index d:value="get post meta"/> | |
| <h1>get post meta</h1> | |
| <p>{{Languages| | |
| {{en| Function Reference/get post meta}} | |
| {{ja|関数リファレンス/get post meta}} | |
| {{fr|Fonction get post meta}} | |
| }} | |
| ==Description== | |
| This function returns the values of the custom fields with the specified key from the specified post. It is a wrapper for <tt>[[Function_Reference/get_metadata | get_metadata]]('post')</tt>. To return all of the custom fields, see [[Function Reference/get_post_custom|get_post_custom()]]. See also [[Function Reference/update post meta|update_post_meta()]], [[Function Reference/delete post meta|delete_post_meta()]] and [[Function Reference/add post meta|add_post_meta()]]. | |
| ==Usage== | |
| %%%<?php $meta_values = get_post_meta( $post_id, $key, $single ); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$post_id|integer|The ID of the post from which you want the data. Use <code>get_the_ID()</code> or the global <code>$post</code> object's ID property (eg <code>$post->ID</code>) while in <tt>The Loop</tt> to get the post's ID, or use your sub-loop's post object ID property (eg <code>$my_post_object->ID</code>). (Note: When using a Page to display your posts (set in Settings -> Reading), <code>get_the_ID()</code> and <code>$post->ID</code> will grab the latest Post's ID. To get the containing Page's ID, you will need to use <code>get_queried_object_id()</code>.) }} | |
| {{Parameter|$key|string|A string containing the name of the meta value you want.|optional}} | |
| {{Parameter|$single|boolean|If set to true then the function will return a single result, as a '''string'''. If false, or not set, then the function returns an '''array''' of the custom fields. This may not be intuitive in the context of serialized arrays. If you fetch a serialized array with this method you want $single to be true to actually get an unserialized array back. If you pass in false, or leave it out, you will have an array of one, and the value at index 0 will be the serialized string.|optional|false}} | |
| ==Return Value== | |
| * If only <tt>$id</tt> is set it will return all meta values in an associative array. | |
| * If <tt>$single</tt> is set to <tt>false</tt>, or left blank, the function returns an array containing all values of the specified key. | |
| * If <tt>$single</tt> is set to <tt>true</tt>, the function returns the first value of the specified key (not in an array) | |
| If there is nothing to return the function will return an empty <tt>array</tt> unless <tt>$single</tt> has been set to <tt>true</tt>, in which case an empty string is returned. | |
| ==Examples== | |
| ===Default Usage=== | |
| Get the meta for all keys: | |
| <?php $meta = get_post_meta( get_the_ID() ); ?> | |
| Get the meta for a single key: | |
| <?php $key_1_values = get_post_meta( 76, 'key_1' ); ?> | |
| ===show the first value of the specified key inside a loop=== | |
| <pre><?php | |
| $key_1_value = get_post_meta( get_the_ID(), 'key_1', true ); | |
| // check if the custom field has a value | |
| if( ! empty( $key_1_value ) ) { | |
| echo $key_1_value; | |
| } | |
| ?></pre> | |
| For a more detailed example, go to the [[Function Reference/post meta Function Examples|post_meta Functions Examples]] page. | |
| ===Retrieve a Custom Field Thumbnail Url=== | |
| While you are in the [http://codex.wordpress.org/The_Loop WordPress Loop], you can use this code to retrieve a custom field. In this example, the thumbnail image url is in a custom field named "thumb". | |
| <?php if ( get_post_meta( get_the_ID(), 'thumb', true ) ) : ?> | |
| <a href="<?php the_permalink() ?>" rel="bookmark"> | |
| <img class="thumb" src="<?php echo get_post_meta( get_the_ID(), 'thumb', true ); ?>" alt="<?php the_title(); ?>" /> | |
| </a> | |
| <?php endif; ?> | |
| == Notes == | |
| * Please note that if a db collation is case insensitive (has with suffix <tt>_ci</tt>) then <tt>update_post_meta</tt> and <tt>delete_post_meta</tt> and <tt>[[Function_Reference/get_posts | get_posts()]]</tt> will update/delete/query the meta records with keys that are upper or lower case. However <tt>get_post_meta</tt> will apparently be case sensitive due to WordPress caching. See https://core.trac.wordpress.org/ticket/18210 for more info. Be careful not to mix upper and lowercase. | |
| * Uses: <tt>[[Function_Reference/get_metadata | get_metadata()]]</tt> to retrieve the metadata. | |
| == Change Log == | |
| * Since: 1.5.0 | |
| == Source Code == | |
| <code>get_post_meta()</code> is located in {{Trac|wp-includes/post.php}} | |
| ==Related== | |
| {{Post Meta Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_delete_attachment" d:title="wp delete attachment"> | |
| <d:index d:value="wp delete attachment"/> | |
| <h1>wp delete attachment</h1> | |
| <p>==Description== | |
| This function deletes an attachment and all of its derivatives. | |
| ==Usage== | |
| %%% <?php wp_delete_attachment( $attachmentid, $force_delete ); ?> %%% | |
| ==Parameters== | |
| {{Parameter|$attachmentid|integer|The ID of the attachment you would like to delete.}} | |
| {{Parameter|$force_delete|bool|Whether to bypass trash and force deletion (added in WordPress 2.9).|optional|false}} | |
| ==Return Values== | |
| Returns <tt>false</tt> on failure, post data on success. This should be checked using the identity operator ( === ) instead of the normal equality operator because of the possibility of a returned 0 or empty array: | |
| <?php if ( false === wp_delete_attachment( $attachmentid ) ) do something; ?> | |
| ==Hooks== | |
| This function fires the [[Plugin_API/Action_Reference/delete_attachment|delete_attachment]] action hook, passing the attachment's ID (<tt>$postid</tt>). | |
| ==Example== | |
| To delete an attachment with an ID of '76': | |
| <?php wp_delete_attachment( 76 ); ?> | |
| == Source File == | |
| <tt> wp_delete_attachment()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| ==Related== | |
| [[Function Reference/wp get attachment url|wp_get_attachment_url()]] | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_count_posts" d:title="wp count posts"> | |
| <d:index d:value="wp count posts"/> | |
| <h1>wp count posts</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_count_posts}} | |
| {{it|Riferimento funzioni/wp_count_posts}} | |
| }} | |
| == Description == | |
| This function was introduced in WordPress [[Version 2.5]], and returns an object, whose properties are the count of each post status of a post type. You can also use <code>wp_count_posts()</code> as a template_tag with the second parameter and include the private post status. By default, or if the user isn't logged in or is a guest of your site, then private post status post count will not be included. | |
| This function will return an object with the post statuses as the properties. You should check for the property using <code>isset()</code> PHP function, if you are wanting the value for the private post status. Not all post statuses will be part of the object. | |
| == Usage == | |
| %%% <?php wp_count_posts( $type, $perm ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$type|string|Post type to count|optional|'post'}} | |
| {{Parameter|$perm|string|To include private posts readable by the current user, set to 'readable'|optional|''empty string''}} | |
| == Examples == | |
| ===Default Usage=== | |
| The default usage returns a count of the posts that are published. This will be an object, you can var_dump() the contents to debug the output. | |
| <pre><?php | |
| $count_posts = wp_count_posts(); | |
| ?></pre> | |
| ===Get the Publish Status Post Count=== | |
| To get the published status type, you would call the <code>wp_count_posts()</code> function and then access the ''''publish'''' property. | |
| <pre><?php | |
| $count_posts = wp_count_posts(); | |
| $published_posts = $count_posts->publish; | |
| ?></pre> | |
| If you are developing for PHP5 only, then you can use shorthand, if you only want to get one status. This will not work in PHP4 and if you want to maintain backwards compatibility, then you must use the above code. | |
| <pre><?php | |
| $published_posts = wp_count_posts()->publish; | |
| ?></pre> | |
| ===Count Drafts=== | |
| Counting drafts is handled the same way as the publish status. | |
| <pre><?php | |
| $count_posts = wp_count_posts(); | |
| $draft_posts = $count_posts->draft; | |
| ?></pre> | |
| ===Count Pages=== | |
| Counting pages status types are done in the same way as posts and make use of the first parameter. Finding the number of posts for the post status is done the same way as for posts. | |
| <pre><?php | |
| $count_pages = wp_count_posts('page'); | |
| ?></pre> | |
| ===Other Uses=== | |
| The <code>wp_count_posts()</code> can be used to find the number for post statuses of any post type. This includes attachments or any post type added in the future, either by a plugin or part of the WordPress Core. | |
| == Source File == | |
| <tt>wp_count_posts()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| ==Related== | |
| {{Count Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="check_admin_referer" d:title="check admin referer"> | |
| <d:index d:value="check admin referer"/> | |
| <h1>check admin referer</h1> | |
| <p>== Description == | |
| Tests either if the current request carries a valid [[Glossary#Nonce|nonce]], or if the current request was referred from an [[Administration Screens|administration screen]]; depending on whether the <tt>$action</tt> argument is given (which is prefered), or not, respectively. On failure, the function [http://php.net/manual/en/function.die.php dies] after calling the <tt>[[Function Reference/wp_nonce_ays|wp_nonce_ays()]]</tt> function. | |
| Used to avoid security exploits. | |
| ''The now improper name of the function is kept for backward compatibility and has origin in previous WordPress versions where the function only checked the referer. For details, see the [[#Notes|Notes]] section below.'' | |
| == Usage == | |
| === Obsolete Usage === | |
| %%%<?php check_admin_referer(); ?>%%% | |
| === Prefered Usage === | |
| %%%<?php check_admin_referer( $action, $query_arg ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$action|string|Action name. Should give the context to what is taking place. (Since [[Version 2.0.1|2.0.1]]).|optional|-1}} | |
| {{Parameter|$query_arg|string|Where to look for nonce in the <tt>[http://php.net/manual/en/reserved.variables.request.php $_REQUEST]</tt> PHP variable. (Since [[Version 2.5|2.5]]).|optional|'_wpnonce'}} | |
| == Return == | |
| To return boolean ''true'', in the case of the [[#Obsolete Usage|obsolete usage]], the current request must be referred from an [[Administration Screens|administration screen]]; in the case of the [[#Prefered Usage|prefered usage]], the nonce must be sent and valid. Otherwise the function [http://php.net/manual/en/function.die.php dies] with an appropriate message (''"Are you sure you want to do this?"'' by default). | |
| == Examples == | |
| Obsolete usage here (script dies if the admin referer is not validated). | |
| <pre> | |
| <?php check_admin_referer(); ?> | |
| </pre> | |
| Here is an example of how you might use this in a plugin's option page. You add a nonce to a form using the <tt>[[Function Reference/wp_nonce_field|wp_nonce_field()]]</tt> function: | |
| <pre> | |
| <form method="post"> | |
| <!-- some inputs here ... --> | |
| <?php wp_nonce_field( 'name_of_my_action','name_of_nonce_field' ); ?> | |
| </form> | |
| </pre> | |
| Then in the page where the form submits to, you can verify whether or not the form was submitted and update values if it was successfully submitted: | |
| <pre> | |
| <?php | |
| // if this fails, check_admin_referer() will automatically print a "failed" page and die. | |
| if ( ! empty( $_POST ) && check_admin_referer( 'name_of_my_action', 'name_of_nonce_field' ) ) { | |
| // process form data, e.g. update fields | |
| } | |
| // Display the form | |
| </pre> | |
| == Notes == | |
| * Using the function without the <tt>$action</tt> argument is obsolete and, as of [[Version 3.2]], if [[WP_DEBUG]] is set to ''true'' will die with an appropriate message (''"You should specify a nonce action to be verified by using the first parameter."'' is the default). | |
| * As of [[Version 2.0.1|2.0.1]], the referer is checked ''only'' if the <tt>$action</tt> argument is not specified (or set to the default ''-1'') as a backward compatibility fallback for not using a nonce. A nonce is prefered to unreliable referers and with <tt>$action</tt> specified the function behaves the same way as <tt>[[Function Reference/wp_verify_nonce|wp_verify_nonce()]]</tt> except that it dies after calling <tt>[[Function Reference/wp_nonce_ays|wp_nonce_ays()]]</tt> if the nonce is not valid or was not sent. | |
| == Change Log == | |
| Since: 1.2.0 | |
| == Source File == | |
| <tt>check_admin_referer()</tt> is located in {{Trac|wp-includes/pluggable.php}}. | |
| == Related == | |
| {{Nonces}} | |
| * [[Wordpress Nonce Implementation]] | |
| == Resources == | |
| * [http://php.net/manual/en/function.die.php PHP: die - Manual] | |
| * [http://php.net/manual/en/reserved.variables.request.php PHP: $_REQUEST - Manual] | |
| * [http://markjaquith.wordpress.com/2006/06/02/wordpress-203-nonces/ Mark Jaquith - WordPress Nonces] | |
| * [http://www.prelovac.com/vladimir/improving-security-in-wordpress-plugins-using-nonces Vladimir Prelovac - Using Nonces in WordPress Plugins] | |
| * [[wikipedia:Cryptographic_nonce|Cryptographic nonce - Wikipedia, the free encyclopedia]] | |
| * [http://wordpress.stackexchange.com/questions/48110/wp-verify-nonce-vs-check-admin-referer wp_verify_nonce vs check_admin_referer - WordPress Answers] | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_verify_nonce" d:title="wp verify nonce"> | |
| <d:index d:value="wp verify nonce"/> | |
| <h1>wp verify nonce</h1> | |
| <p>== Description == | |
| Verify that a [[Glossary#Nonce|nonce]] is correct and unexpired with the respect to a specified action. The function is used to verify the nonce sent in the current request usually accessed by the <tt>[http://php.net/manual/en/reserved.variables.request.php $_REQUEST]</tt> PHP variable. | |
| == Usage == | |
| %%%<?php wp_verify_nonce( $nonce, $action ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$nonce|string|Nonce to verify.}} | |
| {{Parameter|$action|string/int|Action name. Should give the context to what is taking place and be the same when the nonce was created.|optional|-1}} | |
| == Return Values == | |
| {{Return||boolean/integer|Boolean ''false'' if the nonce is invalid. Otherwise, returns an integer with the value of: | |
| * ''1'' – if the nonce has been generated in the past 12 hours or less. | |
| * ''2'' – if the nonce was generated between 12 and 24 hours ago.}} | |
| == Example == | |
| Verify an nonce created with <tt>[[Function_Reference/wp_create_nonce | wp_create_nonce()]]</tt>: | |
| <pre> | |
| <?php | |
| // Create an nonce, and add it as a query var in a link to perform an action. | |
| $nonce = wp_create_nonce( 'my-nonce' ); | |
| echo "<a href='myplugin.php?_wpnonce={$nonce}'>Save Something</a>"; | |
| ?> | |
| ..... | |
| <?php | |
| // In our file that handles the request, verify the nonce. | |
| $nonce = $_REQUEST['_wpnonce']; | |
| if ( ! wp_verify_nonce( $nonce, 'my-nonce' ) ) { | |
| die( 'Security check' ); | |
| } else { | |
| // Do stuff here. | |
| } | |
| ?> | |
| </pre> | |
| You may also decide to take different actions based on the age of the nonce: | |
| <pre> | |
| <?php | |
| $nonce = wp_verify_nonce( $nonce, 'my-nonce' ); | |
| switch ( $nonce ) { | |
| case 1: | |
| echo 'Nonce is less than 12 hours old'; | |
| break; | |
| case 2: | |
| echo 'Nonce is between 12 and 24 hours old'; | |
| break; | |
| default: | |
| exit( 'Nonce is invalid' ); | |
| } | |
| ?> | |
| </pre> | |
| == Change Log == | |
| Since: [[Version 2.0.3|2.0.3]] | |
| == Source File == | |
| <tt>wp_verify_nonce()</tt> is defined in {{Trac|wp-includes/pluggable.php}} | |
| == Related == | |
| {{Nonces}} | |
| * [[Wordpress Nonce Implementation]] | |
| == External Resources == | |
| * [http://php.net/manual/en/reserved.variables.request.php PHP: $_REQUEST - Manual] | |
| * [http://markjaquith.wordpress.com/2006/06/02/wordpress-203-nonces/ Mark Jaquith - WordPress Nonces] | |
| * [http://www.prelovac.com/vladimir/improving-security-in-wordpress-plugins-using-nonces Vladimir Prelovac - Using Nonces in WordPress Plugins] | |
| * [[wikipedia:Cryptographic_nonce|Cryptographic nonce - Wikipedia, the free encyclopedia]] | |
| * [http://wordpress.stackexchange.com/questions/48110/wp-verify-nonce-vs-check-admin-referer wp_verify_nonce vs check_admin_referer - WordPress Answers] | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_create_nonce" d:title="wp create nonce"> | |
| <d:index d:value="wp create nonce"/> | |
| <h1>wp create nonce</h1> | |
| <p>== Description == | |
| Generates and returns a [[Glossary#Nonce|nonce]]. The nonce is generated based on the current time, the <tt>$action</tt> argument, and the current user ID. | |
| == Usage == | |
| %%%<?php wp_create_nonce( $action ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$action|string/int|Action name. Should give the context to what is taking place. Optional but ''recommended''.|optional|-1}} | |
| == Return Values == | |
| {{Return||string|The one use form token.}} | |
| == Example == | |
| In this simple example, we create an nonce and use it as one of the <tt>GET</tt> query parameters in a URL for a link. When the user clicks the link they are directed to a page where a certain action will be performed (for example, a post might be deleted). On the target page the nonce is verified to insure that the request was valid (this user really clicked the link and really wants to perform this action). | |
| <pre><?php | |
| // Create an nonce for a link. | |
| // We pass it as a GET parameter. | |
| // The target page will perform some action based on the 'do_something' parameter. | |
| $nonce = wp_create_nonce( 'my-nonce' ); | |
| ?> | |
| <a href='myplugin.php?do_something=some_action&_wpnonce=<?php echo $nonce; ?>'>Do some action</a> | |
| <?php | |
| // This code would go in the target page. | |
| // We need to verify the nonce. | |
| $nonce = $_REQUEST['_wpnonce']; | |
| if ( ! wp_verify_nonce( $nonce, 'my-nonce' ) ) { | |
| // This nonce is not valid. | |
| die( 'Security check' ); | |
| } else { | |
| // The nonce was valid. | |
| // Do stuff here. | |
| } | |
| ?> | |
| </pre> | |
| In the above example we simply called our nonce <tt>'my-nonce'</tt>. It is best to choose a name for the nonce that is specific to the action. For example, if we were to create an nonce that would be part of a request to delete a post, we might call it <tt>'delete_post'</tt>. Then to make it more specific, we could append the ID of the particular post that the nonce was for. For example <tt>'delete_post-5'</tt> for the post with ID 5. | |
| <pre>wp_create_nonce( 'delete_post-' . $post_id );</pre> | |
| Then we would verify the nonce like this: | |
| <pre>wp_verify_nonce( $nonce, 'delete_post-' . $_REQUEST['post_id'] );</pre> | |
| In general, it is best to make the name for the action as specific as possible. | |
| == Notes == | |
| * The function should be called using the [[Plugin API/Action Reference/init|init]] or any subsequent action [[Glossary#Hook|hook]]. Calling it outside of an action hook can lead to problems, see the [http://core.trac.wordpress.org/ticket/14024 ticket #14024] for details. | |
| * Uses: [[Function Reference/apply_filters|<tt>apply_filters()</tt>]] to apply the [[Plugin API/Filter Reference/nonce_user_logged_out| nonce_user_logged_out]] filters on the current user ID used to generate a nonce. | |
| * Uses: [[Function Reference/wp_nonce_tick|<tt>wp_nonce_tick()</tt>]] as a time-dependent factor to generate a nonce. | |
| == Change Log == | |
| * Since: [[Version 2.0.3|2.0.3]] | |
| == Source File == | |
| <tt>wp_create_nonce()</tt> is located in {{Trac|wp-includes/pluggable.php}}. | |
| == Related == | |
| {{Nonces}} | |
| * [[Wordpress Nonce Implementation]] | |
| == Resources == | |
| * [http://markjaquith.wordpress.com/2006/06/02/wordpress-203-nonces/ Mark Jaquith - WordPress Nonces] | |
| * [http://www.prelovac.com/vladimir/improving-security-in-wordpress-plugins-using-nonces Vladimir Prelovac - Using Nonces in WordPress Plugins] | |
| * [[wikipedia:Cryptographic_nonce|Cryptographic nonce - Wikipedia, the free encyclopedia]] | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_insert_attachment" d:title="wp insert attachment"> | |
| <d:index d:value="wp insert attachment"/> | |
| <h1>wp insert attachment</h1> | |
| <p>==Description== | |
| This function inserts an attachment into the media library. The function should be used in conjunction with <tt>[[Function_Reference/wp_update_attachment_metadata|wp_update_attachment_metadata()]]</tt> and <tt>[[Function_Reference/wp_generate_attachment_metadata|wp_generate_attachment_metadata()]]</tt>. It returns the ID of the entry created in the <tt>wp_posts</tt> table. | |
| This function is part of the low-level API used by WordPress for handling attachments. To perform the entire attachment upload and insertion process at once, you will want to use <tt>[[Function_Reference/media_handle_upload | media_handle_upload()]]</tt> instead in most cases. | |
| ==Usage== | |
| %%% <?php wp_insert_attachment( $attachment, $filename, $parent_post_id ); ?> %%% | |
| ==Parameters== | |
| {{Parameter|$attachment|array|Array of data about the attachment that will be written into the wp_posts table of the database. Must contain at a minimum the keys post_title, post_content (the value for this key should be the empty string), post_status and post_mime_type.}} | |
| {{Parameter|$filename|string|Location of the file on the server. Use absolute path and not the URI of the file. The file MUST be on the uploads directory. See [[Function_Reference/wp_upload_dir|wp_upload_dir()]] |optional|false}} | |
| {{Parameter|$parent_post_id|int|Attachments are associated with parent posts. This is the ID of the parent's post ID.|optional|0}} | |
| ==Return Values== | |
| Returns the resulting post ID (int) on success - likely returns 0 on failure. | |
| ==Example== | |
| To insert an attachment to a parent with a post ID of 37: | |
| <pre> | |
| <?php | |
| // $filename should be the path to a file in the upload directory. | |
| $filename = '/path/to/uploads/2013/03/filname.jpg'; | |
| // The ID of the post this attachment is for. | |
| $parent_post_id = 37; | |
| // Check the type of tile. We'll use this as the 'post_mime_type'. | |
| $filetype = wp_check_filetype( basename( $filename ), null ); | |
| // Get the path to the upload directory. | |
| $wp_upload_dir = wp_upload_dir(); | |
| // Prepare an array of post data for the attachment. | |
| $attachment = array( | |
| 'guid' => $wp_upload_dir['url'] . '/' . basename( $filename ), | |
| 'post_mime_type' => $filetype['type'], | |
| 'post_title' => preg_replace( '/\.[^.]+$/', '', basename( $filename ) ), | |
| 'post_content' => '', | |
| 'post_status' => 'inherit' | |
| ); | |
| // Insert the attachment. | |
| $attach_id = wp_insert_attachment( $attachment, $filename, $parent_post_id ); | |
| // Make sure that this file is included, as wp_generate_attachment_metadata() depends on it. | |
| require_once( ABSPATH . 'wp-admin/includes/image.php' ); | |
| // Generate the metadata for the attachment, and update the database record. | |
| $attach_data = wp_generate_attachment_metadata( $attach_id, $filename ); | |
| wp_update_attachment_metadata( $attach_id, $attach_data ); | |
| </pre> | |
| ==Note== | |
| Using the <code>_wp_relative_upload_path()</code> to build the guid may not be reliable on some servers. | |
| == Source File == | |
| <tt>wp_insert_attachment()</tt> is located in {{Trac|wp-includes/post.php|tags/3.8.1|3976}}. | |
| ==Related== | |
| [[Function Reference/wp get attachment url|wp_get_attachment_url()]], [[Function Reference/wp delete attachment|wp_delete_attachment()]], [[Function Reference/wp insert post|wp_insert_post()]] | |
| {{Tag Footer}} | |
| {{Copyedit}} | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="Category:Conditional_Tags" d:title="Category:Conditional Tags"> | |
| <d:index d:value="Category:Conditional Tags"/> | |
| <h1>Category:Conditional Tags</h1> | |
| <p>[[Category:Advanced Topics]] | |
| [[Category:Design and Layout]] | |
| [[Category:WordPress Development]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_front_page" d:title="is front page"> | |
| <d:index d:value="is front page"/> | |
| <h1>is front page</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/is_front_page}} | |
| {{zh-cn|Function_Reference/is_front_page}} | |
| {{ar|Function_Reference/is_front_page}} | |
| {{he|סימוכין פונקציות/is_front_page}} | |
| {{ja|関数リファレンス/is_front_page}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if the main page is a posts or a [[Pages|Page]]. This is a boolean function, meaning it returns either TRUE or FALSE. It returns TRUE when the main blog page is being displayed and the '''Settings->Reading->Front page displays''' is set to "Your latest posts", '''or''' when is set to "A static page" and the "Front Page" value is the current [[Pages|Page]] being displayed. | |
| ==Usage== | |
| %%%<?php is_front_page(); ?>%%% | |
| ==Parameters== | |
| This tag does not accept any parameters. | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| <!-- Need creative examples. Feel free add one. --> | |
| If you are using a static page as your front page, this is useful: | |
| %%% | |
| <title> | |
| <?php bloginfo('name'); ?> &raquo; <?php is_front_page() ? bloginfo('description') : wp_title(''); ?> | |
| </title> | |
| %%% | |
| ==Notes== | |
| * See Also: [[Function Reference/is home|is_home()]] | |
| ==Change Log== | |
| Since: 2.5.0 | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_front_page()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_single" d:title="is single"> | |
| <d:index d:value="is single"/> | |
| <h1>is single</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/is_single}} | |
| {{ru|Справочник_по_функциям/is single}} | |
| {{es|Function_Reference/is_single}} | |
| {{ja|関数リファレンス/is single}} | |
| {{ko|Function_Reference/is_single}} | |
| {{tr|Fonksiyon_Listesi/is_single}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|conditional tag]] checks if a single post of any [[Post Types|post type]] except [[Using Image and File Attachments|attachment]] and [[Pages|page]] post types is being displayed. If the <tt>$post</tt> parameter is specified, the function will additionally check if the [[Glossary#Query|query]] is for one of the posts specified. To check for all the post types, use the <tt>[[Function Reference/is singular|is_singular()]]</tt> function. | |
| ==Usage== | |
| %%%<?php is_single($post); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$post|mixed|Post ID, Post Title or Post Slug|optional}} | |
| ==Return Values== | |
| {{Return||boolean|''True'' on success, ''false'' on failure}}. | |
| ==Examples== | |
| is_single(); | |
| // When any single Post page is being displayed. | |
| is_single('17'); | |
| // When Post 17 (ID) is being displayed. | |
| is_single(17); | |
| // When Post 17 (ID) is being displayed. Integer parameter also works | |
| is_single('Irish Stew'); | |
| // When the Post with ''post_title'' of "Irish Stew" is being displayed. | |
| is_single('beef-stew'); | |
| // When the Post with ''post_name'' (slug) of "beef-stew" is being displayed. | |
| is_single(array(17,'beef-stew','Irish Stew')); | |
| // Returns true when the single post being displayed is either post ID 17, or the ''post_name'' is "beef-stew", or the ''post_title'' is "Irish Stew". Note: the array ability was added at [[Version 2.5]]. | |
| ==Notes== | |
| * See Also: [[Function Reference/is singular|is_singular()]] | |
| ==Change Log== | |
| Since: 1.5.0 | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_single()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_home" d:title="is home"> | |
| <d:index d:value="is home"/> | |
| <h1>is home</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/is_home}} | |
| {{zh-cn|Function_Reference/is_home}} | |
| {{he|סימוכין פונקציות/is_home}} | |
| {{ja|関数リファレンス/is_home}} | |
| {{tr|Fonksiyon_Listesi/is_home}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if the [[Template_Hierarchy#Home_Page_display|blog posts index page]] is being displayed. This is a Boolean function, meaning it returns either TRUE or FALSE. | |
| ==Usage== | |
| %%%<?php is_home(); ?>%%% | |
| ==Parameters== | |
| This tag does not accept any parameters. | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Blog Posts Index vs. Site Front Page== | |
| Since WordPress 2.1, when the static front page functionality was introduced, the blog posts index and site front page have been treated as two different query contexts, with <code>is_home()</code> applying to the blog posts index, and <code>is_front_page()</code> applying to the site front page. | |
| Be careful not to confuse the two query conditionals: | |
| * On the site front page, <code>is_front_page()</code> will always return <code>TRUE</code>, regardless of whether the site front page displays the blog posts index or a static page. | |
| * On the blog posts index, <code>is_home()</code> will always return <code>TRUE</code>, regardless of whether the blog posts index is displayed on the site front page or a separate page. | |
| Whether <code>is_home()</code> or <code>is_front_page()</code> return <code>TRUE</code> or <code>FALSE</code> depends on the values of certain option values: | |
| * <code>get_option( 'show_on_front' )</code>: returns either <code>'posts'</code> or <code>'page'</code> | |
| * <code>get_option( 'page_on_front' )</code>: returns the <code>ID</code> of the static page assigned to the front page | |
| * <code>get_option( 'page_for_posts' )</code>: returns the <code>ID</code> of the static page assigned to the blog posts index (posts page) | |
| When using these query conditionals: | |
| * If <code>'posts' == get_option( 'show_on_front' )</code>: | |
| ** On the site front page: | |
| *** <code>is_front_page()</code> will return <code>TRUE</code> | |
| *** <code>is_home()</code> will return <code>TRUE</code> | |
| ** If assigned, WordPress ignores the pages assigned to display the site front page or the blog posts index | |
| *If <code>'page' == get_option( 'show_on_front' )</code>: | |
| ** On the page assigned to display the site front page: | |
| *** <code>is_front_page()</code> will return <code>TRUE</code> | |
| *** <code>is_home()</code> will return <code>FALSE</code> | |
| ** On the page assigned to display the blog posts index: | |
| *** <code>is_front_page()</code> will return <code>FALSE</code> | |
| *** <code>is_home()</code> will return <code>TRUE</code> | |
| ==Examples== | |
| The following example can be used in your sidebar to display different content when displaying the blog posts index. | |
| %%% | |
| <?php | |
| if ( is_home() ) { | |
| // This is the blog posts index | |
| get_sidebar( 'blog' ); | |
| } else { | |
| // This is not the blog posts index | |
| get_sidebar(); | |
| } | |
| ?> | |
| %%% | |
| ==Notes== | |
| <code>is_home</code> uses the global <var>$wp_query</var> WP_Query object. <code>is_home</code> isn't usable before the [[Plugin API\Action Reference\parse_query|parse_query]] action. | |
| * See Also: [[Function Reference/is front page|is_front_page()]] | |
| ==Obsolete Usage== | |
| Prior to WordPress 2.1, WordPress did not have static front page functionality, which meant that the site front page and the blog posts index were always the same. Thus, <code>is_home()</code> always returned <code>TRUE</code> on the site front page. | |
| ==Change Log== | |
| Since: 1.5.0 | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_home()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_paged" d:title="is paged"> | |
| <d:index d:value="is paged"/> | |
| <h1>is paged</h1> | |
| <p>==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if page being displayed is "paged" and the current page number is greater than one. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| '''Note''': This refers to an archive or the main page being split up over several pages, this does '''not''' refer to a Post or [[Pages|Page]] whose content has been divided into pages using the <tt><!<nowiki></nowiki>--nextpage--></tt> [[Write Post SubPanel#Quicktags|QuickTag]]. | |
| ==Usage== | |
| %%%<?php is_paged(); ?>%%% | |
| ==Parameters== | |
| This tag does not accept any parameters. | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : <tt>true</tt> on success, <tt>false</tt> on failure. | |
| ==Examples== | |
| If you need to check which page of the blog you are on, you can look in $wp_query->query_vars['paged']. Remember that inside functions you might have to global $wp_query first. | |
| ==Notes== | |
| ==Change Log== | |
| * Since: [[Version 1.5|1.5.0]] | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_paged()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_page" d:title="is page"> | |
| <d:index d:value="is page"/> | |
| <h1>is page</h1> | |
| <p>==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if [[Pages]] are being displayed. This is a boolean function, meaning it returns either TRUE or FALSE. This tag must be used BEFORE [[The Loop]] and does not work inside The Loop (see [[#Notes|Notes]] below). | |
| ==Usage== | |
| %%%<?php is_page($page); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$page|mixed|Page ID, Page Title or Page Slug|optional}} | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : <tt>true</tt> on success, <tt>false</tt> on failure. | |
| ==Examples== | |
| is_page(); | |
| // When any single Page is being displayed. | |
| is_page( 42 ); | |
| // When Page 42 (ID) is being displayed. | |
| is_page( 'Contact' ); | |
| // When the Page with a ''post_title'' of "Contact" is being displayed. | |
| is_page( 'about-me' ); | |
| // When the Page with a ''post_name'' (slug) of "about-me" is being displayed. | |
| is_page( array( 42, 'about-me', 'Contact' ) ); | |
| // Returns true when the Pages displayed is either post ID 42, or ''post_name'' "about-me", or ''post_title'' "Contact". Note: the array ability was added at [[Version 2.5]]. | |
| ==== Testing for paginated Pages ==== | |
| You can use this code to check whether you're on the nth page in a Post or PAGE Page that has been divided into pages using the <tt><!<nowiki></nowiki>--nextpage--></tt> QuickTag. This can be useful, for example, if you wish to display meta-data only on the first page of a post divided into several pages. | |
| '''Example 1''' | |
| <pre><?php | |
| $paged = $wp_query->get( 'paged' ); | |
| if ( ! $paged || $paged < 2 ) | |
| { | |
| // This is not a paginated page (or it's simply the first page of a paginated page/post) | |
| } | |
| else | |
| { | |
| // This is a paginated page. | |
| } | |
| ?> | |
| </pre> | |
| '''Example 2''' | |
| <!-- Could someone please take a look at the difference between 'paged' & 'page'? I ran into some support requests, where people said it's 'page', not 'paged' --> | |
| <pre><?php | |
| $paged = get_query_var( 'paged' ) ? get_query_var( 'paged' ) : false; | |
| if ( $paged === false ) | |
| { | |
| // This is not a paginated page (or it's simply the first page of a paginated page/post) | |
| } | |
| else | |
| { | |
| // This is a paginated page. | |
| } | |
| ?></pre> | |
| ==== Testing for sub-Pages ==== | |
| There is no <tt>is_subpage()</tt> function yet, but you can test this with a little code: | |
| '''Snippet 1''' | |
| <pre><?php | |
| global $post; // if outside the loop | |
| if ( is_page() && $post->post_parent ) { | |
| // This is a subpage | |
| } else { | |
| // This is not a subpage | |
| } | |
| ?></pre> | |
| You can create your own is_subpage() function using the code in Snippet 2. Add it to your [http://codex.wordpress.org/Theme_Development#Theme_Functions_File functions.php] file. It tests for a parent page in the same way as Snippet 1, but will return the ID of the page parent if there is one, or <tt>false</tt> if there isn't. | |
| '''Snippet 2''' | |
| <pre> | |
| function is_subpage() { | |
| global $post; // load details about this page | |
| if ( is_page() && $post->post_parent ) { // test to see if the page has a parent | |
| return $post->post_parent; // return the ID of the parent post | |
| } else { // there is no parent so ... | |
| return false; // ... the answer to the question is false | |
| } | |
| } | |
| </pre> | |
| It is advisable to use a function like that in Snippet 2, rather than using the simple test like Snippet 1, if you plan to test for sub pages frequently. | |
| To test if the parent of a page is a specific page, for instance "About" (page id ''pid'' 2 by default), we can use the tests in Snippet 3. These tests check to see if we are looking at the page in question, as well as if we are looking at any child pages. This is useful for setting variables specific to different sections of a web site, so a different banner image, or a different heading. | |
| '''Snippet 3''' | |
| <pre> | |
| <?php | |
| if ( is_page( 'about' ) || '2' == $post->post_parent ) { | |
| // the page is "About", or the parent of the page is "About" | |
| $bannerimg = 'about.jpg'; | |
| } elseif ( is_page( 'learning' ) || '56' == $post->post_parent ) { | |
| $bannerimg = 'teaching.jpg'; | |
| } elseif ( is_page( 'admissions' ) || '15' == $post->post_parent ) { | |
| $bannerimg = 'admissions.jpg'; | |
| } else { | |
| $bannerimg = 'home.jpg'; // just in case we are at an unclassified page, perhaps the home page | |
| } | |
| ?> | |
| </pre> | |
| Snippet 4 is a function that allows you to carry out the tests above more easily. This function will return true if we are looking at the page in question (so "About") or one of its sub pages (so a page with a parent with ID "2"). | |
| '''Snippet 4''' | |
| <pre> | |
| function is_tree( $pid ) { // $pid = The ID of the page we're looking for pages underneath | |
| global $post; // load details about this page | |
| if ( is_page($pid) ) | |
| return true; // we're at the page or at a sub page | |
| $anc = get_post_ancestors( $post->ID ); | |
| foreach ( $anc as $ancestor ) { | |
| if( is_page() && $ancestor == $pid ) { | |
| return true; | |
| } | |
| } | |
| return false; // we arn't at the page, and the page is not an ancestor | |
| } | |
| </pre> | |
| Add Snippet 4 to your [http://codex.wordpress.org/Theme_Development#Theme_Functions_File functions.php] file, and call <tt>is_tree( 'id' )</tt> to see if the current page is the page, or is a sub page of the page. In Snippet 3, <tt>is_tree( '2' )</tt> would replace "<tt>is_page( 'about' ) || '2' == $post->post_parent</tt>" inside the first <tt>if</tt> tag. | |
| Note that if you have more than one level of pages the parent page is the one directly above and not the one at the very top of the hierarchy. | |
| ====Is a Page Template==== | |
| Allows you to determine whether or not you are in a page template or if a specific page template is being used. | |
| ; <tt>[http://codex.wordpress.org/Function_Reference/is_page_template is_page_template()]</tt> : Is a [[Page_Templates|Page Template]] being used? | |
| ; <tt>is_page_template( 'about.php' )</tt> : Is [[Page_Templates|Page Template]] 'about' being used? Note that unlike with other conditionals, if you want to specify a particular Page Template, you need to use the filename, such as about.php or my_page_template.php. Note: if the file is in a subdirectory you must include this as well. Meaning that this should be the filepath in relation to your theme as well as the filename, for example 'page-templates/about.php'. | |
| ==Notes== | |
| ===Passing Empty Value Returns TRUE=== | |
| Be very careful if there's a possibility of passing an empty value as a parameter to check for a specific page, since the following lines will return <tt>true</tt>: | |
| <pre>is_page( '' ) | |
| is_page( 0 ) | |
| is_page( '0' ) | |
| is_page( null ) | |
| is_page( false ) | |
| is_page( array() )</pre> | |
| * See also: [[Function Reference/is singular|is_singular()]] | |
| ===Cannot Be Used Inside The Loop=== | |
| Due to certain global variables being overwritten during The Loop <code>is_page()</code> will not work. In order to use it after The Loop you must call [[Function_Reference/wp_reset_query| wp_reset_query()]] after The Loop. | |
| * See also [[Function_Reference/is_page_template|is_page_template()]] | |
| ==Change Log== | |
| Since: 1.5.0 | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_page()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_page_template" d:title="is page template"> | |
| <d:index d:value="is page template"/> | |
| <h1>is page template</h1> | |
| <p>==Description== | |
| This [[Conditional Tags|Conditional Tag]] allows you to determine if you are in any page template. Optionally checks if a specific [[Page_Templates|Page Template]] is being used in a [[Pages|Page]]. This is a boolean function, meaning it returns either TRUE or FALSE. This tag must be used BEFORE [[The Loop]] and does not work inside The Loop (see [[#Notes|Notes]] below). | |
| ==Usage== | |
| %%%<?php is_page_template( $template ); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$template|string|Full template filename with ext|optional}} | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| Is [[Page_Templates|Page Template]] 'about' being used? Note that unlike with other conditionals, if you want to specify a particular Page Template, you need to use the filename, such as about.php or my_page_template.php. | |
| <pre> | |
| if ( is_page_template( 'about.php' ) ) { | |
| // Returns true when 'about.php' is being used. | |
| } else { | |
| // Returns false when 'about.php' is not being used. | |
| } | |
| </pre> | |
| ==Notes== | |
| ===Page template in subdirectory === | |
| If the page template is located in a subdirectory of the theme (since WP 3.4), prepend the folder name and a slash to the template filename, e.g.: | |
| <pre> | |
| is_page_template( 'templates/about.php' ); | |
| </pre> | |
| ===Cannot Be Used Inside The Loop=== | |
| Due to certain global variables being overwritten during The Loop <code>is_page_template()</code> will not work. In order to use it after The Loop you must call [[Function_Reference/wp_reset_query|wp_reset_query()]] after The Loop. | |
| ====Alternative==== | |
| Since the page template slug is stored inside the <tt>post_meta</tt> for any post that has been assigned to a page template, it is possible to directly query the <tt>post_meta</tt> to see whether any given page has been assigned a page template. This is the method that <tt>is_page_template()</tt> uses internally. | |
| The function [[Function_Reference/get_page_template_slug|get_page_template_slug( $post_id )]] will return the slug of the currently assigned page template (or an empty string if no template has been assigned - or <tt>false</tt> if the <tt>$post_id</tt> does not correspond to an actual <tt>page</tt>). You can easily use this anywhere (in The Loop, or outside) to determine whether any page has been assigned a page template. | |
| <pre> | |
| <?php | |
| // in the loop: | |
| if ( get_page_template_slug( get_the_ID() ) ){ | |
| // Yep, this page has a page template | |
| } | |
| // anywhere: | |
| if ( get_page_template_slug( $some_post_ID ) ){ | |
| // Uh-huh. | |
| } | |
| ?> | |
| </pre> | |
| * See also [[Function_Reference/is_page|is_page()]] | |
| ==Change Log== | |
| Since: 2.5.0 | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_page_template()</tt> is located in {{Trac|wp-includes/post-template.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_search" d:title="is search"> | |
| <d:index d:value="is search"/> | |
| <h1>is search</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/is_search}} | |
| {{ja|関数リファレンス/is_search}} | |
| {{he|סימוכין פונקציות/is_search}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if search result page archive is being displayed. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| ==Usage== | |
| %%%<?php is_search(); ?>%%% | |
| ==Parameters== | |
| This tag does not accept any parameters. | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| %%% | |
| <?php | |
| if ( is_search() ) { | |
| // add external search form (Google, Yahoo, Bing...) | |
| } | |
| ?> | |
| %%% | |
| ==Notes== | |
| ==Change Log== | |
| Since: 1.5.0 | |
| ==Source File== | |
| <tt>is_search()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_404" d:title="is 404"> | |
| <d:index d:value="is 404"/> | |
| <h1>is 404</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/is_404}} | |
| {{he|סימוכין פונקציות/is_404}} | |
| {{ja|関数リファレンス/is_404}} | |
| {{pt-br|Funções e Referências/is_404}} | |
| {{tr|Fonksiyon_Listesi/is_404}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if 404 error is being displayed (after an "HTTP 404: Not Found" error occurs). This is a boolean function, meaning it returns either TRUE or FALSE. | |
| ==Usage== | |
| %%%<?php is_404(); ?>%%% | |
| ==Parameters== | |
| This tag does not accept any parameters. | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| %%% | |
| <?php | |
| if ( is_404() ) { | |
| // add search form so that users can search other posts | |
| } | |
| ?> | |
| %%% | |
| ==Notes== | |
| ==Change Log== | |
| Since: 1.5.0 | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_404()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_archive" d:title="is archive"> | |
| <d:index d:value="is archive"/> | |
| <h1>is archive</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/is_archive}} | |
| {{ja|関数リファレンス/is_archive}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if any type of Archive page is being displayed. An Archive is a [[Function Reference/is category|Category]], [[Function Reference/is tag|Tag]], [[Function Reference/is author|Author]] or a [[Function Reference/is date|Date]] based pages. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| ==Usage== | |
| %%%<?php is_archive(); ?>%%% | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| %%%<?php | |
| if(is_archive()) | |
| // write your code here ... | |
| ?>%%% | |
| ==Notes== | |
| ===Custom Post Types=== | |
| is_archive() does not accept any parameters. If you want to check if this is the archive of a custom post type, use [http://codex.wordpress.org/Function_Reference/is_post_type_archive is_post_type_archive( $post_type )] | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_archive()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_category" d:title="is category"> | |
| <d:index d:value="is category"/> | |
| <h1>is category</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/is_category}} | |
| {{ja|関数リファレンス/is_category}} | |
| {{ru|Справочник_по_функциям/is_category}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if a Category archive page is being displayed. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| To test if a post <i>is in</i> a category use [[Function Reference/in_category| in_category()]]. | |
| ==Usage== | |
| %%%<?php is_category( $category ); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$category|mixed|Category ID, Category Title, Category Slug or Array of IDs, names, and slugs.|optional}} | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| is_category(); | |
| // When any Category archive page is being displayed. | |
| is_category( '9' ); | |
| // When the archive page for Category 9 is being displayed. | |
| is_category( 'Stinky Cheeses' ); | |
| // When the archive page for the Category with Name "Stinky Cheeses" is being displayed. | |
| is_category( 'blue-cheese' ); | |
| // When the archive page for the Category with Category Slug "blue-cheese" is being displayed. | |
| is_category( array( 9, 'blue-cheese', 'Stinky Cheeses' ) ); | |
| // Returns true when the category of posts being displayed is either term_ID 9, or ''slug'' "blue-cheese", or ''name'' "Stinky Cheeses". Note: the array ability was added at [[Version 2.5]]. | |
| ==Notes== | |
| * See also <tt>[[Function Reference/is_archive|is_archive()]]</tt> and [[Category Templates]]. | |
| * For [[Taxonomies#Custom_Taxonomies|Custom Taxonomies]] use [[Function Reference/is_tax|is_tax()]] | |
| ==Change Log== | |
| * Since: [[Version 1.5|1.5.0]] | |
| == Source File == | |
| <tt>is_category()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_tag" d:title="is tag"> | |
| <d:index d:value="is tag"/> | |
| <h1>is tag</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/is tag}} | |
| {{ja|関数リファレンス/is tag}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if a Tag archive page is being displayed. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| ==Usage== | |
| %%%<?php is_tag( $tag ); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$tag|mixed|Tag ID, name, slug, or array of id's, names, and slugs.|optional}} | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| is_tag(); | |
| // When any Tag archive page is being displayed. | |
| is_tag( '30' ); | |
| // When the archive page for Tag 30 is being displayed. | |
| is_tag( 'extreme' ); | |
| // When the archive page for tag with the Slug of 'extreme' is being displayed. | |
| is_tag( 'mild' ); | |
| // When the archive page for tag with the Name of 'mild' is being displayed. | |
| is_tag( array( 30, 'mild', 'extreme' ) ); | |
| // Returns true when the tag of posts being displayed is either term_ID 30, or ''slug'' "extreme", or ''name'' "mild". Note: the array ability was added at [[Version 3.7]]. | |
| ==Notes== | |
| * See also <tt>[[Function Reference/is_archive|is_archive()]]</tt> and [[Tag Templates]]. | |
| ==Change Log== | |
| * Since: [[Version 2.3|2.3.0]] | |
| * [[Version 3.7|3.7.0]]: Make <tt>$tag</tt> parameter recieve tag ID, name, slug, or array of tag IDs, names, and slugs. | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_tag()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Tag Tags}} | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_author" d:title="is author"> | |
| <d:index d:value="is author"/> | |
| <h1>is author</h1> | |
| <p>{{Languages| | |
| {{en|is_author}} | |
| {{ja|関数リファレンス/is_author}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if an Author archive page is being displayed. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| ==Usage== | |
| %%%<?php is_author($author); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$author|mixed|Author ID or Author Nickname|optional}} | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| is_author(); | |
| // When any Author page is being displayed. | |
| is_author('4'); | |
| // When the archive page for Author number (ID) 4 is being displayed. | |
| is_author('Vivian'); | |
| // When the archive page for the Author with Nickname "Vivian" is being displayed. | |
| is_author('john-jones'); | |
| // When the archive page for the Author with Nicename "john-jones" is being displayed. | |
| is_author(array(4,'john-jones','Vivian')); | |
| // When the archive page for the author is either user ID 4, or ''user_nicename'' "john-jones", or ''nickname'' "Vivian". Note: the array ability was added at [[Version 2.5]]. | |
| ==Notes== | |
| * See also <tt>[[Function Reference/is_archive|is_archive()]]</tt> and [[Category Templates]]. | |
| ==Change Log== | |
| Since: [[Version 1.5]] | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_author()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_date" d:title="is date"> | |
| <d:index d:value="is date"/> | |
| <h1>is date</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/is_date}} | |
| {{ja|関数リファレンス/is_date}} | |
| }} | |
| ==Description== | |
| Test to see if the page is a date based archive page. Similar to [[Function_Reference/is_category|is_category()]] | |
| ==Usage== | |
| %%%<?php is_date(); ?>%%% | |
| ==Parameters== | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| ==Notes== | |
| * See also <tt>[[Function Reference/is_archive|is_archive()]]</tt> and [[Category Templates]]. | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_date()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_year" d:title="is year"> | |
| <d:index d:value="is year"/> | |
| <h1>is year</h1> | |
| <p>==Description== | |
| Test to see if the page is a year based archive page. | |
| ==Usage== | |
| %%%<?php is_year(); ?>%%% | |
| ==Parameters== | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| ==Notes== | |
| * See also <tt>[[Function Reference/is_archive|is_archive()]]</tt> and [[Category Templates]]. | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_year()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_month" d:title="is month"> | |
| <d:index d:value="is month"/> | |
| <h1>is month</h1> | |
| <p>==Description== | |
| Test to see if the page is a month based archive page. | |
| ==Usage== | |
| %%%<?php is_month(); ?>%%% | |
| ==Parameters== | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| ==Notes== | |
| * See also <tt>[[Function Reference/is_archive|is_archive()]]</tt> and [[Category Templates]]. | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_month()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_day" d:title="is day"> | |
| <d:index d:value="is day"/> | |
| <h1>is day</h1> | |
| <p>==Description== | |
| Test to see if the page is a date based archive page. | |
| ==Usage== | |
| %%%<?php is_day(); ?>%%% | |
| ==Parameters== | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| ==Notes== | |
| * See also <tt>[[Function Reference/is_archive|is_archive()]]</tt> and [[Category Templates]]. | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_day()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_time" d:title="is time"> | |
| <d:index d:value="is time"/> | |
| <h1>is time</h1> | |
| <p>==Description== | |
| Test to see if the page is a time based archive page. | |
| ==Usage== | |
| %%%<?php is_time(); ?>%%% | |
| ==Parameters== | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| ==Notes== | |
| * See also <tt>[[Function Reference/is_archive|is_archive()]]</tt> and [[Category Templates]]. | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_time()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_attachment" d:title="is attachment"> | |
| <d:index d:value="is attachment"/> | |
| <h1>is attachment</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/is_ attachment}} | |
| {{it|Riferimento funzioni/is_ attachment}} | |
| {{ja|関数リファレンス/is_ attachment}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if an attachment is being displayed. An attachment is an image or other file uploaded through the post editor's upload utility. Attachments can be displayed on their own 'page' or template. For more information, see [[Using Image and File Attachments]]. | |
| This is a boolean function, meaning it returns either TRUE or FALSE. | |
| ==Usage== | |
| %%%<?php is_attachment(); ?>%%% | |
| ==Parameters== | |
| ==Return Values== | |
| {{Return||boolean|True on success, false on failure.}} | |
| ==Examples== | |
| <pre> | |
| <?php | |
| if ( is_attachment() ) { | |
| // show adv. #1 | |
| } else { | |
| // show adv. #2 | |
| } | |
| ?> | |
| </pre> | |
| ==Notes== | |
| * See Also: [[Function Reference/is singular|is_singular()]] | |
| * For more specific checking of the attachment see: [[Function Reference/wp attachment is image]] | |
| ==Change Log== | |
| Since: 2.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_attachment()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_admin" d:title="is admin"> | |
| <d:index d:value="is admin"/> | |
| <h1>is admin</h1> | |
| <p>==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if the Dashboard or the administration panel is attempting to be displayed. It ''should not'' be used as a means to verify whether the current user has permission to view the Dashboard or the administration panel (try [[Function_Reference/current_user_can|current_user_can()]] instead). This is a boolean function that will return <tt>true</tt> if the URL being accessed is in the admin section, or <tt>false</tt> for a front-end page. | |
| ==Usage== | |
| %%%<?php is_admin(); ?>%%% | |
| ==Parameters== | |
| This tag does not accept any parameters. | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| <pre> | |
| if ( ! is_admin() ) { | |
| echo "You are viewing the theme"; | |
| } else { | |
| echo "You are viewing the WordPress Administration Panels"; | |
| } | |
| </pre> | |
| ==Notes== | |
| * <tt>is_admin()</tt> will return <tt>false</tt> when trying to access wp-login.php. | |
| * <tt>is_admin()</tt> will return <tt>true</tt> when trying to make an ajax request. | |
| * <tt>is_admin()</tt> will return <tt>true</tt> for calls to load-scripts.php and load-styles.php. | |
| * <tt>is_admin()</tt> is ''not'' intended to be used for security checks. It will return true whenever the current URL is for a page on the admin side of WordPress. It does not check if the user is logged in, nor if the user even has access to the page being requested. It is a convenience function for plugins and themes to use for various purposes, but it is not suitable for validating secured requests. | |
| ==Change Log== | |
| Since: 1.5.1 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_admin()</tt> is located in {{Trac|wp-includes/load.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_preview" d:title="is preview"> | |
| <d:index d:value="is preview"/> | |
| <h1>is preview</h1> | |
| <p>==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if the currently displayed post, page or post type is a preview. This is a boolean function that will return the value of the <tt>preview</tt> query value, which is either <tt>true</tt> or <tt>false</tt> for a front-end page. | |
| ==Usage== | |
| %%%<?php is_preview(); ?>%%% | |
| ==Parameters== | |
| This tag does not accept any parameters. | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| <pre>if ( ! is_preview() ) { | |
| // Include analytics code | |
| }</pre> | |
| ==Notes== | |
| ==Change Log== | |
| Since: 2.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_preview()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_feed" d:title="is feed"> | |
| <d:index d:value="is feed"/> | |
| <h1>is feed</h1> | |
| <p>==Description== | |
| Can be used to determine if the current query is for a [[WordPress_Feeds|feed]] (e.g. RSS). | |
| ==Usage== | |
| %%%<?php | |
| if ( is_feed( $feeds ) ) { | |
| //Do stuff | |
| } | |
| ?>%%% | |
| ==Parameters== | |
| {{Parameter|$feeds|array/string|Feed type(s) to check.|optional}} | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| ==Notes== | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_feed()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_trackback" d:title="is trackback"> | |
| <d:index d:value="is trackback"/> | |
| <h1>is trackback</h1> | |
| <p>==Description== | |
| ==Usage== | |
| %%%<?php is_trackback(); ?>%%% | |
| ==Parameters== | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| ==Notes== | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_trackback()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="comments_open" d:title="comments open"> | |
| <d:index d:value="comments open"/> | |
| <h1>comments open</h1> | |
| <p>==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if comments are allowed for the current Post or a given Post ID. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| ==Usage== | |
| %%%<?php comments_open( $post_id ); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$post_id|integer|The post ID|optional|0}} | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| With this code you can always disable comments on pages, assuming your theme uses comments_open() to check if the comments are open. | |
| <pre> | |
| add_filter( 'comments_open', 'my_comments_open', 10, 2 ); | |
| function my_comments_open( $open, $post_id ) { | |
| $post = get_post( $post_id ); | |
| if ( 'page' == $post->post_type ) | |
| $open = false; | |
| return $open; | |
| } | |
| </pre> | |
| With this code you can enable comments on a post that has custom field "Allow Comments" set | |
| to 1. This is helpful when you have told WordPress to disable comments for posts that are older than X days but wish to enable comments for a handful of old posts. | |
| <pre> | |
| add_filter( 'comments_open', 'my_comments_open', 10, 2 ); | |
| function my_comments_open( $open, $post_id ) { | |
| $post = get_post( $post_id ); | |
| if (get_post_meta($post->ID, 'Allow Comments', true)) {$open = true;} | |
| return $open; | |
| } | |
| </pre> | |
| '''Enqueuing a script only if we're seeing a single post and comments are open for the current post''' | |
| <pre> | |
| add_action( 'wp_print_scripts', 'myplugin_scripts' ); | |
| function myplugin_scripts(){ | |
| if ( is_single() && comments_open() ) { | |
| // myplugin_script must have been previously registered via wp_register_script() | |
| wp_enqueue_script( 'myplugin_script' ); | |
| } | |
| } | |
| </pre> | |
| ==Notes== | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>comments_open()</tt> is located in {{Trac|wp-includes/comment-template.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="pings_open" d:title="pings open"> | |
| <d:index d:value="pings open"/> | |
| <h1>pings open</h1> | |
| <p>==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if trackbacks are allowed for the current Post or a given Post ID. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| ==Usage== | |
| %%%<?php pings_open( $post_id ); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$post_id|integer|The post ID|optional|0}} | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| ==Notes== | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>pings_open()</tt> is located in {{Trac|wp-includes/comment-template.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="Function_Reference" d:title="Function Reference"> | |
| <d:index d:value="Function Reference"/> | |
| <h1>Function Reference</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference}} | |
| {{es|Referencia de Funciones}} | |
| {{fax|Function_Reference}} | |
| {{fr|Fonctions de référence}} | |
| {{it|Riferimento funzioni}} | |
| {{ja|関数リファレンス}} | |
| {{ka|ფუნქციების ცნობარი}} | |
| {{ko|Function_Reference}} | |
| {{pt-br|Referência_de_Funções}} | |
| {{ru|Справочник по функциям}} | |
| {{tr|Fonksiyon Listesi}} | |
| {{he|Function Reference}} | |
| {{zh-hans|函数参考}} | |
| {{zh-tw|函數參考}} | |
| }} | |
| __TOC__ | |
| The files of WordPress define many useful PHP functions. Some of the functions, known as [[Template Tags]], are defined especially for use in WordPress Themes. There are also some functions related to actions and filters (the [[Plugin API]]), which are therefore used primarily for developing Plugins. The rest are used to create the core WordPress functionality. | |
| Many of the core WordPress functions are useful to Plugin and Theme developers. So, this article lists most of the core functions, excluding Template Tags. At the bottom of the page, there is a section listing other resources for finding information about WordPress functions. In addition to this information, the [http://phpdoc.wordpress.org/ WordPress phpdoc site] details all the WordPress functions by version since 2.6.1. | |
| <!-- remove the DIV below after there's enough example content --> | |
| <div style="border:#CCCCCC 1px solid; padding:10px; background:#FAEBD7;"> | |
| '''You can help make this page more complete!''' | |
| Here are some things you can do to help: | |
| * Add documentation to un-documented functions, by creating sub-pages or at least by adding short comments in the lists below. If you create a subpage for a function, please include information and examples of usage of that function, if possible, per the examples found in [[Template Tags]]. | |
| * List more functions here, following the category structure. | |
| * Correct errors by moving functions to better categories where appropriate, and of course fixing typos. Note: that it is OK for a function to appear in more than one category. | |
| Read [[Contributing to WordPress]] to find out more about how you can contribute to the effort! | |
| </div> | |
| ==Functions by category== | |
| {| cellspacing="10" width="100%" | |
| |- valign="top" | |
| | width="50%" | | |
| {| class="widefat" | |
| |- style="background:#464646;" | |
| ! | |
| === <span style="color:#d7d7d7;">Post, Custom Post Type, Page, Attachment and Bookmarks Functions</span> === | |
| |- | |
| | | |
| '''Posts''' | |
| * <tt>[[Function Reference/get_adjacent_post|get_adjacent_post]]</tt> | |
| * <tt>[[Function Reference/get_boundary_post|get_boundary_post]]</tt> | |
| * <tt>[[Function Reference/get_children|get_children]]</tt> | |
| * <tt>[[Function Reference/get_extended|get_extended]]</tt> | |
| * <tt>[[Function Reference/get_next_post|get_next_post]]</tt> | |
| * <tt>[[Function Reference/get_next_posts_link|get_next_posts_link]]</tt> | |
| * <tt>[[Function Reference/next_posts_link|next_posts_link]]</tt> | |
| * <tt>[[Function Reference/get_permalink|get_permalink]]</tt> | |
| * <tt>[[Function Reference/the_permalink|the_permalink]]</tt> | |
| * <tt>[[Function Reference/get_the_excerpt|get_the_excerpt]]</tt> | |
| * <tt>[[Function Reference/the_excerpt|the_excerpt]]</tt> | |
| * <tt>[[Function Reference/get_the_post_thumbnail|get_the_post_thumbnail]]</tt> | |
| * <tt>[[Function Reference/get_post|get_post]]</tt> | |
| * <tt>[[Function Reference/get_post_field|get_post_field]]</tt> | |
| * <tt>[[Function Reference/get_post_ancestors|get_post_ancestors]]</tt> | |
| * <tt>[[Function Reference/get_post_mime_type|get_post_mime_type]]</tt> | |
| * <tt>[[Function Reference/get_post_status|get_post_status]]</tt> | |
| * <tt>[[Function Reference/get_post_format|get_post_format]]</tt> | |
| * <tt>[[Function Reference/set_post_format|set_post_format]]</tt> | |
| * <tt>[[Template_Tags/get_edit_post_link|get_edit_post_link]]</tt> | |
| * <tt>[[Function Reference/get_delete_post_link|get_delete_post_link]]</tt> | |
| * <tt>[[Function Reference/get_previous_post|get_previous_post]]</tt> | |
| * <tt>[[Function Reference/get_previous_posts_link|get_previous_posts_link]]</tt> | |
| * <tt>[[Function Reference/previous_posts_link|previous_posts_link]]</tt> | |
| * <tt>[[Template Tags/get_posts|get_posts]]</tt> | |
| * <tt>[[Function Reference/have_posts|have_posts]]</tt> | |
| * <tt>[[Function Reference/is_post|is_post]]</tt> (deprecated) | |
| * <tt>[[Function Reference/is_single|is_single]]</tt> | |
| * <tt>[[Function Reference/is_sticky|is_sticky]]</tt> | |
| * <tt>[[Function Reference/get_the_ID|get_the_ID]]</tt> | |
| * <tt>[[Function Reference/the_ID|the_ID]]</tt> | |
| * <tt>[[Function Reference/the_post|the_post]]</tt> | |
| * <tt>[[Function Reference/wp_get_recent_posts|wp_get_recent_posts]]</tt> | |
| * <tt>[[Function Reference/wp_get_single_post|wp_get_single_post]]</tt> (deprecated) | |
| * <tt>[[Function Reference/has_post_thumbnail|has_post_thumbnail]]</tt> | |
| * <tt>[[Function Reference/has_excerpt|has_excerpt]]</tt> | |
| * <tt>[[Function Reference/has_post_format|has_post_format]]</tt> | |
| '''Custom Post Type''' | |
| * <tt>[[Function Reference/register_post_type|register_post_type]]</tt> | |
| * <tt>[[Function Reference/is_post_type_archive|is_post_type_archive]]</tt> | |
| * <tt>[[Function Reference/post_type_archive_title|post_type_archive_title]]</tt> | |
| * <tt>[[Function Reference/add_post_type_support|add_post_type_support]]</tt> | |
| * <tt>[[Function Reference/remove_post_type_support|remove_post_type_support]]</tt> | |
| * <tt>[[Function Reference/post_type_supports|post_type_supports]]</tt> | |
| * <tt>[[Function Reference/set_post_type|set_post_type]]</tt> | |
| * <tt>[[Function Reference/post_type_exists|post_type_exists]]</tt> | |
| * <tt>[[Function Reference/get_post_type|get_post_type]]</tt> | |
| * <tt>[[Function Reference/get_post_types|get_post_types]]</tt> | |
| * <tt>[[Function Reference/get_post_type_archive_link|get_post_type_archive_link]]</tt> | |
| * <tt>[[Function Reference/get_post_type_object|get_post_type_object]]</tt> | |
| * <tt>[[Function Reference/get_post_type_capabilities|get_post_type_capabilities]]</tt> | |
| * <tt>[[Function Reference/get_post_type_labels|get_post_type_labels]]</tt> | |
| * <tt>[[Function Reference/is_post_type_hierarchical|is_post_type_hierarchical]]</tt> | |
| '''Post insertion/removal''' | |
| * <tt>[[Function Reference/wp_delete_post|wp_delete_post]]</tt> | |
| * <tt>[[Function Reference/wp_insert_post|wp_insert_post]]</tt> | |
| * <tt>[[Function Reference/wp_publish_post|wp_publish_post]]</tt> | |
| * <tt>[[Function Reference/wp_trash_post|wp_trash_post]]</tt> | |
| * <tt>[[Function Reference/wp_update_post|wp_update_post]]</tt> | |
| '''Pages''' | |
| * <tt>[[Function Reference/get_all_page_ids|get_all_page_ids]]</tt> | |
| * <tt>[[Function Reference/get_ancestors|get_ancestors]]</tt> | |
| * <tt>[[Function Reference/get_page|get_page]]</tt> (deprecated) | |
| * <tt>[[Function Reference/get_page_link|get_page_link]]</tt> | |
| * <tt>[[Function Reference/get_page_by_path|get_page_by_path]]</tt> | |
| * <tt>[[Function Reference/get_page_by_title|get_page_by_title]]</tt> | |
| * <tt>[[Function Reference/get_page_children|get_page_children]]</tt> | |
| * <tt>[[Function Reference/get_page_hierarchy|get_page_hierarchy]]</tt> | |
| * <tt>[[Function Reference/get_page_uri|get_page_uri]]</tt> | |
| * <tt>[[Function Reference/get_pages|get_pages]]</tt> | |
| * <tt>[[Function Reference/is_page|is_page]]</tt> | |
| * <tt>[[Function Reference/page_uri_index|page_uri_index]]</tt> (method of class WP_Rewrite) | |
| * <tt>[[Function Reference/wp_link_pages|wp_link_pages]]</tt> | |
| * <tt>[[Template Tags/wp_list_pages|wp_list_pages]]</tt> | |
| * <tt>[[Template Tags/wp_page_menu|wp_page_menu]]</tt> | |
| * <tt>[[Function Reference/wp_dropdown_pages|wp_dropdown_pages]]</tt> | |
| '''Custom Fields (postmeta)''' | |
| * <tt>[[Function Reference/add_post_meta|add_post_meta]]</tt> | |
| * <tt>[[Function Reference/delete_post_meta|delete_post_meta]]</tt> | |
| * <tt>[[Function Reference/get_post_custom|get_post_custom]]</tt> | |
| * <tt>[[Function Reference/get_post_custom_keys|get_post_custom_keys]]</tt> | |
| * <tt>[[Function Reference/get_post_custom_values|get_post_custom_values]]</tt> | |
| * <tt>[[Function Reference/get_post_meta|get_post_meta]]</tt> | |
| * <tt>[[Function Reference/update_post_meta|update_post_meta]]</tt> | |
| '''Attachments''' | |
| * <tt>[[Function Reference/get_attached_file|get_attached_file]]</tt> | |
| * <tt>[[Function Reference/image_resize|image_resize]]</tt> (deprecated) | |
| * <tt>[[Function reference/image_edit_before_change|image_edit_before_change]]</tt> (ported to [[Class Reference/WP_Image_Editor|WP_Image_Editor]] object) | |
| * <tt>[[Function Reference/is_attachment|is_attachment]]</tt> | |
| * <tt>[[Function Reference/is_local_attachment|is_local_attachment]]</tt> | |
| * <tt>[[Function Reference/set_post_thumbnail|set_post_thumbnail]]</tt> | |
| * <tt>[[Function Reference/update_attached_file|update_attached_file]]</tt> | |
| * <tt>[[Function Reference/wp_attachment_is_image|wp_attachment_is_image]]</tt> | |
| * <tt>[[Function Reference/wp_create_thumbnail|wp_create_thumbnail]]</tt> (deprecated) | |
| * <tt>[[Function Reference/wp_insert_attachment|wp_insert_attachment]]</tt> | |
| * <tt>[[Function Reference/wp_delete_attachment|wp_delete_attachment]]</tt> | |
| * <tt>[[Function Reference/wp_get_attachment_image|wp_get_attachment_image]]</tt> | |
| * <tt>[[Function Reference/wp_get_attachment_link|wp_get_attachment_link]]</tt> | |
| * <tt>[[Function Reference/wp_get_attachment_image_src|wp_get_attachment_image_src]]</tt> | |
| * <tt>[[Function Reference/wp_get_attachment_metadata|wp_get_attachment_metadata]]</tt> | |
| * <tt>[[Function Reference/wp_get_attachment_thumb_file|wp_get_attachment_thumb_file]]</tt> | |
| * <tt>[[Function Reference/wp_get_attachment_thumb_url|wp_get_attachment_thumb_url]]</tt> | |
| * <tt>[[Function Reference/wp_get_attachment_url|wp_get_attachment_url]]</tt> | |
| * <tt>[[Function Reference/wp_check_for_changed_slugs|wp_check_for_changed_slugs]]</tt> | |
| * <tt>[[Function Reference/wp_count_posts|wp_count_posts]]</tt> | |
| * <tt>[[Function Reference/wp_get_mime_types|wp_get_mime_types]]</tt> | |
| * <tt>[[Function Reference/wp_mime_type_icon|wp_mime_type_icon]]</tt> | |
| * <tt>[[Function Reference/wp_generate_attachment_metadata|wp_generate_attachment_metadata]]</tt> | |
| * <tt>[[Function Reference/wp_prepare_attachment_for_js|wp_prepare_attachment_for_js]]</tt> | |
| * <tt>[[Function Reference/wp_update_attachment_metadata|wp_update_attachment_metadata]]</tt> | |
| '''Bookmarks''' | |
| * <tt>[[Function Reference/get_bookmark|get_bookmark]]</tt> | |
| * <tt>[[Function_Reference/get_bookmarks|get_bookmarks]]</tt> | |
| * <tt>[[Template_Tags/wp_list_bookmarks|wp_list_bookmarks]]</tt> | |
| '''Terms''' | |
| * <tt>[[Function Reference/wp_get_post_categories|wp_get_post_categories]]</tt> | |
| * <tt>[[Function Reference/wp_set_post_categories|wp_set_post_categories]]</tt> | |
| * <tt>[[Function Reference/wp_get_post_tags|wp_get_post_tags]]</tt> | |
| * <tt>[[Function Reference/wp_set_post_tags|wp_set_post_tags]]</tt> | |
| * <tt>[[Function Reference/wp_get_post_terms|wp_get_post_terms]]</tt> | |
| * <tt>[[Function Reference/wp_set_post_terms|wp_set_post_terms]]</tt> | |
| * <tt>[[Function Reference/wp_count_terms|wp_count_terms]]</tt> | |
| * <tt>[[Function Reference/has_term|has_term]]</tt> | |
| * <tt>[[Function Reference/is_object_in_term|is_object_in_term]]</tt> | |
| '''Others''' | |
| * <tt>[[Function Reference/add_meta_box|add_meta_box]]</tt> | |
| * <tt>[[Function Reference/remove_meta_box|remove_meta_box]]</tt> | |
| * <tt>[[Function Reference/get_the_ID|get_the_ID]]</tt> | |
| * <tt>[[Function Reference/the_ID|the_ID]]</tt> | |
| * <tt>[[Function Reference/get_the_author|get_the_author]]</tt> | |
| * <tt>[[Function Reference/the_author|the_author]]</tt> | |
| * <tt>[[Function Reference/get_the_author_posts|get_the_author_posts]]</tt> | |
| * <tt>[[Function Reference/get_the_content|get_the_content]]</tt> | |
| * <tt>[[Function Reference/the_content|the_content]]</tt> | |
| * <tt>[[Function Reference/get_the_title|get_the_title]]</tt> | |
| * <tt>[[Function Reference/the_title|the_title]]</tt> | |
| * <tt>[[Function Reference/the_title_attribute|the_title_attribute]]</tt> | |
| * <tt>[[Function Reference/register_post_status|register_post_status]]</tt> | |
| * <tt>[[Function Reference/wp_trim_excerpt|wp_trim_excerpt]]</tt> | |
| * <tt>[[Function Reference/wp_get_post_revision|wp_get_post_revision]]</tt> | |
| * <tt>[[Function Reference/wp_get_post_revisions|wp_get_post_revisions]]</tt> | |
| * <tt>[[Function Reference/wp_is_post_revision|wp_is_post_revision]]</tt> | |
| * <tt>[[Function Reference/paginate_links|paginate_links]]</tt> | |
| |} | |
| | width="50%" | | |
| {| class="widefat" | |
| |- style="background:#464646;" | |
| ! | |
| === <span style="color:#d7d7d7;">Category, Tag and Taxonomy Functions</span> === | |
| |- | |
| | | |
| '''Categories''' | |
| * <tt>[[Function Reference/cat_is_ancestor_of|cat_is_ancestor_of]]</tt> | |
| * <tt>[[Function Reference/get_all_category_ids|get_all_category_ids]]</tt> | |
| * <tt>[[Function Reference/get_ancestors|get_ancestors]]</tt> | |
| * <tt>[[Function Reference/get_cat_ID|get_cat_ID]]</tt> | |
| * <tt>[[Function Reference/get_cat_name|get_cat_name]]</tt> | |
| * <tt>[[Function Reference/get_categories|get_categories]]</tt> | |
| * <tt>[[Function Reference/get_category|get_category]]</tt> | |
| * <tt>[[Function Reference/get_category_by_path|get_category_by_path]]</tt> | |
| * <tt>[[Function Reference/get_category_by_slug|get_category_by_slug]]</tt> | |
| * <tt>[[Function Reference/get_the_category_by_ID|get_the_category_by_ID]]</tt> | |
| * <tt>[[Function Reference/get_the_category_list|get_the_category_list]]</tt> | |
| * <tt>[[Function Reference/get_category_link| get_category_link]]</tt> | |
| * <tt>[[Function Reference/get_category_parents|get_category_parents]]</tt> | |
| * <tt>[[Function Reference/get_the_category|get_the_category]]</tt> | |
| * <tt>[[Function Reference/single_cat_title|single_cat_title]]</tt> | |
| * <tt>[[Function Reference/in_category|in_category]]</tt> | |
| * <tt>[[Function Reference/is_category|is_category]]</tt> | |
| * <tt>[[Function Reference/the_category|the_category]]</tt> | |
| * <tt>[[Function Reference/wp_category_checklist|wp_category_checklist]]</tt> | |
| * <tt>[[Function Reference/wp_dropdown_categories|wp_dropdown_categories]]</tt> | |
| * <tt>[[Function Reference/wp_list_categories|wp_list_categories]]</tt> | |
| '''Category Creation''' | |
| * <tt>[[Function Reference/wp_create_category|wp_create_category]]</tt> | |
| * <tt>[[Function Reference/wp_delete_category|wp_delete_category]]</tt> | |
| * <tt>[[Function Reference/wp_insert_category|wp_insert_category]]</tt> | |
| '''Tags''' | |
| * <tt>[[Function Reference/get_tag|get_tag]]</tt> | |
| * <tt>[[Function Reference/get_tag_link|get_tag_link]]</tt> | |
| * <tt>[[Function Reference/get_tags|get_tags]]</tt> | |
| * <tt>[[Function Reference/get_the_tag_list|get_the_tag_list]]</tt> | |
| * <tt>[[Function Reference/get_the_tags|get_the_tags]]</tt> | |
| * <tt>[[Function_Reference/has_tag|has_tag]]</tt> | |
| * <tt>[[Function Reference/is_tag|is_tag]]</tt> | |
| * <tt>[[Function Reference/the_tags|the_tags]]</tt> | |
| * <tt>[[Function Reference/single_tag_title|single_tag_title]]</tt> | |
| * <tt>[[Function Reference/tag_description|tag_description]]</tt> | |
| * <tt>[[Function Reference/wp_generate_tag_cloud|wp_generate_tag_cloud]]</tt> | |
| * <tt>[[Function Reference/wp_tag_cloud|wp_tag_cloud]]</tt> | |
| '''Taxonomy''' | |
| * <tt>[[Function Reference/get_edit_term_link|get_edit_term_link]]</tt> | |
| * <tt>[[Function Reference/get_taxonomy|get_taxonomy]]</tt> | |
| * <tt>[[Function Reference/get_taxonomies|get_taxonomies]]</tt> | |
| * <tt>[[Function Reference/get_term|get_term]]</tt> | |
| * <tt>[[Function Reference/get_the_term_list|get_the_term_list]]</tt> | |
| * <tt>[[Function Reference/get_term_by|get_term_by]]</tt> | |
| * <tt>[[Function Reference/the_terms|the_terms]]</tt> | |
| * <tt>[[Function Reference/get_the_terms|get_the_terms]]</tt> | |
| * <tt>[[Function Reference/get_term_children|get_term_children]]</tt> | |
| * <tt>[[Function Reference/get_term_link|get_term_link]]</tt> | |
| * <tt>[[Function Reference/get_terms|get_terms]]</tt> | |
| * <tt>[[Function Reference/is_taxonomy|is_taxonomy]]</tt> (deprecated) | |
| * <tt>[[Function Reference/is_taxonomy_hierarchical|is_taxonomy_hierarchical]]</tt> | |
| * <tt>[[Function Reference/is_term|is_term]]</tt> (deprecated) | |
| * <tt>[[Function Reference/taxonomy_exists|taxonomy_exists]]</tt> | |
| * <tt>[[Function Reference/term_exists|term_exists]]</tt> | |
| * <tt>[[Function Reference/register_taxonomy|register_taxonomy]]</tt> | |
| * <tt>[[Function Reference/register_taxonomy_for_object_type|register_taxonomy_for_object_type]]</tt> | |
| * <tt>[[Function Reference/wp_get_object_terms|wp_get_object_terms]]</tt> | |
| * <tt>[[Function Reference/wp_remove_object_terms|wp_remove_object_terms]]</tt> | |
| * <tt>[[Function Reference/wp_set_object_terms|wp_set_object_terms]]</tt> | |
| * <tt>[[Function Reference/wp_insert_term|wp_insert_term]]</tt> | |
| * <tt>[[Function Reference/wp_update_term|wp_update_term]]</tt> | |
| * <tt>[[Function Reference/wp_delete_term|wp_delete_term]]</tt> | |
| * <tt>[[Function Reference/wp_terms_checklist|wp_terms_checklist]]</tt> | |
| |} | |
| |- valign="top" | |
| | width="50%" | | |
| {| class="widefat" | |
| |- style="background:#464646;" | |
| ! | |
| === <span style="color:#d7d7d7;">User and Author Functions</span> === | |
| |- | |
| | | |
| '''Admins, Roles and Capabilities''' | |
| * <tt>[[Function Reference/add_cap|add_cap]]</tt> | |
| * <tt>[[Function Reference/add_role|add_role]]</tt> | |
| * <tt>[[Function Reference/author_can|author_can]]</tt> | |
| * <tt>[[Function Reference/current_user_can|current_user_can]]</tt> | |
| * <tt>[[Function Reference/current_user_can_for_blog|current_user_can_for_blog]]</tt> | |
| * <tt>[[Function Reference/get_role|get_role]]</tt> | |
| * <tt>[[Function Reference/get_super_admins|get_super_admins]]</tt> | |
| * <tt>[[Function Reference/is_super_admin|is_super_admin]]</tt> | |
| * <tt>[[Function Reference/map_meta_cap|map_meta_cap]]</tt> | |
| * <tt>[[Function Reference/remove_cap|remove_cap]]</tt> | |
| * <tt>[[Function Reference/remove_role|remove_role]]</tt> | |
| * <tt>[[Function Reference/user_can|user_can]]</tt> | |
| '''Users and Authors''' | |
| * <tt>[[Function Reference/auth_redirect|auth_redirect]]</tt> | |
| * <tt>[[Function Reference/count_users|count_users]]</tt> | |
| * <tt>[[Function Reference/count_user_posts|count_user_posts]]</tt> | |
| * <tt>[[Function Reference/count_many_users_posts|count_many_users_posts]]</tt> | |
| * <tt>[[Function Reference/email_exists|email_exists]]</tt> | |
| * <tt>[[Function Reference/get_currentuserinfo|get_currentuserinfo]]</tt> | |
| * <tt>[[Function Reference/get_current_user_id|get_current_user_id]]</tt> | |
| * <tt>[[Function Reference/get_profile|get_profile]]</tt> (deprecated) | |
| * <tt>[[Function Reference/get_user_by|get_user_by]]</tt> | |
| * <tt>[[Function Reference/get_userdata|get_userdata]]</tt> | |
| * <tt>[[Function Reference/get_usernumposts|get_usernumposts]]</tt> (deprecated) | |
| * <tt>[[Function Reference/get_users|get_users]]</tt> | |
| * <tt>[[Function Reference/set_current_user|set_current_user]]</tt> (deprecated) | |
| * <tt>[[Function Reference/user_pass_ok|user_pass_ok]]</tt> (deprecated) | |
| * <tt>[[Function Reference/wp_authenticate|wp_authenticate]]</tt> | |
| * <tt>[[Function Reference/username_exists|username_exists]]</tt> | |
| * <tt>[[Function Reference/validate_username|validate_username]]</tt> | |
| * <tt>[[Function Reference/wp_dropdown_users|wp_dropdown_users]]</tt> | |
| * <tt>[[Function Reference/wp_get_current_user|wp_get_current_user]]</tt> | |
| * <tt>[[Function Reference/wp_set_current_user|wp_set_current_user]]</tt> | |
| * <tt>[[Function Reference/wp_set_password|wp_set_password]]</tt> | |
| * <tt>[[Function Reference/get_author_posts_url | get_author_posts_url]]</tt> | |
| * <tt>[[Function Reference/get_the_modified_author|get_the_modified_author]]</tt> | |
| * <tt>[[Function Reference/is_multi_author|is_multi_author]]</tt> | |
| '''User meta''' | |
| * <tt>[[Function Reference/add_user_meta|add_user_meta]]</tt> | |
| * <tt>[[Function Reference/delete_user_meta|delete_user_meta]]</tt> | |
| * <tt>[[Function Reference/get_user_meta|get_user_meta]]</tt> | |
| * <tt>[[Function Reference/update_user_meta|update_user_meta]]</tt> | |
| * <tt>[[Function Reference/get_the_author_meta|get_the_author_meta]]</tt> | |
| '''User insertion/removal''' | |
| * <tt>[[Function Reference/wp_create_user|wp_create_user]]</tt> | |
| * <tt>[[Function Reference/wp_delete_user|wp_delete_user]]</tt> | |
| * <tt>[[Function Reference/wp_insert_user|wp_insert_user]]</tt> | |
| * <tt>[[Function Reference/wp_update_user|wp_update_user]]</tt> | |
| '''Login / Logout''' | |
| * <tt>[[Function Reference/is_user_logged_in|is_user_logged_in]]</tt> | |
| * <tt>[[Function Reference/wp_login_form|wp_login_form]]</tt> | |
| * <tt>[[Function Reference/wp_signon|wp_signon]]</tt> | |
| * <tt>[[Function Reference/wp_logout|wp_logout]]</tt> | |
| * <tt>[[Function Reference/wp_loginout|wp_loginout]]</tt> | |
| |} | |
| | width="50%" | | |
| {| class="widefat" | |
| |- style="background:#464646;" | |
| ! | |
| === <span style="color:#d7d7d7;">Feed Functions</span> === | |
| |- | |
| | | |
| * <tt>[[Function Reference/bloginfo_rss|bloginfo_rss]]</tt> | |
| * <tt>[[Function Reference/comment_author_rss|comment_author_rss]]</tt> | |
| * <tt>[[Function Reference/comment_link|comment_link]]</tt> | |
| * <tt>[[Function Reference/comment_text_rss|comment_text_rss]]</tt> | |
| * <tt>[[Function Reference/do_feed|do_feed]]</tt> | |
| * <tt>[[Function Reference/do_feed_atom|do_feed_atom]]</tt> | |
| * <tt>[[Function Reference/do_feed_rdf|do_feed_rdf]]</tt> | |
| * <tt>[[Function Reference/do_feed_rss|do_feed_rss]]</tt> | |
| * <tt>[[Function Reference/do_feed_rss2|do_feed_rss2]]</tt> | |
| * <tt>[[Function Reference/fetch_feed|fetch_feed]]</tt> | |
| * <tt>[[Function Reference/fetch_rss|fetch_rss]]</tt> (deprecated) | |
| * <tt>[[Function Reference/get_author_feed_link|get_author_feed_link]]</tt> | |
| * <tt>[[Function Reference/get_bloginfo_rss|get_bloginfo_rss]]</tt> | |
| * <tt>[[Function Reference/get_category_feed_link|get_category_feed_link]]</tt> | |
| * <tt>[[Function Reference/get_comment_link|get_comment_link]]</tt> | |
| * <tt>[[Function Reference/get_comment_author_rss|get_comment_author_rss]]</tt> | |
| * <tt>[[Function Reference/get_post_comments_feed_link|get_post_comments_feed_link]]</tt> | |
| * <tt>[[Function Reference/get_rss|get_rss]]</tt> (deprecated) | |
| * <tt>[[Function Reference/get_search_comments_feed_link|get_search_comments_feed_link]]</tt> | |
| * <tt>[[Function Reference/get_search_feed_link|get_search_feed_link]]</tt> | |
| * <tt>[[Function Reference/get_the_category_rss|get_the_category_rss]]</tt> | |
| * <tt>[[Function Reference/get_the_title_rss|get_the_title_rss]]</tt> | |
| * <tt>[[Template_Tags/permalink_single_rss|permalink_single_rss]]</tt> (deprecated) | |
| * <tt>[[Function Reference/post_comments_feed_link|post_comments_feed_link]]</tt> | |
| * <tt>[[Function Reference/rss_enclosure|rss_enclosure]]</tt> | |
| * <tt>[[Function Reference/the_title_rss|the_title_rss]]</tt> | |
| * <tt>[[Function Reference/the_category_rss|the_category_rss]]</tt> | |
| * <tt>[[Function Reference/the_content_rss|the_content_rss]]</tt> (deprecated) | |
| * <tt>[[Function Reference/the_excerpt_rss|the_excerpt_rss]]</tt> | |
| * <tt>[[Function Reference/wp_rss|wp_rss]]</tt> (deprecated) | |
| |} | |
| |- valign="top" | |
| | width="50%" | | |
| {| class="widefat" | |
| |- style="background:#464646;" | |
| ! | |
| === <span style="color:#d7d7d7;">HTTP API Functions</span> === | |
| |- | |
| | | |
| * <tt>[[Function Reference/wp_remote_get|wp_remote_get]]</tt> | |
| * <tt>[[Function Reference/wp_remote_retrieve_body|wp_remote_retrieve_body]]</tt> | |
| * <tt>[[Function Reference/wp_get_http_headers|wp_get_http_headers]]</tt> | |
| * <tt>[[Function Reference/wp_remote_fopen|wp_remote_fopen]]</tt> | |
| |} | |
| |- valign="top" | |
| | width="50%" | | |
| {| class="widefat" | |
| |- style="background:#464646;" | |
| ! | |
| === <span style="color:#d7d7d7;">Comment, Ping, and Trackback Functions</span> === | |
| |- | |
| | | |
| * <tt>[[Function Reference/add_ping|add_ping]]</tt> | |
| * <tt>[[Function Reference/add_comment_meta|add_comment_meta]]</tt> | |
| * <tt>[[Function Reference/check_comment|check_comment]]</tt> | |
| * <tt>[[Function Reference/comment_text|comment_text]]</tt> | |
| * <tt>[[Function Reference/comment_form|comment_form]]</tt> | |
| * <tt>[[Function Reference/comments_number|comments_number]]</tt> | |
| * <tt>[[Function Reference/discover_pingback_server_uri|discover_pingback_server_uri]]</tt> | |
| * <tt>[[Function Reference/delete_comment_meta|delete_comment_meta]]</tt> | |
| * <tt>[[Function Reference/do_all_pings|do_all_pings]]</tt> | |
| * <tt>[[Function Reference/do_enclose|do_enclose]]</tt> | |
| * <tt>[[Function Reference/do_trackbacks|do_trackbacks]]</tt> | |
| * <tt>[[Function Reference/generic_ping|generic_ping]]</tt> | |
| * <tt>[[Function Reference/get_approved_comments|get_approved_comments]]</tt> | |
| * <tt>[[Function Reference/get_avatar|get_avatar]]</tt> | |
| * <tt>[[Function Reference/get_comment|get_comment]]</tt> | |
| * <tt>[[Function Reference/get_comment_text|get_comment_text]]</tt> | |
| * <tt>[[Function Reference/get_comment_meta|get_comment_meta]]</tt> | |
| * <tt>[[Function Reference/get_comments|get_comments]]</tt> | |
| * <tt>[[Function Reference/wp_list_comments|wp_list_comments]]</tt> | |
| * <tt>[[Function Reference/get_enclosed|get_enclosed]]</tt> | |
| * <tt>[[Function Reference/get_lastcommentmodified|get_lastcommentmodified]]</tt> | |
| * <tt>[[Function Reference/get_pung|get_pung]]</tt> | |
| * <tt>[[Function Reference/get_to_ping|get_to_ping]]</tt> | |
| * <tt>[[Function Reference/have_comments|have_comments]]</tt> | |
| * <tt>[[Function Reference/get_comment_author|get_comment_author]]</tt> | |
| * <tt>[[Function Reference/is_trackback|is_trackback]]</tt> | |
| * <tt>[[Function Reference/pingback|pingback]]</tt> | |
| * <tt>[[Function Reference/privacy_ping_filter|privacy_ping_filter]]</tt> | |
| * <tt>[[Function Reference/sanitize_comment_cookies|sanitize_comment_cookies]]</tt> | |
| * <tt>[[Function Reference/trackback|trackback]]</tt> | |
| * <tt>[[Function Reference/trackback_url|trackback_url]]</tt> | |
| * <tt>[[Function Reference/trackback_url_list|trackback_url_list]]</tt> | |
| * <tt>[[Function Reference/update_comment_meta|update_comment_meta]]</tt> | |
| * <tt>[[Function Reference/weblog_ping|weblog_ping]]</tt> | |
| * <tt>[[Function Reference/wp_allow_comment|wp_allow_comment]]</tt> | |
| * <tt>[[Function Reference/wp_count_comments|wp_count_comments]]</tt> | |
| * <tt>[[Function Reference/wp_delete_comment|wp_delete_comment]]</tt> | |
| * <tt>[[Function Reference/wp_filter_comment|wp_filter_comment]]</tt> | |
| * <tt>[[Function Reference/wp_get_comment_status|wp_get_comment_status]]</tt> | |
| * <tt>[[Function Reference/wp_get_current_commenter|wp_get_current_commenter]]</tt> | |
| * <tt>[[Function Reference/wp_insert_comment|wp_insert_comment]]</tt> | |
| * <tt>[[Function Reference/wp_new_comment|wp_new_comment]]</tt> | |
| * <tt>[[Function Reference/wp_set_comment_status|wp_set_comment_status]]</tt> | |
| * <tt>[[Function Reference/wp_throttle_comment_flood|wp_throttle_comment_flood]]</tt> | |
| * <tt>[[Function Reference/wp_update_comment|wp_update_comment]]</tt> | |
| * <tt>[[Function Reference/wp_update_comment_count|wp_update_comment_count]]</tt> | |
| * <tt>[[Function Reference/wp_update_comment_count_now|wp_update_comment_count_now]]</tt> | |
| '''Comments Loop''' | |
| * <tt>[[Function Reference/comment_class|comment_class]]</tt> | |
| * <tt>[[Function Reference/comment_ID|comment_ID]]</tt> | |
| * <tt>[[Function Reference/comment_author|comment_author]]</tt> | |
| * <tt>[[Function Reference/comment_date|comment_date]]</tt> | |
| * <tt>[[Function Reference/comment_time|comment_time]]</tt> | |
| * <tt>[[Function Reference/get_comment_date|get_comment_date]]</tt> | |
| * <tt>[[Function Reference/get_comment_time|get_comment_time]]</tt> | |
| '''Comments Pagination''' | |
| * <tt>[[Function Reference/paginate_comments_links|paginate_comments_links]]</tt> | |
| * <tt>[[Function Reference/previous_comments_link|previous_comments_link]]</tt> | |
| * <tt>[[Function Reference/next_comments_link|next_comments_link]]</tt> | |
| * <tt>[[Function Reference/get_comment_pages_count|get_comment_pages_count]]</tt> | |
| |} | |
| | width="50%" | | |
| {| class="widefat" | |
| |- style="background:#464646;" | |
| ! | |
| === <span style="color:#d7d7d7;">Action, Filter, and Plugin Functions</span> === | |
| |- | |
| | | |
| '''Filters''' ([[Plugin API/Filter Reference|Reference]]) | |
| * <tt>[[Function Reference/has_filter|has_filter]]</tt> | |
| * <tt>[[Function Reference/add_filter|add_filter]]</tt> | |
| * <tt>[[Function Reference/apply_filters|apply_filters]]</tt> | |
| * <tt>[[Function Reference/apply_filters_ref_array|apply_filters_ref_array]]</tt> | |
| * <tt>[[Function Reference/current_filter|current_filter]]</tt> | |
| * <tt>[[Function Reference/merge_filters|merge_filters]]</tt> | |
| * <tt>[[Function Reference/remove_filter|remove_filter]]</tt> | |
| * <tt>[[Function Reference/remove_all_filters|remove_all_filters]]</tt> | |
| '''Actions''' ([[Plugin API/Action Reference|Reference]]) | |
| * <tt>[[Function Reference/has_action|has_action]]</tt> | |
| * <tt>[[Function Reference/add_action|add_action]]</tt> | |
| * <tt>[[Function Reference/do_action|do_action]]</tt> | |
| * <tt>[[Function Reference/do_action_ref_array|do_action_ref_array]]</tt> | |
| * <tt>[[Function Reference/did_action|did_action]]</tt> | |
| * <tt>[[Function Reference/remove_action|remove_action]]</tt> | |
| * <tt>[[Function Reference/remove_all_actions|remove_all_actions]]</tt> | |
| '''Plugins''' ([[Plugin API|Reference]]) | |
| * <tt>[[Function Reference/plugin_basename|plugin_basename]]</tt> | |
| * <tt>[[Function Reference/plugins_url|plugins_url]]</tt> | |
| * <tt>[[Function Reference/get_plugin_data|get_plugin_data]]</tt> | |
| * <tt>[[Function Reference/get_admin_page_title|get_admin_page_title]]</tt> | |
| * <tt>[[Function Reference/plugin_dir_path|plugin_dir_path]]</tt> | |
| * <tt>[[Function Reference/register_activation_hook|register_activation_hook]]</tt> | |
| * <tt>[[Function Reference/register_deactivation_hook|register_deactivation_hook]]</tt> | |
| * <tt>[[Function Reference/menu_page_url|menu_page_url]]</tt> | |
| * <tt>[[Function Reference/is_plugin_active|is_plugin_active]]</tt> | |
| * <tt>[[Function Reference/is_plugin_active_for_network|is_plugin_active_for_network]]</tt> | |
| * <tt>[[Function Reference/is_plugin_inactive|is_plugin_inactive]]</tt> | |
| * <tt>[[Function Reference/is_plugin_page|is_plugin_page]]</tt> | |
| * <tt>[[Function Reference/add_contextual_help|add_contextual_help]]</tt> (deprecated) | |
| * <tt>[[Function Reference/get_plugins|get_plugins]]</tt> | |
| '''Widgets''' ([[Widgets API|Reference]]) | |
| * <tt>[[Function Reference/is_active_widget|is_active_widget]]</tt> | |
| * <tt>[[Function Reference/register_widget|register_widget]]</tt> | |
| * <tt>[[Function Reference/the_widget|the_widget]]</tt> | |
| * <tt>[[Function Reference/unregister_widget|unregister_widget]]</tt> | |
| * <tt>[[Function Reference/wp_add_dashboard_widget|wp_add_dashboard_widget]]</tt> | |
| * <tt>[[Function Reference/wp_convert_widget_settings|wp_convert_widget_settings]]</tt> | |
| * <tt>[[Function Reference/wp_get_sidebars_widgets|wp_get_sidebars_widgets]]</tt> | |
| * <tt>[[Function Reference/wp_get_widget_defaults|wp_get_widget_defaults]]</tt> | |
| * <tt>[[Function Reference/wp_register_sidebar_widget|wp_register_sidebar_widget]]</tt> | |
| * <tt>[[Function Reference/wp_register_widget_control|wp_register_widget_control]]</tt> | |
| * <tt>[[Function Reference/wp_set_sidebars_widgets|wp_set_sidebars_widgets]]</tt> | |
| * <tt>[[Function Reference/wp_unregister_sidebar_widget|wp_unregister_sidebar_widget]]</tt> | |
| * <tt>[[Function Reference/wp_unregister_widget_control|wp_unregister_widget_control]]</tt> | |
| * <tt>[[Function Reference/wp_widget_description|wp_widget_description]]</tt> | |
| '''Settings''' ([[Settings API|Reference]]) | |
| * <tt>[[Function Reference/register_setting|register_setting]]</tt> | |
| * <tt>[[Function Reference/unregister_setting|unregister_setting]]</tt> | |
| * <tt>[[Function Reference/settings_fields|settings_fields]]</tt> | |
| * <tt>[[Function Reference/do_settings_fields|do_settings_fields]]</tt> | |
| * <tt>[[Function_Reference/do_settings_sections|do_settings_sections]]</tt> | |
| * <tt>[[Function_Reference/add_settings_field|add_settings_field]]</tt> | |
| * <tt>[[Function_Reference/add_settings_section|add_settings_section]]</tt> | |
| * <tt>[[Function_Reference/add_settings_error|add_settings_error]]</tt> | |
| * <tt>[[Function_Reference/get_settings_errors|get_settings_errors]]</tt> | |
| * <tt>[[Function_Reference/settings_errors|settings_errors]]</tt> | |
| '''Shortcodes''' ([[Shortcode API|Reference]]) | |
| * <tt>[[Function Reference/add_shortcode|add_shortcode]]</tt> | |
| * <tt>[[Function Reference/do_shortcode|do_shortcode]]</tt> | |
| * <tt>[[Function Reference/do_shortcode_tag|do_shortcode_tag]]</tt> | |
| * <tt>[[Function Reference/get_shortcode_regex|get_shortcode_regex]]</tt> | |
| * <tt>[[Function Reference/remove_shortcode|remove_shortcode]]</tt> | |
| * <tt>[[Function Reference/remove_all_shortcodes|remove_all_shortcodes]]</tt> | |
| * <tt>[[Function Reference/shortcode_atts|shortcode_atts]]</tt> | |
| * <tt>[[Function Reference/shortcode_parse_atts|shortcode_parse_atts]]</tt> | |
| * <tt>[[Function Reference/strip_shortcodes|strip_shortcodes]]</tt> | |
| |} | |
| |- valign="top" | |
| | width="50%" | | |
| {| class="widefat" | |
| |- style="background:#464646;" | |
| ! | |
| === <span style="color:#d7d7d7;">Theme-Related Functions</span> === | |
| |- | |
| | | |
| '''Include functions''' | |
| * <tt>[[Function Reference/comments_template|comments_template]]</tt> | |
| * <tt>[[Function Reference/get_footer|get_footer]]</tt> | |
| * <tt>[[Function Reference/get_header|get_header]]</tt> | |
| * <tt>[[Function Reference/get_sidebar|get_sidebar]]</tt> | |
| * <tt>[[Function Reference/get_search_form|get_search_form]]</tt> | |
| '''Other functions''' | |
| * <tt>[[Function Reference/add_custom_background|add_custom_background]]</tt> (deprecated) | |
| * <tt>[[Function Reference/add_custom_image_header|add_custom_image_header]]</tt> (deprecated) | |
| * <tt>[[Function Reference/add_image_size|add_image_size]]</tt> | |
| * <tt>[[Function Reference/add_theme_support|add_theme_support]]</tt> | |
| * <tt>[[Function Reference/body_class|body_class]]</tt> | |
| * <tt>[[Function Reference/current_theme_supports|current_theme_supports]]</tt> | |
| * <tt>[[Function Reference/dynamic_sidebar|dynamic_sidebar]]</tt> | |
| * <tt>[[Function Reference/get_404_template|get_404_template]]</tt> | |
| * <tt>[[Function Reference/get_archive_template|get_archive_template]]</tt> | |
| * <tt>[[Function Reference/get_attachment_template|get_attachment_template]]</tt> | |
| * <tt>[[Function Reference/get_author_template|get_author_template]]</tt> | |
| * <tt>[[Function Reference/get_body_class|get_body_class]]</tt> | |
| * <tt>[[Function Reference/get_category_template|get_category_template]]</tt> | |
| * <tt>[[Function Reference/get_comments_popup_template|get_comments_popup_template]]</tt> | |
| * <tt>[[Function Reference/get_current_theme|get_current_theme]]</tt> | |
| * <tt>[[Function Reference/get_date_template|get_date_template]]</tt> | |
| * <tt>[[Function Reference/get_header_image|get_header_image]]</tt> | |
| * <tt>[[Function Reference/get_header_textcolor|get_header_textcolor]]</tt> | |
| * <tt>[[Function Reference/get_home_template|get_home_template]]</tt> | |
| * <tt>[[Function Reference/get_locale_stylesheet_uri|get_locale_stylesheet_uri]]</tt> | |
| * <tt>[[Function Reference/get_page_template|get_page_template]]</tt> | |
| * <tt>[[Function Reference/get_paged_template|get_paged_template]]</tt> | |
| * <tt>[[Function Reference/get_post_class|get_post_class]]</tt> | |
| * <tt>[[Function Reference/get_query_template|get_query_template]]</tt> | |
| * <tt>[[Function Reference/get_search_template|get_search_template]]</tt> | |
| * <tt>[[Function Reference/get_single_template|get_single_template]]</tt> | |
| * <tt>[[Function Reference/get_stylesheet|get_stylesheet]]</tt> | |
| * <tt>[[Function Reference/get_stylesheet_directory|get_stylesheet_directory]]</tt> | |
| * <tt>[[Function Reference/get_stylesheet_directory_uri|get_stylesheet_directory_uri]]</tt> | |
| * <tt>[[Function Reference/get_stylesheet_uri|get_stylesheet_uri]]</tt> | |
| * <tt>[[Function Reference/get_tag_template|get_tag_template]]</tt> | |
| * <tt>[[Function Reference/get_taxonomy_template|get_taxonomy_template]]</tt> | |
| * <tt>[[Function Reference/get_template|get_template]]</tt> | |
| * <tt>[[Function Reference/get_template_directory|get_template_directory]]</tt> | |
| * <tt>[[Function Reference/get_template_directory_uri|get_template_directory_uri]]</tt> | |
| * <tt>[[Function Reference/get_template_part|get_template_part]]</tt> | |
| * <tt>[[Function Reference/get_theme|get_theme]]</tt> (deprecated) | |
| * <tt>[[Function Reference/wp_get_themes|wp_get_themes]]</tt> | |
| * <tt>[[Function Reference/get_theme_data|get_theme_data]]</tt> (deprecated) | |
| * <tt>[[Function Reference/get_theme_support|get_theme_support]]</tt> | |
| * <tt>[[Function Reference/get_theme_mod|get_theme_mod]]</tt> | |
| * <tt>[[Function Reference/get_theme_mods|get_theme_mods]]</tt> | |
| * <tt>[[Function Reference/get_theme_root|get_theme_root]]</tt> | |
| * <tt>[[Function Reference/get_theme_roots|get_theme_roots]]</tt> | |
| * <tt>[[Function Reference/get_theme_root_uri|get_theme_root_uri]]</tt> | |
| * <tt>[[Function Reference/get_themes|get_themes]]</tt> (deprecated) | |
| * <tt>[[Function Reference/header_image|header_image]]</tt> | |
| * <tt>[[Function Reference/header_textcolor|header_textcolor]]</tt> | |
| * <tt>[[Function Reference/in_the_loop|in_the_loop]]</tt> | |
| * <tt>[[Function Reference/is_child_theme|is_child_theme]]</tt> | |
| * <tt>[[Function Reference/is_active_sidebar|is_active_sidebar]]</tt> | |
| * <tt>[[Function Reference/is_admin_bar_showing|is_admin_bar_showing]]</tt> | |
| * <tt>[[Function Reference/is_dynamic_sidebar|is_dynamic_sidebar]]</tt> | |
| * <tt>[[Function Reference/language_attributes|language_attributes]]</tt> | |
| * <tt>[[Function Reference/load_template|load_template]]</tt> | |
| * <tt>[[Function Reference/locale_stylesheet|locale_stylesheet]]</tt> | |
| * <tt>[[Function Reference/locate_template|locate_template]]</tt> | |
| * <tt>[[Function Reference/post_class|post_class]]</tt> | |
| * <tt>[[Function Reference/preview_theme|preview_theme]]</tt> | |
| <!-- * <tt>[[Function Reference/_preview_theme_template_filter|_preview_theme_template_filter]]</tt> --> | |
| * <tt>[[Function Reference/preview_theme_ob_filter|preview_theme_ob_filter]]</tt> | |
| * <tt>[[Function Reference/preview_theme_ob_filter_callback|preview_theme_ob_filter_callback]]</tt> | |
| * <tt>[[Function Reference/register_nav_menu|register_nav_menu]]</tt> | |
| * <tt>[[Function Reference/register_nav_menus|register_nav_menus]]</tt> | |
| * <tt>[[Function Reference/get_registered_nav_menus|get_registered_nav_menus]]</tt> | |
| * <tt>[[Function Reference/register_sidebar|register_sidebar]]</tt> | |
| * <tt>[[Function Reference/register_sidebars|register_sidebars]]</tt> | |
| * <tt>[[Function Reference/register_theme_directory|register_theme_directory]]</tt> | |
| * <tt>[[Function Reference/remove_theme_mod|remove_theme_mod]]</tt> | |
| * <tt>[[Function Reference/remove_theme_mods|remove_theme_mods]]</tt> | |
| * <tt>[[Function Reference/remove_theme_support|remove_theme_support]]</tt> | |
| * <tt>[[Function Reference/require_if_theme_supports|require_if_theme_supports]]</tt> | |
| * <tt>[[Function Reference/search_theme_directories|search_theme_directories]]</tt> | |
| * <tt>[[Function Reference/set_theme_mod|set_theme_mod]]</tt> | |
| * <tt>[[Function Reference/switch_theme|switch_theme]]</tt> | |
| * <tt>[[Function Reference/validate_current_theme|validate_current_theme]]</tt> | |
| * <tt>[[Function Reference/unregister_nav_menu|unregister_nav_menu]]</tt> | |
| * <tt>[[Function Reference/unregister_sidebar|unregister_sidebar]]</tt> | |
| * <tt>[[Function Reference/wp_add_inline_style|wp_add_inline_style]]</tt> | |
| * <tt>[[Function Reference/wp_clean_themes_cache|wp_clean_themes_cache]]</tt> | |
| * <tt>[[Function Reference/wp_get_archives|wp_get_archives]]</tt> | |
| * <tt>[[Function Reference/wp_get_nav_menu_items|wp_get_nav_menu_items]]</tt> | |
| * <tt>[[Function Reference/wp_get_theme|wp_get_theme]]</tt> | |
| * <tt>[[Function Reference/wp_nav_menu|wp_nav_menu]]</tt> | |
| * <tt>[[Function Reference/wp_oembed_remove_provider|wp_oembed_remove_provider]]</tt> | |
| * <tt>[[Function Reference/wp_page_menu|wp_page_menu]]</tt> | |
| * <tt>[[Function Reference/wp_title|wp_title]]</tt> | |
| |} | |
| | width="50%" | | |
| {| class="widefat" | |
| |- style="background:#464646;" | |
| ! | |
| === <span style="color:#d7d7d7;">Formatting Functions</span> === | |
| |- | |
| | | |
| * <tt>[[Function Reference/absint|absint]]</tt> | |
| * <tt>[[Function Reference/add_magic_quotes|add_magic_quotes]]</tt> | |
| * <tt>[[Function Reference/addslashes_gpc|addslashes_gpc]]</tt> | |
| * <tt>[[Function Reference/antispambot|antispambot]]</tt> | |
| * <tt>[[Function Reference/attribute_escape|attribute_escape]]</tt> (deprecated) | |
| * <tt>[[Function Reference/backslashit|backslashit]]</tt> | |
| * <tt>[[Function Reference/balanceTags|balanceTags]]</tt> | |
| * <tt>[[Function Reference/clean_pre|clean_pre]]</tt> | |
| * <tt>[[Function Reference/clean_url|clean_url]]</tt> | |
| * <tt>[[Function Reference/convert_chars|convert_chars]]</tt> | |
| * <tt>[[Function Reference/convert_smilies|convert_smilies]]</tt> | |
| * <tt>[[Function Reference/ent2ncr|ent2ncr]]</tt> | |
| * <tt>[[Function Reference/esc_attr|esc_attr]]</tt> | |
| * <tt>[[Function Reference/esc_html|esc_html]]</tt> | |
| * <tt>[[Function Reference/esc_js|esc_js]]</tt> | |
| * <tt>[[Function_Reference/esc_textarea|esc_textarea]]</tt> | |
| * <tt>[[Function Reference/esc_sql|esc_sql]]</tt> | |
| * <tt>[[Function Reference/esc_url|esc_url]]</tt> | |
| * <tt>[[Function Reference/esc_url_raw|esc_url_raw]]</tt> | |
| * <tt>[[Function Reference/force_balance_tags|force_balance_tags]]</tt> | |
| * <tt>[[Function Reference/format_to_edit|format_to_edit]]</tt> | |
| * <tt>[[Function Reference/format_to_post|format_to_post]]</tt> | |
| * <tt>[[Function Reference/funky_javascript_fix|funky_javascript_fix]]</tt> (deprecated) | |
| * <tt>[[Function Reference/htmlentities2|htmlentities2]]</tt> | |
| * <tt>[[Function Reference/is_email|is_email]]</tt> | |
| * <tt>[[Function Reference/js_escape|js_escape]]</tt> (deprecated) | |
| * <tt>[[Function Reference/make_clickable|make_clickable]]</tt> | |
| * <tt>[[Function Reference/popuplinks|popuplinks]]</tt> | |
| * <tt>[[Function Reference/remove_accents|remove_accents]]</tt> | |
| * <tt>[[Function Reference/sanitize_email|sanitize_email]]</tt> | |
| * <tt>[[Function Reference/sanitize_file_name|sanitize_file_name]]</tt> | |
| * <tt>[[Function Reference/sanitize_html_class|sanitize_html_class]]</tt> | |
| * <tt>[[Function Reference/sanitize_key|sanitize_key]]</tt> | |
| * <tt>[[Function Reference/sanitize_mime_type|sanitize_mime_type]]</tt> | |
| * <tt>[[Function Reference/sanitize_option|sanitize_option]]</tt> | |
| * <tt>[[Function Reference/sanitize_sql_orderby|sanitize_sql_orderby]]</tt> | |
| * <tt>[[Function Reference/sanitize_text_field|sanitize_text_field]]</tt> | |
| * <tt>[[Function Reference/sanitize_title|sanitize_title]]</tt> | |
| * <tt>[[Function Reference/sanitize_title_for_query|sanitize_title_for_query]]</tt> | |
| * <tt>[[Function Reference/sanitize_title_with_dashes|sanitize_title_with_dashes]]</tt> | |
| * <tt>[[Function Reference/sanitize_user|sanitize_user]]</tt> | |
| * <tt>[[Function Reference/seems_utf8|seems_utf8]]</tt> | |
| * <tt>[[Function Reference/stripslashes_deep|stripslashes_deep]]</tt> | |
| * <tt>[[Function Reference/trailingslashit|trailingslashit]]</tt> | |
| * <tt>[[Function Reference/untrailingslashit|untrailingslashit]]</tt> | |
| * <tt>[[Function Reference/urlencode_deep|urlencode_deep]]</tt> | |
| * <tt>[[Function Reference/url_shorten|url_shorten]]</tt> | |
| * <tt>[[Function Reference/utf8_uri_encode|utf8_uri_encode]]</tt> | |
| * <tt>[[Function Reference/wpautop|wpautop]]</tt> | |
| * <tt>[[Function Reference/wptexturize|wptexturize]]</tt> | |
| * <tt>[[Function Reference/wp_filter_kses|wp_filter_kses]]</tt> | |
| * <tt>[[Function Reference/wp_filter_post_kses|wp_filter_post_kses]]</tt> | |
| * <tt>[[Function Reference/wp_filter_nohtml_kses|wp_filter_nohtml_kses]]</tt> | |
| * <tt>[[Function Reference/wp_iso_descrambler|wp_iso_descrambler]]</tt> | |
| * <tt>[[Function Reference/wp_kses|wp_kses]]</tt> | |
| * <tt>[[Function Reference/wp_kses_array_lc|wp_kses_array_lc]]</tt> | |
| * <tt>[[Function Reference/wp_kses_attr|wp_kses_attr]]</tt> | |
| * <tt>[[Function Reference/wp_kses_bad_protocol|wp_kses_bad_protocol]]</tt> | |
| * <tt>[[Function Reference/wp_kses_bad_protocol_once|wp_kses_bad_protocol_once]]</tt> | |
| * <tt>[[Function Reference/wp_kses_bad_protocol_once2|wp_kses_bad_protocol_once2]]</tt> | |
| * <tt>[[Function Reference/wp_kses_check_attr_val|wp_kses_check_attr_val]]</tt> | |
| * <tt>[[Function Reference/wp_kses_decode_entities|wp_kses_decode_entities]]</tt> | |
| * <tt>[[Function Reference/wp_kses_hair|wp_kses_hair]]</tt> | |
| * <tt>[[Function Reference/wp_kses_hook|wp_kses_hook]]</tt> | |
| * <tt>[[Function Reference/wp_kses_html_error|wp_kses_html_error]]</tt> | |
| * <tt>[[Function Reference/wp_kses_js_entities|wp_kses_js_entities]]</tt> | |
| * <tt>[[Function Reference/wp_kses_no_null|wp_kses_no_null]]</tt> | |
| * <tt>[[Function Reference/wp_kses_normalize_entities|wp_kses_normalize_entities]]</tt> | |
| * <tt>[[Function Reference/wp_kses_normalize_entities2|wp_kses_normalize_entities2]]</tt> | |
| * <tt>[[Function Reference/wp_kses_split|wp_kses_split]]</tt> | |
| * <tt>[[Function Reference/wp_kses_split2|wp_kses_split2]]</tt> | |
| * <tt>[[Function Reference/wp_kses_strip_slashes|wp_kses_stripslashes]]</tt> | |
| * <tt>[[Function Reference/wp_kses_version|wp_kses_version]]</tt> | |
| * <tt>[[Function Reference/wp_make_link_relative|wp_make_link_relative]]</tt> | |
| * <tt>[[Function Reference/wp_normalize_path|wp_normalize_path]]</tt> | |
| * <tt>[[Function Reference/wp_rel_nofollow|wp_rel_nofollow]]</tt> | |
| * <tt>[[Function Reference/wp_richedit_pre|wp_richedit_pre]]</tt> | |
| * <tt>[[Function Reference/wp_specialchars|wp_specialchars]]</tt> | |
| * <tt>[[Function Reference/wp_trim_words|wp_trim_words]]</tt> | |
| * <tt>[[Function Reference/zeroise|zeroise]]</tt> | |
| |} | |
| |- valign="top" | |
| | width="50%" | | |
| {| class="widefat" | |
| |- style="background:#464646;" | |
| ! | |
| === <span style="color:#d7d7d7;">Miscellaneous Functions</span> === | |
| |- | |
| | | |
| '''Time/Date Functions''' | |
| * <tt>[[Function Reference/current_time|current_time]]</tt> | |
| * <tt>[[Function Reference/date_i18n|date_i18n]]</tt> | |
| * <tt>[[Function_Reference/get_calendar|get_calendar]]</tt> | |
| * <tt>[[Function Reference/get_date_from_gmt|get_date_from_gmt]]</tt> | |
| * <tt>[[Function Reference/get_lastpostdate|get_lastpostdate]]</tt> | |
| * <tt>[[Function Reference/get_lastpostmodified|get_lastpostmodified]]</tt> | |
| * <tt>[[Function_Reference/get_day_link|get_day_link]]</tt> | |
| * <tt>[[Function Reference/get_gmt_from_date|get_gmt_from_date]]</tt> | |
| * <tt>[[Function_Reference/get_month_link|get_month_link]]</tt> | |
| * <tt>[[Function Reference/the_date|the_date]]</tt> | |
| * <tt>[[Function Reference/get_the_date|get_the_date]]</tt> | |
| * <tt>[[Function_Reference/the_time|the_time]]</tt> | |
| * <tt>[[Function_Reference/get_the_time|get_the_time]]</tt> | |
| * <tt>[[Function_Reference/the_modified_time|the_modified_time]]</tt> | |
| * <tt>[[Function_Reference/get_the_modified_time|get_the_modified_time]]</tt> | |
| * <tt>[[Function Reference/get_weekstartend|get_weekstartend]]</tt> | |
| * <tt>[[Function_Reference/get_year_link|get_year_link]]</tt> | |
| * <tt>[[Function Reference/human_time_diff|human_time_diff]]</tt> | |
| * <tt>[[Function Reference/is_new_day|is_new_day]]</tt> | |
| * <tt>[[Function Reference/iso8601_timezone_to_offset|iso8601_timezone_to_offset]]</tt> | |
| * <tt>[[Function Reference/iso8601_to_datetime|iso8601_to_datetime]]</tt> | |
| * <tt>[[Function Reference/mysql2date|mysql2date]]</tt> | |
| '''Serialization''' | |
| * <tt>[[Function Reference/is_serialized|is_serialized]]</tt> | |
| * <tt>[[Function Reference/is_serialized_string|is_serialized_string]]</tt> | |
| * <tt>[[Function Reference/maybe_serialize|maybe_serialize]]</tt> | |
| * <tt>[[Function Reference/maybe_unserialize|maybe_unserialize]]</tt> | |
| '''Options''' | |
| * <tt>[[Function Reference/add_option|add_option]]</tt> | |
| * <tt>[[Function Reference/add_site_option|add_site_option]]</tt> | |
| * <tt>[[Function Reference/delete_option|delete_option]]</tt> | |
| * <tt>[[Function Reference/delete_site_option|delete_site_option]]</tt> | |
| * <tt>[[Function Reference/form_option|form_option]]</tt> | |
| * <tt>[[Function Reference/get_alloptions|get_alloptions]]</tt> (deprecated) | |
| * <tt>[[Function Reference/get_site_option|get_site_option]]</tt> | |
| * <tt>[[Function Reference/get_site_url|get_site_url]]</tt> | |
| * <tt>[[Function Reference/get_admin_url|get_admin_url]]</tt> | |
| * <tt>[[Function Reference/get_user_option|get_user_option]]</tt> | |
| * <tt>[[Function Reference/get_option|get_option]]</tt> | |
| * <tt>[[Function Reference/update_option|update_option]]</tt> | |
| * <tt>[[Function Reference/update_site_option|update_site_option]]</tt> | |
| * <tt>[[Function Reference/update_user_option|update_user_option]]</tt> | |
| * <tt>[[Function Reference/wp_load_alloptions|wp_load_alloptions]]</tt> | |
| '''Transients''' | |
| * <tt>[[Function_Reference/set_transient | set_transient()]]</tt> | |
| * <tt>[[Function_Reference/get_transient | get_transient()]]</tt> | |
| * <tt>[[Function_Reference/delete_transient | delete_transient()]]</tt> | |
| * <tt>[[Function_Reference/set_site_transient | set_site_transient()]]</tt> | |
| * <tt>[[Function_Reference/get_site_transient | get_site_transient()]]</tt> | |
| * <tt>[[Function_Reference/delete_site_transient | delete_site_transient()]]</tt> | |
| '''Admin Menu Functions''' | |
| * <tt>[[Function Reference/add_menu_page|add_menu_page]]</tt> | |
| * <tt>[[Function Reference/remove_menu_page|remove_menu_page]]</tt> | |
| * <tt>[[Function Reference/add_submenu_page|add_submenu_page]]</tt> | |
| * <tt>[[Function Reference/remove_submenu_page|remove_submenu_page]]</tt> | |
| * <tt>[[Function Reference/add_object_page|add_object_page]]</tt> | |
| * <tt>[[Function Reference/add_utility_page|add_utility_page]]</tt> | |
| * <tt>[[Function Reference/add_comments_page|add_comments_page]]</tt> | |
| * <tt>[[Function Reference/add_dashboard_page|add_dashboard_page]]</tt> | |
| * <tt>[[Function Reference/add_links_page|add_links_page]]</tt> | |
| * <tt>[[Function Reference/add_management_page|add_management_page]]</tt> | |
| * <tt>[[Function Reference/add_media_page|add_media_page]]</tt> | |
| * <tt>[[Function Reference/add_options_page|add_options_page]]</tt> | |
| * <tt>[[Function Reference/add_pages_page|add_pages_page]]</tt> | |
| * <tt>[[Function Reference/add_plugins_page|add_plugins_page]]</tt> | |
| * <tt>[[Function Reference/add_posts_page|add_posts_page]]</tt> | |
| * <tt>[[Function Reference/add_theme_page|add_theme_page]]</tt> | |
| * <tt>[[Function Reference/add_users_page|add_users_page]]</tt> | |
| '''Toolbar Functions''' | |
| * <tt>[[Function Reference/add_node|add_node]]</tt> | |
| * <tt>[[Function Reference/remove_node|remove_node]]</tt> | |
| * <tt>[[Function Reference/add_group|add_group]]</tt> | |
| * <tt>[[Function Reference/get_node|get_node]]</tt> | |
| * <tt>[[Function Reference/get_nodes|get_nodes]]</tt> | |
| '''Form Helpers''' | |
| * <tt>[[Function Reference/checked|checked]]</tt> | |
| * <tt>[[Function Reference/disabled|disabled]]</tt> | |
| * <tt>[[Function Reference/selected|selected]]</tt> | |
| * <tt>[[Function Reference/submit_button|submit_button]]</tt> | |
| * <tt>[[Function Reference/get_submit_button|get_submit_button]]</tt> | |
| '''Nonces and Referers (Security)''' | |
| * <tt>[[Function Reference/check_admin_referer|check_admin_referer]]</tt> | |
| * <tt>[[Function Reference/check_ajax_referer|check_ajax_referer]]</tt> | |
| * <tt>[[Function Reference/wp_create_nonce|wp_create_nonce]]</tt> | |
| * <tt>[[Function Reference/wp_explain_nonce|wp_explain_nonce]]</tt> (deprecated) | |
| * <tt>[[Function Reference/wp_get_original_referer|wp_get_original_referer]]</tt> | |
| * <tt>[[Function Reference/wp_get_referer|wp_get_referer]]</tt> | |
| * <tt>[[Function Reference/wp_nonce_ays|wp_nonce_ays]]</tt> | |
| * <tt>[[Function Reference/wp_nonce_field|wp_nonce_field]]</tt> | |
| * <tt>[[Function Reference/wp_nonce_url|wp_nonce_url]]</tt> | |
| * <tt>[[Function Reference/wp_original_referer_field|wp_original_referer_field]]</tt> | |
| * <tt>[[Function Reference/wp_referer_field|wp_referer_field]]</tt> | |
| * <tt>[[Function Reference/wp_send_json|wp_send_json]]</tt> | |
| * <tt>[[Function Reference/wp_send_json_error|wp_send_json_error]]</tt> | |
| * <tt>[[Function Reference/wp_send_json_success|wp_send_json_success]]</tt> | |
| * <tt>[[Function Reference/wp_verify_nonce|wp_verify_nonce]]</tt> | |
| '''XMLRPC''' | |
| * <tt>[[Function Reference/xmlrpc_getpostcategory|xmlrpc_getpostcategory]]</tt> | |
| * <tt>[[Function Reference/xmlrpc_getposttitle|xmlrpc_getposttitle]]</tt> | |
| * <tt>[[Function Reference/xmlrpc_removepostdata|xmlrpc_removepostdata]]</tt> | |
| * <tt>[[Function Reference/user_pass_ok|user_pass_ok]]</tt> (deprecated) | |
| '''Localization''' | |
| * <tt>[[Function Reference/_2|__]]</tt> | |
| * <tt>[[Function Reference/_x|_x]]</tt> | |
| * <tt>[[Function Reference/_n|_n]]</tt> | |
| * <tt>[[Function Reference/_nx|_nx]]</tt> | |
| * <tt>[[Function Reference/_e|_e]]</tt> | |
| * <tt>[[Function Reference/_ex|_ex]]</tt> | |
| * <tt>[[Function Reference/_2ngettext|_ngettext]] (deprecated)</tt> | |
| * <tt>[[Function Reference/esc_attr_2|esc_attr__]]</tt> | |
| * <tt>[[Function Reference/esc_attr_e|esc_attr_e]]</tt> | |
| * <tt>[[Function Reference/get_locale|get_locale]]</tt> | |
| * <tt>[[Function Reference/load_default_textdomain|load_default_textdomain]]</tt> | |
| * <tt>[[Function Reference/load_plugin_textdomain|load_plugin_textdomain]]</tt> | |
| * <tt>[[Function Reference/load_textdomain|load_textdomain]]</tt> | |
| * <tt>[[Function Reference/load_theme_textdomain|load_theme_textdomain]]</tt> | |
| * <tt>[[Function Reference/is_rtl|is_rtl]]</tt> | |
| '''Cron (Scheduling)''' | |
| * <tt>[[Function Reference/spawn_cron|spawn_cron]]</tt> | |
| * <tt>[[Function Reference/wp_clear_scheduled_hook|wp_clear_scheduled_hook]]</tt> | |
| * <tt>[[Function Reference/wp_cron|wp_cron]]</tt> | |
| * <tt>[[Function Reference/wp_get_schedule|wp_get_schedule]]</tt> | |
| * <tt>[[Function Reference/wp_get_schedules|wp_get_schedules]]</tt> | |
| * <tt>[[Function Reference/wp_next_scheduled|wp_next_scheduled]]</tt> | |
| * <tt>[[Function Reference/wp_reschedule_event|wp_reschedule_event]]</tt> | |
| * <tt>[[Function Reference/wp_schedule_event|wp_schedule_event]]</tt> | |
| * <tt>[[Function Reference/wp_schedule_single_event|wp_schedule_single_event]]</tt> | |
| * <tt>[[Function Reference/wp_unschedule_event|wp_unschedule_event]]</tt> | |
| '''Conditional Tags Index ''' | |
| * <tt> [[Conditional Tags#Any_Page_Containing_Posts|comments_open]]</tt> | |
| * <tt> [[Conditional_Tags#Has_A_Nav_Menu_Assigned|has_nav_menu]]</tt> | |
| * <tt> [[Conditional Tags#A_Tag_Page|has_tag]]</tt> | |
| * <tt> [[Conditional Tags#A_Category_Page|in_category]]</tt> | |
| * <tt> [[Conditional Tags#A_404_Not_Found_Page|is_404]]</tt> | |
| * <tt> [[Conditional Tags#The_Administration_Panels|is_admin]]</tt> | |
| * <tt> [[Conditional Tags#Any_Archive_Page|is_archive]]</tt> | |
| * <tt> [[Conditional Tags#An_Attachment|is_attachment]]</tt> | |
| * <tt> [[Conditional Tags#An_Author_Page|is_author]]</tt> | |
| * <tt> [[Conditional Tags#A_Category_Page|is_category]]</tt> | |
| * <tt> [[Conditional Tags#A_Comments_Popup|is_comments_popup]]</tt> | |
| * <tt> [[Conditional Tags#A_Date_Page|is_date]]</tt> | |
| * <tt> [[Conditional Tags#A_Date_Page|is_day]]</tt> | |
| * <tt> [[Conditional Tags#A_Syndication|is_feed]]</tt> | |
| * <tt> [[Conditional Tags#The_Front_Page|is_front_page]]</tt> | |
| * <tt> [[Conditional Tags#The_Main_Page|is_home]]</tt> | |
| * <tt> [[Conditional Tags#A_Date_Page|is_month]]</tt> | |
| * <tt> [[Conditional Tags#A_PAGE_Page|is_page]]</tt> | |
| * <tt> [[Conditional Tags#Is_a_Page_Template|is_page_template]]</tt> | |
| * <tt> [[Conditional Tags#A_Paged_Page|is_paged]]</tt> | |
| * <tt> [[Conditional Tags#A_Preview|is_preview]]</tt> | |
| * <tt> [[Conditional Tags#A_Search_Result_Page|is_search]]</tt> | |
| * <tt> [[Conditional Tags#A_Single_Post_Page|is_single]]</tt> | |
| * <tt> [[Conditional Tags#A_Single_Page,_Single_Post_or_Attachment|is_singular]]</tt> | |
| * <tt> [[Conditional Tags#A_Sticky_Post|is_sticky]]</tt> | |
| * <tt> [[Conditional Tags#A_Tag_Page|is_tag]]</tt> | |
| * <tt> [[Conditional Tags#A_Tax_Page|is_tax]]</tt> | |
| * <tt> [[Conditional Tags#A_Date_Page|is_time]]</tt> | |
| * <tt> [[Conditional Tags#A_Trackback|is_trackback]]</tt> | |
| * <tt> [[Conditional Tags#A_Date_Page|is_year]]</tt> | |
| * <tt> [[Conditional Tags#Any_Page_Containing_Posts|pings_open]]</tt> | |
| '''Script and Style Registration''' | |
| * <tt>[[Function Reference/wp_dequeue_script|wp_dequeue_script]]</tt> | |
| * <tt>[[Function Reference/wp_dequeue_style|wp_dequeue_style]]</tt> | |
| * <tt>[[Function Reference/wp_deregister_script|wp_deregister_script]]</tt> | |
| * <tt>[[Function Reference/wp_deregister_style|wp_deregister_style]]</tt> | |
| * <tt>[[Function Reference/wp_enqueue_script|wp_enqueue_script]]</tt> | |
| * <tt>[[Function Reference/wp_enqueue_style|wp_enqueue_style]]</tt> | |
| * <tt>[[Function Reference/wp_localize_script|wp_localize_script]]</tt> | |
| * <tt>[[Function Reference/wp_register_script|wp_register_script]]</tt> | |
| * <tt>[[Function Reference/wp_register_style|wp_register_style]]</tt> | |
| * <tt>[[Function Reference/wp_script_is|wp_script_is]]</tt> | |
| * <tt>[[Function Reference/wp_style_is|wp_style_is]]</tt> | |
| '''sql''' | |
| * <tt>[[Function Reference/get_tax_sql|get_tax_sql]]</tt> | |
| * <tt>[[Function Reference/get_meta_sql|get_meta_sql]]</tt> | |
| * <tt>[[Function Reference/get_posts_by_author_sql|get_posts_by_author_sql]]</tt> | |
| '''Miscellaneous''' | |
| * <tt>[[Function Reference/add_editor_style|add_editor_style]]</tt> | |
| * <tt>[[Function Reference/add_query_arg|add_query_arg]]</tt> | |
| * <tt>[[Function Reference/add_rewrite_rule|add_rewrite_rule]]</tt> | |
| * <tt>[[Function Reference/admin_url|admin_url]]</tt> | |
| * <tt>[[Function Reference/bool_from_yn|bool_from_yn]]</tt> | |
| * <tt>[[Function Reference/cache_javascript_headers|cache_javascript_headers]]</tt> | |
| * <tt>[[Function Reference/capital_P_dangit|capital_P_dangit]]</tt> | |
| * <tt>[[Function Reference/clean_blog_cache|clean_blog_cache]]</tt> | |
| * <tt>[[Function Reference/content_url|content_url]]</tt> | |
| * <tt>[[Function Reference/do_robots|do_robots]]</tt> | |
| * <tt>[[Function Reference/flush_rewrite_rules|flush_rewrite_rules]]</tt> | |
| * <tt>[[Function Reference/get_bloginfo|get_bloginfo]]</tt> | |
| * <tt>[[Function Reference/get_num_queries|get_num_queries]]</tt> | |
| * <tt>[[Function Reference/get_post_stati|get_post_stati]]</tt> | |
| * <tt>[[Function Reference/get_post_statuses|get_post_statuses]]</tt> | |
| * <tt>[[Function Reference/get_query_var|get_query_var]]</tt> | |
| * <tt>[[Function Reference/home_url|home_url]]</tt> | |
| * <tt>[[Function Reference/includes_url|includes_url]]</tt> | |
| * <tt>[[Function Reference/is_blog_installed|is_blog_installed]]</tt> | |
| * <tt>[[Function Reference/is_main_site|is_main_site]]</tt> | |
| * <tt>[[Function Reference/is_main_query|is_main_query]]</tt> | |
| * <tt>[[Function Reference/is_multisite|is_multisite]]</tt> | |
| * <tt>[[Function Reference/is_ssl|is_ssl]]</tt> | |
| * <tt>[[Function Reference/is_wp_error|is_wp_error]]</tt> | |
| * <tt>[[Function Reference/log_app|log_app]]</tt> | |
| * <tt>[[Function Reference/make_url_footnote|make_url_footnote]]</tt> (deprecated) | |
| * <tt>[[Function Reference/network_admin_url|network_admin_url]]</tt> | |
| * <tt>[[Function Reference/network_home_url|network_home_url]]</tt> | |
| * <tt>[[Function Reference/network_site_url|network_site_url]]</tt> | |
| * <tt>[[Function Reference/nocache_headers|nocache_headers]]</tt> | |
| * <tt>[[Function Reference/plugin_dir_url|plugin_dir_url]]</tt> | |
| * <tt>[[Function Reference/query_posts|query_posts]]</tt> | |
| * <tt>[[Function Reference/remove_query_arg|remove_query_arg]]</tt> | |
| * <tt>[[Function Reference/rewind_posts|rewind_posts]]</tt> | |
| * <tt>[[Function Reference/setup_postdata|setup_postdata]]</tt> | |
| * <tt>[[Function Reference/site_url|site_url]]</tt> | |
| * <tt>[[Function Reference/status_header|status_header]]</tt> | |
| * <tt>[[Function_Reference/unzip_file|unzip_file]]</tt> | |
| * <tt>[[Function_Reference/validate_file|validate_file]]</tt> | |
| * <tt>[[Function_Reference/validate_file_to_edit|validate_file_to_edit]]</tt> | |
| * <tt>[[Function Reference/wp|wp]]</tt> | |
| * <tt>[[Function Reference/wp_cache_set|wp_cache_set]]</tt> | |
| * <tt>[[Function Reference/wp_cache_get|wp_cache_get]]</tt> | |
| * <tt>[[Function Reference/wp_cache_reset|wp_cache_reset]]</tt> (deprecated) | |
| * <tt>[[Function Reference/wp_check_filetype|wp_check_filetype]]</tt> | |
| * <tt>[[Function Reference/wp_clearcookie|wp_clearcookie]]</tt> (deprecated) | |
| * <tt>[[Function Reference/wp_die|wp_die]]</tt> | |
| * <tt>[[Function Reference/wp_editor|wp_editor]]</tt> | |
| * <tt>[[Function Reference/wp_footer|wp_footer]]</tt> | |
| * <tt>[[Function Reference/wp_get_cookie_login|wp_get_cookie_login]]</tt> (deprecated) | |
| * <tt>[[Function Reference/wp_get_image_editor|wp_get_image_editor]]</tt> | |
| * <tt>[[Function Reference/wp_get_installed_translations|wp_get_installed_translations]]</tt> | |
| * <tt>[[Function Reference/wp_hash|wp_hash]]</tt> | |
| * <tt>[[Function Reference/wp_handle_sideload|wp_handle_sideload]]</tt> | |
| * <tt>[[Function Reference/wp_head|wp_head]]</tt> | |
| * <tt>[[Function Reference/wp_install_defaults|wp_install_defaults]]</tt> | |
| * <tt>[[Function Reference/wp_is_mobile|wp_is_mobile]]</tt> | |
| * <tt>[[Function Reference/wp_mail|wp_mail]]</tt> | |
| * <tt>[[Function Reference/wp_mkdir_p|wp_mkdir_p]]</tt> | |
| * <tt>[[Function Reference/wp_new_user_notification|wp_new_user_notification]]</tt> | |
| * <tt>[[Function Reference/wp_password_change_notification|wp_password_change_notification]]</tt> | |
| * <tt>[[Function Reference/wp_notify_moderator|wp_notify_moderator]]</tt> | |
| * <tt>[[Function Reference/wp_notify_postauthor|wp_notify_postauthor]]</tt> | |
| * <tt>[[Function Reference/wp_parse_args|wp_parse_args]]</tt> | |
| * <tt>[[Function Reference/wp_redirect|wp_redirect]]</tt> | |
| * <tt>[[Function Reference/wp_reset_postdata|wp_reset_postdata]]</tt> | |
| * <tt>[[Function Reference/wp_reset_query|wp_reset_query]]</tt> | |
| * <tt>[[Function Reference/wp_salt|wp_salt]]</tt> | |
| * <tt>[[Function Reference/wp_set_auth_cookie|wp_set_auth_cookie]]</tt> | |
| * <tt>[[Function Reference/wp_safe_redirect|wp_safe_redirect]]</tt> | |
| * <tt>[[Function Reference/wp_upload_bits|wp_upload_bits]]</tt> | |
| * <tt>[[Function Reference/wp_upload_dir|wp_upload_dir]]</tt> | |
| * <tt>[[Function Reference/wp_list_pluck|wp_list_pluck]]</tt> | |
| * <tt>[[Function Reference/wp_text_diff|wp_text_diff]]</tt> | |
| * <tt>[[Function Reference/post_submit_meta_box|post_submit_meta_box]]</tt> | |
| |} | |
| | width="50%" | | |
| {| class="widefat" | |
| |- style="background:#464646;" | |
| ! | |
| === <span style="color:#d7d7d7;">Multisite functions</span> === | |
| |- | |
| | | |
| As of v3.0, WordPress includes WPMU functionality. Old WPMU functions reference can be found at http://codex.wordpress.org/WPMU_Functions (deprecated page). | |
| '''Multisite administration Functions ''' | |
| * <tt>[[Function Reference/confirm_delete_users|confirm_delete_users]]</tt> | |
| * <tt>[[Function Reference/is_user_member_of_blog|is_user_member_of_blog]]</tt> | |
| * <tt>[[Function Reference/wp_dashboard_quota|wp_dashboard_quota]]</tt> | |
| These functions are found in file wp-admin/includes/ms.php (since 3.0.0). | |
| * <tt>[[Function Reference/admin_notice_feed|admin_notice_feed]]</tt> (deprecated) | |
| * <tt>[[Function Reference/avoid_blog_page_permalink_collision|avoid_blog_page_permalink_collision]]</tt> | |
| * <tt>[[Function Reference/check_import_new_users|check_import_new_users]]</tt> | |
| * <tt>[[Function Reference/check_upload_size|check_upload_size]]</tt> | |
| * <tt>[[Function Reference/choose_primary_blog|choose_primary_blog]]</tt> | |
| * <tt>[[Function Reference/display_space_usage|display_space_usage]]</tt> | |
| * <tt>[[Function Reference/fix_import_form_size|fix_import_form_size]]</tt> | |
| * <tt>[[Function Reference/format_code_lang|format_code_lang]]</tt> | |
| * <tt>[[Function Reference/get_site_allowed_themes|get_site_allowed_themes]]</tt> (deprecated) | |
| * <tt>[[Function Reference/grant_super_admin|grant_super_admin]]</tt> | |
| * <tt>[[Function Reference/ms_deprecated_blogs_file|ms_deprecated_blogs_file]]</tt> (deprecated) | |
| * <tt>[[Function Reference/mu_dropdown_languages|mu_dropdown_languages]]</tt> | |
| * <tt>[[Function Reference/new_user_email_admin_notice|new_user_email_admin_notice]]</tt> | |
| * <tt>[[Function Reference/redirect_user_to_blog|redirect_user_to_blog]]</tt> (deprecated) | |
| * <tt>[[Function Reference/refresh_user_details|refresh_user_details]]</tt> | |
| * <tt>[[Function Reference/revoke_super_admin|revoke_super_admin]]</tt> | |
| * <tt>[[Function Reference/secret_salt_warning|secret_salt_warning]]</tt> | |
| * <tt>[[Function Reference/send_confirmation_on_profile_email|send_confirmation_on_profile_email]]</tt> | |
| * <tt>[[Function Reference/show_post_thumbnail_warning|show_post_thumbnail_warning]]</tt> (deprecated) | |
| * <tt>[[Function Reference/site_admin_notice|site_admin_notice]]</tt> | |
| * <tt>[[Function Reference/sync_category_tag_slugs|sync_category_tag_slugs]]</tt> | |
| * <tt>[[Function Reference/update_option_new_admin_email|update_option_new_admin_email]]</tt> | |
| * <tt>[[Function Reference/update_user_status|update_user_status]]</tt> | |
| * <tt>[[Function Reference/upload_is_user_over_quota|upload_is_user_over_quote]]</tt> | |
| * <tt>[[Function Reference/upload_space_setting|upload_space_setting]]</tt> | |
| * <tt>[[Function Reference/wpmu_delete_blog|wpmu_delete_blog]]</tt> | |
| * <tt>[[Function Reference/wpmu_delete_user|wpmu_delete_user]]</tt> | |
| * <tt>[[Function Reference/wpmu_get_blog_allowedthemes|wpmu_get_blog_allowedthemes]]</tt> (deprecated) | |
| * <tt>[[Function Reference/_admin_notice_multisite_activate_plugins_page|_admin_notice_multisite_activate_plugins_page]]</tt> (deprecated) | |
| '''Multisite Functions ''' | |
| Site/blog functions that work with the blogs table and related data, found in file wp-includes/ms-blogs.php (since 3.0.0). | |
| * <tt>[[Function Reference/add_blog_option|add_blog_option]]</tt> | |
| * <tt>[[Function Reference/delete_blog_option|delete_blog_option]]</tt> | |
| * <tt>[[Function Reference/get_blogaddress_by_domain|get_blogaddress_by_domain]]</tt> | |
| * <tt>[[Function Reference/get_blogaddress_by_id|get_blogaddress_by_id]]</tt> | |
| * <tt>[[Function Reference/get_blogaddress_by_name|get_blogaddress_by_name]]</tt> | |
| * <tt>[[Function Reference/get_blog_details|get_blog_details]]</tt> | |
| * <tt>[[Function Reference/get_blog_option|get_blog_option]]</tt> | |
| * <tt>[[Function Reference/get_blog_status|get_blog_status]]</tt> | |
| * <tt>[[Function Reference/get_id_from_blogname|get_id_from_blogname]]</tt> | |
| * <tt>[[Function Reference/get_last_updated|get_last_updated]]</tt> | |
| * <tt>[[Function Reference/is_archived|is_archived]]</tt> | |
| * <tt>[[Function Reference/refresh_blog_details|refresh_blog_details]]</tt> | |
| * <tt>[[Function Reference/restore_current_blog|restore_current_blog]]</tt> | |
| * <tt>[[Function Reference/switch_to_blog|switch_to_blog]]</tt> | |
| * <tt>[[Function Reference/update_archived|update_archived]]</tt> | |
| * <tt>[[Function Reference/update_blog_details|update_blog_details]]</tt> | |
| * <tt>[[Function Reference/update_blog_option|update_blog_option]]</tt> | |
| * <tt>[[Function Reference/update_blog_status|update_blog_status]]</tt> | |
| * <tt>[[Function Reference/wpmu_update_blogs_date|wpmu_update_blogs_date]]</tt> | |
| Defines constants and global variables that can be overridden, generally in wp-config.php, found in file wp-includes/ms-default-constants.php (since 3.0.0). | |
| * <tt>[[Function Reference/ms_cookie_constants|ms_cookie_constants]]</tt> | |
| * <tt>[[Function Reference/ms_file_constants|ms_file_constants]]</tt> | |
| * <tt>[[Function Reference/ms_subdomain_constants|ms_subdomain_constants]]</tt> | |
| * <tt>[[Function Reference/ms_upload_constants|ms_upload_constants]]</tt> | |
| Multisite WordPress API, found in file wp-includes/ms-functions.php (since 3.0.0). | |
| * <tt>[[Function Reference/add_existing_user_to_blog|add_existing_user_to_blog]]</tt> | |
| * <tt>[[Function Reference/add_new_user_to_blog|add_new_user_to_blog]]</tt> | |
| * <tt>[[Function Reference/add_user_to_blog|add_user_to_blog]]</tt> | |
| * <tt>[[Function Reference/check_upload_mimes|check_upload_mimes]]</tt> | |
| * <tt>[[Function Reference/create_empty_blog|create_empty_blog]]</tt> | |
| * <tt>[[Function Reference/domain_exists|domain_exists]]</tt> | |
| * <tt>[[Function Reference/filter_SSL|filter_SSL]]</tt> | |
| * <tt>[[Function Reference/fix_phpmailer_messageid|fix_phpmailer_messageid]]</tt> | |
| * <tt>[[Function Reference/force_ssl_content|force_ssl_content]]</tt> | |
| * <tt>[[Function Reference/get_active_blog_for_user|get_active_blog_for_user]]</tt> | |
| * <tt>[[Function Reference/get_admin_users_for_domain|get_admin_users_for_domain]]</tt> | |
| * <tt>[[Function Reference/get_blogs_of_user|get_blogs_of_user]]</tt> | |
| * <tt>[[Function Reference/get_blog_count|get_blog_count]]</tt> | |
| * <tt>[[Function Reference/get_blog_id_from_url|get_blog_id_from_url]]</tt> | |
| * <tt>[[Function Reference/get_blog_permalink|get_blog_permalink]]</tt> | |
| * <tt>[[Function Reference/get_blog_post|get_blog_post]]</tt> | |
| * <tt>[[Function Reference/get_current_site|get_current_site]]</tt> | |
| * <tt>[[Function Reference/get_dashboard_blog|get_dashboard_blog]]</tt> | |
| * <tt>[[Function Reference/get_dirsize|get_dirsize]]</tt> | |
| * <tt>[[Function Reference/get_most_recent_post_of_user|get_most_recent_post_of_user]]</tt> | |
| * <tt>[[Function Reference/get_sitestats|get_sitestats]]</tt> | |
| * <tt>[[Function Reference/get_space_allowed|get_space_allowed]]</tt> | |
| * <tt>[[Function Reference/get_space_used|get_space_used]]</tt> | |
| * <tt>[[Function Reference/get_upload_space_available|get_upload_space_available]]</tt> | |
| * <tt>[[Function Reference/get_user_count|get_user_count]]</tt> | |
| * <tt>[[Function Reference/get_user_id_from_string|get_user_id_from_string]]</tt> | |
| * <tt>[[Function Reference/global_terms|global_terms]]</tt> | |
| * <tt>[[Function Reference/insert_blog|insert_blog]]</tt> | |
| * <tt>[[Function Reference/install_blog|install_blog]]</tt> | |
| * <tt>[[Function Reference/install_blog_defaults|install_blog_defaults]]</tt> | |
| * <tt>[[Function Reference/is_blog_user|is_blog_user]]</tt> | |
| * <tt>[[Function Reference/is_email_address_unsafe|is_email_address_unsafe]]</tt> | |
| * <tt>[[Function Reference/is_upload_space_available|is_upload_space_available]]</tt> | |
| * <tt>[[Function Reference/is_user_option_local|is_user_option_local]]</tt> | |
| * <tt>[[Function Reference/is_user_spammy|is_user_spammy]]</tt> | |
| * <tt>[[Function Reference/maybe_add_existing_user_to_blog|maybe_add_existing_user_to_blog]]</tt> | |
| * <tt>[[Function Reference/maybe_redirect_404|maybe_redirect_404]]</tt> | |
| * <tt>[[Function Reference/newblog_notify_siteadmin|newblog_notify_siteadmin]]</tt> | |
| * <tt>[[Function Reference/newuser_notify_siteadmin|newuser_notify_siteadmin]]</tt> | |
| * <tt>[[Function Reference/recurse_dirsize|recurse_dirsize]]</tt> | |
| * <tt>[[Function Reference/redirect_mu_dashboard|redirect_mu_dashboard]]</tt> (not a function??) | |
| * <tt>[[Function Reference/redirect_this_site|redirect_this_site]]</tt> | |
| * <tt>[[Function Reference/remove_user_from_blog|remove_user_from_blog]]</tt> | |
| * <tt>[[Function Reference/signup_nonce_check|signup_nonce_check]]</tt> | |
| * <tt>[[Function Reference/signup_nonce_fields|signup_nonce_fields]]</tt> | |
| * <tt>[[Function Reference/update_blog_public|update_blog_public]]</tt> | |
| * <tt>[[Function Reference/update_posts_count|update_posts_count]]</tt> | |
| * <tt>[[Function Reference/upload_is_file_too_big|upload_is_file_too_big]]</tt> | |
| * <tt>[[Function Reference/upload_is_user_over_quota|upload_is_user_over_quota]]</tt> | |
| * <tt>[[Function Reference/upload_size_limit_filter|upload_size_limit_filter]]</tt> | |
| * <tt>[[Function Reference/users_can_register_signup_filter|users_can_register_signup_filter]]</tt> | |
| * <tt>[[Function Reference/welcome_user_msg_filter|welcome_user_msg_filter]]</tt> | |
| * <tt>[[Function Reference/wordpressmu_wp_mail_from|wordpressmu_wp_mail_from]]</tt> (not a function??) | |
| * <tt>[[Function Reference/wp_get_sites|wp_get_sites]]</tt> | |
| * <tt>[[Function Reference/wpmu_activate_signup|wpmu_activate_signup]]</tt> | |
| * <tt>[[Function Reference/wpmu_admin_redirect_add_updated_param|wpmu_admin_redirect_add_updated_param]]</tt> (deprecated) | |
| * <tt>[[Function Reference/wpmu_create_blog|wpmu_create_blog]]</tt> | |
| * <tt>[[Function Reference/wpmu_create_user|wpmu_create_user]]</tt> | |
| * <tt>[[Function Reference/wpmu_log_new_registrations|wpmu_log_new_registrations]]</tt> | |
| * <tt>[[Function Reference/wpmu_signup_blog|wpmu_signup_blog]]</tt> | |
| * <tt>[[Function Reference/wpmu_signup_blog_notification|wpmu_signup_blog_notification]]</tt> | |
| * <tt>[[Function Reference/wpmu_signup_user|wpmu_signup_user]]</tt> | |
| * <tt>[[Function Reference/wpmu_signup_user_notification|wpmu_signup_user_notification]]</tt> | |
| * <tt>[[Function Reference/wpmu_validate_blog_signup|wpmu_validate_blog_signup]]</tt> | |
| * <tt>[[Function Reference/wpmu_validate_user_signup|wpmu_validate_user_signup]]</tt> | |
| * <tt>[[Function Reference/wpmu_welcome_notification|wpmu_welcome_notification]]</tt> | |
| * <tt>[[Function Reference/wpmu_welcome_user_notification|wpmu_welcome_user_notification]]</tt> | |
| These functions are needed to load Multisite, found in file wp-includes/ms-load.php (since 3.0.0). | |
| * <tt>[[Function Reference/get_current_site_name|get_current_site_name]]</tt> | |
| * <tt>[[Function Reference/is_subdomain_install|is_subdomain_install]]</tt> | |
| * <tt>[[Function Reference/ms_not_installed|ms_not_installed]]</tt> | |
| * <tt>[[Function Reference/ms_site_check|ms_site_check]]</tt> | |
| * <tt>[[Function Reference/wpmu_current_site|wpmu_current_site]]</tt> | |
| |} | |
| |} | |
| == Official and Unofficial References == | |
| * [http://core.trac.wordpress.org/browser Trac Browser] - WordPress source code. Choose 'Tags' to find a specific version source code, or 'Trunk' to see the latest version source code. | |
| * [http://phpxref.com/xref/wordpress/ PHPXref for WordPress] - Cross reference of WordPress files, functions, and variables, which seems to point to the latest released version. | |
| * [http://planetozh.com/projects/wordpress-functions-history/table_light.html WordPress Function History Table] - List each WordPress function with including the version it was introduced in or dropped in. PlanetOzh [http://planetozh.com/blog/my-projects/wordpress-functions-implementation-history-tool/ recommends]: "''see related [http://planetozh.com/blog/go.php?http://planetozh.com/projects/wordpress-functions-history/ WordPress Functions Implementation History Tool] for more information (and for a more usable tool)''" | |
| * [http://dd32.id.au/wp-2.4-variable-report.html WordPress Variable Report] - A list of WordPress functions, listing what version of PHP every function requires (and if there's a compatible function available), what varables/arguments in functions are unused, and what functions/variables each class contains (and their default values). | |
| * [http://adambrown.info/p/wp_hooks WordPress Hooks Table] - A list of WordPress actions and filters, cross-referenced to the files they are in | |
| [[Category:Advanced Topics]] | |
| [[Category:Functions|*]] | |
| [[Category:WordPress Development]]</p> | |
| </d:entry> | |
| <d:entry id="wp_update_post" d:title="wp update post"> | |
| <d:index d:value="wp update post"/> | |
| <h1>wp update post</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/wp_update_post}} | |
| {{ja|関数リファレンス/wp update post}} | |
| {{tr|Fonksiyon Listesi/wp update post}} | |
| }} | |
| ==Description== | |
| This function updates posts (and pages) in the database. To work as expected, it is necessary to pass the ID of the post to be updated. | |
| Note that when the post is "updated", the existing Post record is duplicated for audit/revision purposes. The primary record is then updated with the new values. Category associations, custom fields, post meta, and other related entries continue to be linked to the primary Post record. | |
| ==Usage== | |
| %%% <?php wp_update_post( $post ); ?> %%% | |
| ==Parameters== | |
| {{Parameter|$post|array/object|An array or object representing the elements that make up a post. There is a one-to-one relationship between these elements and the names of columns in the <tt>[[Database_Description#Table:_wp_posts | wp_posts]]</tt> table in the database. Filling out the ID field is not strictly necessary but without it there is little point to using the function.|optional|An empty array}} | |
| {{Parameter|$wp_error|Boolean|A Boolean that can be passed to control what is returned on failure. The default setting (<tt>false</tt>) will return a <tt>0</tt> if the post fails to update. However, if this is set to <tt>true</tt>, it will return with a <tt>[[Class_Reference/WP_Error | WP_Error]]</tt> object.|optional|<tt>false</tt>}} | |
| ==Example== | |
| Before calling <tt>wp_update_post()</tt> it is necessary to create an array to pass the necessary elements. Unlike <tt>[[Function Reference/wp insert post|wp_insert_post()]]</tt>, it is only necessary to pass the ID of the post to be updated and the elements to be updated. The names of the elements should match those in the database. | |
| <pre> | |
| // Update post 37 | |
| $my_post = array( | |
| 'ID' => 37, | |
| 'post_content' => 'This is the updated content.' | |
| ); | |
| // Update the post into the database | |
| wp_update_post( $my_post ); | |
| </pre> | |
| ===Categories=== | |
| Categories need to be passed as an array of integers that match the category IDs in the database. This is the case even where only one category is assigned to the post. | |
| ===Caution!=== | |
| When executed by an action hooked into <tt>save_post</tt> (e.g. a custom metabox), <tt>wp_update_post()</tt> has the potential to create an infinite loop. This happens because (1) <tt>wp_update_post()</tt> results in <tt>save_post</tt> being fired and (2) <tt>save_post</tt> is called twice when revisions are enabled (first when creating the revision, then when updating the original post&mdash;resulting in the creation of endless revisions). | |
| If you must update a post from code called by <tt>save_post</tt>, make sure to verify the <tt>post_type</tt> is not set to <tt>'revision'</tt> and that the <tt>$post</tt> object does indeed need to be updated. | |
| Likewise, an action hooked into <tt>edit_attachment</tt> can cause an infinite loop if it contains a function call to <tt>wp_update_post</tt> passing an array parameter with a key value of <tt>"ID"</tt> and an associated value that corresponds to an Attachment. | |
| Note you will need to remove then add the hook, code sample modified from the API/Action reference: <tt>[[Plugin_API/Action_Reference/save_post | save_post]]</tt> | |
| <pre> | |
| <?php | |
| function my_function( $post_id ){ | |
| if ( ! wp_is_post_revision( $post_id ) ){ | |
| // unhook this function so it doesn't loop infinitely | |
| remove_action('save_post', 'my_function'); | |
| // update the post, which calls save_post again | |
| wp_update_post( $my_args ); | |
| // re-hook this function | |
| add_action('save_post', 'my_function'); | |
| } | |
| } | |
| add_action('save_post', 'my_function'); | |
| ?> | |
| </pre> | |
| ===Scheduling posts=== | |
| If you are trying to use <tt>wp_update_post()</tt> to schedule an existing draft, it will not work unless you pass <tt>$my_post->edit_date = true</tt>. WordPress will ignore the <tt>post_date</tt> when updating drafts unless <tt>edit_date</tt> is true. | |
| ==Return== | |
| {{Return||integer|The ID of the post if the post is successfully updated in the database. Otherwise returns <tt>0</tt>}}. | |
| ==Change Log== | |
| * Since: [[Version 1.0|1.0.0]] | |
| == Source File == | |
| <tt>wp_update_post()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| ==Related== | |
| [[Function Reference/wp insert post|wp_insert_post()]] | |
| {{Tag Footer}} | |
| {{Copyedit}} | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="get_bookmark" d:title="get bookmark"> | |
| <d:index d:value="get bookmark"/> | |
| <h1>get bookmark</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get bookmark}} | |
| {{ja|Function Reference/get bookmark}} | |
| }} | |
| == Description == | |
| Retrieve Bookmark data based on bookmark link ID. | |
| == Usage == | |
| %%%<?php get_bookmark( $bookmark, $output, $filter ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$bookmark|integer&#124;object|Bookmark link ID or Bookmark object.}} | |
| {{Parameter|$output|string|Either OBJECT, ARRAY_N, or ARRAY_A constant|optional|OBJECT}} | |
| {{Parameter|$filter|string|default is '<tt>raw</tt>'.|optional|'raw'}} | |
| == Return Values == | |
| ; (array&#124;object) : Type returned depends on <tt>$output</tt> value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| === Display Bookmark Name === | |
| <pre><?php | |
| $bookmark = get_bookmark(5); | |
| echo $bookmark->link_name; | |
| ?> | |
| </pre> | |
| or: | |
| <?php echo get_bookmark(5)->link_name; ?> | |
| === Display Bookmark as a Link === | |
| <pre><?php | |
| $bookmark = get_bookmark(5); | |
| echo '<a href="'.$bookmark->link_url.'">'.$bookmark->link_name.'</a>'; | |
| ?></pre> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] Database Object | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_bookmark()</tt> is located in {{Trac|wp-includes/bookmark.php}}. | |
| == Related == | |
| {{Bookmark Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_children" d:title="get children"> | |
| <d:index d:value="get children"/> | |
| <h1>get children</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get children}} | |
| {{it|Riferimento funzioni/get children}} | |
| {{ja|関数リファレンス/get children}} | |
| {{pt-br|Referência de Função/get children}} | |
| {{ru|Справочник по функциям/get children}} | |
| }} | |
| == Description == | |
| get_children() retrieves attachments, revisions, or sub-pages, possibly by post parent. It works similar to [[Function Reference/get posts|get_posts()]]. | |
| == Usage == | |
| %%% <?php $children_array = get_children( $args, $output ); ?> %%% | |
| ===Default Usage=== | |
| <pre> | |
| <?php $args = array( | |
| 'post_parent' => 0, | |
| 'post_type' => 'any', | |
| 'posts_per_page' => -1, | |
| 'post_status' => 'any' ); ?> | |
| </pre> | |
| == Parameters == | |
| As of [[Version 2.6]], you must pass a non-empty <tt>post_type</tt> parameter (either <tt>attachment</tt> or <tt>page</tt>). | |
| The following options are available in the <tt>$args</tt> array: | |
| {{Parameter|'numberposts'|integer|Number of child posts to retrieve.|optional|'-1'}} | |
| {{Parameter|'post_parent'|integer|Pass the ID of a post or Page to get its children. Pass 0 to get attachments without parent. Pass <tt>null</tt> to get any child regardless of parent.|optional|'0'}} | |
| {{Parameter|'post_type'|string|Any value from post_type column of the posts table, such as <tt>attachment</tt>, <tt>page</tt>, or <tt>revision</tt>; or the keyword <tt>any</tt>.|optional|'0'}} | |
| {{Parameter|'post_status'|string|Any value from the <tt>post_status</tt> column of the wp_posts table, such as <tt>publish</tt>, <tt>draft</tt>, or <tt>inherit</tt>; or the keyword <tt>any</tt>.|optional|'any'}} | |
| {{Parameter|'post_mime_type'|string|A full or partial mime-type, e.g. <tt>image</tt>, <tt>video</tt>, <tt>video/mp4</tt>, which is matched against a post's <tt>post_mime_type</tt> field.|optional}} | |
| '''Note: ''' See [[Template Tags/get posts|get_posts()]] for a full list of $args parameters. | |
| {{Parameter|'output'|constant|Variable type of the array items returned by the function: one of <tt>OBJECT</tt>, <tt>ARRAY_A</tt>, <tt>ARRAY_N</tt>.|optional|OBJECT}} | |
| == Return Values == | |
| ; (array) : Associative array of posts (of variable type set by <tt>$output</tt> parameter) with post IDs as array keys, or an empty array if no posts are found. | |
| '''Note: ''' Prior to [[Version 2.9]], the return value would be <tt>false</tt> when no children found. | |
| == Examples == | |
| If you just want to get or display attachments, it's probably a little easier to use <code>[[Template_Tags/get_posts#Show_attachments_for_the_current_post|get_posts()]]</code> instead. | |
| <pre>$images =& get_children( 'post_type=attachment&post_mime_type=image' ); | |
| $videos =& get_children( 'post_type=attachment&post_mime_type=video/mp4' ); | |
| if ( empty($images) ) { | |
| // no attachments here | |
| } else { | |
| foreach ( $images as $attachment_id => $attachment ) { | |
| echo wp_get_attachment_image( $attachment_id, 'full' ); | |
| } | |
| } | |
| // If you don't need to handle an empty result: | |
| foreach ( (array) $videos as $attachment_id => $attachment ) { | |
| echo wp_get_attachment_link( $attachment_id ); | |
| }</pre> | |
| === Show the first image associated with the post === | |
| This function retrieves the first image associated with a post | |
| <pre> | |
| <?php | |
| function echo_first_image( $postID ) { | |
| $args = array( | |
| 'numberposts' => 1, | |
| 'order' => 'ASC', | |
| 'post_mime_type' => 'image', | |
| 'post_parent' => $postID, | |
| 'post_status' => null, | |
| 'post_type' => 'attachment', | |
| ); | |
| $attachments = get_children( $args ); | |
| if ( $attachments ) { | |
| foreach ( $attachments as $attachment ) { | |
| $image_attributes = wp_get_attachment_image_src( $attachment->ID, 'thumbnail' ) ? wp_get_attachment_image_src( $attachment->ID, 'thumbnail' ) : wp_get_attachment_image_src( $attachment->ID, 'full' ); | |
| echo '<img src="' . wp_get_attachment_thumb_url( $attachment->ID ) . '" class="current">'; | |
| } | |
| } | |
| } | |
| </pre> | |
| === Show the first image associated with the post and re-key the array === | |
| In the example above, a primary array is keyed with the image ID (the exact thing which is being sought - since we don't know it how are we supposed to access it?). The code below provides an easier handle for the image information: the array $child_image. Should be used in the loop. | |
| <pre> | |
| $args = array( | |
| 'numberposts' => 1, | |
| 'order'=> 'DESC', | |
| 'post_mime_type' => 'image', | |
| 'post_parent' => $post->ID, | |
| 'post_type' => 'attachment' | |
| ); | |
| $get_children_array = get_children($args,ARRAY_A); //returns Array ( [$image_ID]... | |
| $rekeyed_array = array_values($get_children_array); | |
| $child_image = $rekeyed_array[0]; | |
| print_r($child_image); //Show the contents of the $child_image array. | |
| echo $child_image['ID']; //Show the $child_image ID. | |
| </pre> | |
| == Change Log == | |
| Since: 2.0.0 | |
| ==Source File== | |
| <tt>get_children()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| get_children() calls [[Template Tags/get posts|get_posts()]], which calls [[Class Reference/WP Query#Methods|$WP_Query->get_posts()]]. | |
| [[Template Tags/wp get attachment link|wp_get_attachment_link()]], | |
| [[Function_Reference/get_page_children|get_page_children()]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Attachments]]</p> | |
| </d:entry> | |
| <d:entry id="wp_remote_fopen" d:title="wp remote fopen"> | |
| <d:index d:value="wp remote fopen"/> | |
| <h1>wp remote fopen</h1> | |
| <p>== Description == | |
| Returns the contents of a remote URI. Tries to retrieve the HTTP content with fopen first and then using cURL, if fopen can't be used. | |
| == Usage == | |
| %%% <?php $contents = wp_remote_fopen($uri); ?> %%% | |
| == Parameters == | |
| {{Parameter|$uri|string|The URI of the remote page to be retrieved.}} | |
| == Return Values == | |
| {{Return||bool&#124;string|HTTP content. False on failure.}} | |
| == Examples == | |
| == Notes == | |
| See http://codex.wordpress.org/HTTP_API | |
| == Change Log == | |
| Since: [[Version 1.5.1|1.5.1]] | |
| == Source File == | |
| wp_remote_fopen() is located in {{Trac|wp-includes/functions.php}} | |
| == Related == | |
| &nbsp; | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_delete_post" d:title="wp delete post"> | |
| <d:index d:value="wp delete post"/> | |
| <h1>wp delete post</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/wp_delete_post}} | |
| {{ru|Справочник по функциям/wp delete post}} | |
| {{ja|関数リファレンス/wp delete post}} | |
| {{tr|wp_delete_post}} | |
| }} | |
| == Description == | |
| Removes or trashes a post, attachment, or page. | |
| When the post and page goes, everything that is tied to it is deleted also. This includes comments, post meta fields, and relationships between the post and taxonomy terms. | |
| == Usage == | |
| %%% <?php wp_delete_post( $postid, $force_delete ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$postid|integer|Post ID.|optional|0}} | |
| {{Parameter|$force_delete|bool|Whether to bypass trash and force deletion (added in WordPress 2.9).|optional|false}} | |
| == Return Values == | |
| ; (mixed) : The post object (if it was deleted or moved to the trash successfully) or false (failure). If the post was moved to to the trash, $post represents its new state; if it was deleted, $post represents its state before deletion. | |
| == Examples == | |
| === Delete Post === | |
| Deleting WP default post "Hello World" which ID is '1'. | |
| %%% <?php wp_delete_post(1); ?> %%% | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * wp_delete_post() automatically reverts to [[Function_Reference/wp_trash_post|<tt>wp_trash_post()</tt>]] if <tt>$force_delete</tt> is ''false'', the <tt>post_type</tt> of <tt>$postid</tt> is ''page'' or ''post'', <tt>$postid</tt> is not already in the trash '''and''' if [[Editing_wp-config.php#Empty_Trash|that trash feature]] enabled (which it it is by default). | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] on '<tt>delete_post</tt>' before deletion unless post type is '<tt>attachment</tt>'. | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] on '<tt>deleted_post</tt>' after deletion unless <tt>post type</tt> is ''attachment''. | |
| * Uses: [[Function_Reference/wp_delete_attachment|<tt>wp_delete_attachment()</tt>]] if <tt>post type</tt> is ''attachment''. | |
| * Uses global <tt>$wpdb</tt>: (<tt>object</tt>) [[Class Reference/wpdb|wpdb]] | |
| * Uses global <tt>$wp_rewrite</tt>: (<tt>object</tt>) [[Function_Reference/WP_Rewrite|WP_Rewrite]] | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_delete_post()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| [[Function_Reference/#Post.2C_Page.2C_Attachment_and_Bookmarks_Functions|'''Post, Page, Attachment and Bookmarks Functions''']]: [[Function_Reference/wp_trash_post|wp_trash_post()]], [[Function Reference/wp update post|wp_update_post()]], [[Function Reference/wp delete attachment|wp_delete_attachment()]], [[Function Reference/wp insert attachment|wp_insert_attachment()]], [[Function Reference/wp insert post|wp_insert_post()]] | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_pages" d:title="get pages"> | |
| <d:index d:value="get pages"/> | |
| <h1>get pages</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get pages}} | |
| {{ja| 関数リファレンス/get pages}} | |
| }} | |
| ==Description== | |
| This function returns an array of pages that are in the blog, optionally constrained by parameters. This array is not tree-like (hierarchical). See the [[Template_Tags/wp_list_pages|wp_list_pages()]] [[Template_Tags|template tag]] for the output of page titles in a tree-like fashion. | |
| This function can also retrieve other post types using the 'post_type' parameter, but the type must be hierarchical like pages, or the function will return false. | |
| Note that, although similar to [[Function_Reference/get_posts|get_posts()]], several of the parameter names and values differ. (It is implemented quite differently, see get_posts().) | |
| ==Usage== | |
| %%% <?php get_pages( $args ); ?> %%% | |
| ===Default Usage=== | |
| <pre> | |
| <?php $args = array( | |
| 'sort_order' => 'ASC', | |
| 'sort_column' => 'post_title', | |
| 'hierarchical' => 1, | |
| 'exclude' => '', | |
| 'include' => '', | |
| 'meta_key' => '', | |
| 'meta_value' => '', | |
| 'authors' => '', | |
| 'child_of' => 0, | |
| 'parent' => -1, | |
| 'exclude_tree' => '', | |
| 'number' => '', | |
| 'offset' => 0, | |
| 'post_type' => 'page', | |
| 'post_status' => 'publish' | |
| ); | |
| $pages = get_pages($args); | |
| ?> | |
| </pre> | |
| ==Parameters== | |
| ; sort_column : (''string'') Sorts the list of Pages in a number of different ways. The default setting is ''sort alphabetically by Page title''. | |
| :* <tt>'post_title'</tt> - Sort Pages alphabetically (by title) - default | |
| :* <tt>'menu_order'</tt> - Sort Pages by Page Order. ''N.B.'' Note the difference between ''Page Order'' and ''Page ID''. The Page ID is a unique number assigned by WordPress to every post or page. The Page Order can be set by the user in the [[Write_Page_SubPanel|Write>Pages]] administrative panel. | |
| :* <tt>'post_date'</tt> - Sort by creation time. | |
| :* <tt>'post_modified'</tt> - Sort by time last modified. | |
| :* <tt>'ID'</tt> - Sort by numeric Page ID. | |
| :* <tt>'post_author'</tt> - Sort by the Page author's numeric ID. | |
| :* <tt>'post_name'</tt> - Sort alphabetically by Post [[Glossary#Slug|slug]]. Not supported yet, as of WP 3.3 (See: http://core.trac.wordpress.org/ticket/14368 ) | |
| :'''Note:''' The '''sort_column''' parameter can be used to sort the list of Pages by the descriptor of any field in the [[Database Description#Table:_wp_posts|wp_post table]] of the WordPress database. Some useful examples are listed here. | |
| :'''Note:''' get_posts() uses the parameter <tt>'orderby'</tt> instead of <tt>'sort_column'</tt>. Also, get_posts() automatically prepends <tt>'post_'</tt> to these values: <tt>'author, date, modified, parent, title, excerpt, content'</tt>. | |
| ; sort_order : (''string'') Change the sort order of the list of Pages (either ascending or descending). The default is ''ascending''. Valid values: | |
| :* <tt>'asc'</tt> - Sort from lowest to highest (Default). | |
| :* <tt>'desc'</tt> - Sort from highest to lowest. | |
| :'''Note:''' get_posts() uses the parameter <tt>'order'</tt> instead of <tt>'sort_order'</tt>. | |
| ; exclude : (''string or array'') Define a comma-separated list of Page IDs to be excluded from the list (example: <tt>'exclude=3,7,31'</tt>). Beginning with [[Version 3.0]], an array of Page ID also can be used. There is no default value. | |
| ; include : (''string or array'') Only include certain Pages in the list generated by ''get_pages''. Like '''exclude''', this parameter takes a comma-separated list of Page IDs. Beginning with [[Version 3.0]], an array of Page ID also can be used. There is no default value. | |
| :'''Note:''' If this parameter is provided, child_of, parent, exclude, meta_key, and meta_value params are ignored, and hierarchical is set to false. | |
| ; child_of : (''integer'') Lists the sub-pages of a single Page only; uses the ID for a Page as the value. Defaults to ''0'' (list all Pages). Note that the child_of parameter will also fetch "grandchildren" of the given ID, not just direct descendants. | |
| :* <tt>0</tt> - default, no child_of restriction | |
| :'''Note:''' The <tt>child_of</tt> parameter is not applied to the SQL query for pages. It is applied to the results of the query. If a number parameter is also provided, the final results may be less than the number specified. | |
| ; parent : (''integer'') List those pages that have the provided single page only ID as parent. Defaults to -1 (displays all Pages regardless of parent). Note that the 'hierarchical' parameter must be set to 0 (false) -- which is not default -- or else no results will be returned for any page other than the top level pages with no parent (ID=0) and the default all pages (ID=-1). In contrast to the 'child_of' parameter, this parameter only returns the direct descendants of the parent, no 'grandchildren'. You can obviate the 'hierarchical' set to 0 requirement by passing a 'child_of' parameter set to the same (parent) ID value. | |
| :* <tt>-1</tt> - default, no parent restriction | |
| :* <tt>0</tt> - returns all top level pages | |
| ; exclude_tree : (''integer'') The opposite of 'child_of', 'exclude_tree' will remove all children of a given ID from the results. Useful for hiding all children of a given page. Can also be used to hide grandchildren in conjunction with a 'child_of' value. This parameter was available at [[Version 2.7]]. | |
| ; hierarchical : (''boolean'') Lists sub-Pages below their parent or lists the Pages inline. The default is ''true'' (list sub-Pages below the parent list item). NOTE: This default value will prevent meta_key & parent page searches from finding sub-pages. You need to set 'hierarchical' => 0 for these parameters to work properly. Valid values: | |
| :* <tt>1 (true)</tt> - default | |
| :* <tt>0 (false)</tt> | |
| ; meta_key : (''string'') Only include the Pages that have this Custom Field Key (use in conjunction with the meta_value field). | |
| ; meta_value : (''string'') Only include the Pages that have this Custom Field Value (use in conjunction with the meta_key field). | |
| ; authors : (''string'') Only include the Pages written by the given author(s) | |
| :'''Note:''' get_posts() uses the parameter <tt>'author'</tt> instead of <tt>'authors'</tt>. | |
| ; number : (''integer'') Sets the number of Pages to list. This causes the SQL LIMIT value to be defined. Default to no LIMIT. This parameter was added with [[Version 2.8]]. | |
| :'''Note:''' get_posts() uses the parameter <tt>'numberposts'</tt> instead of <tt>'number'</tt>. | |
| ; post_type : ("string") Show posts associated with certain [[Post Types|type]]. Valid values include: | |
| :* '<tt>post</tt>' - a post. | |
| :* '<tt>page</tt>' - a page. | |
| :* '<tt>revision</tt>' - a revision. | |
| :* '<tt>attachment</tt>' - an attachment. | |
| :* Custom Post Types. | |
| ; offset : (''integer'') The number of Pages to pass over (or displace) before collecting the set of Pages. Default is no OFFSET. This parameter was added with [[Version 2.8]]. | |
| ; post_status : (''string'') A comma-separated list of post status types that should be included. For example, <tt>'publish,private'</tt>. | |
| ==Return== | |
| ; (Array) : An array containing all the [[Pages]] matching the request, or <tt>false</tt> on failure. The returned array is an array of "page" objects. Each page object is a map containing 24 keys: | |
| <ul> | |
| <li><code>ID</code>: page/post ID (<i>int</i>)</li> | |
| <li><code>post_author</code>: author ID (<i>string</i>)</li> | |
| <li><code>post_date</code>: time-date string (<tt>YYYY-MM-DD HH:MM:SS</tt>), e.g., "2012-10-15 01:02:59"</li> | |
| <li><code>post_date_gmt</code>: time-date string</li> | |
| <li><code>post_content</code>: HTML (<i>string</i>)</li> | |
| <li><code>post_title</code></li> | |
| <li><code>post_excerpt</code>: HTML (<i>string</i>)</li> | |
| <li><code>post_status</code>: (<tt>publish|inherit|pending|private|future|draft|trash</tt>)</li> | |
| <li><code>comment_status</code>: closed/open</li> | |
| <li><code>ping_status</code>: (<tt>closed|open</tt>)</li> | |
| <li><code>post_password</code></li> | |
| <li><code>post_name</code>: slug for page/post</li> | |
| <li><code>to_ping</code></li> | |
| <li><code>pinged</code></li> | |
| <li><code>post_modified</code>: time-date string</li> | |
| <li><code>post_modified_gmt</code>: time-date string</li> | |
| <li><code>post_content_filtered</code></li> | |
| <li><code>post_parent</code>: parent ID (<i>int</i>)</li> | |
| <li><code>guid</code>: URL</li> | |
| <li><code>menu_order</code>: (<i>int</i>)</li> | |
| <li><code>post_type</code>: (<tt>page|post|attachment</tt>)</li> | |
| <li><code>post_mime_type</code></li> | |
| <li><code>comment_count</code>: number of comments (<i>string</i>)</li> | |
| <li><code>filter</code> | |
| </ul> | |
| All values are strings unless otherwise shown as (<i>int</i>). | |
| ==Example== | |
| === Displaying pages in dropdown list === | |
| In this example a dropdown list with all the pages. Note how you can grab the link for the page with a simple call to the function get_page_link passing the ID of the page. | |
| <pre> | |
| <select name="page-dropdown" | |
| onchange='document.location.href=this.options[this.selectedIndex].value;'> | |
| <option value=""> | |
| <?php echo esc_attr( __( 'Select page' ) ); ?></option> | |
| <?php | |
| $pages = get_pages(); | |
| foreach ( $pages as $page ) { | |
| $option = '<option value="' . get_page_link( $page->ID ) . '">'; | |
| $option .= $page->post_title; | |
| $option .= '</option>'; | |
| echo $option; | |
| } | |
| ?> | |
| </select> | |
| </pre> | |
| === Displaying Child pages of the current page in post format === | |
| <pre> | |
| <?php | |
| $mypages = get_pages( array( 'child_of' => $post->ID, 'sort_column' => 'post_date', 'sort_order' => 'desc' ) ); | |
| foreach( $mypages as $page ) { | |
| $content = $page->post_content; | |
| if ( ! $content ) // Check for empty page | |
| continue; | |
| $content = apply_filters( 'the_content', $content ); | |
| ?> | |
| <h2><a href="<?php echo get_page_link( $page->ID ); ?>"><?php echo $page->post_title; ?></a></h2> | |
| <div class="entry"><?php echo $content; ?></div> | |
| <?php | |
| } | |
| ?> | |
| </pre> | |
| ==Changelog== | |
| * Since: 1.5.0 | |
| == Source File == | |
| <tt>get_pages()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Page Tags}} | |
| {{Tag Footer}} | |
| {{Copyedit}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_login" d:title="wp login"> | |
| <d:index d:value="wp login"/> | |
| <h1>wp login</h1> | |
| <p>{{Deprecated}} | |
| ==Description== | |
| Checks a user's login information and logs them in if it checks out. | |
| == Replace With == | |
| * [[Function_Reference/wp_signon|wp_signon()]] | |
| ==Usage== | |
| %%% <?php wp_login( $username, $password, $deprecated ); ?> %%% | |
| ==Parameters== | |
| ; $username : (string) User's username | |
| ; $password : (string) User's password | |
| ; $deprecated : (string) Not used | |
| ==Return== | |
| ; (bool) : False on login failure, true on successful check | |
| Use the global $error to get the reason why the login failed. If the username is blank, no error will be set, so assume blank username on that case. | |
| Plugins extending this function should also provide the global $error and set what the error is, so that those checking the global for why there was a failure can utilize it later. | |
| ==Examples== | |
| ==Notes== | |
| * See Also: [[Function_Reference/wp_logout|wp_logout()]] | |
| ==Change Log== | |
| * Since: 1.2.2 | |
| * Deprecated: 2.5 | |
| * Replaced By: [[Function_Reference/wp_signon|wp_signon()]] | |
| ==Related== | |
| {{Login Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| {{Copyedit}}</p> | |
| </d:entry> | |
| <d:entry id="mysql2date" d:title="mysql2date"> | |
| <d:index d:value="mysql2date"/> | |
| <h1>mysql2date</h1> | |
| <p>==Description== | |
| Converts given MySQL date string into a different format. | |
| ==Usage== | |
| %%%<?php $date = mysql2date( $format, $date, $translate ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$format|string|The requested output format, should be either a [[Formatting_Date_and_Time|PHP date format]] string, e.g. 'U' for a Unix timestamp, or 'G' for a Unix timestamp assuming that <tt>$date</tt> is GMT.|required}} | |
| {{Parameter|$date|string|the input string, this cannot be the raw time-stamp, it has to be converted into the following format first: <tt>'Y-m-d H:i:s'</tt> . This is the only way <tt>mysql2date()</tt> will recognize your date.|required}} | |
| {{Parameter|$translate|boolean|If true then the given date and format string will be passed to <tt>[[Function Reference/date_i18n|date_i18n()]]</tt> for translation.|optional|true}} | |
| == Return Values == | |
| {{Return||string&#124;integer|Formatted date string, or Unix timestamp.}} | |
| == Examples == | |
| Convert a MySQL date to a Unix timestamp: | |
| echo mysql2date( 'U', '2012-02-23 06:12:45' ); // 1329977565 | |
| Convert a MySQL date to another date format: | |
| echo mysql2date( 'l, F j, Y', '2012-02-23 06:12:45' ) // Thursday, February 23, 2012 | |
| == Notes == | |
| == Change Log == | |
| Since: [[Version 0.71|0.71]] | |
| == Source File == | |
| <tt>mysql2date()</tt> is located in {{Trac|wp-includes/functions.php}} | |
| == Related == | |
| [[Formatting_Date_and_Time|Formatting Date and Time]] | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="register_sidebars" d:title="register sidebars"> | |
| <d:index d:value="register sidebars"/> | |
| <h1>register sidebars</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/register_sidebars}} | |
| {{ja|関数リファレンス/register_sidebars}} | |
| }} | |
| == Description == | |
| Creates multiple [[Sidebars]]. | |
| Registers one or more sidebars to be used in the current theme. Most themes have only one sidebar. For this reason, the number parameter is optional and defaults to one. | |
| The args array parameter can contain a 'name' which will be prepended to the sidebar number if there is more than one sidebar. If no name is specified, 'Sidebar' is used. | |
| == Usage == | |
| %%% <?php register_sidebars( $number, $args ); ?> %%% | |
| ===Default Usage=== | |
| <pre> | |
| <?php $args = array( | |
| 'name' => __('Sidebar %d'), | |
| 'id' => 'sidebar', | |
| 'description' => '', | |
| 'class' => '', | |
| 'before_widget' => '<li id="%1$s" class="widget %2$s">', | |
| 'after_widget' => '</li>', | |
| 'before_title' => '<h2 class="widgettitle">', | |
| 'after_title' => '</h2>' ); ?> | |
| </pre> | |
| == Parameters == | |
| {{Parameter|number|integer|Number of sidebars to create.|optional|1}} | |
| {{Parameter|args|string/array|Builds Sidebar based off of 'name' and 'id' values.|optional}} | |
| :* <tt>name</tt> - Sidebar name. | |
| :* <tt>id</tt> - Sidebar id. (Note: "%d" is added automatically to supplied 'id' value after the first; e.g., "Sidebar", "Sidebar-2", "Sidebar-3", etc.) | |
| :* <tt>description</tt> - Text description of what/where the sidebar is. Shown on widget management screen. (Since 2.9) (default: empty) | |
| :* <tt>class</tt> - CSS class name to assign to the widget HTML (default: empty). | |
| :* <tt>before_widget</tt> - HTML to place before every widget. | |
| :* <tt>after_widget</tt> - HTML to place after every widget. | |
| :* <tt>before_title</tt> - HTML to place before every title. | |
| :* <tt>after_title</tt> - HTML to place after every title. | |
| The optional <code>args</code> parameter is an associative array that will be passed as a first argument to every active widget callback. (If a string is passed instead of an array, it will be passed through [http://php.net/manual/en/function.parse-str.php parse_str()] to generate an associative array.) The basic use for these arguments is to pass theme-specific HTML tags to wrap the widget and its title. | |
| == Return Values == | |
| None. | |
| == Example == | |
| This will register 1 sidebar named Sidebar: | |
| <pre>register_sidebars();</pre> | |
| This will create 2 sidebars named “Foobar 1″ and “Foobar 2″: | |
| <pre>register_sidebars(2, array('name'=>'Foobar %d'));</pre> | |
| This will create 2 sidebars with &lt;h1&gt; and &lt;/h1&gt; before and after the title: | |
| <pre>register_sidebars(2, array('before_title'=>'<h1>','after_title'=>'</h1>'));</pre> | |
| == Changelog == | |
| Since: [[Version 2.2|2.2.0]] | |
| == Source File == | |
| <tt>register_sidebars()</tt> is located in {{Trac|wp-includes/widgets.php}}. | |
| == Related == | |
| {{Sidebar Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Widgets]]</p> | |
| </d:entry> | |
| <d:entry id="dynamic_sidebar" d:title="dynamic sidebar"> | |
| <d:index d:value="dynamic sidebar"/> | |
| <h1>dynamic sidebar</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/dynamic_sidebar}} | |
| {{ru|Справочник по функциям/dynamic_sidebar}} | |
| {{ja|関数リファレンス/dynamic_sidebar}} | |
| }} | |
| == Description == | |
| This function calls each of the active widget callbacks in order, which prints the markup for the [[Sidebars|sidebar]]. If you have more than one sidebar, you should give this function the name or number of the sidebar you want to print. This function returns true on success and false on failure. | |
| The return value should be used to determine whether to display a static sidebar. This ensures that your theme will look good even when the Widgets plug-in is not active. | |
| If your sidebars were registered by number, they should be retrieved by number. If they had names when you registered them, use their names to retrieve them. | |
| == Usage == | |
| %%% <?php dynamic_sidebar( $index ); ?> %%% | |
| == Parameters == | |
| {{Parameter|index|integer/string|Name or ID of dynamic sidebar.|optional|1}} | |
| == Return Value == | |
| ; (boolean) : True, if widget sidebar was found and called. False if not found or not called. | |
| ==Examples== | |
| Here is the recommended use of this function: | |
| <pre> | |
| <ul id="sidebar"> | |
| <?php if ( ! dynamic_sidebar() ) : ?> | |
| <li>{static sidebar item 1}</li> | |
| <li>{static sidebar item 2}</li> | |
| <?php endif; ?> | |
| </ul> | |
| </pre> | |
| <pre> | |
| <ul id="sidebar"> | |
| <?php dynamic_sidebar( 'right-sidebar' ); ?> | |
| </ul> | |
| </pre> | |
| <pre> | |
| <?php if ( is_active_sidebar( 'left-sidebar' ) ) : ?> | |
| <ul id="sidebar"> | |
| <?php dynamic_sidebar( 'left-sidebar' ); ?> | |
| </ul> | |
| <?php endif; ?> | |
| </pre> | |
| === in the "Twenty Ten" theme (3.0+) === | |
| * {{Trac|wp-content/themes/twentyten/sidebar.php}} | |
| * {{Trac|wp-content/themes/twentyten/sidebar-footer.php}} | |
| ==Multiple Sidebars== | |
| You can load a specific sidebar by either their name (if given a string) or ID (if given an integer). For example, <tt>dynamic_sidebar('top_menu')</tt> will present a sidebar registered with <tt>register_sidebar(array('name'=>'top_menu',))</tt>. | |
| Using ID's ( <tt>dynamic_sidebar(1)</tt> ) is easier in that you don't need to name your sidebar, but they are harder to figure out without looking into your <tt>functions.php</tt> file or in the widgets administration panel and thus make your code less readable. Note that ID's begin at 1. | |
| If you name your own ID values in the <tt>register_sidebar()</tt> WordPress function, you might increase readability of the code. The ID should be all lowercase alphanumeric characters and not contain white space. You can also use the <tt>-</tt> and <tt>_</tt> characters. IDs must be unique and cannot match a sidebar name. Using your own IDs can also make the sidebar name translatable. | |
| <pre>// See the __() WordPress function for valid values for $text_domain. | |
| register_sidebar( array( | |
| 'id' => 'top-menu', | |
| 'name' => __( 'Top Menu', $text_domain ), | |
| 'description' => __( 'This sidebar is located above the age logo.', $text_domain ), | |
| ) ); | |
| </pre> | |
| This allows the use of <tt>dynamic_sidebar( 'top-menu' )</tt> which uses an ID and is readable. | |
| == Changelog == | |
| Since: [[Version 2.2|2.2.0]] | |
| == Source File == | |
| <tt>dynamic_sidebar()</tt> is located in {{Trac|wp-includes/widgets.php}}. | |
| == Further Reading == | |
| * [http://www.prelovac.com/vladimir/wordpress-theme-flexibility-with-dynamic-sidebars WordPress theme flexibility with dynamic sidebars] | |
| * [http://wordpress.org/support/topic/the-meaning-of-spitting-out-widgets The meaning of "spitting out" widgets] | |
| == Related == | |
| {{Sidebar Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Widgets]]</p> | |
| </d:entry> | |
| <d:entry id="register_sidebar_widget" d:title="register sidebar widget"> | |
| <d:index d:value="register sidebar widget"/> | |
| <h1>register sidebar widget</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/register_sidebar_widget}} | |
| {{ja|関数リファレンス/register_sidebar_widget}} | |
| }} | |
| {{Deprecated|wp_register_sidebar_widget()}} | |
| == Description == | |
| Register widget for sidebar with backwards compatibility. | |
| Provides backwards compatability to [[Function_Reference/wp_register_sidebar_widget|wp_register_sidebar_widget()]]. Registers callback as a widget output function with unique index name. This causes a draggable object containing name to appear in the admin interface. | |
| A basic widget is simply a function that prints some HTML. To get a widget included in the widgets palette, you must register it via this function. | |
| It is possible for theme authors to define replacement widgets within functions.php. Replace an existing widget by registering its name with a new callback. An empty callback will unregister a widget. | |
| Because each widget has a unique name and a non-unique callback, the default markup before a widget looks like this: | |
| <pre><li id="{name}" class="{callback}">{callback output}</li></pre> | |
| When you register a widget you may pass a custom HTML class to replace <code>callback</code>. This is most useful for object-oriented widgets whose callbacks are passed as arrays. | |
| == Replace With == | |
| [[Function_Reference/wp_register_sidebar_widget|wp_register_sidebar_widget()]] | |
| == Usage == | |
| %%% <?php register_sidebar_widget( $name, $output_callback, $classname ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$name|string/int|Widget ID.}} | |
| {{Parameter|$output_callback|callback|Run when widget is called.}} | |
| {{Parameter|$classname|string|Classname widget.|optional}} | |
| ==Example== | |
| <pre><?php | |
| function my_widget { | |
| // print some HTML for the widget to display here. | |
| } | |
| register_sidebar_widget("my_widget", "my_widget"); | |
| ?></pre> | |
| Given a class <code>my_widget</code> whose method that prints the widget HTML is called <code>display</code>, you would use the following code: | |
| <pre><?php | |
| class my_widget { | |
| function display() { | |
| // print some HTML for the widget to display here. | |
| } | |
| } | |
| register_sidebar_widget('My Widget', array('my_widget', 'display')); // callback is mywidget::display | |
| ?></pre> | |
| == Change Log == | |
| * Deprecated: [[Version 2.8|2.8.0]] Use [[Function_Reference/wp_register_sidebar_widget|wp_register_sidebar_widget()]] | |
| * Since: [[Version 2.2|2.2.0]] | |
| == Source File == | |
| <tt>register_sidebar_widget()</tt> is located in {{Trac|wp-includes/deprecated.php}}. | |
| == Related == | |
| {{Widget Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Widgets]]</p> | |
| </d:entry> | |
| <d:entry id="unregister_sidebar_widget" d:title="unregister sidebar widget"> | |
| <d:index d:value="unregister sidebar widget"/> | |
| <h1>unregister sidebar widget</h1> | |
| <p>{{Deprecated|new_function=wp_unregister_sidebar_widget|version=2.8}} | |
| == Description == | |
| Makes a previously available widget unavailable. This is most commonly used within a theme's functions.php to disable a widget that does not work well in that theme's sidebar. | |
| == Usage == | |
| %%% <?php unregister_sidebar_widget( $id ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$id|string/int|Widget ID.}} | |
| == Example == | |
| == Notes == | |
| * Uses [[Function Reference/wp_unregister_sidebar_widget|wp_unregister_sidebar_widget()]] | |
| == Change Log == | |
| * Deprecated: 2.8.0 | |
| * Since: 2.2.0 | |
| == Source File == | |
| <tt>unregister_sidebar_widget()</tt> was located in {{Trac|wp-includes/widgets.php}}. Upon deprecation it was moved to {{Trac|wp-includes/deprecated.php}}. | |
| == Related == | |
| {{Widget Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Widgets]]</p> | |
| </d:entry> | |
| <d:entry id="register_widget_control" d:title="register widget control"> | |
| <d:index d:value="register widget control"/> | |
| <h1>register widget control</h1> | |
| <p>{{Deprecated}} | |
| ==Synopsis== | |
| <tt>void register_widget_control ( string name, callback [, int width [, int height ] ] )</tt> | |
| Adds the output of callback to the admin interface as an inline popup. The popup is a child of the main form so it must not include <form> tags or submit buttons. It should include form inputs with very specific names and id’s. | |
| The form data should also be handled within callback as its first action, but advanced widgets may have good reasons to differ from this model. | |
| The string name used in register_widget_control() needs to match the string name used in [[Function Reference/register_sidebar_widget|register_sidebar_widget()]]. | |
| == Related == | |
| {{Widget Tags}} | |
| [[Category:Functions]] | |
| [[Category:Widgets]]</p> | |
| </d:entry> | |
| <d:entry id="unregister_widget_control" d:title="unregister widget control"> | |
| <d:index d:value="unregister widget control"/> | |
| <h1>unregister widget control</h1> | |
| <p>{{Deprecated}} | |
| ==Synopsis== | |
| <tt>void unregister_widget_control ( string name )</tt> | |
| Removes a widget’s admin callback. | |
| == Related == | |
| {{Widget Tags}} | |
| [[Category:Functions]] | |
| [[Category:Widgets]]</p> | |
| </d:entry> | |
| <d:entry id="unregister_sidebar" d:title="unregister sidebar"> | |
| <d:index d:value="unregister sidebar"/> | |
| <h1>unregister sidebar</h1> | |
| <p>== Description == | |
| De-registers a previously registered [[Sidebars|sidebar]]. | |
| == Usage == | |
| %%% <?php unregister_sidebar( $id ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$id|string|The ID of the sidebar when it was added.}} | |
| == Example == | |
| If added to a child theme's functions.php file, this will remove the footer sidebars registered by the TwentyTen theme. | |
| <pre> | |
| function remove_some_widgets(){ | |
| // Unregister some of the TwentyTen sidebars | |
| unregister_sidebar( 'first-footer-widget-area' ); | |
| unregister_sidebar( 'second-footer-widget-area' ); | |
| unregister_sidebar( 'third-footer-widget-area' ); | |
| unregister_sidebar( 'fourth-footer-widget-area' ); | |
| } | |
| add_action( 'widgets_init', 'remove_some_widgets', 11 ); | |
| </pre> | |
| == Notes == | |
| In the example, note that we assign a priority of 11 when registering the widgets_init hook. This is because a child theme's functions.php file is called before the parent theme's, which means that our call to unregister_sidebar() would accomplish nothing since the sidebar has not yet been registered. | |
| By lowering the priority of our action, we ensure that it is called after the parent theme's functions.php file is loaded. | |
| == Change Log == | |
| Since: 2.2.0 | |
| == Source File == | |
| <tt>unregister_sidebar()</tt> is located in {{Trac|wp-includes/widgets.php}}. | |
| == Related == | |
| {{Sidebar Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Widgets]]</p> | |
| </d:entry> | |
| <d:entry id="is_active_widget" d:title="is active widget"> | |
| <d:index d:value="is active widget"/> | |
| <h1>is active widget</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/is active widget}} | |
| {{ja|関数リファレンス/is_active_widget}} | |
| }} | |
| == Description == | |
| This [[Conditional Tags|Conditional Tag]] checks whether widget is displayed on the front-end. | |
| To be effective this function has to run after widgets have initialized, at action <tt>[[Plugin_API/Action_Reference/init | 'init']]</tt> or later. | |
| == Usage == | |
| <pre><?php | |
| is_active_widget( $callback, $widget_id, $id_base, $skip_inactive ); | |
| ?></pre> | |
| == Parameters == | |
| {{Parameter|$callback|string|Widget callback to check.|optional|False}} | |
| {{Parameter|$widget_id|int|Widget ID. Needed for checking.|optional}} | |
| {{Parameter|$id_base|string|Base ID of a widget created by extending WP_Widget.|optional}} | |
| {{Parameter|$skip_inactive|boolean|Whether to check in 'wp_inactive_widgets'.|optional|True}} | |
| ==Return Values== | |
| ; <tt>(mixed)</tt> : Returns false if the specified widget is not active, or the id of the sidebar in which the widget is active. If the callback is non-unique you can optionally specify the ID of the widget. | |
| == Examples == | |
| === Only load a script when the widget is active === | |
| <pre><?php | |
| if ( is_active_widget( false, false, $this->id_base, true ) ) { | |
| wp_enqueue_script( 'jquery' ); | |
| } | |
| ?></pre> | |
| == Change Log == | |
| Since: 2.2.0 | |
| == Source File == | |
| <tt>is_active_widget()</tt> is located in {{Trac|wp-includes/widgets.php}}. | |
| == Related == | |
| {{Widget Tags}} | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]] | |
| [[Category:Widgets]]</p> | |
| </d:entry> | |
| <d:entry id="is_dynamic_sidebar" d:title="is dynamic sidebar"> | |
| <d:index d:value="is dynamic sidebar"/> | |
| <h1>is dynamic sidebar</h1> | |
| <p>== Description == | |
| This [[Conditional Tags|Conditional Tag]] checks if any registered [[Sidebars|sidebar]] has active widgets. | |
| == Usage == | |
| %%% <?php is_dynamic_sidebar(); ?> %%% | |
| == Parameters == | |
| This tag does not accept any parameters. | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : <tt>true</tt> if any registered sidebar contains a widget; otherwise <tt>false</tt>. | |
| == Examples == | |
| == Change Log == | |
| Since: 2.2.0 | |
| == Source File == | |
| <tt>is_dynamic_sidebar()</tt> is located in {{Trac|wp-includes/widgets.php}}. | |
| == Related == | |
| {{Sidebar Tags}} | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_current_theme" d:title="get current theme"> | |
| <d:index d:value="get current theme"/> | |
| <h1>get current theme</h1> | |
| <p>== Description == | |
| Retrieve the name of the current theme. | |
| get_current_theme() is deprecated since version 3.4! Use [[Function Reference/wp_get_theme | wp_get_theme()]] instead | |
| == Usage == | |
| %%%<?php get_current_theme() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Template name. | |
| == Examples == | |
| === Current Theme Name === | |
| Get the name of the current theme. | |
| <?php | |
| $theme_name = get_current_theme(); | |
| echo $theme_name; | |
| ?> | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>template_directory</tt>' filter on template directory path and template name. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_current_theme()</tt> is located in {{Trac|wp-includes/deprecated.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| [[Function Reference/get_stylesheet_directory|get_stylesheet_directory]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_page_by_title" d:title="get page by title"> | |
| <d:index d:value="get page by title"/> | |
| <h1>get page by title</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get page by title}} | |
| {{ru|Справочник по функциям/get page by title}} | |
| }} | |
| == Description == | |
| Retrieves a post given its title. If more that one post uses the same title, the post with the smallest ID will be returned. | |
| Because this function uses the MySQL <tt>'='</tt> comparison the <tt>$page_title</tt> will ''usually'' be matched as case insensitive with [http://dev.mysql.com/doc/refman/5.5/en/case-sensitivity.html default collating]. | |
| == Usage == | |
| %%% | |
| <?php | |
| get_page_by_title( $page_title, $output, $post_type ); | |
| ?> | |
| %%% | |
| == Parameters == | |
| {{Parameter|$page_title|string|Page title}} | |
| {{Parameter|$output|string|Output type. <tt>OBJECT</tt>, <tt>ARRAY_N</tt>, or <tt>ARRAY_A</tt>.|optional|OBJECT}} | |
| {{Parameter|$post_type|string|Post type.|optional|page}} | |
| == Return Values == | |
| ; (mixed) : <tt>OBJECT</tt>, <tt>ARRAY_N</tt>, or <tt>ARRAY_A</tt>. | |
| <tt>NULL</tt> when no posts found. | |
| == Examples == | |
| ===Find Page ID to use with exclude in wp_list_pages=== | |
| This example will return the $page object for the page titled "About". Then the $page->ID element is used to exclude the About page when listing pages. | |
| <pre> | |
| <?php | |
| $page = get_page_by_title( 'About' ); | |
| wp_list_pages( 'exclude=' . $page->ID ); | |
| ?> | |
| </pre> | |
| ===How To Find WordPress Page ID By Title Then Replace the_content()=== | |
| In this example, we find the page id of "Sample Page" then replace the page's the_content() with "Hello World!" | |
| <pre> | |
| function my_content($content) { | |
| $page = get_page_by_title( 'Sample Page' ); | |
| if ( is_page($page->ID) ) | |
| $content = "Hello World!"; | |
| return $content; | |
| } | |
| add_filter('the_content', 'my_content'); | |
| </pre> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| == Change Log == | |
| * Since: [[Version 2.1|2.1.0]] | |
| * [[Version 3.0|3.0.0]]: <code>$post_type</code> Parameter was added. | |
| == Source File == | |
| <tt>get_page_by_title()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Page Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_terms" d:title="get terms"> | |
| <d:index d:value="get terms"/> | |
| <h1>get terms</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get terms}} | |
| {{ja|関数リファレンス/get terms}} | |
| }} | |
| ==Description== | |
| Retrieve the terms in a taxonomy or list of taxonomies. | |
| Returns an array of term objects, or a WP_Error object if any of the taxonomies to get terms from does not exist. | |
| ==Usage== | |
| %%%<?php get_terms( $taxonomies, $args ) ?>%%% | |
| === Default Usage === | |
| <pre><?php | |
| // no default values. using these as examples | |
| $taxonomies = array( | |
| 'post_tag', | |
| 'my_tax', | |
| ); | |
| $args = array( | |
| 'orderby' => 'name', | |
| 'order' => 'ASC', | |
| 'hide_empty' => true, | |
| 'exclude' => array(), | |
| 'exclude_tree' => array(), | |
| 'include' => array(), | |
| 'number' => '', | |
| 'fields' => 'all', | |
| 'slug' => '', | |
| 'parent' => '', | |
| 'hierarchical' => true, | |
| 'child_of' => 0, | |
| 'get' => '', | |
| 'name__like' => '', | |
| 'description__like' => '', | |
| 'pad_counts' => false, | |
| 'offset' => '', | |
| 'search' => '', | |
| 'cache_domain' => 'core' | |
| ); | |
| ?></pre> | |
| == Parameters == | |
| {{Parameter|$taxonomies|string&#124;array|The taxonomies to retrieve terms from. ([[Taxonomies#Default_Taxonomies|Default Taxonomies]])}} | |
| {{Parameter|$args|string&#124;array|Change what is returned.|optional|array}} | |
| ===Possible Arguments=== | |
| ; orderby : (''string'') | |
| :* <tt>id</tt> | |
| :* <tt>count</tt> | |
| :* <tt>name</tt> - Default | |
| :* <tt>slug</tt> | |
| :* <tt>term_group</tt> - Not fully implemented (avoid using) | |
| :* <tt>none</tt> | |
| ; order : (''string'') | |
| :* <tt>ASC</tt> - Default | |
| :* <tt>DESC</tt> | |
| ; hide_empty : (''boolean'') Whether to <b>not</b> return empty $terms. | |
| :* <tt>1 (true)</tt> - Default (i.e. Do not show empty terms) | |
| :* <tt>0 (false)</tt> | |
| ; exclude : (''integer|string|array'') An array of term ids to exclude. Also accepts a string of comma-separated ids. | |
| ; exclude_tree : (''integer'') An array of parent term ids to exclude | |
| ; include : (''integer'') An array of term ids to include. Empty returns all. | |
| ; number : (''integer'') The maximum number of terms to return. Default is to return them all. | |
| ; fields : (''string'') | |
| :* all - returns an array of term objects - Default | |
| :* ids - returns an array of integers | |
| :* names - returns an array of strings | |
| :* count - (3.2+) returns the number of terms found | |
| :* id=>parent - returns an associative array where the key is the term id and the value is the parent term id if present or 0 | |
| :* id=>slug - returns an associative array where the key is the term id and the value is the slug | |
| :* id=>name - returns an associative array where the key is the term id and the value is the name | |
| ; slug : (''string'') Returns terms whose "slug" matches this value. Default is empty string. | |
| ; parent : (''integer'') Get direct children of this term (only terms whose explicit parent is this value). If 0 is passed, only top-level terms are returned. Default is an empty string. | |
| ; hierarchical : (''boolean'') Whether to include terms that have non-empty descendants (even if 'hide_empty' is set to true). | |
| :* <tt>1 (true)</tt> - Default | |
| :* <tt>0 (false)</tt> | |
| ; child_of : (''integer'') Get all descendents of this term. Default is 0. '''Note:''' the difference between <tt>child_of</tt> and <tt>parent</tt> is that where <tt>parent</tt> only gets direct children of the parent term (ie: 1 level down), <tt>child_of</tt> gets ''all'' descendants (as many levels as are available) | |
| ; get : (''string'') Default is nothing . Allow for overwriting 'hide_empty' and 'child_of', which can be done by setting the value to 'all'. | |
| ; name__like : (''string'') The term name you wish to match. It does a LIKE '%string%' query against the term name only. This matches terms that '''contain''' the 'name__like' string. '''Note:''' This was changed in WordPress 3.7, when previously name__like matched terms that '''begin with''' the string. See [http://core.trac.wordpress.org/ticket/8214 ticket #8214]. | |
| ; description__like : (''string'') Returned terms' descriptions will contain the value of 'description__like', case-insensitive. Default is empty string. It does a LIKE '%string%' query against the term description only. This matches terms that '''contain''' the 'description__like' string. | |
| ; pad_counts : (''boolean'') If true, count all of the children along with the $terms. | |
| :* <tt>1 (true)</tt> | |
| :* <tt>0 (false)</tt> - Default | |
| ; offset : (''integer'') The number by which to offset the terms query. Must be used in conjunction with 'number' otherwise 'offset' is ignored and the entire result set is returned. | |
| ; search : (''string'') The term name you wish to match. It does a LIKE '%search_string%' query against the term name and slug. This matches terms that '''contain''' the 'search_string' string. | |
| ; cache_domain : (''string'') Version 3.2 and above. The 'cache_domain' argument enables a unique cache key to be produced when the query produced by get_terms() is stored in object cache. For instance, if you are using one of this function's filters to modify the query (such as 'terms_clauses'), setting 'cache_domain' to a unique value will not overwrite the cache for similar queries. Default value is 'core'. | |
| '''NOTE''': Arguments are passed in the format used by [[Function_Reference/wp_parse_args|wp_parse_args()]]. e.g. | |
| == Return Values == | |
| ; <tt>(array&#124;string&#124;WP_Error)</tt> : Array of term objects or an empty array if no terms were found. <tt>[[Class_Reference/WP_Error | WP_Error]]</tt> if any of <tt>$taxonomies</tt> does not exist. If the <tt>'fields'</tt> argument was <tt>'count'</tt>, the number of terms found will be returned as a string. | |
| The fields returned are: | |
| * <tt>term_id</tt> | |
| * <tt>name</tt> | |
| * <tt>slug</tt> | |
| * <tt>term_group</tt> | |
| * <tt>term_taxonomy_id</tt> | |
| * <tt>taxonomy</tt> | |
| * <tt>description</tt> | |
| * <tt>parent</tt> | |
| * <tt>count</tt> | |
| '''Warning: string vs integer confusion!''' Field values, including <tt>term_id</tt> are returned in string format. Before further use, typecast numeric values to actual integers, otherwise WordPress will mix up term_ids and slugs which happen to have only numeric characters | |
| == Examples == | |
| Get all post categories ordered by count. | |
| String syntax: | |
| $categories = get_terms( 'category', 'orderby=count&hide_empty=0' ); | |
| Array syntax: | |
| <pre> | |
| $categories = get_terms( 'category', array( | |
| 'orderby' => 'count', | |
| 'hide_empty' => 0 | |
| ) ); | |
| </pre> | |
| Get all the links categories: | |
| $mylinks_categories = get_terms('link_category', 'orderby=count&hide_empty=0'); | |
| List all the terms in a custom taxonomy, without a link: | |
| <pre> $terms = get_terms("my_taxonomy"); | |
| if ( !empty( $terms ) && !is_wp_error( $terms ) ){ | |
| echo "<ul>"; | |
| foreach ( $terms as $term ) { | |
| echo "<li>" . $term->name . "</li>"; | |
| } | |
| echo "</ul>"; | |
| } | |
| </pre> | |
| List all the terms, with link to term archive, separated by an interpunct ('''&middot;'''): | |
| <pre lang="php">$args = array( 'hide_empty=0' ); | |
| $terms = get_terms('my_term', $args); | |
| if ( !empty( $terms ) && !is_wp_error( $terms ) ) { | |
| $count = count($terms); | |
| $i=0; | |
| $term_list = '<p class="my_term-archive">'; | |
| foreach ($terms as $term) { | |
| $i++; | |
| $term_list .= '<a href="' . get_term_link( $term ) . '" title="' . sprintf(__('View all post filed under %s', 'my_localization_domain'), $term->name) . '">' . $term->name . '</a>'; | |
| if ($count != $i) { | |
| $term_list .= ' &amp;middot; '; | |
| } | |
| else { | |
| $term_list .= '</p>'; | |
| } | |
| } | |
| echo $term_list; | |
| }</pre> | |
| ==Details== | |
| You can inject any customizations to the query before it is sent or control the output with filters. | |
| The 'get_terms' filter will be called when the cache has the term and will pass the found term along with the array of $taxonomies and array of $args. | |
| This filter is also called before the array of terms is passed and will pass the array of terms, along with the $taxonomies and $args. | |
| The 'list_terms_exclusions' filter passes the compiled exclusions along with the $args. | |
| == Change Log == | |
| * Since: [[Version 2.3|2.3.0]] | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_terms()</tt> is located in {{Trac|wp-includes/taxonomy.php}}. | |
| ==Related== | |
| {{Term Tags}} | |
| == Resources == | |
| [[Category:Functions]] | |
| [[Category:Taxonomies]] | |
| {{Tag Footer}}</p> | |
| </d:entry> | |
| <d:entry id="wp_upload_dir" d:title="wp upload dir"> | |
| <d:index d:value="wp upload dir"/> | |
| <h1>wp upload dir</h1> | |
| <p>== Description == | |
| Returns an array of '''key => value''' pairs containing path information on the currently configured uploads directory. | |
| Checks the 'upload_path' option, which should be from the web root folder, and if it isn't empty it will be used. If it is empty, then the path will be 'WP_CONTENT_DIR/uploads'. If the 'UPLOADS' constant is defined, then it will override the 'upload_path' option and 'WP_CONTENT_DIR/uploads' path. | |
| The upload URL path is set either by the 'upload_url_path' option or by using the 'WP_CONTENT_URL' constant and appending '/uploads' to the path. | |
| If the 'uploads_use_yearmonth_folders' is set to true (checkbox if checked in the administration settings panel), then the time will be used. The format will be year first and then month. | |
| If the path couldn't be created, then an error will be returned with the key <tt>'error'</tt> containing the error message. The error suggests that the parent directory is not writable by the server. | |
| On success, the returned array will have many indices: | |
| * 'path' - base directory and sub directory or full path to upload directory. | |
| * 'url' - base url and sub directory or absolute URL to upload directory. | |
| * 'subdir' - sub directory if uploads use year/month folders option is on. | |
| * 'basedir' - path without subdir. | |
| * 'baseurl' - URL path without subdir. | |
| * 'error' - set to false. | |
| == Usage == | |
| <pre> | |
| <?php $upload_dir = wp_upload_dir(); ?> | |
| </pre> | |
| == Parameters == | |
| {{Parameter|$time|string|Time formatted in 'yyyy/mm'.|optional|null}} | |
| == Example == | |
| Basic example to produce the upload directory URL. | |
| %%%<?php $upload_dir = wp_upload_dir(); ?> | |
| <?php echo $upload_dir['baseurl']; ?>%%% | |
| More in-depth break down of the data returned. | |
| %%%<?php | |
| $upload_dir = wp_upload_dir(); // Array of key => value pairs | |
| /* | |
| $upload_dir now contains something like the following (if successful) | |
| Array ( | |
| [path] => C:\path\to\wordpress\wp-content\uploads\2010\05 | |
| [url] => http://example.com/wp-content/uploads/2010/05 | |
| [subdir] => /2010/05 | |
| [basedir] => C:\path\to\wordpress\wp-content\uploads | |
| [baseurl] => http://example.com/wp-content/uploads | |
| [error] => | |
| ) | |
| // Descriptions | |
| [path] - base directory and sub directory or full path to upload directory. | |
| [url] - base url and sub directory or absolute URL to upload directory. | |
| [subdir] - sub directory if uploads use year/month folders option is on. | |
| [basedir] - path without subdir. | |
| [baseurl] - URL path without subdir. | |
| [error] - set to false. | |
| */ | |
| echo $upload_dir['path'] . '<br />'; | |
| echo $upload_dir['url'] . '<br />'; | |
| echo $upload_dir['subdir'] . '<br />'; | |
| echo $upload_dir['basedir'] . '<br />'; | |
| echo $upload_dir['baseurl'] . '<br />'; | |
| echo $upload_dir['error'] . '<br />'; | |
| $upload_url = ( $upload_dir['url'] ); | |
| $upload_url_alt = ( $upload_dir['baseurl'] . $upload_dir['subdir'] ); | |
| // Now echo the final result | |
| echo $upload_url . '<br />'; // Output - http://example.com/wp-content/uploads/2010/05 | |
| // Using year and month based folders, the below will be the same as the line above. | |
| echo $upload_url_alt . '<br />'; // Output - http://example.com/wp-content/uploads/2010/05 | |
| ?>%%% | |
| == Important Note == | |
| Note that using this function <strong>will create a subfolder in your Uploads folder</strong> corresponding to the queried month (or current month, if no <tt>$time</tt> argument is provided), if that folder is not already there. You don't have to upload anything in order for this folder to be created. | |
| == Folder Name == | |
| In case you want to move the <tt>/uploads</tt> folder, you'll have to use the <tt>UPLOADS</tt> constant. It normally shouldn't get used, as it only get's defined when <tt>ms_default_constants()</tt> is run (only multisite), but you can simply set | |
| <pre> | |
| define( 'UPLOADS', trailingslashit( WP_CONTENT_DIR ).'custom_uploads_name' ); | |
| </pre> | |
| in a single site install and it will just work, as the public directory structure function <tt>wp_upload_dir()</tt> sets it up, when it was defined: <tt>$dir = ABSPATH . UPLOADS;</tt>. | |
| ''Note:'' You can extract the folder name with the following line: | |
| <pre> | |
| // returns `false` if the UPLOADS constant is not defined | |
| $upload_dir_name = false; | |
| if ( defined( 'UPLOADS' ) ) | |
| str_replace( trailingslashit( WP_CONTENT_DIR ), '', untrailingslashit( UPLOADS ) ); | |
| </pre> | |
| == Change Log == | |
| Since: [[Version 2.0|2.0.0]] | |
| == Source File == | |
| <tt>wp_upload_dir()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| {{Directory URL Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_attachment_image" d:title="wp get attachment image"> | |
| <d:index d:value="wp get attachment image"/> | |
| <h1>wp get attachment image</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp get attachment image}} | |
| {{it|Riferimento funzioni/wp get attachment image}} | |
| {{ja|Function Reference/wp get attachment image}} | |
| }} | |
| == Description == | |
| Returns an HTML image element representing an attachment file, if there is any, otherwise an empty string. | |
| == Usage == | |
| %%%<?php wp_get_attachment_image( $attachment_id, $size, $icon, $attr ); ?>%%% | |
| == Default Usage == | |
| <?php echo wp_get_attachment_image( 1 ); ?> | |
| If the attachment is an image, the function returns an image at the specified size. | |
| For other attachments, the function returns a media icon if the <var>$icon</var> parameter is set to <tt>true</tt>. | |
| To get attachment IDs dynamically in a template, you can use [[Template_Tags/get_posts|get_posts('post_type=attachment')]], etc. | |
| == Parameters == | |
| {{Parameter|$attachment_id|integer|ID of the desired attachment.}} | |
| {{Parameter|$size|string/array|Image size. Either a string keyword (thumbnail, medium, large or full) or a 2-item array representing width and height in pixels, e.g. array(32,32). As of [[Version 2.5]], this parameter does not affect the size of media icons, which are always shown at their original size.|Optional|'thumbnail'}} | |
| Instead of using an array which requires checking all of the image sizes, you should consider registering a size with <code>add_image_size</code> so that a cropped version is generated. It's much more efficient than having to find the closest sized image. | |
| {{Parameter|$icon|boolean|Use a media icon to represent the attachment.|Optional|'False'}} | |
| :* <tt>1 (True)</tt> | |
| :* <tt>0 (False)</tt> - Default | |
| {{Parameter|$attr|string/array|Query string or array of attributes.|Optional}} | |
| <pre> | |
| $default_attr = array( | |
| 'src' => $src, | |
| 'class' => "attachment-$size", | |
| 'alt' => trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )), | |
| ); | |
| </pre> | |
| The <tt>$attr</tt> argument is merged with WordPress's default attributes and passed through the <tt>wp_get_attachment_image_attributes</tt> filter. | |
| == Examples == | |
| === Display all images as a list === | |
| To display all of the images and titles attached to a certain page and display them as a list of bullets you can use the following: | |
| <pre><ul> | |
| <?php if ( have_posts() ) : while ( have_posts() ) : the_post(); | |
| $args = array( | |
| 'post_type' => 'attachment', | |
| 'numberposts' => -1, | |
| 'post_status' => null, | |
| 'post_parent' => $post->ID | |
| ); | |
| $attachments = get_posts( $args ); | |
| if ( $attachments ) { | |
| foreach ( $attachments as $attachment ) { | |
| echo '<li>'; | |
| echo wp_get_attachment_image( $attachment->ID, 'full' ); | |
| echo '<p>'; | |
| echo apply_filters( 'the_title', $attachment->post_title ); | |
| echo '</p></li>'; | |
| } | |
| } | |
| endwhile; endif; ?> | |
| </ul></pre> | |
| == Return Value == | |
| an HTML img element or empty string on failure. | |
| == Change Log == | |
| Since: 2.5.0 | |
| == Source File == | |
| <tt>wp_get_attachment_image()</tt> is located in {{Trac|wp-includes/media.php}}. | |
| == Related == | |
| {{Attachment Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_attachment_image_src" d:title="wp get attachment image src"> | |
| <d:index d:value="wp get attachment image src"/> | |
| <h1>wp get attachment image src</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_get_attachment_image_src}} | |
| {{it|Riferimento funzioni/wp_get_attachment_image_src}} | |
| {{ja| 関数リファレンス/wp_get_attachment_image_src}} | |
| }} | |
| == Description == | |
| Returns an ordered array with values corresponding to the (0) url, (1) width, (2) height, and (3) scale of an image attachment (or an icon representing any attachment). | |
| It's most often used to get the URL (src) for an image attachment: use the first element in the returned array. | |
| wp_get_attachment_image() uses wp_get_attachment_image_src() to fill the width, height, and src attributes of an <tt>img</tt>. | |
| == Usage == | |
| %%% <?php wp_get_attachment_image_src( $attachment_id, $size, $icon ); ?> %%% | |
| == Parameters == | |
| {{Parameter|$attachment_id|integer|ID of the desired attachment.}} | |
| {{Parameter|$size|string/array|Size of the image shown for an image attachment: either a string keyword (thumbnail, medium, large or full) or a 2-item array representing width and height in pixels, e.g. array(32,32). As of Version 2.5, this parameter does not affect the size of media icons, which are always shown at their original size.|optional|thumbnail}} | |
| {{Parameter|$icon|bool|Use a media icon to represent the attachment.|optional|false}} | |
| == Return Value == | |
| {{Return||array|An array containing:}} | |
| * [0] => url | |
| * [1] => width | |
| * [2] => height | |
| * [3] => boolean: true if $url is a resized image, false if it is the original. | |
| or false, if no image is available. | |
| == Examples == | |
| === Default Usage === | |
| <pre><?php | |
| $attachment_id = 8; // attachment ID | |
| $image_attributes = wp_get_attachment_image_src( $attachment_id ); // returns an array | |
| if( $image_attributes ) { | |
| ?> | |
| <img src="<?php echo $image_attributes[0]; ?>" width="<?php echo $image_attributes[1]; ?>" height="<?php echo $image_attributes[2]; ?>"> | |
| <?php } ?></pre> | |
| === Change Icon Directory === | |
| WordPress can use media icons to represent [[Using_Image_and_File_Attachments|attachment files]] on your blog and in the Admin interface, if those icons are available. For images it returns the thumbnail. For other media types It looks for image files named by media type (e.g. audio.jpg) in the directory: ''wp-includes/images/crystal/''. | |
| This example shows how you can change this directory to a folder called "images" in your theme: ''wp-content/themes/yourtheme/images''. Create the folder and put the "media type images" in there. To tell WordPress the directory has changed put this in the current theme's [[Theme_Development#Functions_File|functions.php]] file: | |
| <pre>add_filter( 'icon_dir', 'my_theme_icon_directory' ); | |
| add_filter( 'icon_dir_uri', 'my_theme_icon_uri' ); | |
| function my_theme_icon_directory( $icon_dir ) { | |
| return get_stylesheet_directory() . '/images'; | |
| } | |
| function my_theme_icon_uri( $icon_dir ) { | |
| return get_stylesheet_directory_uri() . '/images'; | |
| } | |
| </pre> | |
| === Show the first image of the post === | |
| find the full code here [[Function Reference/get_children#Examples|get_children()]]. | |
| == Change Log == | |
| Since: [[Version 2.5|2.5.0]] | |
| == Source File == | |
| <tt>wp_get_attachment_image_src()</tt> is located in {{Trac|wp-includes/media.php}}. | |
| == Related == | |
| {{Attachment Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="is_email" d:title="is email"> | |
| <d:index d:value="is email"/> | |
| <h1>is email</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/is_email}} | |
| {{ko|Function_Reference/is_email}} | |
| }} | |
| == Description == | |
| Verifies that an email is valid. | |
| == Usage == | |
| %%%<?php is_email( $email ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$email|string|Email address to check.}} | |
| == Return Values == | |
| ; <tt>(string|bool)</tt> : Either returns false or the valid email address. | |
| == Examples == | |
| <pre> | |
| if ( is_email( 'email@domain.com' ) ) { | |
| echo 'email address is valid.'; | |
| } | |
| </pre> | |
| == Notes == | |
| Does not grok i18n domains. Not RFC compliant. | |
| == Change Log == | |
| * [[Version_3.0 | 3.0.0]]: The second parameter, <tt>$check_dns</tt> was deprecated. See [http://core.trac.wordpress.org/changeset/14381 changeset 14381]. | |
| * Since: 0.71 | |
| == Source File == | |
| <tt>is_email()</tt> is located in | |
| {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find any related functions. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| See: [[Data_Validation|Data Validation]] article for an in-depth discussion of input and output sanitization. | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="attribute_escape" d:title="attribute escape"> | |
| <d:index d:value="attribute escape"/> | |
| <h1>attribute escape</h1> | |
| <p>[[Function Reference|''&larr; Return to function reference.'']] | |
| {{Deprecated}} | |
| == Description == | |
| '''This function is deprecated as of WordPress 2.8.0. Please use [[Function Reference/esc_attr|esc_attr]] instead.''' | |
| This function escapes or encodes HTML special characters (including single and double quotes) for use in HTML attributes. It works like the standard PHP <code>[http://php.net/manual/en/function.htmlspecialchars.php htmlspecialchars]</code> except that it doesn't double-encode HTML entities (i.e. <code>&amp;amp;</code> will remain unchanged, rather than encoded to <code>&amp;amp;amp;</code>). | |
| <code>attribute_escape</code> can be found in <code>/wp-includes/formatting.php</code>. | |
| == Usage == | |
| %%%<?php echo attribute_escape($text); ?>%%% | |
| == Parameters == | |
| ;<code>$text</code>: (''string'') Text to be escaped. | |
| == Related == | |
| [[Function Reference/esc_attr|esc_attr]], [[Function Reference/esc_attr_e|esc_attr_e]]. | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_page" d:title="get page"> | |
| <d:index d:value="get page"/> | |
| <h1>get page</h1> | |
| <p>{{Deprecated|new_function=get_post}} | |
| == Description == | |
| Retrieves page data given a page ID or page object. | |
| Pages provide a way to have static content that will not affect things like articles or archives or any other blog entry features of WordPress. Its simply a way to turn a blog entry into static content. | |
| == Usage == | |
| %%%<?php get_page( $page_id ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$page_id|integer|Page ID passed by reference (see example below)|required|Page ID from global variable at time function is called }} | |
| {{Parameter|$output|OBJECT/ARRAY_A/ARRAY_N| What to output. |optional|OBJECT }} | |
| {{Parameter|$filter|string|How the return value should be filtered. Options are 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The 'attribute' and 'js' contexts are treated like 'display'. |optional|'raw'}} | |
| == Return Values == | |
| <!-- The possible values need to be verified and inserted where there are question marks --> | |
| ; <tt>(object|array)</tt> : mixed Page data. | |
| [ID] => (integer) | |
| [post_author] => (integer) | |
| [post_date] => (YYYY-MM-DD HH:MM:SS) | |
| [post_date_gmt] => (YYYY-MM-DD HH:MM:SS) | |
| [post_content] => (all post content is in here) | |
| [post_title] => (Post Title Here) | |
| [post_excerpt] => (Post Excerpt) | |
| [post_status] => (? | publish) | |
| [comment_status] => (? | closed) | |
| [ping_status] => (? | closed) | |
| [post_password] => (blank if not specified) | |
| [post_name] => (slug-is-here) | |
| [to_ping] => (?) | |
| [pinged] => (?) | |
| [post_modified] => (YYYY-MM-DD HH:MM:SS) | |
| [post_modified_gmt] => (YYYY-MM-DD HH:MM:SS) | |
| [post_content_filtered] => (?) | |
| [post_parent] => (integer) | |
| [guid] => (a unique identifier that is not necessarily the URL to the Page) | |
| [menu_order] => (integer) | |
| [post_type] => (? | page) | |
| [post_mime_type] => ()?) | |
| [comment_count] => (integer) | |
| [ancestors] => (object|array) | |
| [filter] => (? | raw) | |
| If you need the URL to the Page, don't try and use the <code>guid</code> value. Use [[Function_Reference/the_permalink|the_permalink]] or [[Function_Reference/get_permalink|get_permalink]] instead. | |
| If a page is not found, a null value is returned. | |
| {{Stub}} | |
| == Examples == | |
| This example code can be used when you want to include the text of a specific page in a theme. | |
| <pre> | |
| <?php | |
| $page_id = 123; // 123 should be replaced with a specific Page's id from your site, which you can find by mousing over the link to edit that Page on the Manage Pages admin page. The id will be embedded in the query string of the URL, e.g. page.php?action=edit&post=123. | |
| $page_data = get_page( $page_id ); // You must pass in a variable to the get_page function. If you pass in a value (e.g. get_page ( 123 ); ), WordPress will generate an error. By default, this will return an object. | |
| echo '<h3>'. $page_data->post_title .'</h3>';// echo the title | |
| echo apply_filters('the_content', $page_data->post_content); // echo the content and retain WordPress filters such as paragraph tags. | |
| Origin: http://wordpress.org/support/topic/get_pagepost-and-no-paragraphs-problem | |
| ?> | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| * Deprecated: 3.5.0 | |
| * Since: 1.5.1 | |
| == Source File == | |
| <tt>get_page()</tt> is located in | |
| {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Page Tags}} | |
| [[Function_Reference/get_post|get_post]] | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="post_meta_Function_Examples" d:title="post meta Function Examples"> | |
| <d:index d:value="post meta Function Examples"/> | |
| <h1>post meta Function Examples</h1> | |
| <p>==Description== | |
| The following is a detailed example for the usage of the [[Function Reference/add post meta|add_post_meta]], [[Function Reference/delete post meta|delete_post_meta]], [[Function Reference/update post meta|update_post_meta]], and [[Function Reference/get post meta|get_post_meta]] functions. | |
| ==Example== | |
| <div style="padding: 1em; border: 1px dashed #2f6fab; color: Black; background-color: #fafafa; line-height: 1.1em"> | |
| %%%<?php | |
| /******************* | |
| This function handles the mood and listening_to meta tags. | |
| It can be called with an action of update, delete, and get (default) | |
| When called with an action of update, either $mood or $listening_to must be provided. | |
| i.e. mood_music( $post->ID, 'update', 'Happy', 'Bon Jovi - It's My Life' ); | |
| *******************/ | |
| function mood_music( $post_id, $action = 'get', $mood = 0, $listening_to = 0 ) { | |
| //Let's make a switch to handle the three cases of 'Action' | |
| switch ($action) { | |
| case 'update' : | |
| if( ! $mood && ! $listening_to ) | |
| //If nothing is given to update, end here | |
| return false; | |
| //add_post_meta usage: | |
| //add_post_meta( $post_id, $meta_key, $meta_value, $unique = false ) | |
| //If the $mood variable is supplied, | |
| //add a new key named 'mood', containing that value. | |
| //If the 'mood' key already exists on this post, | |
| //this command will simply add another one. | |
| if( $mood ) { | |
| add_post_meta( $post_id, 'mood', $mood ); | |
| return true; | |
| } | |
| //update_post_meta usage: | |
| //update_post_meta( $post_id, $meta_key, $meta_value ) | |
| //If the $listening_to variable is supplied, | |
| //add a new key named 'listening_to', containing that value. | |
| //If the 'listening_to' key already exists on this post, | |
| //this command will update it to the new value | |
| if( $listening_to ) { | |
| add_post_meta( $post_id, 'listening_to', $listening_to, true ) or | |
| update_post_meta( $post_id, 'listening_to', $listening_to ); | |
| return true; | |
| } | |
| case 'delete' : | |
| //delete_post_meta usage: | |
| //delete_post_meta( $post_id, $meta_key, $prev_value = ' ' ) | |
| //This will delete all instances of the following keys from the given post | |
| delete_post_meta( $post_id, 'mood' ); | |
| delete_post_meta( $post_id, 'listening_to' ); | |
| //To only delete 'mood' if it's value is 'sad': | |
| //delete_post_meta( $post_id, 'mood', 'sad' ); | |
| break; | |
| case 'get' : | |
| //get_post_custom usage: | |
| //get_post_meta( $post_id, $meta_key, $single value = false ) | |
| //$stored_moods will be an array containing all values of the meta key 'mood' | |
| $stored_moods = get_post_meta( $post_id, 'mood' ); | |
| //$stored_listening_to will be the first value of the key 'listening_to' | |
| $stored_listening_to = get_post_meta( $post_id, 'listening_to', 'true' ); | |
| //Now we need a nice ouput format, so that | |
| //the user can implement it how he/she wants: | |
| //ie. echo mood_music( $post->ID, 'get' ); | |
| $return = '<div class='mood-music'>'; | |
| if ( ! empty( $stored_moods ) ) | |
| $return .= '<strong>Current Mood</strong>: '; | |
| foreach( $stored_moods as $mood ) | |
| $return .= $mood . ', '; | |
| $return .= '<br/>'; | |
| if ( ! empty( $stored_listening_to ) ) { | |
| $return .= '<strong>Currently Listening To</strong>: '; | |
| $return .= $stored_listening_to; | |
| } | |
| $return .= '</div>'; | |
| return $return; | |
| default : | |
| return false; | |
| break; | |
| } //end switch | |
| } //end function | |
| ?>%%%</div> | |
| ==Resources== | |
| * | |
| ==Related== | |
| {{Post Meta Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_category_by_slug" d:title="get category by slug"> | |
| <d:index d:value="get category by slug"/> | |
| <h1>get category by slug</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_category_by_slug}} | |
| {{it|Riferimento funzioni/get_category_by_slug}} | |
| {{ja|関数リファレンス/get_category_by_slug}} | |
| }} | |
| == Description == | |
| Retrieve category object by category slug. Returns false if not found. | |
| == Usage == | |
| %%%<?php get_category_by_slug( $slug ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$slug|string|The category slug.}} | |
| == Return Values == | |
| ; (object) : Category data object. | |
| ; (boolean) : false if not found | |
| == Examples == | |
| <pre><?php | |
| $idObj = get_category_by_slug('category-slug'); | |
| $id = $idObj->term_id; | |
| ?></pre> | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_term_by|<tt>get_term_by()</tt>]] to get the category object | |
| * Uses: [[Function_Reference/_make_cat_compat|<tt>_make_cat_compat()</tt>]] to make category object compatible with WP 2.3.0 and earlier versions. | |
| == Change Log == | |
| Since: 2.3.0 | |
| == Source File == | |
| <tt>get_category_by_slug()</tt> is located in {{Trac|wp-includes/category.php}}. | |
| == Related == | |
| {{Category Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_attachment_is_image" d:title="wp attachment is image"> | |
| <d:index d:value="wp attachment is image"/> | |
| <h1>wp attachment is image</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_attachment_is_image}} | |
| {{it|Riferimento funzioni/wp_attachment_is_image}} | |
| {{ja|関数リファレンス/wp_attachment_is_image}} | |
| }} | |
| ==Description== | |
| This function determines if a post's attachment is an image. It returns TRUE if the attachment is an image, FALSE if not. The accepted file extensions/mime types are: .jpg, .jpeg, .gif, .png. | |
| ==Usage== | |
| %%% <?php wp_attachment_is_image( $post_id ); ?> %%% | |
| ==Parameters== | |
| {{Parameter|$post_id|int|Integer ID of the post.|optional|0}} | |
| == Return Values == | |
| ; (bool) : TRUE if the attachment is an image, FALSE if not. | |
| ==Example== | |
| To check if post ID 37's attachment is an image: | |
| <pre> | |
| <?php | |
| $id = 37; | |
| if ( wp_attachment_is_image( $id ) ) { | |
| echo "Post ".$id." is an image!"; | |
| } else { | |
| echo "Post ".$id." is not an image."; | |
| } | |
| ?> | |
| </pre> | |
| ==Notes== | |
| * Uses: [[Function_Reference/get_attached_file|<tt>get_attached_file()</tt>]] | |
| ==Change Log== | |
| Since: 2.1.0 | |
| ==Source File== | |
| <tt>wp_attachment_is_image()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]] | |
| [[Category:New page created]]</p> | |
| </d:entry> | |
| <d:entry id="get_page_by_path" d:title="get page by path"> | |
| <d:index d:value="get page by path"/> | |
| <h1>get page by path</h1> | |
| <p>== Description == | |
| Retrieves a page given its path. | |
| == Usage == | |
| %%%<?php get_page_by_path( $page_path, $output, $post_type ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$page_path|string|Page path}} | |
| {{Parameter|$output|string|Output type. <tt>OBJECT</tt>, <tt>ARRAY_N</tt>, or <tt>ARRAY_A</tt>.|optional|OBJECT}} | |
| {{Parameter|$post_type|string|Post Type.|optional|page}} | |
| == Return Values == | |
| ; (mixed) : Null when complete. | |
| == Examples == | |
| === Page Path === | |
| This is the equivalent of the '<tt>pagename</tt>' query, as in: '<tt>index.php?pagename=parent-page/sub-page</tt>'. | |
| Code for the above could be written as (assuming '<tt>parent-page/sub-page</tt>' is actually the path to a page): | |
| get_page_by_path('parent-page/sub-page'); | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| For non-heirarchical custom post types, you need to use just the slug in tandem with the post_type parameter. | |
| //Returns nothing, assumes animals is the rewrite slug for the animal CPT | |
| get_page_by_path('animals/cat', OBJECT, 'animal'); | |
| //Returns the animal with the slug 'cat' | |
| get_page_by_path('cat', OBJECT, 'animal'); | |
| The functions basename() and untrailingslashit() are handy for grabbing the last part of the URL for this: | |
| $page_path = 'animals/cat/'; | |
| get_page_by_path( basename( untrailingslashit( $page_path ) ) , OBJECT, 'animal'); | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_page_by_path()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Page Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="check_comment" d:title="check comment"> | |
| <d:index d:value="check comment"/> | |
| <h1>check comment</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/check_comment}} | |
| {{it|Riferimento funzioni/check_comment}} | |
| }} | |
| {{Copyedit}} | |
| == Description == | |
| <tt>check_comment()</tt> checks whether a comment passes internal checks set by WordPress [[Comment_Moderation]]. | |
| == Usage == | |
| %%%<?php | |
| check_comment( $author, $email, $url, $comment, $user_ip, | |
| $user_agent, $comment_type ); | |
| ?>%%% | |
| == Parameters == | |
| {{Parameter|$author|string|Comment author name.}} | |
| {{Parameter|$email|string|Comment author email.}} | |
| {{Parameter|$url|string|Comment author URL.}} | |
| {{Parameter|$comment|string|Comment contents.}} | |
| {{Parameter|$user_ip|string|Comment author [[Glossary#IP Address|IP address]].}} | |
| {{Parameter|$user_agent|string|Comment author user agent.}} | |
| {{Parameter|$comment_type|string|Comment type ([[Glossary#Comments|<tt>comment</tt>]], [[Glossary#Trackback|<tt>trackback</tt>]], or [[Glossary#Pingback|<tt>pingback</tt>]]).}} | |
| == Return Values == | |
| ; <tt>(boolean)</tt> : This function returns a single [http://us2.php.net/manual/en/language.types.boolean.php boolean] value of either <tt>true</tt> or <tt>false</tt>. | |
| Returns <tt>false</tt> if in [[Comment_Moderation]]: | |
| * The Administrator must approve all messages, | |
| * The number of external links is too high, or | |
| * Any banned word, name, URL, e-mail, or IP is found in any parameter except <tt>$comment_type</tt>. | |
| Returns <tt>true</tt> if the Administrator does not have to approve all messages and: | |
| * <tt>$comment_type</tt> parameter is a [[Glossary#Trackback|<tt>trackback</tt>]] or [[Glossary#Pingback|<tt>pingback</tt>]] and part of the [[Glossary#Blogroll|blogroll]], or | |
| * <tt>$author</tt> and <tt>$email</tt> parameters have been approved previously. | |
| Returns <tt>true</tt> in all other cases. | |
| == Examples == | |
| Simple use case | |
| <pre> <?php | |
| $author = "John Charles Smith"; | |
| $email = "jsmith@example.com"; | |
| $url = "http://example.com"; | |
| $comment = "Excellent..."; | |
| $user_ip = "12.34.56.78"; | |
| $user_agent = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.79 Safari/535.11"; | |
| $comment_type = "comment"; | |
| if (check_comment( $author, $email, $url, $comment, $user_ip, $user_agent, $comment_type )) { | |
| echo "The Comment robot says: Thank you for your comment."; | |
| } else { | |
| echo "The Comment robot says: This comment is NOT valid!"; | |
| } | |
| ?></pre> | |
| == Notes == | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] | |
| == Change Log == | |
| * Since: WordPress Version 1.2 | |
| <!-- Need to search change logs --> | |
| == Source File == | |
| <tt>check_comment()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="WordPress_Nonces" d:title="WordPress Nonces"> | |
| <d:index d:value="WordPress Nonces"/> | |
| <h1>WordPress Nonces</h1> | |
| <p>{{Languages| | |
| {{en|WordPress Nonces}} | |
| {{fr|Les Nonces WordPress}} | |
| {{ja|WordPress Nonces}} | |
| }} | |
| A ''[[Glossary#Nonce|nonce]]'' is a "number used once" to protect URLs and forms from being misused. | |
| For example, an admin screen might generate a URL like this that trashes post number 123. You can see that the URL contains a nonce at the end: | |
| <nowiki>http://example.com/wp-admin/post.php?post=123&action=trash&_wpnonce=b192fc4204</nowiki> | |
| If anyone attempts to modify the URL to trash post number 456, the nonce is not valid and the attempt fails: | |
| <nowiki>http://example.com/wp-admin/post.php?post=456&action=trash&_wpnonce=b192fc4204</nowiki> | |
| The invalid nonce causes WordPress to send a "403 Forbidden" response to the browser, with the error message: "Are you sure you want to do this?" | |
| == Creating a nonce == | |
| You can create a nonce and add it to the query string in a URL, you can add it in a hidden field in a form, or you can use it some other way. | |
| For nonces that are to be used in AJAX requests, it is common to add the nonce to a hidden field, from where JavaScript code can fetch it. | |
| === Adding a nonce to a URL === | |
| To add a nonce to a URL, call [[Function_Reference/wp_nonce_url|wp_nonce_url()]] specifying the bare URL and a string representing the action. For example: | |
| $complete_url = wp_nonce_url( $bare_url, 'trash-post_'.$post->ID ); | |
| For maximum protection, ensure that the string representing the action is as specific as possible. | |
| By default, wp_nonce_url() adds a field named <code>_wpnonce</code>. You can specify a different name in the function call. For example: | |
| $complete_url = wp_nonce_url( $bare_url, 'trash-post_'.$post->ID, 'my_nonce' ); | |
| === Adding a nonce to a form === | |
| To add a nonce to a form, call [[Function_Reference/wp_nonce_field|wp_nonce_field()]] specifying a string representing the action. By default wp_nonce_field() generates two hidden fields, one whose value is the nonce and one whose value is the current URL (the referrer), and it echoes the result. For example, this call: | |
| wp_nonce_field( 'delete-comment_'.$comment_id ); | |
| might echo something like: | |
| <input type="hidden" id="_wpnonce" name="_wpnonce" value="796c7766b1" /> | |
| <input type="hidden" name="_wp_http_referer" value="/wp-admin/edit-comments.php" /> | |
| For maximum protection, ensure that the string representing the action is as specific as possible. | |
| You can specify a different name for the nonce field, you can specify that you do not want a referrer field, and you can specify that you want the result to be returned and not echoed. For details of the syntax, see: [[Function_Reference/wp_nonce_field|wp_nonce_field()]] | |
| === Creating a nonce for use in some other way === | |
| To create a nonce for use in some other way, call [[Function_Reference/wp_create_nonce|wp_create_nonce()]] specifying a string representing the action. For example: | |
| $nonce = wp_create_nonce( 'my-action_'.$post->ID ); | |
| This simply returns the nonce itself. For example: <code>295a686963</code> | |
| For maximum protection, ensure that the string representing the action is as specific as possible. | |
| == Verifying a nonce == | |
| You can verify a nonce that was passed in a URL, a form in an admin screen, an AJAX request, or in some other context. | |
| === Verifying a nonce passed from an admin screen === | |
| To verify a nonce that was passed in a URL or a form in an admin screen, call [[Function_Reference/check_admin_referer|check_admin_referer()]] specifying the string representing the action. For example: | |
| check_admin_referer( 'delete-comment_'.$comment_id ); | |
| This call checks the nonce and the referrer, and if the check fails it takes the normal action (terminating script execution with a "403 Forbidden" response and an error message). | |
| If you did not use the default field name (<code>_wpnonce</code>) when you created the nonce, specify the field name. For example: | |
| check_admin_referer( 'delete-comment_'.$comment_id, 'my_nonce' ); | |
| === Verifying a nonce passed in an AJAX request === | |
| To verify a nonce that was passed in an AJAX request, call [[Function_Reference/check_ajax_referer|check_ajax_referer()]] specifying the string representing the action. For example: | |
| check_ajax_referer( 'process-comment' ); | |
| This call checks the nonce (but not the referrer), and if the check fails then by default it terminates script execution. | |
| If you did not use one of the default field names (<code>_wpnonce</code> or <code>_ajax_nonce</code>) when you created the nonce, or if you want to take some other action instead of terminating execution, you can specify additional parameters. For details, see: [[Function_Reference/check_ajax_referer|check_ajax_referer()]] | |
| === Verifying a nonce passed in some other context === | |
| To verify a nonce passed in some other context, call [[Function_Reference/wp_verify_nonce|wp_verify_nonce()]] specifying the nonce and the string representing the action. For example: | |
| wp_verify_nonce( $_REQUEST['my_nonce'], 'process-comment'.$comment_id ); | |
| If the result is false, do not continue processing the request. Instead take some appropriate action. The usual action is to call [[Function_Reference/wp_nonce_ays|wp_nonce_ays()]], which sends a "403 Forbidden" response to the browser with the error message: "Are you sure you want to do this?". | |
| == Modifying the nonce system == | |
| You can modify the nonce system by adding various [[Plugin_API#Actions|actions]] and [[Plugin_API#Filters|filters]]. | |
| === Modifying the nonce lifetime === | |
| By default, a nonce has a lifetime of one day. After that, the nonce is no longer valid even if it matches the action string. To change the lifetime, add a <code>nonce_life</code> filter specifying the lifetime in seconds. For example, to change the lifetime to four hours: | |
| add_filter( 'nonce_life', function () { return 4 * HOUR_IN_SECONDS; } ); | |
| === Performing additional verification === | |
| To perform additional verification when check_admin_referrer() has found that the nonce and the referrer are valid, add a <code>check_admin_referer</code> action. For example: | |
| function my_additional_check ( $action, $result ) { ... } | |
| add_action( 'check_admin_referrer', 'my_additional_check', 10, 2 ); | |
| For check_ajax_referer() add a <code>check_ajax_referer</code> action in the same way. | |
| === Changing the error message === | |
| You can change the error message sent when a nonce is not valid, by using the translation system. For example: | |
| function my_nonce_message ($translation) { | |
| if ($translation == 'Are you sure you want to do this?') | |
| return 'No! No! No!'; | |
| else | |
| return $translation; | |
| } | |
| add_filter('gettext', 'my_nonce_message'); | |
| == Additional information == | |
| This section contains additional information about the nonce system in Wordpress that might occasionally be useful. | |
| === Nonce lifetime === | |
| The lifetime of a nonce is divided into two ''ticks''. When a nonce is valid, the functions that validate nonces return the current tick number, 1 or 2. You could use this information, for example, to refresh nonces that are in their second tick so that they do not expire. | |
| === Nonce security === | |
| Nonces are generated using a key and salt that are unique to your site if you have installed WordPress correctly. NONCE_KEY and NONCE_SALT are defined in your [[Editing_wp-config.php|wp-config.php]] file, and the file contains comments that provide more information. | |
| == Replacing the nonce system == | |
| Some of the functions that make up the nonce system are [[Pluggable_Functions|pluggable]], so that you can replace them by supplying your own functions. | |
| To change the way admin requests or AJAX requests are verified, you can replace check_admin_referrer() or check_ajax_referrer(), or both. | |
| To replace the nonce system with some other nonce system, you can replace wp_create_nonce(), wp_verify_nonce() and wp_nonce_tick(). | |
| == Related == | |
| {{Nonces}} | |
| * [[Creating Options Pages]] | |
| * [[Plugin API/Filter Reference]] | |
| * [[Plugin API/Action Reference]] | |
| == Resources == | |
| * [http://markjaquith.wordpress.com/2006/06/02/wordpress-203-nonces/ WordPress 2.0.3: Nonces | Mark on WordPress] | |
| * [http://www.prelovac.com/vladimir/improving-security-in-wordpress-plugins-using-nonces Improving security in Wordpress plugins using Nonces | Prelovac.com] | |
| * [[Wikipedia:Cryptographic_nonce|Cryptographic nonce - Wikipedia, the free encyclopedia]] | |
| * [[Wikipedia:Cross-site_request_forgery|Cross-site request forgery - Wikipedia, the free encyclopedia]] | |
| *[http://www.wp-entwickler.at/wordpress-sicherheit-bei-formulareingaben-und-ajax-aufrufen-verwendet-nonces/ Einführung zu Nonces und deren Verwendung] '''Artikel auf Deutsch''' | |
| [[Category:Advanced_Topics]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_register_sidebar_widget" d:title="wp register sidebar widget"> | |
| <d:index d:value="wp register sidebar widget"/> | |
| <h1>wp register sidebar widget</h1> | |
| <p>== Description == | |
| Register [[WordPress Widgets]] for use in your themes [[Sidebars|sidebars]]. You can also modify your theme and start [[Customizing Your Sidebar]]. | |
| == Usage == | |
| %%%<?php | |
| wp_register_sidebar_widget( | |
| $id, | |
| $name, | |
| $output_callback, | |
| $options, | |
| $params, | |
| ... | |
| ); | |
| ?> %%% | |
| == Parameters == | |
| {{Parameter|$id|int/string|Widget ID.}} | |
| {{Parameter|$name|string|Widget display title.}} | |
| {{Parameter|$output_callback|callback|Run when widget is called.}} | |
| {{Parameter|$options|array/string|Widget Options.|optional}} | |
| {{Parameter|$params,...|mixed|Widget parameters to add to widget.|optional}} | |
| == Output Callback Function Parameters Format == | |
| <tt>function my_output_callback_function( $args, $params ){ ... }</tt> | |
| {{Parameter|$args|array|Various values merged into an array}} | |
| {{Parameter|$params|array|The extra <tt>$params</tt> given to <tt>wp_register_sidebar_widget</tt>, as an array}} | |
| <b><tt>$args</tt></b> array contains: | |
| * [[Function Reference/register sidebars|register_sidebars()]] argument array values (<tt>'before_widget'</tt>, etc.) | |
| * <tt>'widget_id'</tt> | |
| * <tt>'widget_name'</tt> | |
| The <tt>'dynamic_sidebar_params'</tt> filter is applied to the parameters (as an array), before your output function is called back. | |
| == Example == | |
| The following code will create a widget called "Your Widget" which will become available in the WordPress Administrative Panels. The widget can then be dragged to an available sidebar for display. | |
| ''Note that this widget can only be used once in exactly 1 of the sidebars. For recursive widgets (widgets you can add to multiple times and add to multiple sidebars) please see the [[Function_Reference/register_widget|Register Widget]] function.'' | |
| <pre> | |
| <?php | |
| function your_widget_display($args) { | |
| extract($args); | |
| echo $before_widget; | |
| echo $before_title . 'My Unique Widget' . $after_title; | |
| echo $after_widget; | |
| // print some HTML for the widget to display here | |
| echo "Your Widget Test"; | |
| } | |
| wp_register_sidebar_widget( | |
| 'your_widget_1', // your unique widget id | |
| 'Your Widget', // widget name | |
| 'your_widget_display', // callback function | |
| array( // options | |
| 'description' => 'Description of what your widget does' | |
| ) | |
| ); | |
| ?> | |
| </pre> | |
| == Change Log == | |
| Since: 2.2.0 | |
| == Source File == | |
| <tt>wp_register_sidebar_widget()</tt> is located in {{Trac|wp-includes/widgets.php}}. | |
| == Related == | |
| {{Sidebar Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Widgets]]</p> | |
| </d:entry> | |
| <d:entry id="get_post_mime_type" d:title="get post mime type"> | |
| <d:index d:value="get post mime type"/> | |
| <h1>get post mime type</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get post mime type}} | |
| {{ru|Справочник_по_функциям/get_post_mime_type}} | |
| {{ja|関数リファレンス/get post mime type}} | |
| }} | |
| == Description == | |
| 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]]. | |
| == Usage == | |
| %%%<?php get_post_mime_type( $ID ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$ID|integer|Post ID.|optional|&#39;&#39;}} | |
| == Return Values == | |
| {{Return|Mime Type|boolean&#124;string|False on failure or returns the mime type.}} | |
| == Examples == | |
| ===Return an icon image path according to the MIME type of the given post=== | |
| <pre> | |
| function get_icon_for_attachment($post_id) { | |
| $base = get_template_directory_uri() . "/images/icons/"; | |
| $type = get_post_mime_type($post_id); | |
| switch ($type) { | |
| case 'image/jpeg': | |
| case 'image/png': | |
| case 'image/gif': | |
| return $base . "image.png"; break; | |
| case 'video/mpeg': | |
| case 'video/mp4': | |
| case 'video/quicktime': | |
| return $base . "video.png"; break; | |
| case 'text/csv': | |
| case 'text/plain': | |
| case 'text/xml': | |
| return $base . "text.png"; break; | |
| default: | |
| return $base . "file.png"; | |
| } | |
| } | |
| // call it like this: | |
| echo '<img src="'.get_icon_for_attachment($my_attachment->ID).'" />'; | |
| </pre> | |
| == Notes == | |
| WordPress already has a function to get the mime type icon called wp_mime_type_icon http://codex.wordpress.org/Function_Reference/wp_mime_type_icon | |
| == Change Log == | |
| * Since: [[Version 2.0|2.0.0]] | |
| == Source File == | |
| <tt>get_post_mime_type()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_post_type" d:title="get post type"> | |
| <d:index d:value="get post type"/> | |
| <h1>get post type</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get post type}} | |
| {{it|Riferimento_funzioni/get_post_type}} | |
| {{ja|関数リファレンス/get post type}} | |
| {{ru|Справочник_по_функциям/get_post_type}} | |
| }} | |
| == Description == | |
| Retrieve the post type of the current post or of a given post. | |
| == Usage == | |
| %%%<?php echo get_post_type( $post ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post|mixed|Post object or post ID. If empty, the current post will be used.|optional|<tt>null</tt>}} | |
| == Return Values == | |
| ; <tt>(boolean&#124;string)</tt> : post type or <tt>false</tt> on failure. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| Display the post type. This example needs to be inside the loop. | |
| <pre> | |
| <?php echo 'The post type is: ' . get_post_type( get_the_ID() ); ?> | |
| </pre> | |
| == Notes == | |
| * Uses: <tt>[[Function_Reference/get_post | get_post()]]</tt> To retrieve the post. | |
| == Change Log == | |
| * [[Version 3.5 | 3.5.0]]: The default for <tt>$post</tt> is now <tt>null</tt> instead of <tt>false</tt>, and <tt>[[Function_Reference/get_post | get_post()]]</tt> is used instead of directly accessing the global <tt>$post</tt> variable. | |
| * Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>get_post_type()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Post Type Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_extended" d:title="get extended"> | |
| <d:index d:value="get extended"/> | |
| <h1>get extended</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_extended}} | |
| {{it|Riferimento funzioni/get_extended}} | |
| {{ja|関数リファレンス/get_extended}} | |
| {{ru|Справочник_по_функциям/get_extended}} | |
| }} | |
| {{Stub}} | |
| == Description == | |
| Get extended entry info (<tt><nowiki><!--more--></nowiki></tt>). | |
| 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 <tt>'main'</tt> and <tt>'extended'</tt> keys. Main has the text before the <tt><nowiki><!--more--></nowiki></tt>. The <tt>'extended'</tt> key has the content after the <tt><nowiki><!--more--></nowiki></tt> comment. | |
| == Usage == | |
| %%%<?php get_extended( $post_content ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_content|string|Post content.}} | |
| == Return Values == | |
| ; <tt>(array)</tt> : Post before (<tt>'main'</tt>) and after (<tt>'extended'</tt>). | |
| == Examples == | |
| === Displaying small excerpts from latest posts. === | |
| If you want to display the latest posts on your WordPress blog, but only the content which comes before the <tt><nowiki><!--more--></nowiki></tt> tag, you can use this: | |
| <pre> | |
| <ul> | |
| <?php | |
| global $post; | |
| $args = array( 'numberposts' => 5 ); | |
| $myposts = get_posts( $args ); | |
| foreach( $myposts as $post ) : setup_postdata( $post ); | |
| $content_arr = get_extended (get_the_content() ); ?> | |
| <li> | |
| <a href="<?php the_permalink(); ?>"><?php the_title(); ?></a> | |
| </br> | |
| <?php echo $content_arr['main']; //Display the part before the more tag ?> | |
| </li> | |
| <?php endforeach; ?> | |
| </ul> | |
| </pre> | |
| '''Note:''' ''<tt>$content_arr['extended']</tt> contains the contents after the more tag.'' | |
| == Notes == | |
| == Change Log == | |
| Since: [[Version 1.0|1.0.0]] | |
| == Source File == | |
| <tt>get_extended()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| * <tt>[[Function_Reference/the_excerpt | the_excerpt()]]</tt> - Retrieve the excerpt for the current post in the loop. | |
| * <tt>[[Function_Reference/get_the_excerpt | get_the_excerpt()]]</tt> - Get the excerpt for a post. | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_publish_post" d:title="wp publish post"> | |
| <d:index d:value="wp publish post"/> | |
| <h1>wp publish post</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp publish post}} | |
| {{ja|関数リファレンス/wp publish post}} | |
| }} | |
| == Description == | |
| Publish a post by transitioning the post status. | |
| '''Note:''' This function does not do anything except transition the post status. If you want to ensure <tt>post_name</tt> is set, use [[Function_Reference/wp_update_post|<tt>wp_update_post()</tt>]] instead. | |
| == Usage == | |
| %%%<?php wp_publish_post( $post_id ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Post ID.}} | |
| == Return Values == | |
| ; <tt>(null)</tt> : | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] to initiate the following action hooks, passing <tt>$post->ID</tt> and <tt>$post</tt> (post data) parameters: | |
| ** 'edit_post' | |
| ** [[Plugin_API/Action_Reference/save_post|<tt>'save_post'</tt>]] | |
| ** [[Plugin_API/Action_Reference/wp_insert_post|<tt>'wp_insert_post'</tt>]] | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_publish_post()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| [http://alexking.org/blog/2011/09/19/wp_publish_post-does-not-set-post_ Alex King's post on <tt>wp_publish_post()</tt> vs <tt>wp_update_post()</tt>] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_all_page_ids" d:title="get all page ids"> | |
| <d:index d:value="get all page ids"/> | |
| <h1>get all page ids</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_all_page_ids}} | |
| {{it|Riferimento funzioni/get_all_page_ids}} | |
| }} | |
| == Description == | |
| Get a list of page IDs. | |
| == Usage == | |
| %%%<?php get_all_page_ids() ?>%%% | |
| == Parameters == | |
| * None | |
| == Return Values == | |
| ; <tt>(array)</tt> : List of page IDs. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_all_page_ids()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Page Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_page_uri" d:title="get page uri"> | |
| <d:index d:value="get page uri"/> | |
| <h1>get page uri</h1> | |
| <p>== Description == | |
| Builds and returns a URI for a page from a page id. | |
| If the page has parents, those are prepended to the URI to provide a full path. For example, a third level page might return a URI like this: | |
| <pre>top-level-page/sub-page/current-page</pre> | |
| == Usage == | |
| %%%<?php get_page_uri( $page_id ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$page_id|integer|Page ID.}} | |
| == Return Values == | |
| ; <tt>(string)</tt> : Page URI. | |
| == Examples == | |
| <pre> | |
| <?php | |
| $page_id = 5; | |
| $uri = get_page_uri($page_id); | |
| echo '<a href="'. $uri .'">The Page</a>'; | |
| ?> | |
| </pre> | |
| == Notes == | |
| This function will return a "slug" style URI regardless of whether [[Using_Permalinks#Using_.22Pretty.22_permalinks|"pretty" Permalinks]] are configured. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_page_uri()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Page Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_attached_file" d:title="get attached file"> | |
| <d:index d:value="get attached file"/> | |
| <h1>get attached file</h1> | |
| <p>== Description == | |
| Retrieve attached file path based on attachment ID. | |
| You can optionally send it through the 'get_attached_file' filter, but by default it will just return the file path unfiltered. | |
| The function works by getting the single post meta name, named '<tt>_wp_attached_file</tt>' and returning it. This is a convenience function to prevent looking up the meta name and provide a mechanism for sending the attached file name through a filter. | |
| == Usage == | |
| %%%<?php get_attached_file( $attachment_id, $unfiltered ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$attachment_id|integer|Attachment ID.}} | |
| {{Parameter|$unfiltered|boolean|Whether to apply filters or not.|optional|false}} | |
| == Return Values == | |
| ; <tt>(string)</tt> : The file path to the attached file. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] to call [[Function_Reference/get_attached_file|<tt>get_attached_file()</tt>]] on file path and <tt>$attachment_id</tt>. | |
| * Uses: [[Function_Reference/get_post_meta|<tt>get_post_meta()</tt>]] on <tt>$attachment_id</tt>, the '<tt>_wp_attached_file</tt>' meta name. | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <tt>get_attached_file()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="update_attached_file" d:title="update attached file"> | |
| <d:index d:value="update attached file"/> | |
| <h1>update attached file</h1> | |
| <p>== Description == | |
| Update attachment file path based on attachment ID. | |
| Used to update the file path of the attachment, which uses post meta name '<tt>_wp_attached_file</tt>' to store the path of the attachment. | |
| Note: This does not move the file. This simply updates the '<tt>_wp_attached_file</tt>' post meta after a move. | |
| == Usage == | |
| %%%<?php update_attached_file( $attachment_id, $file ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$attachment_id|integer|Attachment ID}} | |
| {{Parameter|$file|string|File path for the attachment}} | |
| == Return Values == | |
| ; <tt>(boolean)</tt> : False on failure, true on success. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] to add <tt>update_attached_file()</tt> on <tt>$file</tt> and <tt>$attachment_id</tt>. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>update_attached_file()</tt> is located in {{Trac|wp-includes/post.php|tags/3.4.2|189}} | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="is_local_attachment" d:title="is local attachment"> | |
| <d:index d:value="is local attachment"/> | |
| <h1>is local attachment</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/is_local_attachment}} | |
| {{it|Riferimento funzioni/is_local_attachment}} | |
| }} | |
| == Description == | |
| Check if the attachment URI is local one and is really an attachment. | |
| == Usage == | |
| %%%<?php is_local_attachment( $url ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$url|string|URL to check}} | |
| == Return Values == | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_local_attachment()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_attachment_metadata" d:title="wp get attachment metadata"> | |
| <d:index d:value="wp get attachment metadata"/> | |
| <h1>wp get attachment metadata</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_get_attachment_metadata}} | |
| {{it|Riferimento funzioni/wp_get_attachment_metadata}} | |
| }} | |
| == Description == | |
| Retrieve attachment meta field for attachment ID. | |
| == Usage == | |
| %%%<?php wp_get_attachment_metadata( $attachment_id, $unfiltered ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$attachment_id|integer|Attachment ID}} | |
| {{Parameter|$unfiltered|boolean|If true, filters are not run.|optional|false}} | |
| == Return Values == | |
| {{Return||array&#124;boolean|Attachment meta field. False on failure.}} | |
| The fields are: | |
| ; <tt>width</tt> : (''integer'') The width of the attachment | |
| ; <tt>height</tt> : (''integer'') The height of the attachment | |
| ; <tt>file</tt> : (''string'') The file path relative to `wp-content/uploads/` | |
| ; <tt>sizes</tt> : (''array'') Keys are size slugs, each value is an array containing 'file', 'width', 'height', and 'mime-type' | |
| ; <tt>image_meta</tt> : (''array'') | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| Array | |
| ( | |
| [width] => 2400 | |
| [height] => 1559 | |
| [file] => 2011/12/press_image.jpg | |
| [sizes] => Array | |
| ( | |
| [thumbnail] => Array | |
| ( | |
| [file] => press_image-150x150.jpg | |
| [width] => 150 | |
| [height] => 150 | |
| [mime-type] => image/jpeg | |
| ) | |
| [medium] => Array | |
| ( | |
| [file] => press_image-4-300x194.jpg | |
| [width] => 300 | |
| [height] => 194 | |
| [mime-type] => image/jpeg | |
| ) | |
| [large] => Array | |
| ( | |
| [file] => press_image-1024x665.jpg | |
| [width] => 1024 | |
| [height] => 665 | |
| [mime-type] => image/jpeg | |
| ) | |
| [post-thumbnail] => Array | |
| ( | |
| [file] => press_image-624x405.jpg | |
| [width] => 624 | |
| [height] => 405 | |
| [mime-type] => image/jpeg | |
| ) | |
| ) | |
| [image_meta] => Array | |
| ( | |
| [aperture] => 5 | |
| [credit] => | |
| [camera] => Canon EOS-1Ds Mark III | |
| [caption] => | |
| [created_timestamp] => 1323190643 | |
| [copyright] => | |
| [focal_length] => 35 | |
| [iso] => 800 | |
| [shutter_speed] => 0.016666666666667 | |
| [title] => | |
| ) | |
| ) | |
| == Notes == | |
| == Change Log == | |
| Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>wp_get_attachment_metadata()</tt> is located in {{Source|wp-includes/post.php}} | |
| == Related == | |
| {{Attachment Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_update_attachment_metadata" d:title="wp update attachment metadata"> | |
| <d:index d:value="wp update attachment metadata"/> | |
| <h1>wp update attachment metadata</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_update_attachment_metadata}} | |
| {{it|Riferimento funzioni/wp_update_attachment_metadata}} | |
| }} | |
| == Description == | |
| Update metadata for an attachment. | |
| == Usage == | |
| %%%<?php wp_update_attachment_metadata( $post_id, $data ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Attachment ID.}} | |
| {{Parameter|$data|array|Attachment data.}} | |
| == Return Values == | |
| ; <tt>(boolean)</tt> : Returns value from [[Function_Reference/update_post_meta|<tt>update_post_meta()</tt>]] | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] to add <tt>wp_update_attachment_metadata()</tt> on <tt>$data</tt> and post ID. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_update_attachment_metadata()</tt> is located in <tt>[http://core.trac.wordpress.org/browser/trunk/wp-includes/post.php wp-includes/post.php]</tt>. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_attachment_thumb_file" d:title="wp get attachment thumb file"> | |
| <d:index d:value="wp get attachment thumb file"/> | |
| <h1>wp get attachment thumb file</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_get_attachment_thumb_file}} | |
| {{it|Riferimento funzioni/wp_get_attachment_thumb_file}} | |
| }} | |
| == Description == | |
| Retrieve thumbnail for an attachment. | |
| == Usage == | |
| %%%<?php wp_get_attachment_thumb_file( $post_id ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Attachment ID.|optional|0}} | |
| == Return Values == | |
| ; <tt>(mixed)</tt> : False on failure. Thumbnail file path on success. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>wp_get_attachment_thumb_file()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Attachment Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_attachment_thumb_url" d:title="wp get attachment thumb url"> | |
| <d:index d:value="wp get attachment thumb url"/> | |
| <h1>wp get attachment thumb url</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_get_attachment_thumb_url}} | |
| {{it|Riferimento funzioni/wp_get_attachment_thumb_url}} | |
| }} | |
| == Description == | |
| Retrieve URL for an attachment thumbnail. | |
| == Usage == | |
| %%%<?php wp_get_attachment_thumb_url( $attachment_id ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$attachment_id|integer|Attachment ID|optional|0}} | |
| == Return Values == | |
| {{Return||string&#124;boolean|False on failure. Thumbnail URL on success.}} | |
| == Examples == | |
| <pre> | |
| <?php | |
| $thumb_id = 25; | |
| $url = wp_get_attachment_thumb_url( $thumb_id ); | |
| ?> | |
| <img src="<?php echo $url ?>"/> | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>wp_get_attachment_thumb_url()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Attachment Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_mime_type_icon" d:title="wp mime type icon"> | |
| <d:index d:value="wp mime type icon"/> | |
| <h1>wp mime type icon</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_mime_type_icon}} | |
| {{it|Riferimento funzioni/wp_mime_type_icon}} | |
| }} | |
| == Description == | |
| Retrieve the icon for a [[wikipedia:MIME|MIME type]]. | |
| == Usage == | |
| %%%<?php wp_mime_type_icon( $mime ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$mime|string|MIME type|optional|0}} | |
| == Return Values == | |
| ; <tt>(string&#124;boolean)</tt> : Returns a value from The filtered value after all hooked functions are applied to it. | |
| == Examples == | |
| === Display the icon image of the video format === | |
| <pre> | |
| <?php | |
| $img = wp_mime_type_icon('video/mp4'); | |
| ?> | |
| <img src="<?php echo $img ?>" /> | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters</tt>]] calls '<tt>wp_mime_type_icon</tt>' on <tt>$icon</tt>, <tt>$mime</tt> and <tt>$post_id</tt> | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_mime_type_icon()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_check_for_changed_slugs" d:title="wp check for changed slugs"> | |
| <d:index d:value="wp check for changed slugs"/> | |
| <h1>wp check for changed slugs</h1> | |
| <p>== Description == | |
| Checked for changed slugs for published posts and save old slug. | |
| The function is used along with form POST data. It checks for the wp-old-slug POST field. Will only be concerned with published posts and the slug actually changing. | |
| If the slug was changed and not already part of the old slugs then it will be added to the post meta field ('<tt>_wp_old_slug</tt>') for storing old slugs for that post. | |
| The most logical usage of this function is redirecting changed posts, so that those that linked to an changed post will be redirected to the new post. | |
| == Usage == | |
| %%%<?php wp_check_for_changed_slugs( $post_id ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Post ID.}} | |
| == Return Values == | |
| ; <tt>(integer)</tt> : Same as <tt>$post_id</tt> | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: May use [[Function_Reference/add_post_meta|<tt>add_post_meta()</tt>]] or [[Function_Reference/delete_post_meta|<tt>delete_post_meta()</tt>]] depending on current post data ([[Function_Reference/get_post_meta|<tt>get_post_meta()</tt>]]). | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>wp_check_for_changed_slugs()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_post_categories" d:title="wp get post categories"> | |
| <d:index d:value="wp get post categories"/> | |
| <h1>wp get post categories</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_get_post_categories}} | |
| {{it|Riferimento funzioni/wp_get_post_categories}} | |
| {{ja|関数リファレンス/wp_get_post_categories}} | |
| }} | |
| == Description == | |
| The function wp_get_post_categories() retrieve a list of categories for a post. | |
| Compatibility layer for [[Glossary#Theme|themes]] and [[Glossary#Plugin|plugins]]. Also an easy layer of abstraction away from the complexity of the [[WordPress_Taxonomy|taxonomy layer]]. | |
| == Usage == | |
| %%%<?php wp_get_post_categories( $post_id, $args ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|The Post ID.|optional|0}} | |
| {{Parameter|$args|array|Overwrite the defaults.|optional|array|}} | |
| Default $args are: | |
| $defaults = array('fields' => 'ids'); | |
| == Return Values == | |
| ; <tt>(array)</tt> : The array contains a list of category ID's. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| The example below shows how categories are retrieved, and then additional information is retrieved for each category. | |
| <pre> | |
| $post_categories = wp_get_post_categories( $post_id ); | |
| $cats = array(); | |
| foreach($post_categories as $c){ | |
| $cat = get_category( $c ); | |
| $cats[] = array( 'name' => $cat->name, 'slug' => $cat->slug ); | |
| } | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/wp_get_object_terms|<tt>wp_get_object_terms()</tt>]] Retrieves the categories. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_get_post_categories()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_set_post_categories" d:title="wp set post categories"> | |
| <d:index d:value="wp set post categories"/> | |
| <h1>wp set post categories</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_set_post_categories}} | |
| {{ja|関数リファレンス/wp_set_post_categories}} | |
| }} | |
| == Description == | |
| Set categories for a post. | |
| == Usage == | |
| %%%<?php wp_set_post_categories( $post_ID, $post_categories, $append ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_ID|integer|Post ID.|optional|0}} | |
| {{Parameter|$post_categories|array|Array of category IDs.|optional|array}} | |
| {{Parameter|$append|boolean|If true, categories will be appended to the post. If false, categories will replace existing categories.|optional|false}} | |
| == Return Values == | |
| ; <tt>(boolean&#124;mixed)</tt>: Returns an array of category IDs that were assigned to the post ID. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| If no categories are passed with a post ID that has a post type of '''post''', the default category will be used. | |
| '''Be careful''', as <tt>wp_set_post_categories</tt> will overwrite any existing categories already assigned to the post unless <tt>$append</tt> is set to true. | |
| If an ID is passed with the categories array that is '''not''' associated with a valid category, it will be stripped before the object terms are updated and from the return array. | |
| [[Function Reference/wp_set_object_terms|wp_set_object_terms()]] performs the same function with more granular control for built in categories and can also be used to set any custom taxonomies. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_set_post_categories()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| * [[Function Reference/wp_set_object_terms|wp_set_object_terms()]] | |
| * [[Function Reference/wp_set_post_tags|wp_set_post_tags()]] | |
| * [[Function Reference/wp_set_post_terms|wp_set_post_terms()]] | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| {{Copyedit}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_profile" d:title="get profile"> | |
| <d:index d:value="get profile"/> | |
| <h1>get profile</h1> | |
| <p>{{Deprecated|new_function=get_the_author_meta}} | |
| == Description == | |
| Retrieve user data based on field. | |
| Use <tt>get_profile()</tt> will make a database query to get the value of the table column. The value might be cached using the query cache, but care should be taken when using the function to not make a lot of queries for retrieving user profile information. | |
| If the <tt>$user</tt> parameter is not used, then the user will be retrieved from a cookie of the user. Therefore, if the cookie does not exist, then no value might be returned. Sanity checking must be done to ensure that when using <tt>get_profile()</tt> that (<tt>empty|null|false</tt>) values are handled and that something is at least displayed. | |
| == Usage == | |
| %%%<?php get_profile( $field, $user ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$field|string|User field to retrieve. See [[Database_Description#Table:_wp_users|users table]] for possible <tt>$field</tt> values.}} | |
| {{Parameter|$user|string|User username. Uses [[WordPress_Cookies|user cookie]] to determine user if this is false or omitted.|optional|false}} | |
| == Return Values == | |
| ; <tt>(string)</tt> : The value in the field. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] Reads from the [[Database_Description#Table:_wp_users|users table]]. | |
| == Change Log == | |
| * Deprecated: 3.0 | |
| * Since: 1.5.0 | |
| == Source File == | |
| <tt>get_profile()</tt> is located in {{Trac|wp-includes/user.php|tags/2.9.2}} - (2.9.2)<br /><tt>get_profile()</tt> is located in {{Trac|wp-includes/deprecated.php|branches/3.0}} - (Deprecated, 3.0) | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="set_current_user" d:title="set current user"> | |
| <d:index d:value="set current user"/> | |
| <h1>set current user</h1> | |
| <p>{{Deprecated|new_function=wp_set_current_user|version=3.0}} | |
| == Description == | |
| This function can be replaced via [[Glossary#plugins|plugins]]. If plugins do not redefine these functions, then this will be used instead. | |
| Changes the current user by ID or name. | |
| Set <tt>$id</tt> to null and specify a name if you do not know a user's ID. | |
| == Usage == | |
| %%%<?php set_current_user( $id, $name ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$id|integer&#124;null|User ID.}} | |
| {{Parameter|$name|string|The user's username|optional|&#39;&#39;}} | |
| == Return Values == | |
| ; <tt>(object)</tt> : returns values returned by [[Function_Reference/wp_set_current_user|<tt>wp_set_current_user()</tt>]] | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * This function can be replaced via [[Glossary#plugins|plugins]]. If plugins do not redefine these functions, then this will be used instead. | |
| * Uses: [[Function_Reference/wp_set_current_user|<tt>wp_set_current_user()</tt>]] | |
| == Change Log == | |
| * Deprecated: [[Version 3.0|3.0.0]] | |
| * Since: [[Version 2.0.1|2.0.1]] | |
| == Source File == | |
| <tt>set_current_user()</tt> is located in {{Trac|wp-includes/pluggable-deprecated.php}}. Before deprecation it was located in {{Trac|wp-includes/pluggable.php}}. | |
| == Related == | |
| {{Current User Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_set_current_user" d:title="wp set current user"> | |
| <d:index d:value="wp set current user"/> | |
| <h1>wp set current user</h1> | |
| <p>== Description == | |
| This function can be replaced via [[Glossary#plugins|plugins]]. If plugins do not redefine these functions, then this will be used instead. | |
| Changes the current user by ID or name. | |
| Set <tt>$id</tt> to null and specify a name if you do not know a user's ID. | |
| Some WordPress functionality is based on the current user and not based on the signed in user. <tt>wp_set_current_user()</tt> opens the ability to edit and perform actions on users who aren't signed in. | |
| == Usage == | |
| %%%<?php wp_set_current_user( $id, $name ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$id|integer|User ID}} | |
| {{Parameter|$name|string|User's username|optional|&#39;&#39;}} | |
| === Return Values === | |
| {{Return|WP_User|object|[[Class_Reference/WP_User|WP_User]] object with the current user}}. | |
| == Examples == | |
| Note that setting the current user does not log in that user. This example will set the current user and log them in. | |
| %%%$user_id = 12345; | |
| $user = get_user_by( 'id', $user_id ); | |
| if( $user ) { | |
| wp_set_current_user( $user_id, $user->user_login ); | |
| wp_set_auth_cookie( $user_id ); | |
| do_action( 'wp_login', $user->user_login ); | |
| }%%% | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * This function can be replaced via [[Glossary#plugins|plugins]]. If plugins do not redefine these functions, then this will be used instead. | |
| * Uses: [[Class_Reference/WP_User|<tt>WP_User</tt>]] object | |
| * Uses: [[Function_Reference/setup_userdata|<tt>setup_userdata()</tt>]] | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] Calls 'set_current_user' hook after setting the current user. | |
| == Change Log == | |
| Since: 2.0.4 | |
| == Source File == | |
| <tt>wp_set_current_user()</tt> is located in {{Trac|wp-includes/pluggable.php}}. | |
| == Related == | |
| {{Current User Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_userdatabylogin" d:title="get userdatabylogin"> | |
| <d:index d:value="get userdatabylogin"/> | |
| <h1>get userdatabylogin</h1> | |
| <p>{{Pluggable_Deprecated|new_function=get_user_by}} | |
| Use [[Function_Reference/get_user_by|get_user_by( 'login', $user_login )]] instead. | |
| == Description == | |
| This function can be replaced via [[Glossary#plugins|plugins]]. If plugins do not redefine these functions, then this will be used instead. | |
| Retrieve user info by login name. | |
| == Usage == | |
| %%%<?php get_userdatabylogin( $user_login ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$user_login|string|User's username}} | |
| == Return Values == | |
| ; <tt>(boolean&#124;object)</tt> : False on failure. User DB row object on success. | |
| == Notes == | |
| * This function can be replaced via [[Glossary#plugins|plugins]]. If plugins do not redefine these functions, then this will be used instead. | |
| == Change Log == | |
| Since: 0.71. Deprecated since: 3.3. | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_userdatabylogin()</tt> is located in {{Trac|wp-includes/pluggable-deprecated.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| == See Also == | |
| [[Function_Reference/get_user_by|get_user_by()]], [[Function_Reference/get_currentuserinfo|get_currentuserinfo()]], [[Function_Reference/get_userdata|get_userdata()]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="validate_username" d:title="validate username"> | |
| <d:index d:value="validate username"/> | |
| <h1>validate username</h1> | |
| <p>== Description == | |
| Checks whether username is valid. | |
| '''Note:''' this function attempts to sanitize the username, and if it "passes", the name is considered valid. For additional logic, you can use the 'validate_username' hook. | |
| == Usage == | |
| %%%<?php validate_username( $username ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$username|string|Username.}} | |
| == Return Values == | |
| ; <tt>(boolean)</tt> : Returns <tt>true</tt> if <tt>$username</tt> is valid, <tt>false</tt> if <tt>$username</tt> is invalid. | |
| == Examples == | |
| <pre> | |
| <?php | |
| if (!empty($_POST['username']) && validate_username($_POST['username'])) { | |
| // Go ahead and save the user... | |
| } | |
| ?> | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls [[Plugin_API/Filter_Reference#Database_Writes|<tt>validate_username</tt>]] hook on <tt>$valid</tt> check and <tt>$username</tt> as parameters. | |
| * Uses: [[Function_Reference/sanitize_user|<tt>sanitize_user()</tt>]] | |
| == Change Log == | |
| Since: 2.0.1 | |
| == Source File == | |
| <b>Before</b> 3.0 <br/> | |
| <tt>validate_username()</tt> is located in <tt>[http://core.trac.wordpress.org/browser/branches/2.9/wp-includes/registration.php wp-includes/registration.php]</tt>.<br/><br/> | |
| <b>After</b> 3.0 <br/> | |
| <tt>validate_username()</tt> is located in <tt>[http://core.trac.wordpress.org/browser/trunk/wp-includes/user.php wp-includes/user.php]</tt>. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_insert_user" d:title="wp insert user"> | |
| <d:index d:value="wp insert user"/> | |
| <h1>wp insert user</h1> | |
| <p>== Description == | |
| Insert a user into the database. For '''updating an existing user''', use [[Function Reference/wp_update_user|<tt>wp_update_user</tt>]] function instead. | |
| == Usage == | |
| %%%<?php wp_insert_user( $userdata ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$userdata|mixed|An array of user data, stdClass or [[Class_Reference/WP_User|WP_User]] object.}} | |
| == Return Values == | |
| ; <tt>(mixed)</tt> : If successful, returns the newly-created user's user_id, otherwise returns a [[Class_Reference/WP_Error|WP_Error]] object. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| Below is an example showing how to insert a new user with the website profile field filled. | |
| <pre> | |
| <?php | |
| $website = "http://example.com"; | |
| $userdata = array( | |
| 'user_login' => 'login_name', | |
| 'user_url' => $website, | |
| 'user_pass' => NULL // When creating an user, `user_pass` is expected. | |
| ); | |
| $user_id = wp_insert_user( $userdata ) ; | |
| //On success | |
| if( !is_wp_error($user_id) ) { | |
| echo "User created : ". $user_id; | |
| } ?> | |
| </pre> | |
| == Notes == | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] WordPress database layer. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls filters for most of the <tt>$userdata</tt> fields with the prefix 'pre_user'. See [[#Description|description above]]. | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] Calls 'profile_update' hook when updating giving the user's ID | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] Calls 'user_register' hook when creating a new user giving the user's ID | |
| {| border="0" cellspacing="5" summary="User data array fields." | |
| |+ The <tt>$userdata</tt> array can contain the following fields | |
| |- | |
| ! style="font-weight:bold" | Field Name | |
| ! Description | |
| ! [[Plugin_API/Filter_Reference#Database_Writes_4|Associated Filter]] | |
| |-valign="top" | |
| | style="font-weight:bold" | ID | |
| | An integer that will be used for updating an existing user. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | user_pass | |
| | A string that contains the plain text password for the user. | |
| | <tt>pre_user_pass</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | user_login | |
| | A string that contains the user's username for logging in. | |
| | <tt>pre_user_login</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | user_nicename | |
| | A string that contains a URL-friendly name for the user. The default is the user's username. | |
| | <tt>pre_user_nicename</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | user_url | |
| | A string containing the user's URL for the user's web site. | |
| | <tt>pre_user_url</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | user_email | |
| | A string containing the user's email address. | |
| | <tt>pre_user_email</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | display_name | |
| | A string that will be shown on the site. Defaults to user's username. It is likely that you will want to change this, for both appearance and security through obscurity (that is if you dont use and delete the default admin user). | |
| | <tt>pre_user_display_name</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | nickname | |
| | The user's nickname, defaults to the user's username. | |
| | <tt>pre_user_nickname</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | first_name | |
| | The user's first name. | |
| | <tt>pre_user_first_name</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | last_name | |
| | The user's last name. | |
| | <tt>pre_user_last_name</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | description | |
| | A string containing content about the user. | |
| | <tt>pre_user_description</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | rich_editing | |
| | A string for whether to enable the rich editor or not. False if not empty. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | user_registered | |
| | The date the user registered. Format is Y-m-d H:i:s. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | role | |
| | A string used to set the user's role. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | jabber | |
| | User's Jabber account. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | aim | |
| | User's AOL IM account. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | yim | |
| | User's Yahoo IM account. | |
| | (none) | |
| |} | |
| If there is no ID, a new user will be created. | |
| If ''' you pass an ID ''', the user with that ID will be updated, and these meta fields are updated if set in '''$userdata''' otherwise they are set to null: | |
| <pre> | |
| first_name, | |
| last_name, | |
| nickname, | |
| description, | |
| rich_editing, | |
| comment_shortcuts, | |
| admin_color, | |
| use_ssl, | |
| show_admin_bar_front | |
| </pre> | |
| When performing an update operation using [[Function Reference/wp_insert_user|<tt>wp_insert_user</tt>]], user_pass should be the hashed password and not the plain text password. | |
| == Change Log == | |
| * [[Version_3.5|3.5.0]]: Now accepts stdClass or [[Class Reference/WP_User|WP_User]] object | |
| * Since: 2.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| As of 3.1 <tt>wp_insert_user()</tt> is located in {{Trac|wp-includes/user.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| [[Function Reference/wp_update_user|wp_update_user]], [[Function Reference/wp_create_user|wp_create_user]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="page_uri_index" d:title="page uri index"> | |
| <d:index d:value="page uri index"/> | |
| <h1>page uri index</h1> | |
| <p>== Description == | |
| {{Rename}}'''Note:''' This is not a directly callable function, it is a method of the WP_Rewrite class. This page should be moved from Function Reference to Rewrite API | |
| <hr> | |
| Retrieve all pages and attachments for pages URIs. | |
| The attachments are for those that have pages as parents and will be retrieved. | |
| == Usage == | |
| %%%<?php $wp_rewrite->page_uri_index() ?>%%% | |
| == Parameters == | |
| None | |
| == Return Values == | |
| ; <tt>(array)</tt> : Array of page URIs as first element and attachment URIs as second element. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses: [[Function_Reference/get_page_hierarchy|<tt>get_page_hierarchy()</tt>]] on db query result in [[Database_Description#Table:_wp_posts|posts table]]. | |
| * Uses: [[Function_Reference/get_page_uri|<tt>get_page_uri()</tt>]] on each page ID. | |
| == Change Log == | |
| Since: 2.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>page_uri_index()</tt> is located in <tt>wp-includes/rewrite.php</tt>. | |
| == Related == | |
| {{Page Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_page_children" d:title="get page children"> | |
| <d:index d:value="get page children"/> | |
| <h1>get page children</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_page_children}} | |
| {{it|Riferimento funzioni/get_page_children}} | |
| }} | |
| == Description == | |
| 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. | |
| == Usage == | |
| %%%<?php &get_page_children( $page_id, $pages ) ?> | |
| <?php get_page_children( $page_id, $pages ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$page_id|integer|Page ID.}} | |
| {{Parameter|$pages|array|List of pages' objects.}} | |
| == Return Values == | |
| ; <tt>(array)</tt> : | |
| == Examples == | |
| <pre><?php | |
| // Set up the objects needed | |
| $my_wp_query = new WP_Query(); | |
| $all_wp_pages = $my_wp_query->query(array('post_type' => 'page')); | |
| // Get the page as an Object | |
| $portfolio = get_page_by_title('Portfolio'); | |
| // Filter through all pages and find Portfolio's children | |
| $portfolio_children = get_page_children( $portfolio->ID, $all_wp_pages ); | |
| // echo what we get back from WP to the browser | |
| echo '&lt;pre>' . print_r( $portfolio_children, true ) . '&lt;/pre>'; | |
| ?></pre> | |
| == Notes == | |
| This function calls itself recursively. | |
| == Change Log == | |
| Since: 1.5.1 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>&get_page_children()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Page Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_recent_posts" d:title="wp get recent posts"> | |
| <d:index d:value="wp get recent posts"/> | |
| <h1>wp get recent posts</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp get recent posts}} | |
| {{ja|????????/wp get recent posts}} | |
| }} | |
| == Description == | |
| Retrieve the most recent posts. | |
| == Usage == | |
| %%%<?php wp_get_recent_posts( $args, $output ) ?>%%% | |
| === Default Usage === | |
| %%%<?php $args = array( | |
| 'numberposts' => 10, | |
| 'offset' => 0, | |
| 'category' => 0, | |
| 'orderby' => 'post_date', | |
| 'order' => 'DESC', | |
| 'include' => '', | |
| 'exclude' => '', | |
| 'meta_key' => '', | |
| 'meta_value' =>'', | |
| 'post_type' => 'post', | |
| 'post_status' => 'draft, publish, future, pending, private', | |
| 'suppress_filters' => true ); | |
| $recent_posts = wp_get_recent_posts( $args, ARRAY_A ); | |
| ?>%%% | |
| == Return Value == | |
| {{Return|$posts|array|List of post arrays (default) or objects depending on '''$output'''}} | |
| == Parameters == | |
| {{Parameter|$args|array||optional|array}} | |
| {{Parameter|$output|string|Constant OBJECT, ARRAY_A|optional|ARRAY_A}} | |
| == Examples == | |
| This is an example that shows how to use the wp_get_recent_posts() function to list the recent 10 posts. | |
| <pre> | |
| <h2>Recent Posts</h2> | |
| <ul> | |
| <?php | |
| $recent_posts = wp_get_recent_posts(); | |
| foreach( $recent_posts as $recent ){ | |
| echo '<li><a href=&quot;' . get_permalink($recent[&quot;ID&quot;]) . '&quot; title=&quot;Look '.esc_attr($recent[&quot;post_title&quot;]).'&quot; >' . $recent[&quot;post_title&quot;].'</a> </li> '; | |
| } | |
| ?> | |
| </ul> | |
| </pre> | |
| If you want to delimit more or less recent posts you have to put the number in the function parameter like this example below: | |
| <pre> | |
| <h2>Recent Posts</h2> | |
| <ul> | |
| <?php | |
| $args = array( 'numberposts' => '5' ); | |
| $recent_posts = wp_get_recent_posts( $args ); | |
| foreach( $recent_posts as $recent ){ | |
| echo '<li><a href=&quot;' . get_permalink($recent[&quot;ID&quot;]) . '&quot; title=&quot;Look '.esc_attr($recent[&quot;post_title&quot;]).'&quot; >' . $recent[&quot;post_title&quot;].'</a> </li> '; | |
| } | |
| ?> | |
| </ul> | |
| </pre> | |
| To exclude posts with a certain post format, you can use [[Class_Reference/WP_Query#Taxonomy_Parameters]] like this next example, which excludes all posts with the 'aside' and 'image' formats: | |
| <pre> | |
| <h2>Recent Posts</h2> | |
| <ul> | |
| <?php | |
| $args = array( 'numberposts' => '5', 'tax_query' => array( | |
| array( | |
| 'taxonomy' => 'post_format', | |
| 'field' => 'slug', | |
| 'terms' => 'post-format-aside', | |
| 'operator' => 'NOT IN' | |
| ), | |
| array( | |
| 'taxonomy' => 'post_format', | |
| 'field' => 'slug', | |
| 'terms' => 'post-format-image', | |
| 'operator' => 'NOT IN' | |
| ) | |
| ) ); | |
| $recent_posts = wp_get_recent_posts( $args ); | |
| foreach( $recent_posts as $recent ){ | |
| echo '<li><a href=&quot;' . get_permalink($recent[&quot;ID&quot;]) . '&quot; | |
| title=&quot;'.esc_attr( __($recent[&quot;post_title&quot;])).'&quot; >' . ( __($recent[&quot;post_title&quot;])).'</a> </li> '; | |
| } | |
| ?> | |
| </ul> | |
| </pre> | |
| In the last example you can see the post_title wrapped in a __() function reference, | |
| this is used for internationalization (it's important in case you're dealing with multilanguage site). | |
| == Notes == | |
| * Uses: [[Function_Reference/wp_parse_args|wp_parse_args()]] | |
| * Uses: [[Function_Reference/get_posts|get_posts()]] | |
| * Only the value of <tt>ARRAY_A</tt> is checked for $output. Any other value or constant passed will return an array of objects. | |
| * This function returns posts in an associative array (<tt>ARRAY_A</tt>) format which is compatible with WordPress versions below 3.1. To get output similar to <tt>get_posts()</tt>, use <tt>OBJECT</tt> as the second parameter: <tt>wp_get_recent_posts( $args, OBJECT );</tt> | |
| == Change Log == | |
| * Since: [[Version 1.0|1.0.0]] | |
| * [[Version 3.1|3.1.0]]: The <tt>$num</tt> parameter deprecated in favor of <tt>$args</tt>. | |
| == Source File == | |
| <tt>wp_get_recent_posts()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_single_post" d:title="wp get single post"> | |
| <d:index d:value="wp get single post"/> | |
| <h1>wp get single post</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp get single post}} | |
| {{ja|関数リファレンス/wp get single post}} | |
| }} | |
| {{Deprecated|version=3.5|new_function=get_post}} | |
| == Description == | |
| Retrieve a single post, based on post ID. | |
| == Usage == | |
| %%%<?php wp_get_single_post( $postid, $mode ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$postid|integer|Post ID.|optional|0}} | |
| {{Parameter|$mode|string|How to return result. Expects a Constant: <tt>OBJECT</tt>, <tt>ARRAY_N</tt>, or <tt>ARRAY_A</tt>.|optional|<tt>OBJECT</tt>}} | |
| == Return Values == | |
| ; <tt>(object&#124;array)</tt> : Post object or array holding post contents and information with two additional fields (or keys): '<tt>post_category</tt>' and '<tt>tags_input</tt>'. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_post|<tt>get_post()</tt>]] | |
| * Uses: [[Function_Reference/wp_get_post_categories|<tt>wp_get_post_categories()</tt>]] | |
| * Uses: [[Function_Reference/wp_get_post_tags|<tt>wp_get_post_tags()</tt>]] | |
| == Change Log == | |
| * Deprecated: [[Version 3.5|3.5.0]] | |
| * Since: 1.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_get_single_post()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_trim_excerpt" d:title="wp trim excerpt"> | |
| <d:index d:value="wp trim excerpt"/> | |
| <h1>wp trim excerpt</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp trim excerpt}} | |
| {{ja| 関数リファレンス/wp trim excerpt}} | |
| }} | |
| == Description == | |
| Generates an excerpt from the content, if needed. Must be used inside the "Loop". | |
| The excerpt word amount will be 55 words and if the amount is greater than that, then the string '<tt> [...]</tt>' will be appended to the excerpt. If the string is less than 55 words, then the content will be returned as is. | |
| == Usage == | |
| %%%<?php wp_trim_excerpt( $text ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$text|string|The excerpt. If set to empty an excerpt is generated. If you supply text it will be returned untouched. It will <strong>not</strong> be shortened.}} | |
| == Return Values == | |
| ; <tt>(string)</tt> : The excerpt. | |
| == Examples == | |
| == Notes == | |
| * Uses: [[Function_Reference/get_the_content|<tt>get_the_content</tt>]] | |
| * Uses: [[Function_Reference/strip_shortcodes|<tt>strip_shortcodes()</tt>]] on <tt>$text</tt>. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] for '<tt>the_content</tt>' on <tt>$text</tt>. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] for '<tt>[[Plugin API/Filter Reference/excerpt length|excerpt_length]]</tt>' on <tt>55</tt>. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] for '<tt>[[Plugin API/Filter Reference/excerpt more|excerpt_more]]</tt>' on '<tt>[...]</tt>'. | |
| == Change Log == | |
| * Since: 1.5.0 | |
| * [[Version 2.8|2.8]] : Added the '<tt>[[Plugin API/Filter Reference/excerpt length|excerpt_length]]</tt>' filter. | |
| * [[Version 2.9|2.9]] : Added the '<tt>[[Plugin API/Filter Reference/excerpt more|excerpt_more]]</tt>' filter. ([https://core.trac.wordpress.org/ticket/10395 Ticket 10395]) | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_trim_excerpt()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| [[Function_Reference/the_excerpt_rss|the_excerpt_rss]] | |
| [[Function_Reference/wp_trim_words|wp_trim_words]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_the_content" d:title="get the content"> | |
| <d:index d:value="get the content"/> | |
| <h1>get the content</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get the content}} | |
| {{ja|Function Reference/get the content}} | |
| {{zh-cn|get the content}} | |
| }} | |
| == Description == | |
| Retrieve the post content. | |
| (Must be used in a Loop) | |
| == Usage == | |
| %%%<?php get_the_content( $more_link_text, $stripteaser ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$more_link_text|string|Content for when there is more text.|optional|null}} | |
| {{Parameter|$stripteaser|boolean|Strip teaser content before the more text.|optional|false}} | |
| == Return Values == | |
| ; <tt>(string)</tt> : | |
| == Examples == | |
| === Display the post content, ending with "Read more" if needed === | |
| <pre> | |
| <?php | |
| $content = get_the_content('Read more'); | |
| print $content; | |
| ?> | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/post_password_required|<tt>post_password_required()</tt>]] | |
| * Uses: [[Function_Reference/get_the_password_form|<tt>get_the_password_form()</tt>]] if [[Function_Reference/post_password_required|<tt>post_password_required()</tt>]] fails | |
| * Uses: [[Function_Reference/wp_kses_no_null|<tt>wp_kses_no_null()</tt>]] while processing the <!--more--> tag. | |
| * Uses: [[Function_Reference/balanceTags|<tt>balanceTags()</tt>]] | |
| * Uses: [[Template_Tags/get_permalink|<tt>get_permalink()</tt>]] | |
| * Uses global: <tt>$id</tt> | |
| * Uses global: <tt>$post</tt> | |
| * Uses global: <tt>$more</tt> | |
| * Uses global: <tt>$page</tt> | |
| * Uses global: <tt>$pages</tt> | |
| * Uses global: <tt>$multipage</tt> | |
| * Uses global: <tt>$preview</tt> | |
| * Uses global: <tt>$pagenow</tt> | |
| If you use plugins that filter content ([[Function_Reference/add_filter|add_filter]]('the_content')), then this will not apply the filters, unless you call it this way (using [[Function_Reference/apply_filters|apply_filters]]): | |
| %%%<?php apply_filters('the_content',get_the_content( $more_link_text, $stripteaser, $more_file )) ?>%%% | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>get_the_content()</tt> is located in {{Trac|wp-includes/post-template.php|tags/{{CurrentVersion}}|180}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_update_user" d:title="wp update user"> | |
| <d:index d:value="wp update user"/> | |
| <h1>wp update user</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_update_user}} | |
| {{ko|Function Reference/wp_update_user}} | |
| }} | |
| == Description == | |
| This function updates a single user in the database. This update can contain multiple pieces of user metadata as an array. | |
| To update a single piece of user metadata, use [[Function_Reference/update_user_meta|update_user_meta()]] instead. | |
| To create a ''new'' user, use [[Function_Reference/wp_insert_user|wp_insert_user()]] instead. | |
| '''Note:''' If current user's password is being updated, then the cookies will be cleared! | |
| ===Special Note=== | |
| <del>If <tt>$userdata</tt> does not contain an 'ID' key, then a new user will be created and the new user's ID will be returned.</del> Since version 3.6 this is no longer the case, but this behavior may be restored in the future. See [https://core.trac.wordpress.org/ticket/16731 ticket #16731]. | |
| == Usage == | |
| %%%<?php wp_update_user( $userdata ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$userdata|mixed|An array of user data, stdClass or [[Class_Reference/WP_User|WP_User]] object.}} | |
| == Return Values == | |
| ; <tt>(mixed)</tt> : If successful, returns the user_id, otherwise returns a [[Class_Reference/WP_Error|WP_Error]] object. | |
| == Examples == | |
| Below is an example showing how to update a user's website profile field: | |
| <pre> | |
| <?php | |
| $user_id = 1; | |
| $website = 'http://wordpress.org'; | |
| $user_id = wp_update_user( array( 'ID' => $user_id, 'user_url' => $website ) ); | |
| if ( is_wp_error( $user_id ) ) { | |
| // There was an error, probably that user doesn't exist. | |
| } else { | |
| // Success! | |
| } | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_userdata|<tt>get_userdata()</tt>]] | |
| * Uses: [[Function_Reference/wp_hash_password|<tt>wp_hash_password()</tt>]] | |
| * Uses: [[Function_Reference/wp_insert_user|<tt>wp_insert_user()</tt>]] Used to update existing user or add new one if user doesn't exist already | |
| * Uses: [[Function_Reference/wp_get_current_user|<tt>wp_get_current_user()</tt>]] | |
| * Uses: [[Function_Reference/wp_clear_auth_cookie|<tt>wp_clear_auth_cookie()</tt>]] | |
| * Uses: [[Function_Reference/wp_set_auth_cookie|<tt>wp_set_auth_cookie()</tt>]] | |
| {| border="0" cellspacing="5" summary="User data array fields." | |
| |+ The <tt>$userdata</tt> array can contain the following fields | |
| |- | |
| ! style="font-weight:bold" | Field Name | |
| ! Description | |
| ! [[Plugin_API/Filter_Reference#Database_Writes_4|Associated Filter]] | |
| |-valign="top" | |
| | style="font-weight:bold" | ID | |
| | An integer that will be used for updating an existing user. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | user_pass | |
| | A string that contains the plain text password for the user. | |
| | <tt>pre_user_pass</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | user_login | |
| | A string that contains the user's username for logging in. Please note that the function cannot alter this field, since WordPress does not allow usernames to be changed. | |
| | <tt>pre_user_login</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | user_nicename | |
| | A string that contains a URL-friendly name for the user. The default is the user's username. | |
| | <tt>pre_user_nicename</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | user_url | |
| | A string containing the user's URL for the user's web site. | |
| | <tt>pre_user_url</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | user_email | |
| | A string containing the user's email address. | |
| | <tt>pre_user_email</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | display_name | |
| | A string that will be shown on the site. Defaults to user's username. It is likely that you will want to change this, for both appearance and security through obscurity (that is if you dont use and delete the default admin user). | |
| | <tt>pre_user_display_name</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | nickname | |
| | The user's nickname, defaults to the user's username. | |
| | <tt>pre_user_nickname</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | first_name | |
| | The user's first name. | |
| | <tt>pre_user_first_name</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | last_name | |
| | The user's last name. | |
| | <tt>pre_user_last_name</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | description | |
| | A string containing content about the user. | |
| | <tt>pre_user_description</tt> | |
| |-valign="top" | |
| | style="font-weight:bold" | rich_editing | |
| | A string for whether to enable the rich editor or not. False if not empty. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | user_registered | |
| | The date the user registered. Format is Y-m-d H:i:s. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | role | |
| | A string used to set the user's role. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | jabber | |
| | User's Jabber account. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | aim | |
| | User's AOL IM account. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | yim | |
| | User's Yahoo IM account. | |
| | (none) | |
| |-valign="top" | |
| | style="font-weight:bold" | show_admin_bar_front | |
| | Show the WP admin bar on the front-end. | |
| | (none) | |
| |} | |
| Remember, <tt>user_pass</tt> should be the plain text password as it will be automatically hashed by WordPress. | |
| == Change Log == | |
| * [[Version_3.5|3.5.0]]: Now accepts stdClass or [[Class Reference/WP_User|WP_User]] object. | |
| * Since: [[Version 2.0|2.0.0]] | |
| == Source File == | |
| <tt>wp_update_user()</tt> is located in {{Trac|wp-includes/user.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_lastcommentmodified" d:title="get lastcommentmodified"> | |
| <d:index d:value="get lastcommentmodified"/> | |
| <h1>get lastcommentmodified</h1> | |
| <p>== Description == | |
| The date the last comment was modified. If <tt>$cache_lastcommentmodified</tt> is set this function returns its value from the cache without hitting the database. | |
| == Usage == | |
| %%%<?php get_lastcommentmodified( $timezone ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$timezone|string|Which timezone to use in reference to '<tt>gmt</tt>', '<tt>blog</tt>', or '<tt>server</tt>' locations.|optional|'server'}} | |
| == Return Values == | |
| ; <tt>(string)</tt> : Last comment modified date as a [http://dev.mysql.com/doc/refman/4.1/en/datetime.html MySQL DATETIME]. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] to read from the [[Database_Description#Table:_wp_comments|comments table]]. | |
| * Uses global: array <tt>$cache_lastcommentmodified</tt> | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_lastcommentmodified()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="sanitize_comment_cookies" d:title="sanitize comment cookies"> | |
| <d:index d:value="sanitize comment cookies"/> | |
| <h1>sanitize comment cookies</h1> | |
| <p>== Description == | |
| Sanitizes the cookies sent to the user already. | |
| Will only do anything if the cookies have already been created for the user. Mostly used after cookies had been sent to use elsewhere. | |
| == Usage == | |
| %%%<?php sanitize_comment_cookies() ?>%%% | |
| == Parameters == | |
| None | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] with 'pre_comment_author_name' on 'comment_author' cookie | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] with 'pre_comment_author_email' on 'comment_author_email' cookie | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] with 'pre_comment_author_url' on 'comment_author_url' cookie | |
| == Change Log == | |
| Since: 2.0.4 | |
| == Source File == | |
| <tt>sanitize_comment_cookies()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_allow_comment" d:title="wp allow comment"> | |
| <d:index d:value="wp allow comment"/> | |
| <h1>wp allow comment</h1> | |
| <p>== Description == | |
| Validates whether this comment is allowed to be made or not. | |
| == Usage == | |
| %%%<?php wp_allow_comment( $commentdata ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$commentdata|array|Contains information on the comment}} | |
| == Return Values == | |
| ; <tt>(mixed)</tt> : Signifies the approval status (0|1|'spam') | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls 'pre_comment_approved' hook on the type of comment | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] Calls 'check_comment_flood' hook on <tt>$comment_author_IP</tt>, <tt>$comment_author_email</tt>, and <tt>$comment_date_gmt</tt> | |
| * Uses: The <tt>WP_User</tt> object. | |
| * Uses: [[Function_Reference/get_userdata|<tt>get_userdata()</tt>]] | |
| * Uses: [[Function_Reference/check_comment|<tt>check_comment()</tt>]] | |
| * Uses: [[Function_Reference/wp_blacklist_check|<tt>wp_blacklist_check() to find spam.</tt>]] | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <tt>wp_allow_comment()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_delete_comment" d:title="wp delete comment"> | |
| <d:index d:value="wp delete comment"/> | |
| <h1>wp delete comment</h1> | |
| <p>== Description == | |
| Trashes or deletes a comment. | |
| The comment is moved to trash instead of permanently deleted unless trash is disabled, item is already in the trash, or <tt>$force_delete</tt> is true. | |
| The post comment count will be updated if the comment was approved and has a post ID available. | |
| == Usage == | |
| %%%<?php wp_delete_comment( $comment_id, $force_delete ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$comment_id|integer|Comment ID}} | |
| {{Parameter|$force_delete|boolean|Move comment to trash or delete.|optional|false}} | |
| == Return Values == | |
| ; <tt>(boolean)</tt> : False if delete comment query failure, true on success. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] Calls 'delete_comment' hook on comment ID | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] Calls 'wp_set_comment_status' hook on comment ID with 'delete' set for the second parameter | |
| * Uses: [[Function_Reference/wp_transition_comment_status|<tt>wp_transition_comment_status()</tt>]] Passes new and old comment status along with <tt>$comment</tt> object | |
| * Uses: [[Function_Reference/get_comment|<tt>get_comment()</tt>]] | |
| * Uses: [[Function_Reference/wp_update_comment_count|<tt>wp_update_comment_count()</tt>]] to decrease count on success. | |
| * Uses: [[Function_Reference/clean_comment_cache|<tt>clean_comment_cache()</tt>]] to remove comment form cache on success. | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <tt>wp_delete_comment()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| &nbsp; | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_comment_status" d:title="wp get comment status"> | |
| <d:index d:value="wp get comment status"/> | |
| <h1>wp get comment status</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_get_comment_status}} | |
| {{it|Riferimento funzioni/wp_get_comment_status}} | |
| }} | |
| == Description == | |
| The status of a comment by ID. | |
| == Usage == | |
| %%%<?php wp_get_comment_status( $comment_id ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$comment_id|integer|Comment ID}} | |
| == Return Values == | |
| ; <tt>(string&#124;boolean)</tt> : Status might be '<tt>deleted</tt>', '<tt>approved</tt>', '<tt>unapproved</tt>', '<tt>spam</tt>' or <tt>false</tt> on failure. | |
| == Examples == | |
| <pre> | |
| <?php | |
| $status = wp_get_comment_status( $comment_id ); | |
| if ( $status == "approved" ) { | |
| // show the comment | |
| } | |
| ?> | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_comment|<tt>get_comment()</tt>]] | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_get_comment_status()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| &nbsp; | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_current_commenter" d:title="wp get current commenter"> | |
| <d:index d:value="wp get current commenter"/> | |
| <h1>wp get current commenter</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_get_current_commenter}} | |
| {{it|Riferimento funzioni/wp_get_current_commenter}} | |
| }} | |
| == Description == | |
| Get current commenter's name, email, and URL. | |
| Expects cookies content to already be sanitized. User of this function might wish to recheck the returned array for validity. | |
| == Usage == | |
| %%%<?php wp_get_current_commenter() ?>%%% | |
| == Parameters == | |
| == Return Values == | |
| ; <tt>(array)</tt> : Comment author, email, url respectively. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Return array is mapped like this: | |
| <pre> | |
| Array ( | |
| ['comment_author'] => 'Harriet Smith, | |
| ['comment_author_email'] => 'hsmith@,example.com', | |
| ['comment_author_url'] => 'http://example.com/' | |
| ) | |
| </pre> | |
| == Change Log == | |
| Since: 2.0.4 | |
| == Source File == | |
| <tt>wp_get_current_commenter()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| &nbsp; | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_insert_comment" d:title="wp insert comment"> | |
| <d:index d:value="wp insert comment"/> | |
| <h1>wp insert comment</h1> | |
| <p>== Description == | |
| Inserts a comment to the database. | |
| The available <tt>$commentdata</tt> key names are '<tt>comment_author_IP</tt>', '<tt>comment_date</tt>', '<tt>comment_date_gmt</tt>', '<tt>comment_parent</tt>', '<tt>comment_approved</tt>', and '<tt>user_id</tt>'. | |
| Also, consider using [[Function Reference/wp new comment|wp_new_comment()]], which sanitizes and validates comment data before calling wp_insert_comment() to insert the comment into the database. | |
| == Usage == | |
| <!-- this was wrapped in a triple percent (%%%), but it prevented the double apostrophe ('') from being rendered --> | |
| <pre><?php | |
| $time = current_time('mysql'); | |
| $data = array( | |
| 'comment_post_ID' => 1, | |
| 'comment_author' => 'admin', | |
| 'comment_author_email' => 'admin@admin.com', | |
| 'comment_author_url' => 'http://', | |
| 'comment_content' => 'content here', | |
| 'comment_type' => '', | |
| 'comment_parent' => 0, | |
| 'user_id' => 1, | |
| 'comment_author_IP' => '127.0.0.1', | |
| 'comment_agent' => 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.10) Gecko/2009042316 Firefox/3.0.10 (.NET CLR 3.5.30729)', | |
| 'comment_date' => $time, | |
| 'comment_approved' => 1, | |
| ); | |
| wp_insert_comment($data); | |
| ?></pre> | |
| == Parameters == | |
| {{Parameter|$commentdata|array|Contains information on the comment.}} | |
| == Return Values == | |
| ; <tt>(integer)</tt> : The new comment's ID. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses: [[Function_Reference/current_time|<tt>current_time()</tt>]] | |
| * Uses: [[Function_Reference/get_gmt_from_date|<tt>get_gmt_from_date()</tt>]] | |
| * Uses: [[Function_Reference/wp_update_comment_count|<tt>wp_update_comment_count()</tt>]] | |
| * Uses:Inserts a record in the [[Database_Description#Table:_wp_comments|comments table]] in the database | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_insert_comment()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="register_taxonomy" d:title="register taxonomy"> | |
| <d:index d:value="register taxonomy"/> | |
| <h1>register taxonomy</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/register_taxonomy}} | |
| {{zh-cn|函数参考/register_taxonomy}} | |
| {{ja|関数リファレンス/register_taxonomy}} | |
| }} | |
| == Description == | |
| This function adds or overwrites a [[Taxonomies|taxonomy]]. It takes in a name, an object name that it affects, and an array of parameters. It does not return anything. | |
| Care should be used in selecting a taxonomy name so that it does not conflict with other taxonomies, post types, and [http://core.trac.wordpress.org/browser/trunk/wp-includes/class-wp.php reserved WordPress public and private query variables]. A complete list of those is described in the [[#Reserved Terms|Reserved Terms section]]. In particular, capital letters should be avoided (This was allowed in 3.0, but not enforced until 3.1 with the "Cheatin'" error). | |
| == Usage == | |
| %%% <?php register_taxonomy( $taxonomy, $object_type, $args ); ?> %%% | |
| '''Use the <tt>init</tt> action to call this function.''' Calling it outside of an action can lead to troubles. See [http://core.trac.wordpress.org/ticket/15568 #15568] for details. | |
| Better '''be safe than sorry''' when registering custom taxonomies for custom post types. Use [[Function Reference/register_taxonomy_for_object_type|register_taxonomy_for_object_type()]] right after the function to interconnect them. Else you could run into minetraps where the post type isn't attached inside filter callback that run during <code>parse_request</code> or <code>pre_get_posts</code>. | |
| == Parameters == | |
| {{Parameter|$taxonomy|string|The name of the taxonomy. Name should only contain lowercase letters and the underscore character, and not be more than 32 characters long (database structure restriction).}} | |
| {{Parameter|$object_type|array/string|Name of the object type for the taxonomy object. Object-types can be built-in [[Post Type]] or any [[Post_Types#Custom_Types|Custom Post Type]] that may be registered.}} | |
| :Builtin Post Types: | |
| :* '''<tt>post</tt>''' | |
| :* '''<tt>page</tt>''' | |
| :* '''<tt>attachment</tt>''' | |
| :* '''<tt>revision</tt>''' | |
| :* '''<tt>nav_menu_item</tt>''' | |
| :Custom Post Types: | |
| :* '''<tt>{custom_post_type}</tt>''' - Custom Post Type names must be all in lower-case and without any spaces. | |
| :* '''<tt>null</tt>''' - Setting explicitly to <tt>null</tt> registers the taxonomy but doesn't associate it with any objects, so it won't be directly available within the Admin UI. You will need to manually register it using the 'taxonomy' parameter (passed through $args) when registering a custom post_type (see [[Function_Reference/register_post_type|register_post_type()]]), or using [[Function_Reference/register_taxonomy_for_object_type|register_taxonomy_for_object_type()]]. | |
| {{Parameter|$args|array/string|An array of [[#Arguments|Arguments]].|optional}} | |
| === Arguments === | |
| {{Parameter|label|string|A '''plural''' descriptive name for the taxonomy marked for translation.|optional|overridden by ''$labels->name''}} | |
| {{Parameter|labels|array|labels - An array of labels for this taxonomy. By default tag labels are used for non-hierarchical types and category labels for hierarchical ones.|optional|if empty, name is set to label value, and singular_name is set to name value}} | |
| :* ''''name'''' - general name for the taxonomy, usually plural. The same as and overridden by $tax->label. Default is <code>_x( 'Post Tags', 'taxonomy general name' )</code> or <code>_x( 'Categories', 'taxonomy general name' )</code>. When internationalizing this string, please use a [[I18n_for_WordPress_Developers#Disambiguation_by_context|gettext context]] matching your post type. Example: <code>_x('Writers', 'taxonomy general name');</code> | |
| :* ''''singular_name'''' - name for one object of this taxonomy. Default is <code>_x( 'Post Tag', 'taxonomy singular name' )</code> or <code>_x( 'Category', 'taxonomy singular name' )</code>. When internationalizing this string, please use a [[I18n_for_WordPress_Developers#Disambiguation_by_context|gettext context]] matching your post type. Example: <code>_x('Writer', 'taxonomy singular name');</code> | |
| :* ''''menu_name'''' - the menu name text. This string is the name to give menu items. If not set, defaults to value of ''name'' label. | |
| :* ''''all_items'''' - the all items text. Default is <code>__( 'All Tags' )</code> or <code>__( 'All Categories' )</code> | |
| :* ''''edit_item'''' - the edit item text. Default is <code>__( 'Edit Tag' )</code> or <code>__( 'Edit Category' )</code> | |
| :* ''''view_item'''' - the view item text, Default is <code>__( 'View Tag' )</code> or <code>__( 'View Category' )</code> | |
| :* ''''update_item'''' - the update item text. Default is <code>__( 'Update Tag' )</code> or <code>__( 'Update Category' )</code> | |
| :* ''''add_new_item'''' - the add new item text. Default is <code>__( 'Add New Tag' )</code> or <code>__( 'Add New Category' )</code> | |
| :* ''''new_item_name'''' - the new item name text. Default is <code>__( 'New Tag Name' )</code> or <code>__( 'New Category Name' )</code> | |
| :* ''''parent_item'''' - the parent item text. This string is not used on non-hierarchical taxonomies such as post tags. Default is null or <code>__( 'Parent Category' )</code> | |
| :* ''''parent_item_colon'''' - The same as <code>parent_item</code>, but with colon <code>:</code> in the end null, <code>__( 'Parent Category:' )</code> | |
| :* ''''search_items'''' - the search items text. Default is <code>__( 'Search Tags' )</code> or <code>__( 'Search Categories' )</code> | |
| :* ''''popular_items'''' - the popular items text. This string is not used on hierarchical taxonomies. Default is <code>__( 'Popular Tags' )</code> or null | |
| :* ''''separate_items_with_commas'''' - the separate item with commas text used in the taxonomy meta box. This string is not used on hierarchical taxonomies. Default is <code>__( 'Separate tags with commas' )</code>, or null | |
| :* ''''add_or_remove_items'''' - the add or remove items text and used in the meta box when JavaScript is disabled. This string is not used on hierarchical taxonomies. Default is <code>__( 'Add or remove tags' )</code> or null | |
| :* ''''choose_from_most_used'''' - the choose from most used text used in the taxonomy meta box. This string is not used on hierarchical taxonomies. Default is <code>__( 'Choose from the most used tags' )</code> or null | |
| :* ''''not_found'''' (3.6+) - the text displayed via clicking 'Choose from the most used tags' in the taxonomy meta box when no tags are available. This string is not used on hierarchical taxonomies. Default is <code>__( 'No tags found.' )</code> or null | |
| {{Parameter|public|boolean|If the taxonomy should be publicly queryable.|optional|true}} | |
| {{Parameter|show_ui|boolean|Whether to generate a default UI for managing this taxonomy.|optional|if not set, defaults to value of ''public'' argument. As of [[Version_3.5|3.5]], setting this to <strong>false</strong> for attachment taxonomies will hide the UI.}} | |
| {{Parameter|show_in_nav_menus|boolean|true makes this taxonomy available for selection in navigation menus.|optional|if not set, defaults to value of ''public'' argument}} | |
| {{Parameter|show_tagcloud|boolean|Whether to allow the Tag Cloud widget to use this taxonomy.|optional|if not set, defaults to value of ''show_ui'' argument}} | |
| {{Parameter|meta_box_cb|callback|Provide a callback function name for the meta box display. (Available since [[Version 3.8|3.8]])|optional|null}} | |
| '''Note:''' Defaults to the categories meta box (<tt>post_categories_meta_box()</tt> in <tt>meta-boxes.php</tt>) for hierarchical taxonomies and the tags meta box (<tt>post_tags_meta_box()</tt>) for non-hierarchical taxonomies. No meta box is shown if set to false. | |
| {{Parameter|show_admin_column|boolean|Whether to allow automatic creation of taxonomy columns on associated post-types table. (Available since [[Version 3.5|3.5]])|optional|false}} | |
| {{Parameter|hierarchical|boolean|Is this taxonomy hierarchical (have descendants) like categories or not hierarchical like tags.|optional|false}} | |
| '''Note:''' Hierarchical taxonomies will have a list with checkboxes to select an existing category in the taxonomy admin box on the post edit page (like default post categories). Non-hierarchical taxonomies will just have an empty text field to type-in taxonomy terms to associate with the post (like default post tags). | |
| {{Parameter|update_count_callback|string|A function name that will be called when the count of an associated ''$object_type'', such as post, is updated. Works much like a hook.|optional|None - but see Note, below.}} | |
| '''Note:''' While the default is <tt><nowiki>''</nowiki></tt>, when actually performing the count update in <tt>wp_update_term_count_now()</tt>, if the taxonomy is only attached to <tt>post</tt> types (as opposed to other WordPress objects, like <tt>user</tt>), the built-in <tt>_update_post_term_count()</tt> function will be used to count only published posts associated with that term, otherwise <tt>_update_generic_term_count()</tt> will be used instead, that does no such checking. | |
| This is significant in the case of '''attachments'''. Because an attachment is a type of <tt>post</tt>, the default <tt>_update_post_term_count()</tt> will be used. However, this may be undesirable, because this will only count attachments that are actually attached to another post (like when you insert an image into a post). This means that attachments that you simply upload to WordPress using the Media Library, but do not actually attach to another post will '''not''' be counted. If your intention behind associating a taxonomy with attachments was to leverage the Media Library as a sort of Document Management solution, you are probably more interested in the counts of unattached Media items, than in those attached to posts. In this case, you should force the use of <tt>_update_generic_term_count()</tt> by setting '_update_generic_term_count' as the value for <tt>update_count_callback</tt>. | |
| {{Parameter|query_var|boolean or string|False to disable the query_var, set as string to use custom query_var instead of default which is $taxonomy, the taxonomy's "name".|optional|$taxonomy}} | |
| '''Note:''' The query_var is used for direct queries through WP_Query like <code>new WP_Query(array('people'=>$person_name))</code> and URL queries like <code>/?people=$person_name</code>. Setting query_var to false will disable these methods, but you can still fetch posts with an explicit WP_Query taxonomy query like <code>WP_Query(array('taxonomy'=>'people', 'term'=>$person_name))</code>. | |
| {{Parameter|rewrite|boolean/array|Set to false to prevent automatic URL rewriting a.k.a. "pretty permalinks". Pass an ''$args'' array to override default URL settings for permalinks as outlined below:|optional|true}} | |
| :* ''''slug'''' - Used as pretty permalink text (i.e. /tag/) - defaults to $taxonomy (taxonomy's name slug) | |
| :* ''''with_front'''' - allowing permalinks to be prepended with front base - defaults to true | |
| :* ''''hierarchical'''' - true or false allow hierarchical urls (implemented in [[Version 3.1]]) - defaults to false | |
| :* ''''ep_mask'''' - Assign an endpoint mask for this taxonomy - defaults to EP_NONE. For more info see [http://make.wordpress.org/plugins/2012/06/07/rewrite-endpoints-api/ this Make WordPress Plugins summary of endpoints]. | |
| '''Note:''' You may need to flush the rewrite rules after changing this. You can do it manually by going to the Permalink Settings page and re-saving the rules -- you don't need to change them -- or by calling <tt>$wp_rewrite->flush_rules()</tt>. You should only flush the rules once after the taxonomy has been created, not every time the plugin/theme loads. | |
| {{Parameter|capabilities|array|An array of the capabilities for this taxonomy.|optional}} | |
| :* ''''manage_terms'''' - 'manage_categories' | |
| :* ''''edit_terms'''' - 'manage_categories' | |
| :* ''''delete_terms'''' - 'manage_categories' | |
| :* ''''assign_terms'''' - 'edit_posts' | |
| {{Parameter|sort|boolean|Whether this taxonomy should remember the order in which terms are added to objects.|optional}} | |
| {{Parameter|_builtin|boolean|Whether this taxonomy is a native or "built-in" taxonomy. '''Note: this Codex entry is for documentation - core developers recommend you don't use this when registering your own taxonomy'''|not for general use|false}} | |
| == Example == | |
| An example of registering a two taxonomies, genres and writers, for the post type called "book" (uses [[Version 3.1]] arguments): | |
| Note: You can define custom taxonomies in a themes's <code>functions.php</code> template file: | |
| <pre> | |
| <?php | |
| // hook into the init action and call create_book_taxonomies when it fires | |
| add_action( 'init', 'create_book_taxonomies', 0 ); | |
| // create two taxonomies, genres and writers for the post type "book" | |
| function create_book_taxonomies() { | |
| // Add new taxonomy, make it hierarchical (like categories) | |
| $labels = array( | |
| 'name' => _x( 'Genres', 'taxonomy general name' ), | |
| 'singular_name' => _x( 'Genre', 'taxonomy singular name' ), | |
| 'search_items' => __( 'Search Genres' ), | |
| 'all_items' => __( 'All Genres' ), | |
| 'parent_item' => __( 'Parent Genre' ), | |
| 'parent_item_colon' => __( 'Parent Genre:' ), | |
| 'edit_item' => __( 'Edit Genre' ), | |
| 'update_item' => __( 'Update Genre' ), | |
| 'add_new_item' => __( 'Add New Genre' ), | |
| 'new_item_name' => __( 'New Genre Name' ), | |
| 'menu_name' => __( 'Genre' ), | |
| ); | |
| $args = array( | |
| 'hierarchical' => true, | |
| 'labels' => $labels, | |
| 'show_ui' => true, | |
| 'show_admin_column' => true, | |
| 'query_var' => true, | |
| 'rewrite' => array( 'slug' => 'genre' ), | |
| ); | |
| register_taxonomy( 'genre', array( 'book' ), $args ); | |
| // Add new taxonomy, NOT hierarchical (like tags) | |
| $labels = array( | |
| 'name' => _x( 'Writers', 'taxonomy general name' ), | |
| 'singular_name' => _x( 'Writer', 'taxonomy singular name' ), | |
| 'search_items' => __( 'Search Writers' ), | |
| 'popular_items' => __( 'Popular Writers' ), | |
| 'all_items' => __( 'All Writers' ), | |
| 'parent_item' => null, | |
| 'parent_item_colon' => null, | |
| 'edit_item' => __( 'Edit Writer' ), | |
| 'update_item' => __( 'Update Writer' ), | |
| 'add_new_item' => __( 'Add New Writer' ), | |
| 'new_item_name' => __( 'New Writer Name' ), | |
| 'separate_items_with_commas' => __( 'Separate writers with commas' ), | |
| 'add_or_remove_items' => __( 'Add or remove writers' ), | |
| 'choose_from_most_used' => __( 'Choose from the most used writers' ), | |
| 'not_found' => __( 'No writers found.' ), | |
| 'menu_name' => __( 'Writers' ), | |
| ); | |
| $args = array( | |
| 'hierarchical' => false, | |
| 'labels' => $labels, | |
| 'show_ui' => true, | |
| 'show_admin_column' => true, | |
| 'update_count_callback' => '_update_post_term_count', | |
| 'query_var' => true, | |
| 'rewrite' => array( 'slug' => 'writer' ), | |
| ); | |
| register_taxonomy( 'writer', 'book', $args ); | |
| } | |
| ?> | |
| </pre> | |
| == Basic Example == | |
| <pre> | |
| <?php | |
| add_action( 'init', 'create_book_tax' ); | |
| function create_book_tax() { | |
| register_taxonomy( | |
| 'genre', | |
| 'book', | |
| array( | |
| 'label' => __( 'Genre' ), | |
| 'rewrite' => array( 'slug' => 'genre' ), | |
| 'hierarchical' => true, | |
| ) | |
| ); | |
| } | |
| ?> | |
| </pre> | |
| Note: If you want to ensure that your custom taxonomy behaves like a tag, you must add the option 'update_count_callback' => '_update_post_term_count'. Not doing so will result in multiple comma-separated items added at once being saved as a single value, not as separate values. This can cause undue stress when using get_the_term_list and other term display functions. | |
| ==Reserved Terms== | |
| Avoiding the following reserved terms is particularly important if you are passing the term through the $_GET or $_POST array. Doing so can cause WordPress to respond with a 404 error without any other hint or explanation. | |
| * attachment | |
| * attachment_id | |
| * author | |
| * author_name | |
| * calendar | |
| * cat | |
| * category | |
| * category__and | |
| * category__in | |
| * category__not_in | |
| * category_name | |
| * comments_per_page | |
| * comments_popup | |
| * customize_messenger_channel | |
| * customized | |
| * cpage | |
| * day | |
| * debug | |
| * error | |
| * exact | |
| * feed | |
| * hour | |
| * link_category | |
| * m | |
| * minute | |
| * monthnum | |
| * more | |
| * name | |
| * nav_menu | |
| * nonce | |
| * nopaging | |
| * offset | |
| * order | |
| * orderby | |
| * p | |
| * page | |
| * page_id | |
| * paged | |
| * pagename | |
| * pb | |
| * perm | |
| * post | |
| * post__in | |
| * post__not_in | |
| * post_format | |
| * post_mime_type | |
| * post_status | |
| * post_tag | |
| * post_type | |
| * posts | |
| * posts_per_archive_page | |
| * posts_per_page | |
| * preview | |
| * robots | |
| * s | |
| * search | |
| * second | |
| * sentence | |
| * showposts | |
| * static | |
| * subpost | |
| * subpost_id | |
| * tag | |
| * tag__and | |
| * tag__in | |
| * tag__not_in | |
| * tag_id | |
| * tag_slug__and | |
| * tag_slug__in | |
| * taxonomy | |
| * tb | |
| * term | |
| * theme | |
| * type | |
| * w | |
| * withcomments | |
| * withoutcomments | |
| * year | |
| == Changelog == | |
| * [[Version_3.6|3.6.0]]: | |
| ** Add '<tt>not_found</tt>' label. | |
| * [[Version_3.5|3.5.0]]: | |
| ** Setting '<tt>show_ui</tt>' to false hides UI for attachment taxonomies. | |
| ** Add '<tt>show_admin_column</tt>' to allow automatic creation of taxonomy columns on associated post types. | |
| * Since: [[Version 2.3|2.3.0]] | |
| == Source File == | |
| <tt>register_taxonomy()</tt> is located in {{Trac|wp-includes/taxonomy.php}}. | |
| == Resources == | |
| * [http://generatewp.com/taxonomy/ WordPress Taxonomy Generator] | |
| == Related == | |
| [http://codex.wordpress.org/Function_Reference/register_post_type register_post_type()] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_filter_comment" d:title="wp filter comment"> | |
| <d:index d:value="wp filter comment"/> | |
| <h1>wp filter comment</h1> | |
| <p>== Description == | |
| Filters and sanitizes comment data. | |
| Sets the comment data '<tt>filtered</tt>' field to true when finished. This can be checked as to whether the comment should be filtered and to keep from filtering the same comment more than once. | |
| == Usage == | |
| %%%<?php wp_filter_comment( $commentdata ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$commentdata|array|Contains information on the comment.}} | |
| == Return Values == | |
| ; <tt>(array)</tt> : Parsed comment information. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>pre_user_id</tt>' hook on comment author's user ID | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>pre_comment_user_agent</tt>' hook on comment author's user agent | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>pre_comment_author_name</tt>' hook on comment author's name | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>pre_comment_content</tt>' hook on the comment's content | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>pre_comment_user_ip</tt>' hook on comment author's IP | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>pre_comment_author_url</tt>' hook on comment author's URL | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>pre_comment_author_email</tt>' hook on comment author's email address | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <tt>wp_filter_comment()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| &nbsp; | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_category" d:title="get category"> | |
| <d:index d:value="get category"/> | |
| <h1>get category</h1> | |
| <p>{{Languages| | |
| {{en| Function_Reference/get_category}} | |
| {{ja|関数リファレンス/get_category}} | |
| }} | |
| == Description == | |
| Retrieves category data given a category ID or category object. | |
| If you pass the <tt>$category</tt> parameter an object, which is assumed to be the category row object retrieved the database. It will cache the category data. | |
| If you pass <tt>$category</tt> an integer of the category ID, then that category will be retrieved from the database, if it isn't already cached, and pass it back. | |
| If you look at [[Function_Reference/get_term|<tt>get_term()</tt>]], then both types will be passed through several filters and finally sanitized based on the <tt>$filter</tt> parameter value. | |
| The category will converted to maintain backwards compatibility. | |
| <b>Note</b>: use [[Function_Reference/get_term|<tt>get_term()</tt>]] to get Link Categories based on their ID's. <tt>get_category</tt> only returns Post Categories. | |
| == Usage == | |
| %%%<?php get_category( $category, $output, $filter ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$category|integer&#124;object|Category ID or Category row object}} | |
| {{Parameter|$output|string|Constant OBJECT, ARRAY_A, or ARRAY_N|optional|OBJECT}} | |
| {{Parameter|$filter|string|Default is raw or no WordPress defined filter will applied.|optional|'raw'}} | |
| == Return Values == | |
| ; (mixed) : Category data in type defined by <tt>$output</tt> parameter. | |
| == Examples == | |
| === Print category data === | |
| <pre>$thisCat = get_category(get_query_var('cat'),false); | |
| print_r($thisCat);</pre> | |
| produces; | |
| <pre>stdClass Object | |
| ( | |
| [term_id] => 85 | |
| [name] => Category Name | |
| [slug] => category-name | |
| [term_group] => 0 | |
| [term_taxonomy_id] => 85 | |
| [taxonomy] => category | |
| [description] => | |
| [parent] => 70 | |
| [count] => 0 | |
| [cat_ID] => 85 | |
| [category_count] => 0 | |
| [category_description] => | |
| [cat_name] => Category Name | |
| [category_nicename] => category-name | |
| [category_parent] => 70 | |
| )</pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_term|<tt>get_term()</tt>]] Used to get the category data from the taxonomy. | |
| * The <code>count</code> attribute includes custom post types as well if the custom post type uses standard categories. | |
| == Change Log == | |
| * Since: [[Version 1.5.1|1.5.1]] | |
| == Source File == | |
| <tt>get_category()</tt> is located in {{Trac|wp-includes/category.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_signon" d:title="wp signon"> | |
| <d:index d:value="wp signon"/> | |
| <h1>wp signon</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_signon}} | |
| {{it|Riferimento funzioni/wp_signon}} | |
| }} | |
| == Description == | |
| Authenticates a user with option to remember credentials. Replaces deprecated function [[Function_Reference/wp_login|wp_login]]. | |
| == Usage == | |
| %%% <?php wp_signon( $credentials, $secure_cookie ) ?> %%% | |
| == Parameters == | |
| {{Parameter|$credentials|array|User info in order to sign on.|optional}} | |
| {{Parameter|$secure_cookie|boolean|Whether to use secure cookie.|optional}} | |
| '''NOTE:''' If you don't provide $credentials, wp_signon uses the $_POST variable (the keys being "log", "pwd" and "rememberme"). | |
| == Return Value == | |
| ; '''(object)''' : Either [[Class_Reference/WP_Error|WP_Error]] on failure, or [[Class_Reference/WP_User|WP_User]] on success. | |
| == Examples == | |
| This function and action can be placed in functions.php of the theme. | |
| Using the hook after_setup_theme will make it run before the headers and cookies are sent, so it can set the needed cookie for login. | |
| <pre><nowiki> | |
| function custom_login() { | |
| $creds = array(); | |
| $creds['user_login'] = 'example'; | |
| $creds['user_password'] = 'plaintextpw'; | |
| $creds['remember'] = true; | |
| $user = wp_signon( $creds, false ); | |
| if ( is_wp_error($user) ) | |
| echo $user->get_error_message(); | |
| } | |
| // run it before the headers and cookies are sent | |
| add_action( 'after_setup_theme', 'custom_login' ); | |
| </nowiki></pre> | |
| == Notes == | |
| *This function sends headers to the page. It must be run before any content is returned. | |
| *This function sets an authentication cookie. Users will not be logged in if it is not sent. | |
| == Change Log == | |
| Since: 2.5.0 | |
| == Source File == | |
| <tt>wp_signon()</tt> is located in {{Trac|wp-includes/user.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_throttle_comment_flood" d:title="wp throttle comment flood"> | |
| <d:index d:value="wp throttle comment flood"/> | |
| <h1>wp throttle comment flood</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_throttle_comment_flood}} | |
| {{it|Riferimento funzioni/wp_throttle_comment_flood}} | |
| }} | |
| == Description == | |
| Determine whether comment should be blocked because of comment flood. | |
| == Usage == | |
| %%%<?php wp_throttle_comment_flood( $block, $time_lastcomment, $time_newcomment ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$block|boolean|True if plugin is blocking comments.}} | |
| {{Parameter|$time_lastcomment|integer|Timestamp for last comment.}} | |
| {{Parameter|$time_newcomment|integer|Timestamp for new comment.}} | |
| == Return Values == | |
| ; <tt>(boolean)</tt> : Returns true if <tt>$block</tt> is true or if <tt>$block</tt> is false and <tt>$time_newcomment - $time_lastcomment &lt; 15</tt>. Returns false otherwise. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>wp_throttle_comment_flood()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| &nbsp; | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_new_comment" d:title="wp new comment"> | |
| <d:index d:value="wp new comment"/> | |
| <h1>wp new comment</h1> | |
| <p>== Description == | |
| Adds a new comment to the database. | |
| Filters new comment to ensure that the fields are sanitized and valid before inserting comment into database. Calls <tt>'comment_post'</tt> action with comment ID and whether comment is approved by WordPress. Also has <tt>'preprocess_comment'</tt> filter for processing the comment data before the function handles it. | |
| == Usage == | |
| %%%<?php wp_new_comment( $commentdata ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$commentdata|array|Contains information on the comment.}} | |
| == Return Values == | |
| ; <tt>(integer)</tt> : The ID of the comment after adding. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>'preprocess_comment'</tt> hook on <tt>$commentdata</tt> parameter array before processing | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] Calls <tt>'comment_post'</tt> hook on <tt>$comment_ID</tt> returned from adding the comment and if the comment was approved. | |
| * Uses: [[Function_Reference/wp_filter_comment|<tt>wp_filter_comment()</tt>]] Used to filter comment before adding comment. | |
| * Uses: [[Function_Reference/wp_allow_comment|<tt>wp_allow_comment()</tt>]] checks to see if comment is approved. | |
| * Uses: [[Function_Reference/wp_insert_comment|<tt>wp_insert_comment()</tt>]] Does the actual comment insertion to the database. | |
| * Uses: [[Function_Reference/wp_notify_moderator|<tt>wp_notify_moderator()</tt>]] | |
| * Uses: [[Function_Reference/wp_notify_postauthor|<tt>wp_notify_postauthor()</tt>]] | |
| * Uses: [[Function_Reference/wp_get_comment_status|<tt>wp_get_comment_status()</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_new_comment()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_set_comment_status" d:title="wp set comment status"> | |
| <d:index d:value="wp set comment status"/> | |
| <h1>wp set comment status</h1> | |
| <p>== Description == | |
| Sets the status of a comment. | |
| The <tt>'wp_set_comment_status'</tt> action is called after the comment is handled and will only be called, if the comment status is either <tt>'hold'</tt>, <tt>'approve'</tt>, or <tt>'spam'</tt>. If the comment status is not in the list, then false is returned and if the status is <tt>'delete'</tt>, then the comment is deleted without calling the action. | |
| == Usage == | |
| %%%<?php wp_set_comment_status( $comment_id, $comment_status ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$comment_id|integer|Comment ID.}} | |
| {{Parameter|$comment_status|string|New comment status, either <tt>'hold'</tt>, <tt>'approve'</tt>, <tt>'spam'</tt>, or <tt>'trash'</tt>.}} | |
| == Return Values == | |
| ; <tt>(boolean)</tt> : False on failure or deletion and true on success. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/wp_transition_comment_status|<tt>wp_transition_comment_status()</tt>]] Passes new and old comment status along with <tt>$comment</tt> object | |
| * Uses: [[Function_Reference/wp_notify_postauthor|<tt>wp_notify_postauthor()</tt>]] | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] | |
| * Uses: [[Function_Reference/wp_delete_comment|<tt>wp_delete_comment()</tt>]] | |
| * Uses: [[Function_Reference/clean_comment_cache|<tt>clean_comment_cache()</tt>]] | |
| * Uses: [[Function_Reference/get_comment|<tt>get_comment()</tt>]] | |
| * Uses: [[Function_Reference/wp_transition_comment_status|<tt>wp_transition_comment_status()</tt>]] | |
| * Uses: [[Function_Reference/wp_update_comment_count|<tt>wp_update_comment_count()</tt>]] | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| == Change Log == | |
| * Since 2.9: $comment_status: the parameter 'delete' was replaced with 'trash'. Comments will be added to the Comment Trash instead of being purged from the database. | |
| * Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_set_comment_status()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| &nbsp; | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_update_comment" d:title="wp update comment"> | |
| <d:index d:value="wp update comment"/> | |
| <h1>wp update comment</h1> | |
| <p>== Description == | |
| Updates an existing comment in the database. | |
| Filters the comment and makes sure certain fields are valid before updating. | |
| == Usage == | |
| %%%<?php wp_update_comment( $commentarr ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$commentarr|array|Contains information on the comment. See [[Function_Reference/get_comment|<tt>get_comment()</tt>]] for a list of valid attributes.}} | |
| == Return Values == | |
| ; <tt>(integer)</tt> : Comment was updated if value is 1, or was not updated if value is 0. | |
| == Examples == | |
| === Unapproving a comment === | |
| <pre> | |
| <?php | |
| $commentarr = array(); | |
| $commentarr['comment_ID'] = 123; // This is the only required array key | |
| $commentarr['comment_approved'] = 0; | |
| wp_update_comment( $commentarr ); | |
| ?> | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/wp_transition_comment_status|<tt>wp_transition_comment_status()</tt>]] Passes new and old comment status along with <tt>$comment</tt> object | |
| * Uses: [[Function_Reference/get_comment|<tt>get_comment()</tt>]] | |
| * Uses: [[Function_Reference/wp_filter_comment|<tt>wp_filter_comment()</tt>]] | |
| * Uses: [[Function_Reference/get_gmt_from_date|<tt>get_gmt_from_date()</tt>]] | |
| * Uses: [[Function_Reference/clean_comment_cache|<tt>clean_comment_cache()</tt>]] | |
| * Uses: [[Function_Reference/wp_update_comment_count|<tt>wp_update_comment_count()</tt>]] | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] on <tt>'edit_comment'</tt> on <tt>$comment_ID</tt>. | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_update_comment()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_update_comment_count" d:title="wp update comment count"> | |
| <d:index d:value="wp update comment count"/> | |
| <h1>wp update comment count</h1> | |
| <p>== Description == | |
| Updates the comment count for post(s). | |
| When <tt>$do_deferred</tt> is <tt>false</tt> (is by default) and the comments have been set to be deferred, <tt>$post_id</tt> will be added to a queue, which will be updated at a later date and only updated once per post ID. | |
| If the comments have not be set up to be deferred, then the post will be updated. When <tt>$do_deferred</tt> is set to true, then all previous deferred post IDs will be updated along with the current <tt>$post_id</tt>. | |
| == Usage == | |
| %%%<?php wp_update_comment_count( $post_id, $do_deferred ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Post ID}} | |
| {{Parameter|$do_deferred|boolean|Whether to process previously deferred post comment counts|optional|false}} | |
| == Return Values == | |
| ; <tt>(boolean)</tt> : True on success, false on failure | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * See [[Function_Reference/wp_update_comment_count_now|<tt>wp_update_comment_count_now()</tt>]] for what could cause a false return value | |
| * Uses: [[Function_Reference/wp_update_comment_count_now|<tt>wp_update_comment_count_now()</tt>]] | |
| * Uses: [[Function_Reference/wp_defer_comment_counting|<tt>wp_defer_comment_counting()</tt>]] | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>wp_update_comment_count()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| &nbsp; | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="discover_pingback_server_uri" d:title="discover pingback server uri"> | |
| <d:index d:value="discover pingback server uri"/> | |
| <h1>discover pingback server uri</h1> | |
| <p>== Description == | |
| Finds a pingback server URI based on the given URL. | |
| Checks the xhtml for the <tt>rel="pingback"</tt> link and x-pingback headers. It does a check for the x-pingback headers first and returns that, if available. The check for the <tt>rel="pingback"</tt> has more overhead than just the header. | |
| == Usage == | |
| %%%<?php discover_pingback_server_uri( $url, $deprecated ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$url|string|URL to ping.}} | |
| {{Parameter|$deprecated|integer||Not Used.}} | |
| == Return Values == | |
| ; <tt>(boolean&#124;string)</tt> : False on failure, string containing URI on success. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/wp_remote_get|<tt>wp_remote_get()</tt>]] | |
| * Uses: [[Function_Reference/is_wp_error|<tt>is_wp_error()</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>discover_pingback_server_uri()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="do_all_pings" d:title="do all pings"> | |
| <d:index d:value="do all pings"/> | |
| <h1>do all pings</h1> | |
| <p>== Description == | |
| Perform all pingbacks, enclosures, trackbacks, and send to pingback services. | |
| == Usage == | |
| %%%<?php do_all_pings() ?>%%% | |
| == Parameters == | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * See Reads from the [[Database_Description#Table:_wp_posts|<tt>_posts</tt> table]] from the database. | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses: [[Function_Reference/pingback|<tt>pingback()</tt>]] | |
| * Uses: [[Function_Reference/do_enclose|<tt>do_enclose()</tt>]] | |
| * Uses: [[Function_Reference/do_trackbacks|<tt>do_trackbacks()</tt>]] | |
| * Uses: [[Function_Reference/generic_ping|<tt>generic_ping()</tt>]] | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>do_all_pings()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="do_trackbacks" d:title="do trackbacks"> | |
| <d:index d:value="do trackbacks"/> | |
| <h1>do trackbacks</h1> | |
| <p>== Description == | |
| Perform [[Glossary#Trackback|trackbacks]]. | |
| == Usage == | |
| %%%<?php do_trackbacks( $post_id ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Post ID to do trackbacks on.}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * See Reads from and may update the <tt>_posts</tt> table from the database. | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses: [[Function_Reference/get_to_ping|<tt>get_to_ping()</tt>]] | |
| * Uses: [[Function_Reference/get_pung|<tt>get_pung()</tt>]] | |
| * Uses: [[Function_Reference/wp_html_excerpt|<tt>wp_html_excerpt()</tt>]] | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] on 'the_content' on 'post_content' | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] on 'the_excerpt' on 'post_excerpt' | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] on 'the_title' on 'post_title' | |
| * Uses: [[Function_Reference/trackback|<tt>trackback()</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>do_trackbacks()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="generic_ping" d:title="generic ping"> | |
| <d:index d:value="generic ping"/> | |
| <h1>generic ping</h1> | |
| <p>== Description == | |
| Sends [[Glossary#Ping|pings]] to all of the ping site services. | |
| == Usage == | |
| %%%<?php generic_ping( $post_id ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Post ID. Only used as a return velue.|optional|0}} | |
| == Return Values == | |
| ; <tt>(integer)</tt> : Returns <tt>$post_id</tt> unaltered. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * The <tt>$post_id</tt> and return values do not <strong>have</strong> to be an <tt>integer</tt> data types, but in WordPress <tt>$post_id</tt> is always an <tt>integer</tt> data type. | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] to get all ping sites. | |
| * Uses: [[Function_Reference/weblog_ping|<tt>weblog_ping()</tt>]] for each ping site. | |
| == Change Log == | |
| Since: 1.2.0 | |
| == Source File == | |
| <tt>generic_ping()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="pingback" d:title="pingback"> | |
| <d:index d:value="pingback"/> | |
| <h1>pingback</h1> | |
| <p>== Description == | |
| [[Glossary#Pingback|Pings back]] the links found in a post. | |
| Includes <tt>wp-include/class-IXR.php</tt> file if not already included. | |
| == Usage == | |
| %%%<?php pingback( $content, $post_ID ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$content|string|Post content to check for links.}} | |
| {{Parameter|$post_ID|integer|Post ID.}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>string</tt>) <tt>$wp_version</tt> holds the installed WordPress version number. | |
| * Uses: [[XML-RPC_Support|IXR_Client]] WordPress class. | |
| * Uses: [[Function_Reference/discover_pingback_server_uri|<tt>discover_pingback_server_uri()</tt>]] | |
| * Uses: [[Function_Reference/get_pung|<tt>get_pung()</tt>]] | |
| * Uses: [[Function_Reference/url_to_postid|<tt>url_to_postid()</tt>]] | |
| * Uses: [[Function_Reference/is_local_attachment|<tt>is_local_attachment()</tt>]] | |
| * Uses: [[Function_Reference/do_action_ref_array|<tt>do_action_ref_array()</tt>]] on <tt>'pre_ping'</tt> on <tt>'post_links'</tt> and on [[Function_Reference/pung|<tt>pung()</tt>]] result. | |
| * Uses: [[Function_Reference/get_permalink|<tt>get_permalink()</tt>]] | |
| * Uses: [[Function_Reference/add_ping|<tt>add_ping()</tt>]] | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>pingback()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| [[Function Reference/trackback url|trackback_url]] | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="privacy_ping_filter" d:title="privacy ping filter"> | |
| <d:index d:value="privacy ping filter"/> | |
| <h1>privacy ping filter</h1> | |
| <p>== Description == | |
| Check whether blog is public before returning sites. | |
| == Usage == | |
| %%%<?php privacy_ping_filter( $sites ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$sites|mixed|Will return if blog is public, will not return if not public.}} | |
| == Return Values == | |
| ; <tt>(mixed)</tt> : Returns empty string (<tt>&#39;&#39;</tt>) if blog is not public. Returns value in <tt>$sites</tt> if site is public. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] to check <tt>'blog_public'</tt> option. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>privacy_ping_filter()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="weblog_ping" d:title="weblog ping"> | |
| <d:index d:value="weblog ping"/> | |
| <h1>weblog ping</h1> | |
| <p>== Description == | |
| Send a [[Glossary#Pingback|pingback]]. | |
| == Usage == | |
| %%%<?php weblog_ping( $server, $path ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$server|string|Host of blog to connect to.|optional|&#39;&#39;}} | |
| {{Parameter|$path|string|Path to send the ping.|optional|&#39;&#39;}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>string</tt>) <tt>$wp_version</tt> holds the installed WordPress version number. | |
| * Uses: [[XML-RPC_Support|IXR_Client]] WordPress class. | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] to retrieve the <tt>'home'</tt> option. | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] to retrieve the <tt>'blogname'</tt> option. | |
| * Uses: [[Function_Reference/get_bloginfo|<tt>get_bloginfo()</tt>]] to retrieve the <tt>'rss2_url'</tt>. | |
| == Change Log == | |
| Since: 1.2.0 | |
| == Source File == | |
| <tt>weblog_ping()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="do_enclose" d:title="do enclose"> | |
| <d:index d:value="do enclose"/> | |
| <h1>do enclose</h1> | |
| <p>== Description == | |
| Check content for video and audio links to add as [http://en.wikipedia.org/wiki/RSS_enclosure enclosures]. | |
| Will not add enclosures that have already been added. | |
| == Usage == | |
| %%%<?php do_enclose( $content, $post_ID ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$content|string|Post Content}} | |
| {{Parameter|$post_ID|integer|Post ID}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] to read and condtionally insert records on [[Database_Description#Table:_wp_postmeta|<tt>_postmeta table</tt>]] in the database. | |
| * Uses: [[Function_Reference/debug_fopen|<tt>debug_fopen()</tt>]] to open 'enclosures.log' file. | |
| * Uses: [[Function_Reference/debug_fwrite|<tt>debug_fwrite()</tt>]] to write to 'enclosures.log' file. | |
| * Uses: [[Function_Reference/get_enclosed|<tt>get_enclosed()</tt>]] | |
| * Uses: [[Function_Reference/wp_get_http_headers|<tt>wp_get_http_headers()</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>do_enclose()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="add_ping" d:title="add ping"> | |
| <d:index d:value="add ping"/> | |
| <h1>add ping</h1> | |
| <p>== Description == | |
| Add a URL to those already pung. | |
| == Usage == | |
| %%%<?php add_ping( $post_id, $uri ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Post ID.}} | |
| {{Parameter|$uri|string|Ping URI.}} | |
| == Return Values == | |
| ; (integer) : Count of updated rows. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] to read and to update the [[Database_Description#Table:_wp_posts|<tt>_posts table</tt>]] in database. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] on 'add_ping' | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>add_ping()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_enclosed" d:title="get enclosed"> | |
| <d:index d:value="get enclosed"/> | |
| <h1>get enclosed</h1> | |
| <p>== Description == | |
| Retrieve [http://en.wikipedia.org/wiki/RSS_enclosure enclosures] already enclosed for a post. | |
| == Usage == | |
| %%%<?php get_enclosed( $post_id ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Post ID.}} | |
| == Return Values == | |
| ; (array) : List of enclosures. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_post_custom|<tt>get_post_custom()</tt>]] on <tt>$post_id</tt>. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] on <tt>'get_enclosed'</tt> on enclosures. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_enclosed()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_pung" d:title="get pung"> | |
| <d:index d:value="get pung"/> | |
| <h1>get pung</h1> | |
| <p>== Description == | |
| Retrieve URLs already [[Glossary#Ping|pinged]] for a post. | |
| == Usage == | |
| %%%<?php get_pung( $post_id ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Post ID.}} | |
| == Return Values == | |
| ; (array) : Returns array of pinged URLs. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| <?php | |
| $pinged_posts = get_pung( $post->ID ); | |
| foreach ( $pinged_posts as $pinged_post ) : | |
| if (!empty($pinged_post) ) { | |
| echo 'Incoming Link: <a href="'.$pinged_post.'" rel="external">'.$pinged_post.'</a>'; | |
| } | |
| endforeach; | |
| ?> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] to retrieve pinged URLs from the [[Database_Description#Table:_wp_posts|<tt>_posts table</tt>]] in the database. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] on <tt>'get_pung'</tt> on pinged URLs. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_pung()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_to_ping" d:title="get to ping"> | |
| <d:index d:value="get to ping"/> | |
| <h1>get to ping</h1> | |
| <p>== Description == | |
| Retrieve URLs that need to be [[Glossary#Ping|pinged]]. | |
| == Usage == | |
| %%%<?php get_to_ping( $post_id ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Post ID}} | |
| == Return Values == | |
| ; (array) : Returns array of URLs that need to be pinged. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] to read <tt>'to_ping'</tt> field from [[Database_Description#Table:_wp_posts|<tt>_posts table</tt>]] from database. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] on <tt>'get_to_ping'</tt> on the URLs that need to be pinged. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_to_ping()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="trackback_url_list" d:title="trackback url list"> | |
| <d:index d:value="trackback url list"/> | |
| <h1>trackback url list</h1> | |
| <p>== Description == | |
| Do [[Glossary#Trackback|trackbacks]] for a list of URLs. | |
| == Usage == | |
| %%%<?php trackback_url_list( $tb_list, $post_id ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$tb_list|string|Comma separated list of URLs}} | |
| {{Parameter|$post_id|integer|Post ID}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/wp_get_single_post|<tt>wp_get_single_post()</tt>]] on <tt>$post_id</tt>. | |
| * Uses: [[Function_Reference/trackback|<tt>trackback()</tt>]] on each trackback url. | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>trackback_url_list()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="trackback" d:title="trackback"> | |
| <d:index d:value="trackback"/> | |
| <h1>trackback</h1> | |
| <p>== Description == | |
| Send a [[Glossary#Trackback|trackback]]. | |
| Updates database when sending trackback to prevent duplicates. | |
| == Usage == | |
| %%%<?php trackback( $trackback_url, $title, $excerpt, $ID ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$trackback_url|string|URL to send trackbacks.}} | |
| {{Parameter|$title|string|Title of post.}} | |
| {{Parameter|$excerpt|string|Excerpt of post.}} | |
| {{Parameter|$ID|integer|Post ID.}} | |
| == Return Values == | |
| ; (mixed) : Database query from update. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] to update the [[Database_Description#Table:_wp_posts|<tt>_posts table</tt>]] from the database. | |
| * Uses: [[Function_Reference/get_permalink|<tt>get_permalink()</tt>]] on <tt>$ID</tt>. | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] to retrieve the <tt>'blogname'</tt> option. | |
| * Uses: [[Function_Reference/wp_remote_post|<tt>wp_remote_post()</tt>]] on <tt>$trackback_url</tt>. | |
| * Uses: [[Function_Reference/is_wp_error|<tt>is_wp_error()</tt>]] | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>trackback()</tt> is located in {{Trac|wp-includes/comment.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_stylesheet" d:title="get stylesheet"> | |
| <d:index d:value="get stylesheet"/> | |
| <h1>get stylesheet</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_stylesheet}} | |
| {{it|Riferimento funzioni/get_stylesheet}} | |
| }} | |
| == Description == | |
| Retrieve name of the current [http://en.wikipedia.org/wiki/Cascading_Style_Sheets stylesheet]. | |
| The [[Glossary#Theme|theme]] name that the administrator has currently set the front end theme as. | |
| For all intents and purposes, the template name and the stylesheet name are going to be the same for most cases. In the event that you use a child theme, that is the name that will be returned, rather than the parent. | |
| == Usage == | |
| %%%<?php get_stylesheet(); ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Stylesheet name. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls 'stylesheet' filter on stylesheet name. | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] to retrieve the 'stylesheet' option. | |
| * In the event a child theme is being used, that is the name that will be returned, not the parent theme name (use [[Function_Reference/get_template_directory|<tt> get_template_directory()</tt>]] instead if you want the parent directory) | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_stylesheet()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_stylesheet_directory" d:title="get stylesheet directory"> | |
| <d:index d:value="get stylesheet directory"/> | |
| <h1>get stylesheet directory</h1> | |
| <p>== Description == | |
| Retrieve [http://en.wikipedia.org/wiki/Cascading_Style_Sheets stylesheet] directory Path for the current theme/child theme. | |
| <b>Note:</b> Does not contain a trailing slash. | |
| Returns an absolute server path (eg: /home/user/public_html/wp-content/themes/my_theme), not a URI. | |
| To retrieve the URI of the stylesheet directory use [[Function_Reference/get_stylesheet_directory_uri|get_stylesheet_directory_uri()]] instead. | |
| == Usage == | |
| %%%<?php get_stylesheet_directory() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| {{Return|uri|string|Stylesheet directory Absolute Path}}. | |
| == Examples == | |
| <b>Include a PHP file</b> | |
| <pre> | |
| <?php include( get_stylesheet_directory() . '/includes/myfile.php'); ?> | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>'stylesheet_directory'</tt> filter on stylesheet path and name. | |
| * Uses: [[Function_Reference/get_stylesheet|<tt>get_stylesheet()</tt>]] | |
| * Uses: [[Function_Reference/get_theme_root|<tt>get_theme_root()</tt>]] | |
| * In the event a child theme is being used, that is the directory that will be returned, not the parent theme directory (use [[Function_Reference/get_template_directory|<tt> get_template_directory()</tt>]] instead if you want the parent directory) | |
| == Change Log == | |
| * Since: [[Version 1.5|1.5.0]] | |
| == Source File == | |
| <tt>get_stylesheet_directory()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| {{Theme Paths}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_stylesheet_directory_uri" d:title="get stylesheet directory uri"> | |
| <d:index d:value="get stylesheet directory uri"/> | |
| <h1>get stylesheet directory uri</h1> | |
| <p>== Description == | |
| Retrieve [http://en.wikipedia.org/wiki/Cascading_Style_Sheets stylesheet] directory URI for the current theme/child theme. Checks for SSL. | |
| <b>Note:</b> Does not contain a trailing slash. | |
| Note that this returns a properly-formed [http://en.wikipedia.org/wiki/Uniform_Resource_Identifier URI]; in other words, it will be a web-address (starting with http:// or https:// for SSL). As such, it is most appropriately used for links, referencing additional stylesheets, or probably most commonly, images. | |
| In the event a child theme is being used, this function will return the child's theme directory URI. | |
| Use [[Function_Reference/get_template_directory_uri|<tt> get_template_directory_uri()</tt>]] to avoid being overridden by a child theme. | |
| If you want to include a local file in PHP, use [[Function_Reference/get_stylesheet_directory|get_stylesheet_directory()]] instead. | |
| == Usage == | |
| '''Use the URI''' | |
| %%%<?php get_stylesheet_directory_uri(); ?>%%% | |
| '''Output the URI''' | |
| %%%<?php echo get_stylesheet_directory_uri(); ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| {{Return|uri|string|Stylesheet directory URI}}. | |
| == Examples == | |
| <b>Image (HTML)</b> | |
| <pre> | |
| <img src="<?php echo get_stylesheet_directory_uri() ?>/images/aternus.png" alt="" title="" width="" height="" /> | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>'stylesheet_directory_uri'</tt> filter on stylesheet path and name. | |
| * Uses: [[Function_Reference/get_stylesheet|<tt>get_stylesheet()</tt>]] | |
| * Uses: [[Function_Reference/get_theme_root|<tt>get_theme_root()</tt>]] | |
| == Change Log == | |
| * Since: [[Version 1.5|1.5.0]] | |
| == Source File == | |
| <tt>get_stylesheet_directory_uri()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| * [[Function Reference/get_stylesheet_uri|<tt>get_stylesheet_uri();</tt>]] | |
| * [[Function Reference/get_bloginfo|<tt>get_bloginfo( 'stylesheet_directory' );</tt>]] | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_stylesheet_uri" d:title="get stylesheet uri"> | |
| <d:index d:value="get stylesheet uri"/> | |
| <h1>get stylesheet uri</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get stylesheet uri}} | |
| {{ja|Function Reference/get stylesheet uri}} | |
| }} | |
| == Description == | |
| Retrieves the URI of the current [[Glossary#Theme|theme]] [http://en.wikipedia.org/wiki/Cascading_Style_Sheets stylesheet]. | |
| The stylesheet file name is <tt>'style.css'</tt> which is appended to [[Function_Reference/get_stylesheet_directory_uri|<tt>get_stylesheet_directory_uri()</tt>]] path. | |
| == Usage == | |
| %%%<?php get_stylesheet_uri(); ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Returns URI of current theme stylesheet. | |
| == Examples == | |
| To output the URL | |
| %%%<?php echo get_stylesheet_uri(); ?>%%% | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>'stylesheet_uri'</tt> filter on stylesheet URI path and stylesheet directory URI. | |
| * Uses: [[Function_Reference/get_stylesheet_directory_uri|<tt>get_stylesheet_directory_uri()</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_stylesheet_uri()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_locale_stylesheet_uri" d:title="get locale stylesheet uri"> | |
| <d:index d:value="get locale stylesheet uri"/> | |
| <h1>get locale stylesheet uri</h1> | |
| <p>== Description == | |
| Retrieve localized stylesheet URI. | |
| The [http://en.wikipedia.org/wiki/Cascading_Style_Sheets stylesheet] directory for the localized stylesheet files are located, by default, in the base [[Glossary#Theme|theme]] directory. The name of the locale file will be the locale followed by <tt>'.css'</tt>. If that does not exist, then the text direction stylesheet will be checked for existence, for example <tt>'ltr.css'</tt>. | |
| The theme may change the location of the stylesheet directory by either using the <tt>'stylesheet_directory_uri'</tt> filter or the <tt>'locale_stylesheet_uri'</tt> filter. If you want to change the location of the stylesheet files for the entire WordPress workflow, then change the former. If you just have the locale in a separate folder, then change the latter. | |
| == Usage == | |
| %%%<?php get_locale_stylesheet_uri() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Returns localized stylesheet URI. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) <tt>$wp_locale</tt> handles the date and time locales. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>'locale_stylesheet_uri'</tt> filter on stylesheet URI path and stylesheet directory URI. | |
| * Uses: [[Function_Reference/get_stylesheet_directory_uri|<tt>get_stylesheet_directory_uri()</tt>]] | |
| * Uses: [[Function_Reference/get_stylesheet_directory|<tt>get_stylesheet_directory()</tt>]] | |
| * Uses: [[Function_Reference/get_locale|<tt>get_locale()</tt>]] | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>get_locale_stylesheet_uri()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_template" d:title="get template"> | |
| <d:index d:value="get template"/> | |
| <h1>get template</h1> | |
| <p>== Description == | |
| Retrieves the directory name of the current [[Glossary#Theme|theme]], without the trailing slash. | |
| In the case a child theme is being used, the directory name of the parent theme will be returned. Use [[Function Reference/get_stylesheet|<tt>get_stylesheet()</tt>]] to get the directory name of the child theme. | |
| == Usage == | |
| %%%<?php get_template() ?>%%% | |
| == Parameters == | |
| This tag has no parameters. | |
| == Return Values == | |
| {{Return||string| Directory name of the current theme (without the trailing slash). Its the same as the name of the theme.}}. | |
| == Examples == | |
| For example, if your current active theme is named 'heli', then: | |
| %%%<?php echo get_template() ?>%%% | |
| will output | |
| %%%heli%%% | |
| == Notes == | |
| * Uses: [[Function Reference/get_option|<tt>get_option()</tt>]] to retrieve the [[Option_Reference#Themes|template]] option. | |
| * Uses: [[Function Reference/apply_filters|<tt>apply_filters()</tt>]] to apply the [[Plugin API/Filter Reference/template|template]] filters on the retrieved ''template'' option. | |
| == Change Log == | |
| Since: [[Version_1.5 | 1.5.0]] | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_template()</tt> is located in {{Trac|wp-includes/theme.php}}, line 241. | |
| == Related == | |
| {{Theme Paths}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_template_directory_uri" d:title="get template directory uri"> | |
| <d:index d:value="get template directory uri"/> | |
| <h1>get template directory uri</h1> | |
| <p>== Description == | |
| Retrieve [[Templates|template]] directory URI for the current theme. Checks for SSL. | |
| <b>Note:</b> Does not return a trailing slash following the directory address. | |
| In the event a [[Child_Themes|child theme]] is being used, the parent theme directory URI will be returned, <tt>get_template_directory_uri()</tt> should be used for resources that are not intended to be included in/over-ridden by a child theme. Use [[Function_Reference/get_stylesheet_directory_uri|<tt> get_stylesheet_directory_uri()</tt>]] to include resources that are intended to be included in/over-ridden by the Child Theme. | |
| == Usage == | |
| '''Use the URI''' | |
| %%%<?php get_template_directory_uri(); ?>%%% | |
| '''Output the URI''' | |
| %%%<?php echo get_template_directory_uri(); ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| {{Return|uri|string|Template directory URI}}. | |
| == Examples == | |
| Using get_template_directory_uri() to enqueue a script with the correct path | |
| <?php | |
| function my_scripts_method() { | |
| wp_enqueue_script( | |
| 'custom_script', | |
| get_template_directory_uri() . '/js/custom_script.js', | |
| array('jquery') | |
| ); | |
| } | |
| add_action('wp_enqueue_scripts', 'my_scripts_method'); | |
| ?> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls 'template_directory_uri' filter on template directory URI path and template name. | |
| * Uses: [[Function_Reference/get_template|<tt>get_template()</tt>]] | |
| * Uses: [[Function_Reference/get_theme_root_uri|<tt>get_theme_root_uri()</tt>]] | |
| == Change Log == | |
| * Since: [[Version 1.5|1.5.0]] | |
| == Source File == | |
| <tt>get_template_directory_uri()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_themes" d:title="get themes"> | |
| <d:index d:value="get themes"/> | |
| <h1>get themes</h1> | |
| <p>{{Deprecated|new_function()=wp_get_themes}} | |
| == Description == | |
| Retrieve list of [[Glossary#Theme|themes]] with theme data in theme directory. | |
| The theme is broken if it doesn't have a parent theme and is missing either <tt>style.css</tt> or <tt>index.php</tt>. If the theme has a parent theme, it is broken if it is missing <tt>style.css</tt>; <tt>index.php</tt> is optional. The broken theme list is saved in the <tt>$wp_broken_themes</tt> global, which is displayed on the theme list in the administration panels. | |
| == Usage == | |
| %%%<?php get_themes() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (array) : Theme list with theme data. | |
| == Notes == | |
| * Uses global: (<tt>array</tt>) <tt>$wp_themes</tt> holds working themes list. | |
| == Change Log == | |
| Since: 1.5.0. Deprecated since 3.4.0. | |
| == Source File == | |
| <tt>get_themes()</tt> is located in {{Trac|wp-includes/deprecated.php}}. | |
| == Related == | |
| * [[Function_Reference/get_theme]] | |
| * [[Function_Reference/wp_get_theme]] | |
| * [[Function_Reference/wp_get_themes]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_theme" d:title="get theme"> | |
| <d:index d:value="get theme"/> | |
| <h1>get theme</h1> | |
| <p>{{Deprecated|new_function()=wp_get_theme}} | |
| == Description == | |
| Retrieve [[Glossary#Theme|theme]] data. | |
| == Usage == | |
| %%%<?php get_theme( $theme ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$theme|string|Theme name.}} | |
| == Return Values == | |
| ; (array&#124;null) : Null, if theme name does not exist. Theme data, if exists. | |
| == Notes == | |
| * Uses: [[Function_Reference/get_themes|<tt>get_themes()</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_theme()</tt> is located in {{Trac|wp-includes/deprecated.php}}. | |
| == Related == | |
| * [[Function_Reference/get_themes]] | |
| * [[Function_Reference/wp_get_theme]] | |
| * [[Function_Reference/wp_get_themes]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_theme_root" d:title="get theme root"> | |
| <d:index d:value="get theme root"/> | |
| <h1>get theme root</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get theme root}} | |
| {{ja|Function Reference/get theme root}} | |
| }} | |
| == Description == | |
| Retrieves the absolute path to the [[Glossary#Theme|themes]] directory, without the trailing slash. | |
| == Usage == | |
| %%%<?php get_theme_root(); ?>%%% | |
| == Parameters == | |
| {{Parameter|$stylesheet_or_template|string|The stylesheet or template name of the theme.}} | |
| == Return Values == | |
| {{Return||string|Absolute path to the [[Glossary#Theme|themes]] directory (without the trailing slash)}}. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| ===Number of Subdirectories in Themes Directory=== | |
| The function below informs about the number of subdirectories in the themes directory. Note that this doesn't necessarily match the number of [[Theme Development#Theme_Stylesheet|themes recognized]] by WordPress. | |
| <pre><?php | |
| function display_themes_subdirs_count_info() | |
| $theme_root = get_theme_root(); | |
| $files_array = glob("$theme_root/*", GLOB_ONLYDIR); | |
| echo "There are " . count($files_array) . " subdirectories in the " . $theme_root " directory"; | |
| } | |
| ?></pre> | |
| Example output: | |
| <div style="border:1px solid blue; margin: 20px 0; padding:20px">There are 5 subdirectories in the /home/user/public_html/wp-content/themes directory.</div> | |
| == Notes == | |
| * Uses: [[Function Reference/apply_filters|<tt>apply_filters()</tt>]] to apply the [[Plugin API/Filter Reference/theme_root|theme_root]] filters on the retrieved path. | |
| == Change Log == | |
| Since: [[Version 1.5|1.5.0]] | |
| == Source File == | |
| <tt>get_theme_root()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| {{Theme Paths}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_theme_root_uri" d:title="get theme root uri"> | |
| <d:index d:value="get theme root uri"/> | |
| <h1>get theme root uri</h1> | |
| <p>== Description == | |
| Retrieve URI for [[Glossary#Theme|themes]] directory. | |
| Does not have trailing slash. | |
| == Usage == | |
| %%%<?php get_theme_root_uri(); ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Themes URI. For example: <pre>http://www.wordpress.org/wp-content/themes</pre> | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>'theme_root_uri'</tt> filter on uri. | |
| * Uses: [[Function_Reference/content_url|<tt>content_url()</tt>]] to retrieve the <tt>'themes'</tt> uri. | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] to retrieve <tt>'siteurl'</tt> option. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_theme_root_uri()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_query_template" d:title="get query template"> | |
| <d:index d:value="get query template"/> | |
| <h1>get query template</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_query_template}} | |
| {{it|Riferimento funzioni/get_query_template}} | |
| }} | |
| == Description == | |
| Retrieve path to file without the use of extension. | |
| Used to quickly retrieve the path of file without including the file extension. It will also check the parent template, if the file exists, with the use of [[Function_Reference/locate_template|<tt>locate_template()</tt>]]. Allows for more generic file location without the use of the other <tt>get_*_template()</tt> functions. | |
| Can be used with [http://us3.php.net/manual/en/function.include.php <tt>include()</tt>] or [http://us3.php.net/manual/en/function.require.php <tt>require()</tt>] to retrieve path. | |
| <code> | |
| if ( &#39;&#39; != get_query_template( '404' ) ) | |
| include( get_query_template( '404' ) ); | |
| </code> | |
| or the same can be accomplished with | |
| <code> | |
| if ( &#39;&#39; != get_404_template() ) | |
| include( get_404_template() ); | |
| </code> | |
| == Usage == | |
| %%%<?php get_query_template( $type, $templates ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$type|string|Filename without extension.}} | |
| {{Parameter|$templates|array|An optional list of template candidates|optional|array()}} | |
| == Return Values == | |
| ; (string) : Full path to file. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] on <tt>[[Filter_Reference/type_template|{$type}_template]]</tt> on result from [[Function_Reference/locate_template|<tt>locate_template()</tt>]]. | |
| * Uses: [[Function_Reference/locate_template|<tt>locate_template()</tt>]] on "{<tt>$type</tt>}.php". | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_query_template()</tt> is located in {{Trac|wp-includes/template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_404_template" d:title="get 404 template"> | |
| <d:index d:value="get 404 template"/> | |
| <h1>get 404 template</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_404_template}} | |
| {{it|Riferimento funzioni/get_404_template}} | |
| }} | |
| == Description == | |
| Retrieve path of 404 template in current or parent template. | |
| == Usage == | |
| %%%<?php get_404_template(); ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Returns result from [[Function_Reference/get_query_template|<tt>get_query_template('404')</tt>]]. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_query_template|<tt>get_query_template()</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_404_template()</tt> is located in {{Trac|wp-includes/theme.php}} (if v3.x {{Trac|wp-includes/template.php}}). | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_archive_template" d:title="get archive template"> | |
| <d:index d:value="get archive template"/> | |
| <h1>get archive template</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_archive_template}} | |
| {{it|Riferimento funzioni/get_archive_template}} | |
| }} | |
| == Description == | |
| Retrieve path of archive template in current or parent template. | |
| == Usage == | |
| %%%<?php get_archive_template(); ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Returns result from [[Function_Reference/get_query_template|<tt>get_query_template('archive')</tt>]] | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_query_template|<tt>get_query_template()</tt>]] | |
| === Filters === | |
| * Calls <b><tt>'archive_template'</tt></b> filter on found path: <br /><tt>apply_filters('archive_template', $template)</tt> | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_archive_template()</tt> is located in {{Trac|wp-includes/template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_author_template" d:title="get author template"> | |
| <d:index d:value="get author template"/> | |
| <h1>get author template</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_author_template}} | |
| {{it|Riferimento funzioni/get_author_template}} | |
| }} | |
| == Description == | |
| Retrieve path of author template in current or parent template. | |
| == Usage == | |
| %%%<?php get_author_template() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Returns result from [[Function_Reference/get_query_template|<tt>get_query_template('author')</tt>]] | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_query_template|<tt>get_query_template()</tt>]]; | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_author_template()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| &nbsp; | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_category_template" d:title="get category template"> | |
| <d:index d:value="get category template"/> | |
| <h1>get category template</h1> | |
| <p>== Description == | |
| Retrieve path of category template in current or parent [[Templates|template]]. | |
| Works by retrieving the current category ID, for example <tt>'category-1.php'</tt> and will fallback to <tt>category.php</tt> template, if the category ID file doesn't exist. | |
| == Usage == | |
| %%%<?php get_category_template() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Returns path of category template in current or parent template. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>'category_template'</tt> on file path of category template. | |
| * Uses: [[Function_Reference/locate_template|<tt>locate_template()</tt>]] | |
| * Uses: [[Function_Reference/get_query_var|<tt>get_query_var()</tt>]] on <tt>'cat'</tt>. | |
| === Filters === | |
| * Calls <b><tt>'category_template'</tt></b> filter on found path: <br /><tt>apply_filters('category_template', $template)</tt> | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_category_template()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_date_template" d:title="get date template"> | |
| <d:index d:value="get date template"/> | |
| <h1>get date template</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_date_template}} | |
| {{it|Riferimento funzioni/get_date_template}} | |
| }} | |
| == Description == | |
| Retrieve path of date template in current or parent template. | |
| == Usage == | |
| %%%<?php get_date_template() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Result of [[Function_Reference/get_query_template|<tt>get_query_template('date')</tt>]]. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_query_template|<tt>get_query_template()</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_date_template()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_home_template" d:title="get home template"> | |
| <d:index d:value="get home template"/> | |
| <h1>get home template</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_home_template}} | |
| {{it|Riferimento funzioni/get_home_template}} | |
| }} | |
| == Description == | |
| Retrieve path of home template in current or parent template. | |
| Attempts to locate <tt>'home.php'</tt> first before falling back to <tt>'index.php'</tt>. | |
| == Usage == | |
| %%%<?php get_home_template() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Returns path of home template in current or parent template. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>'home_template'</tt> on file path of home template. | |
| * Uses: [[Function_Reference/locate_template|<tt>locate_template()</tt>]] on <tt>'home.php'</tt> and <tt>'index.php'</tt>. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_home_template()</tt> is located in {{Trac|wp-includes/template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_page_template" d:title="get page template"> | |
| <d:index d:value="get page template"/> | |
| <h1>get page template</h1> | |
| <p>== Description == | |
| Retrieve path of [[Page_Templates|page template]] in current or parent template. | |
| First attempt is to look for the file in the <tt>'_wp_page_template'</tt> page meta data. The second attempt, if the first has a file and is not empty, is to look for <tt>'page.php'</tt>. | |
| == Usage == | |
| %%%<?php get_page_template(); ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Returns path of page template in current or parent template. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| Displays the filename of the page template used to render a Page (printed within an HTML comment, in this example) : | |
| <pre><?php echo '<!-- ' . basename( get_page_template() ) . ' -->'; ?></pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_post_meta|<tt>get_post_meta()</tt>]] | |
| * Uses: [[Function_Reference/validate_file|<tt>validate_file()</tt>]] | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] on 'page_template' on result of [[Function_Reference/locate_template|<tt>locate_template()</tt>]]. | |
| * Uses: [[Function_Reference/locate_template|<tt>locate_template()</tt>]] | |
| * Uses global: (<tt>object</tt>) [[Class_Reference/WP_Query|<tt>$wp_query</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_page_template()</tt> is located in {{Trac|wp-includes/template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_paged_template" d:title="get paged template"> | |
| <d:index d:value="get paged template"/> | |
| <h1>get paged template</h1> | |
| <p>== Description == | |
| Retrieve path of paged [[Templates|template]] in current or parent template. | |
| == Usage == | |
| %%%<?php get_paged_template() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Result of [[Function_Reference/get_query_template|<tt>get_query_template('paged')</tt>]]. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_query_template|<tt>get_query_template()</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_paged_template()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_search_template" d:title="get search template"> | |
| <d:index d:value="get search template"/> | |
| <h1>get search template</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_search_template}} | |
| {{it|Riferimento funzioni/get_search_template}} | |
| }} | |
| == Description == | |
| Retrieve path of search template in current or parent template. | |
| == Usage == | |
| %%%<?php get_search_template() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Result of [[Function_Reference/get_query_template|<tt>get_query_template('search')</tt>]]. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_query_template|<tt>get_query_template()</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_search_template()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_single_template" d:title="get single template"> | |
| <d:index d:value="get single template"/> | |
| <h1>get single template</h1> | |
| <p>== Description == | |
| Retrieve path of [[Templates|single template]] in current or parent template. | |
| == Usage == | |
| %%%<?php get_single_template() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Result of <tt>get_query_template('single')</tt>. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_query_template|<tt>get_query_template()</tt>]] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_single_template()</tt> is located in {{Trac|wp-includes/template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_attachment_template" d:title="get attachment template"> | |
| <d:index d:value="get attachment template"/> | |
| <h1>get attachment template</h1> | |
| <p>== Description == | |
| Retrieve path of [[Templates|attachment template]] in current or parent template. | |
| The attachment path first checks if the first part of the mime type exists. The second check is for the second part of the mime type. The last check is for both types separated by an underscore. If neither are found then the file <tt>'attachment.php'</tt> is checked and returned. | |
| Some examples for the <tt>'text/plain'</tt> mime type are <tt>'text.php'</tt>, <tt>'plain.php'</tt>, and finally <tt>'text_plain.php'</tt>. | |
| == Usage == | |
| %%%<?php get_attachment_template() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Returns path of attachment template in current or parent template. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_query_template|<tt>get_query_template()</tt>]] | |
| * Uses global: (<tt>object</tt>) <tt>$posts</tt> a property of the [[Class_Reference/WP_Query|<tt>WP_Query</tt>]] object. | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <tt>get_attachment_template()</tt> is located in {{Trac|wp-includes/template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="User:Chrisbliss18/wp_cache_add" d:title="User:Chrisbliss18/wp cache add"> | |
| <d:index d:value="User:Chrisbliss18/wp cache add"/> | |
| <h1>User:Chrisbliss18/wp cache add</h1> | |
| <p>{{Draft}} | |
| == Description == | |
| <span style="background-color:#F5F5F5; border:1px solid #DADADA; margin:0px 0px 22px 0px; padding:11px; display:block;"><tt>bool wp_cache_add ( int|string $key, mixed $data [, string $flag [, int $expire ]] )</tt></span> | |
| __TOC__ | |
| This function is part of the [[Function Reference/WP Cache|WP Cache]] system. Its function is to add data to the cache, if the cache key doesn't already exist. | |
| For examples of how to use this function, see the [[User:Chrisbliss18/wp_cache_add#Examples|Examples section]] below. | |
| == Parameters == | |
| This function uses [[Template Tags/How to Pass Tag Parameters#Tags with PHP function-style parameters|PHP function style parameters]]. | |
| <dl style="background-color:#F5F5F5; border:1px solid #DADADA; margin:0px 0px 22px 0px; padding:11px 11px 0px 11px;"> | |
| <dt style="font-weight:normal; font-style:italic;"> | |
| key | |
| <dd style="background-color:#FAFAFA; border:1px solid #DADADA; margin:0px 0px 22px 22px; padding:11px; font-weight:normal;"> | |
| The cache ID to use for retrieval later. This is a required parameter. | |
| <dt style="font-weight:normal; font-style:italic;"> | |
| data | |
| <dd style="background-color:#FAFAFA; border:1px solid #DADADA; margin:0px 0px 22px 22px; padding:11px; font-weight:normal;"> | |
| The data to add to the cache store. This is a required parameter. | |
| <dt style="font-weight:normal; font-style:italic;"> | |
| flag | |
| <dd style="background-color:#FAFAFA; border:1px solid #DADADA; margin:0px 0px 22px 22px; padding:11px; font-weight:normal;"> | |
| The group to add the cache to. Default value is an empty string.<br /> | |
| <br /> | |
| It should be noted that the default value for this parameter in both <tt>WP_Object_Cache::add()</tt> and <tt>WP_Object_Cache::set()</tt> is <tt>default</tt> rather than an empty string. This editor does not know if this difference was an oversight or intentional. | |
| <dt style="font-weight:normal; font-style:italic;"> | |
| expire | |
| <dd style="background-color:#FAFAFA; border:1px solid #DADADA; margin:0px 0px 22px 22px; padding:22px; font-weight:normal;"> | |
| When the cache data should expire. Default value is <tt>0</tt>.<br /> | |
| <br /> | |
| Tracing this variable through the resulting call to <tt>WP_Object_Cache::set()</tt>, it can be seen that this parameter is not used. This may just be a placeholder for future functionality.</dl> | |
| == Return Values == | |
| The function returns <tt>true</tt> on success and <tt>false</tt> if the cache ID and group already exists. | |
| == Errors/Exceptions == | |
| Placeholder section that would be used with functions that return [[Function Reference/WP Error|WP Error]] objects. | |
| == ChangeLog == | |
| <table> | |
| <tr> | |
| <th style="padding-right:10px; font-weight:bold;">Version</th> | |
| <th style="font-weight:bold;">Description</th> | |
| </tr> | |
| <tr> | |
| <td style="padding-right:10px;">2.5</td> | |
| <td><tt>$data</tt> filtering is removed.</td> | |
| </tr> | |
| <tr> | |
| <td style="padding-right:10px;>2.1.1</td> | |
| <td><tt>$data</tt> is filtered through first <tt>serialize()</tt> and then <tt>unserialize()</tt>.</td> | |
| </tr> | |
| <tr> | |
| <td style="padding-right:10px;">2.0.0</td> | |
| <td>Added to WordPress core.</td> | |
| </tr> | |
| </table> | |
| == Examples == | |
| There are many examples throughout WordPress' core that use this function. Below are a couple of code selections. | |
| === Retrieving All Category IDs === | |
| The [[Function Reference/Category API]] shows a very good example of using <tt>wp_cache_add()</tt> in combination with <tt>[[Function Reference/wp_cache_get|wp_cache_get()]]</tt> to ensure that the expensive queries and data processing to gather all the category IDs only occur once. | |
| ''Note: The following code was taken from wp-includes/category.php version 2.7.'' | |
| <span style="background-color:#F5F5F5; border:1px solid #DADADA; margin:0px; padding:0px 11px 0px 11px; display:block;">%%%<?php | |
| function get_all_category_ids() { | |
| if ( ! $cat_ids = wp_cache_get( 'all_category_ids', 'category' ) ) { | |
| $cat_ids = get_terms( 'category', 'fields=ids&get=all' ); | |
| wp_cache_add( 'all_category_ids', $cat_ids, 'category' ); | |
| } | |
| return $cat_ids; | |
| } | |
| ?>%%%</span> | |
| === Display Recent Entries Widget === | |
| The code that displays the Recent Entries widget provides a good example of how much code can be skipped by using caching. | |
| ''Note: The following code was taken from wp-includes/widgets.php version 2.7.'' | |
| <span style="background-color:#F5F5F5; border:1px solid #DADADA; margin:0px; padding:0px 11px 0px 11px; display:block;">%%%<?php | |
| function wp_widget_recent_entries($args) { | |
| if ( '%BEG_OF_TITLE%' != $args['before_title'] ) { | |
| if ( $output = wp_cache_get('widget_recent_entries', 'widget') ) | |
| return print($output); | |
| ob_start(); | |
| } | |
| extract($args); | |
| $options = get_option('widget_recent_entries'); | |
| $title = empty($options['title']) ? __('Recent Posts') : | |
| apply_filters('widget_title', $options['title']); | |
| if ( !$number = (int) $options['number'] ) | |
| $number = 10; | |
| else if ( $number < 1 ) | |
| $number = 1; | |
| else if ( $number > 15 ) | |
| $number = 15; | |
| $r = new WP_Query(array('showposts' => $number, 'what_to_show' => 'posts', | |
| 'nopaging' => 0, 'post_status' => 'publish', 'caller_get_posts' => 1)); | |
| if ($r->have_posts()) : | |
| ?> | |
| <?php echo $before_widget; ?> | |
| <?php if ( !empty( $title ) ) { echo $before_title . $title . $after_title; } ?> | |
| <ul> | |
| <?php while ($r->have_posts()) : $r->the_post(); ?> | |
| <li><a href="<?php the_permalink() ?>"> | |
| <?php if ( get_the_title() ) the_title(); else the_ID(); ?> | |
| </a></li> | |
| <?php endwhile; ?> | |
| </ul> | |
| <?php echo $after_widget; ?> | |
| <?php | |
| wp_reset_query(); // Restore global post data stomped by the_post(). | |
| endif; | |
| if ( '%BEG_OF_TITLE%' != $args['before_title'] ) | |
| wp_cache_add('widget_recent_entries', ob_get_flush(), 'widget'); | |
| } | |
| ?>%%%</span> | |
| == Notes == | |
| * This function uses [[Template Tags/How to Pass Tag Parameters#Tags with PHP function-style parameters|PHP function style parameters]]. | |
| * <tt>wp_cache_add()</tt> is a wrapper that calls <tt>$wp_object_cache->add(...)</tt>. See the <tt>WP_Object_Cache::add()</tt> function code for details on how this code operates. | |
| == See Also == | |
| * [[Function Reference/WP Cache|WP Cache Reference]] | |
| * [http://dougal.gunters.org/blog/2006/07/21/using-the-wordpress-object-cache Using the WordPress Object Cache] | |
| * [http://perishablepress.com/press/2007/12/26/how-to-enable-the-default-wordpress-object-cache/|How to Enable the Default WordPress Object Cache] | |
| [[Category:Functions]] | |
| == Limitations While Creating This Document == | |
| * A rule in the Codex's CSS prevents DIVs from being styled. I worked around this by using SPANs with a display of block. | |
| * The CSS rules don't have any padding for table elements. The only way to work around this (due to not being able to define CSS rules other than via individual style declarations) is by either using cellspacing and cellpadding (not desirable) or adding style information to every TH and TD element (also not desirable). | |
| * Lack of styling for DD and DT elements. I solved this by manually applying style information to each element. | |
| * The <tt>&lt;/dd&gt;</tt> and <tt>&lt;/dt&gt;</tt> elements are not supported, thus breaking standards. | |
| * The &#37;&#37;&#37; directive makes very nicely-colored PHP code output, but it has limitations. | |
| ** To get the output to be have syntax highlighting, it needs to be wrapped in <?php ?> tags. This adds unnecessary lines since the presence of these tags can be assumed in most instances. It would be nice if there could be an option to force highlighting without the use of the tags. | |
| ** The output contains large amounts of whitespace at the top and bottom. | |
| ** The output is not contained in a box like as the CSS styles the PRE. This type of container is helpful as it clearly sets the code apart from the rest of the documentation. I manually applied this look using the styled SPAN that I used for the function structure.</p> | |
| </d:entry> | |
| <d:entry id="get_comments_popup_template" d:title="get comments popup template"> | |
| <d:index d:value="get comments popup template"/> | |
| <h1>get comments popup template</h1> | |
| <p>== Description == | |
| Retrieve path of comment popup template in current or parent template. | |
| Checks for comment popup template file <tt>comments-popup.php</tt> in the current template, if it exists there, or in the parent template. If that fails, it may look for a deprecated default file in {{Trac|wp-includes/theme-compat}}. | |
| == Usage == | |
| %%%<?php get_comments_popup_template() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Returns the template path. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>'comments_popup_template'</tt> filter on path. | |
| * Uses: [[Function_Reference/locate_template|<tt>locate_template()</tt>]] to locate <tt>'comments-popup.php'</tt> file. | |
| == Change Log == | |
| Since: 1.5.0. After 3.0: Default file deprecated. | |
| == Source File == | |
| <tt>get_comments_popup_template()</tt> is located in {{Trac|wp-includes/template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="load_template" d:title="load template"> | |
| <d:index d:value="load template"/> | |
| <h1>load template</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/load_template}} | |
| {{it|Riferimento funzioni/load_template}} | |
| }} | |
| == Description == | |
| Require once the template file with WordPress environment. | |
| The globals are set up for the template file to ensure that the WordPress environment is available from within the function. The query variables are also available. | |
| == Usage == | |
| %%%<?php load_template( $_template_file, $require_once ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$_template_file|string|Path to template file.}} | |
| {{Parameter|$require_once |bool|Whether to require_once or require.|optional|true}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| ===Loading a template in a plugin, but allowing theme and child theme to override template=== | |
| <tt> | |
| if ( $overridden_template = locate_template( 'some-template.php' ) ) { | |
| // locate_template() returns path to file | |
| // if either the child theme or the parent theme have overridden the template | |
| load_template( $overridden_template ); | |
| } else { | |
| // If neither the child nor parent theme have overridden the template, | |
| // we load the template from the 'templates' sub-directory of the directory this file is in | |
| load_template( dirname( __FILE__ ) . '/templates/some-template.php' ); | |
| } | |
| </tt> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class_Reference/WP_Query|<tt>$wp_query</tt>]] to extract [http://us.php.net/manual/en/function.extract.php <tt>extract()</tt>] global variables returned by the <tt>query_vars</tt> method while protecting the current values in these global variables: | |
| ** (<tt>unknown type</tt>) <tt>$posts</tt> | |
| ** (<tt>unknown type</tt>) <tt>$post</tt> | |
| ** (<tt>boolean</tt>) <tt>$wp_did_header</tt> Returns <tt>true</tt> if the WordPress header was already loaded. See the <tt>/wp-blog-header.php</tt> file for details. | |
| ** (<tt>boolean</tt>) <tt>$wp_did_template_redirect</tt> | |
| ** (<tt>object</tt>) <tt>$wp_rewrite</tt> | |
| ** (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| ** (<tt>string</tt>) <tt>$wp_version</tt> holds the installed WordPress version number. | |
| ** (<tt>string</tt>) <tt>$wp</tt> | |
| ** (<tt>string</tt>) <tt>$id</tt> | |
| ** (<tt>string</tt>) <tt>$comment</tt> | |
| ** (<tt>string</tt>) <tt>$user_ID</tt> | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>load_template()</tt> is located in {{Trac|wp-includes/template.php}}. | |
| == Related == | |
| {{Template_Functions}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="locale_stylesheet" d:title="locale stylesheet"> | |
| <d:index d:value="locale stylesheet"/> | |
| <h1>locale stylesheet</h1> | |
| <p>== Description == | |
| Display localized stylesheet link element. | |
| If [[Function_Reference/get_locale_stylesheet_uri|<tt>get_locale_stylesheet_uri()</tt>]] returns a value, locale_stylesheet will echo a valid xhtml <tt>&lt;link&gt;</tt> tag like this:<br> | |
| <pre> | |
| <link rel="stylesheet" href="path_to_stylesheet" type="text/css" media="screen" /> | |
| </pre> | |
| If [[Function_Reference/get_locale_stylesheet_uri|<tt>get_locale_stylesheet_uri()</tt>]] does not return a value then the function exits immediately. | |
| == Usage == | |
| %%%<?php locale_stylesheet() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| Uses [[Function_Reference/get_locale_stylesheet_uri|<tt>get_locale_stylesheet_uri()</tt>]]. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>locale_stylesheet()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="preview_theme" d:title="preview theme"> | |
| <d:index d:value="preview theme"/> | |
| <h1>preview theme</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/preview_theme}} | |
| {{it|Riferimento funzioni/preview_theme}} | |
| }} | |
| == Description == | |
| Start preview theme output buffer. | |
| Will only perform task if the user has permissions and '<tt>template</tt>' and '<tt>preview</tt>' query variables exist. Will add '<tt>stylesheet</tt>' filter if '<tt>stylesheet</tt>' query variable exists. | |
| == Usage == | |
| %%%<?php preview_theme() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.5.0 | |
| == Source File == | |
| <tt>preview_theme()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="preview_theme_ob_filter" d:title="preview theme ob filter"> | |
| <d:index d:value="preview theme ob filter"/> | |
| <h1>preview theme ob filter</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/preview_theme_ob_filter}} | |
| {{it|Riferimento funzioni/preview_theme_ob_filter}} | |
| }} | |
| {{Private}} | |
| == Description == | |
| Callback function for [http://us2.php.net/manual/en/function.ob-start.php <tt>ob_start()</tt>] to capture all links in the theme. | |
| == Usage == | |
| %%%<?php preview_theme_ob_filter( $content ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$content|string|}} | |
| == Return Values == | |
| ; (string) : | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Change Log == | |
| Since: unknown | |
| == Source File == | |
| <tt>preview_theme_ob_filter()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="preview_theme_ob_filter_callback" d:title="preview theme ob filter callback"> | |
| <d:index d:value="preview theme ob filter callback"/> | |
| <h1>preview theme ob filter callback</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/preview_theme_ob_filter_callback}} | |
| {{it|Riferimento funzioni/preview_theme_ob_filter_callback}} | |
| }} | |
| {{Private}} | |
| == Description == | |
| Manipulates preview theme links in order to control and maintain location. | |
| Callback function for [http://us2.php.net/manual/en/function.preg-replace-callback.php <tt>preg_replace_callback()</tt>] to accept and filter matches. | |
| == Usage == | |
| %%%<?php preview_theme_ob_filter_callback( $matches ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$matches|array|}} | |
| == Return Values == | |
| ; (string) : | |
| == Change Log == | |
| Since: unknown | |
| == Source File == | |
| <tt>preview_theme_ob_filter_callback()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="validate_current_theme" d:title="validate current theme"> | |
| <d:index d:value="validate current theme"/> | |
| <h1>validate current theme</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/validate_current_theme}} | |
| {{it|Riferimento funzioni/validate_current_theme}} | |
| }} | |
| == Description == | |
| Checks that current theme files '<tt>index.php</tt>' and '<tt>style.css</tt>' exists. | |
| Does not check the '<tt>default</tt>' theme. The '<tt>default</tt>' theme should always exist or should have another theme renamed to that template name and directory path. Will switch theme to default if current theme does not validate. You can use the '<tt>validate_current_theme</tt>' filter to return <tt>false</tt> to disable this functionality. | |
| == Usage == | |
| %%%<?php validate_current_theme() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (boolean) : | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>validate_current_theme()</tt> is located in <tt>wp-includes/theme.php</tt>. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="switch_theme" d:title="switch theme"> | |
| <d:index d:value="switch theme"/> | |
| <h1>switch theme</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/switch_theme}} | |
| {{it|Riferimento funzioni/switch_theme}} | |
| }} | |
| == Description == | |
| Switches current theme to new template and stylesheet names. | |
| <br />Accepts one argument: $stylesheet of the theme. ($stylesheet is the name of your folder slug. It's the same value that you'd use for a child theme, something like `twentythirteen`.) It also accepts an additional function signature of two arguments: $template then $stylesheet. This is for backwards compatibility. | |
| == Usage == | |
| %%%<?php switch_theme( $stylesheet ) ?>%%% | |
| Optional usage for backwards compatibility: | |
| %%%<?php switch_theme( $template, $stylesheet ) ?>%%% | |
| == Parameters == | |
| ===Current Parameters=== | |
| {{Parameter|$stylesheet|string|Stylesheet name.}} | |
| ===Alternate Function Signature Parameters for Backwards Compatibility === | |
| {{Parameter|$template|string|Template name.}} | |
| {{Parameter|$stylesheet|string|Stylesheet name.}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] Calls '<tt>switch_theme</tt>' action on updated theme display name. | |
| == Change Log == | |
| Since: 2.5.0 | |
| <br />Altered 4/23 to define default/alternate function signature and parameters | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>switch_theme()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_theme_mod" d:title="get theme mod"> | |
| <d:index d:value="get theme mod"/> | |
| <h1>get theme mod</h1> | |
| <p>== Description == | |
| Retrieves a modification setting for the current theme. Along with [[set_theme_mod|set_theme_mod()]] this function can sometimes offer theme developers a simpler alternative to the [[Settings API]] when there is a need to handle basic theme-specific settings. | |
| If the modification name does not exist, then the <tt>$default</tt> will be passed through [http://us2.php.net/manual/en/function.sprintf.php <tt>sprintf()</tt>] with the first string the template directory URI and the second string the stylesheet directory URI. | |
| == Usage == | |
| %%%<?php get_theme_mod( $name, $default ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$name|string|Theme modification name.}} | |
| {{Parameter|$default|boolean&#124;string||optional|false}} | |
| == Return Values == | |
| ; (string) : | |
| == Examples == | |
| ===Calling the Custom Background Color=== | |
| This example could be used to add the custom background color as a border on the top of the footer. It would be css inserted in the header: | |
| <pre> | |
| .footer { | |
| border-top: solid 1px #<?php echo get_theme_mod( 'background_color' ); ?>; | |
| } | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>[[Plugin_API/Filter_Reference/theme_mod_$name|'theme_mod_$name']]</tt> filter on the value. | |
| == Change Log == | |
| Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>get_theme_mod()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| [[Function Reference/background_color|background_color()]], | |
| {{Theme Mod Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]] | |
| [[Category:Theme Modification API]]</p> | |
| </d:entry> | |
| <d:entry id="set_theme_mod" d:title="set theme mod"> | |
| <d:index d:value="set theme mod"/> | |
| <h1>set theme mod</h1> | |
| <p>== Description == | |
| Creates or updates a modification setting for the current theme. Along with [[get_theme_mod|get_theme_mod()]] this function sometimes offers theme developers a simpler alternative to the [[Settings API]] when there is a need to handle basic theme-specific settings. | |
| == Usage == | |
| %%%<?php set_theme_mod( $name, $value ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$name|string|Theme modification name.}} | |
| {{Parameter|$value|string|Theme modification value.}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>[[Plugin_API/Filter_Reference/theme_mod_$name|'pre_set_theme_mod_$name']]</tt> filter on the value. | |
| == Change Log == | |
| Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>set_theme_mod()</tt> is located in {{Trac|wp-includes/theme.php}} | |
| == Related == | |
| {{Theme Mod Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]] | |
| [[Category:Theme Modification API]]</p> | |
| </d:entry> | |
| <d:entry id="get_header_textcolor" d:title="get header textcolor"> | |
| <d:index d:value="get header textcolor"/> | |
| <h1>get header textcolor</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_header_textcolor}} | |
| {{it|Riferimento funzioni/get_header_textcolor}} | |
| }} | |
| == Description == | |
| Retrieves the color value of the text inside the header. | |
| == Usage == | |
| %%%<?php get_header_textcolor() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : | |
| Gets and stores the color value of the text inside the header. | |
| == Examples == | |
| The example below gets the color of the text inside the header, stores it in a variable and then prints it within the echo statement. | |
| <pre> | |
| <?php | |
| $header_text_color = get_header_textcolor(); | |
| echo "The color of the text inside the header is #". $header_text_color . "."; | |
| ?> | |
| </pre> | |
| == Notes == | |
| * Uses: <tt>HEADER_TEXTCOLOR</tt> | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>get_header_textcolor()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| %%%<?php header_textcolor(); ?>%%% | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_header_image" d:title="get header image"> | |
| <d:index d:value="get header image"/> | |
| <h1>get header image</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_header_image}} | |
| {{it|Riferimento funzioni/get_header_image}} | |
| }} | |
| == Description == | |
| Retrieve header image for custom header. | |
| == Usage == | |
| %%%<?php get_header_image() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Returns header image URL. | |
| An empty string will be returned if: | |
| * The current theme does NOT support header images. (Learn how to enable it in [[Custom Headers]] page). | |
| * The current theme DOES support header images. However, the user has selected the "Remove Header Image" option from the Appearance -> Header screen. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: <tt>HEADER_IMAGE</tt> | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>get_header_image()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| *Function: [[header_image]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="header_image" d:title="header image"> | |
| <d:index d:value="header image"/> | |
| <h1>header image</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/header_image}} | |
| {{it|Riferimento funzioni/header_image}} | |
| }} | |
| == Description == | |
| Display header image path. | |
| == Usage == | |
| %%%<?php header_image() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : This function return an absolute url of header image without escaping the entities. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>header_image()</tt> is located in <tt>[http://core.trac.wordpress.org/browser/trunk/wp-includes/theme.php wp-includes/theme.php]</tt>. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| *Function: [[get_header_image]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="add_custom_image_header" d:title="add custom image header"> | |
| <d:index d:value="add custom image header"/> | |
| <h1>add custom image header</h1> | |
| <p>{{Deprecated|new_function()=add_theme_support}} | |
| == Description == | |
| Add callbacks for image header display. | |
| The parameter <tt>$header_callback</tt> callback will be required to display the content for the '<tt>wp_head</tt>' action. The parameter <tt>$admin_header_callback</tt> callback will be added to <tt>Custom_Image_Header</tt> class and that will be added to the '<tt>admin_menu</tt>' action. | |
| == Replace With == | |
| [[Function Reference/add theme support|add_theme_support( 'custom-header' )]] | |
| == Usage == | |
| %%%<?php add_custom_image_header( $header_callback, $admin_header_callback, $admin_image_div_callback ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$header_callback|callback|Call on '<tt>wp_head</tt>' action.}} | |
| {{Parameter|$admin_header_callback|callback|Call on custom header administration screen.}} | |
| {{Parameter|$admin_image_div_callback|callback|Output a custom header image div on the custom header administration screen. Optional.}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| Edit the file <tt>functions.php</tt> inside your theme and add the following code. | |
| Four constants must be defined in order for the custom image header to work: | |
| <pre>define('HEADER_TEXTCOLOR', 'ffffff'); | |
| define('HEADER_IMAGE', '%s/images/default_header.jpg'); // %s is the template dir uri | |
| define('HEADER_IMAGE_WIDTH', 775); // use width and height appropriate for your theme | |
| define('HEADER_IMAGE_HEIGHT', 200);</pre> | |
| If you don't want to allow changing the header text color, add: | |
| <pre>define('NO_HEADER_TEXT', true );</pre> | |
| Then change the first definition to: | |
| <pre>define('HEADER_TEXTCOLOR', '');</pre> | |
| If you intend to create child themes use: | |
| <pre>define('HEADER_IMAGE', trailingslashit( get_stylesheet_directory_uri() ).'images/banner.jpg');</pre> | |
| Otherwise, you'll pick up the header image for the parent theme rather than the child. | |
| Next you need to write two functions. One will be included in the site header. The second will be included in the admin header. Both of these functions are required. The smallest possible amount of code would be something like this, although you can do anything you need. | |
| <pre>// gets included in the site header | |
| function header_style() { | |
| ?><style type="text/css"> | |
| #header { | |
| background: url(<?php header_image(); ?>); | |
| } | |
| </style><?php | |
| }</pre> | |
| <pre>// gets included in the admin header | |
| function admin_header_style() { | |
| ?><style type="text/css"> | |
| #headimg { | |
| width: <?php echo HEADER_IMAGE_WIDTH; ?>px; | |
| height: <?php echo HEADER_IMAGE_HEIGHT; ?>px; | |
| background: no-repeat; | |
| } | |
| </style><?php | |
| }</pre> | |
| Finish with calling the add_custom_image_header function with the two earlier function names as parameters: | |
| <pre>add_custom_image_header('header_style', 'admin_header_style');</pre> | |
| Taking this last step will make the Custom Header item appear in the Appearance menu. WordPress takes care of everything else. | |
| == Notes == | |
| * Uses: <tt>Custom_Image_Header</tt>. Sets up for <tt>$admin_header_callback</tt> for [[Administration_Panels|administration panel]] display. | |
| == Change Log == | |
| * Deprecated: [[Version 3.4|3.4.0]] | |
| * Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>add_custom_image_header()</tt> is located in {{Trac|wp-includes/theme.php}}. | |
| == Related == | |
| {{Custom Headers}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_gmt_from_date" d:title="get gmt from date"> | |
| <d:index d:value="get gmt from date"/> | |
| <h1>get gmt from date</h1> | |
| <p>== Description == | |
| Returns a date in the GMT equivalent. | |
| Requires and returns a date in the <tt>Y-m-d H:i:s</tt> format. Simply subtracts the value of the '<tt>gmt_offset</tt>' option. | |
| == Usage == | |
| %%%<?php get_gmt_from_date( $string ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|The date to be converted.}} | |
| == Return Values == | |
| ; (string) : GMT version of the date provided. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] to retrieve the value of the 'gmt_offset' option. | |
| == Change Log == | |
| Since: 1.2.0 | |
| == Source File == | |
| <tt>get_gmt_from_date()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_date_from_gmt" d:title="get date from gmt"> | |
| <d:index d:value="get date from gmt"/> | |
| <h1>get date from gmt</h1> | |
| <p>== Description == | |
| Converts a GMT date into the correct format for the blog. | |
| Requires and returns in the <tt>Y-m-d H:i:s</tt> format. Simply adds the value of the '<tt>gmt_offset</tt>' option. | |
| == Usage == | |
| %%%<?php get_date_from_gmt( $string, $format ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|The date to be converted.}} | |
| {{Parameter|$format|string|The format string for the returned date|false|Y-m-d H:i:s}} | |
| == Return Values == | |
| ; (string) : Formatted date relative to the GMT offset. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] to retrieve the value of <tt>'gmt_offset</tt>'. | |
| == Change Log == | |
| Since: 1.2.0 | |
| ==Source File== | |
| <tt>get_date_from_gmt()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="iso8601_timezone_to_offset" d:title="iso8601 timezone to offset"> | |
| <d:index d:value="iso8601 timezone to offset"/> | |
| <h1>iso8601 timezone to offset</h1> | |
| <p>== Description == | |
| Computes an offset in seconds from an ISO 8601 timezone. | |
| == Usage == | |
| %%%<?php iso8601_timezone_to_offset( $timezone ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$timezone|string|Either 'Z' for 0 offset or '±hhmm'.}} | |
| == Return Values == | |
| ; (integer&#124;float) : The offset in seconds. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * See Also: [http://en.wikipedia.org/wiki/ISO_8601 ISO 8601] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>iso8601_timezone_to_offset()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="iso8601_to_datetime" d:title="iso8601 to datetime"> | |
| <d:index d:value="iso8601 to datetime"/> | |
| <h1>iso8601 to datetime</h1> | |
| <p>== Description == | |
| Converts an iso8601 date to [http://dev.mysql.com/doc/refman/4.1/en/datetime.html MySQL DATETIME] format used by <tt>post_date[_gmt]</tt>. | |
| == Usage == | |
| %%%<?php iso8601_to_datetime( $date_string, $timezone ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$date_string|string|Date and time in ISO 8601 format.}} | |
| {{Parameter|$timezone|string|If set to GMT returns the time minus gmt_offset. Default is '<tt>user</tt>'.|optional|'user'}} | |
| == Return Values == | |
| ; (string) : The date and time in [http://dev.mysql.com/doc/refman/4.1/en/datetime.html MySQL DATETIME] format - <tt>Y-m-d H:i:s</tt>. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * See Also: [http://en.wikipedia.org/wiki/ISO_8601 ISO 8601] | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>iso8601_to_datetime()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="human_time_diff" d:title="human time diff"> | |
| <d:index d:value="human time diff"/> | |
| <h1>human time diff</h1> | |
| <p>== Description == | |
| Determines the difference between two timestamps. | |
| The difference is returned in a human readable format such as "1 hour", "5 mins", "2 days". | |
| == Usage == | |
| %%%<?php human_time_diff( $from, $to ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$from|integer|Unix timestamp from which the difference begins.}} | |
| {{Parameter|$to|integer|Unix timestamp to end the time difference. Default becomes [http://us2.php.net/manual/en/function.time.php <tt>time()</tt>] if not set.|optional|&#39;&#39;}} | |
| == Return Values == | |
| ; (string) : Human readable time difference. | |
| == Examples == | |
| To print an entry's time ("2 days ago"): | |
| %%%<?php echo human_time_diff( get_the_time('U'), current_time('timestamp') ) . ' ago'; ?>%%% | |
| For comments: | |
| %%%<?php echo human_time_diff( get_comment_time('U'), current_time('timestamp') ) . ' ago'; ?>%%% | |
| == Notes == | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <code>human_time_diff()</code> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| {{Time Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="date_i18n" d:title="date i18n"> | |
| <d:index d:value="date i18n"/> | |
| <h1>date i18n</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/date_i18n}} | |
| {{ja|関数リファレンス/date_i18n}} | |
| }} | |
| == Description == | |
| Retrieve the date in localized format, based on timestamp. | |
| If the locale specifies the locale month and weekday, then the locale will take over the format for the date. If it isn't, then the date format string will be used instead. | |
| [[Wikipedia:i18n|<tt>i18n</tt>]] is an abbreviation for Internationalization. (There are 18 letters between the first "i" and last "n".) | |
| == Usage == | |
| %%%<?php echo date_i18n( $dateformatstring, $unixtimestamp, $gmt ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$dateformatstring|string|Format to display the date.}} | |
| {{Parameter|$unixtimestamp|integer|Unix timestamp.|optional|false}} | |
| {{Parameter|$gmt|boolean|Whether to convert to GMT for time.|optional|false}} | |
| == Return Values == | |
| ; (string) : The date, translated if locale specifies it. | |
| == Examples == | |
| Depending on your blog settings you will see the date displayed in your local format, for example: 15. november 1976. | |
| <?php echo date_i18n( get_option( 'date_format' ), strtotime( '11/15-1976' ) ); ?> | |
| == Notes == | |
| * See Also: [[Formatting Date and Time]] | |
| * Uses global: (<tt>object</tt>) <tt>$wp_locale</tt> handles the date and time locales. | |
| == Change Log == | |
| * Since: 0.71 | |
| == Source File == | |
| <tt>date_i18n()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| * <tt>[[Function_Reference/number_format_i18n | number_format_i18n()]]</tt> | |
| {{L10n}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_weekstartend" d:title="get weekstartend"> | |
| <d:index d:value="get weekstartend"/> | |
| <h1>get weekstartend</h1> | |
| <p>== Description == | |
| Get the week start and end from the [http://dev.mysql.com/doc/refman/4.1/en/datetime.html MySQL DATETIME] or date string. | |
| == Usage == | |
| %%%<?php get_weekstartend( $mysqlstring, $start_of_week ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$mysqlstring|string|Date or [http://dev.mysql.com/doc/refman/4.1/en/datetime.html MySQL DATETIME] field type.}} | |
| {{Parameter|$start_of_week|integer|Start of the week as an integer.|optional|&#39;&#39;}} | |
| == Return Values == | |
| ; (array) : Keys are '<tt>start</tt>' and '<tt>end</tt>'. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_option|<tt>get_option()</tt>]] to retrieve the '<tt>start_of_week</tt>' option if <tt>$start_of_week</tt> is not numeric. | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>get_weekstartend()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_lastpostdate" d:title="get lastpostdate"> | |
| <d:index d:value="get lastpostdate"/> | |
| <h1>get lastpostdate</h1> | |
| <p>== Description == | |
| Retrieve the date the the last post was published. | |
| The server timezone is the default and is the difference between [[Glossary#GMT|GMT]] and server time. The '<tt>blog</tt>' value is the date when the last post was posted. The '<tt>gmt</tt>' is when the last post was posted in [[Glossary#GMT|GMT]] formatted date. | |
| == Usage == | |
| %%%<?php get_lastpostdate( $timezone ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$timezone|string|The location to get the time. Can be '<tt>gmt</tt>', '<tt>blog</tt>', or '<tt>server</tt>'.|optional|'server'}} | |
| == Return Values == | |
| ; (string) : The date of the last post. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>get_lastpostdate</tt>' filter | |
| * Uses global: (<tt>mixed</tt>) <tt>$cache_lastpostdate</tt> Stores the date the last post. | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses global: (<tt>integer</tt>) <tt>$blog_id</tt> The Blog ID. | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_lastpostdate()</tt> is located in <tt>wp-includes/post.php</tt>. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_lastpostmodified" d:title="get lastpostmodified"> | |
| <d:index d:value="get lastpostmodified"/> | |
| <h1>get lastpostmodified</h1> | |
| <p>== Description == | |
| Retrieve last post modified date depending on timezone. | |
| The server timezone is the default and is the difference between [[Glossary#GMT|GMT]] and server time. The '<tt>blog</tt>' value is just when the last post was modified. The '<tt>gmt</tt>' is when the last post was modified in [[Glossary#GMT|GMT]] time. | |
| == Usage == | |
| %%%<?php get_lastpostmodified( $timezone ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$timezone|string|The location to get the time. Can be '<tt>gmt</tt>', '<tt>blog</tt>', or '<tt>server</tt>'.|optional|'server'}} | |
| == Return Values == | |
| ; (string) : The date the post was last modified. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>get_lastpostmodified</tt>' filter | |
| * Uses global: (<tt>mixed</tt>) <tt>$cache_lastpostmodified</tt> Stores the date the last post was last modified. | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses global: (<tt>integer</tt>) <tt>$blog_id</tt> The Blog ID. | |
| == Change Log == | |
| Since: 1.2.0 | |
| == Source File == | |
| <tt>get_lastpostmodified()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="is_new_day" d:title="is new day"> | |
| <d:index d:value="is new day"/> | |
| <h1>is new day</h1> | |
| <p>==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if today is a new day. This is a boolean function, meaning it returns TRUE when new day or FALSE if not a new day. | |
| ==Usage== | |
| %%%<?php is_new_day(); ?>%%% | |
| ==Parameters== | |
| This tag does not accept any parameters. | |
| ==Return Values== | |
| ; (boolean) : TRUE (1) when new day, FALSE (0) if not a new day. | |
| ==Examples== | |
| ==Notes== | |
| * Uses global: (<tt>string</tt>) <tt>$day</tt> Holds the date of the day of the current post during [[The_Loop]]. | |
| * Uses global: (<tt>string</tt>) <tt>$previousday</tt> Holds the date of the day of the previous post (if any) during [[The_Loop]]. | |
| ==Change Log== | |
| Since: 0.71 | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_new_day()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_comments_popup" d:title="is comments popup"> | |
| <d:index d:value="is comments popup"/> | |
| <h1>is comments popup</h1> | |
| <p>==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks when in Comments Popup window. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| ==Usage== | |
| %%%<?php is_comments_popup(); ?>%%% | |
| ==Parameters== | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| ==Notes== | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_comments_popup()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_plugin_page" d:title="is plugin page"> | |
| <d:index d:value="is plugin page"/> | |
| <h1>is plugin page</h1> | |
| <p><big>'''Notice: ''is_plugin_page'' is deprecated since version 3.1 with no alternative available.'''</big> | |
| ==Description== | |
| Returns true when the current request is for a plugin page in the administration panel. For example, if the request is for "http://www.example.com/wp-admin/edit.php?page=some_plugin.php", this will return true. | |
| As of version 2.6, this appears to key off of the "page" URL parameter and is based on the variable $plugin_page, set in wp-admin/admin.php. | |
| ==Usage== | |
| %%%<?php is_plugin_page(); ?>%%% | |
| ==Parameters== | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| ==Notes== | |
| ==Change Log== | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_plugin_page()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| As of version 2.6, this is defined in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_category_by_path" d:title="get category by path"> | |
| <d:index d:value="get category by path"/> | |
| <h1>get category by path</h1> | |
| <p>== Description == | |
| Retrieve category based on URL containing the category slug. | |
| Breaks the <tt>$category_path</tt> parameter up to get the category slug. | |
| Tries to find the child path and will return it. If it doesn't find a match, then it will return the first category matching slug, if <tt>$full_match</tt>, is set to false. If it does not, then it will return null. | |
| It is also possible that it will return a <tt>WP_Error</tt> object on failure. Check for it when using this function. | |
| == Usage == | |
| %%%<?php get_category_by_path( $category_path, $full_match, $output ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$category_path|string|URL containing category slugs.}} | |
| {{Parameter|$full_match|boolean|Whether should match full path or not.|optional|true}} | |
| {{Parameter|$output|string|Constant OBJECT, ARRAY_A, or ARRAY_N|optional|OBJECT}} | |
| == Return Values == | |
| ; (null&#124;object&#124;array) : Null on failure. Type is based on <tt>$output</tt> value. | |
| == Examples == | |
| === Default usage === | |
| <pre> | |
| <?php | |
| $categ = get_category_by_path('uncategorized'); | |
| echo "Category ".$categ->name; | |
| ?> | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_category_by_path()</tt> is located in <tt>{{Trac|wp-includes/category.php}}</tt>. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_tags" d:title="get tags"> | |
| <d:index d:value="get tags"/> | |
| <h1>get tags</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get tags}} | |
| {{ja|関数リファレンス/get tags}} | |
| }} | |
| == Description == | |
| Retrieve an array of objects for each term in post_tag taxonomy. | |
| == Usage == | |
| %%% <?php $tags_array = get_tags( $args ); ?> %%% | |
| == Parameters == | |
| Retrieves a list of post tags based on the criteria provided in $args. The list of arguments that $args can contain, which will overwrite the defaults: | |
| ;orderby :Default is 'name'. Can be name, count, or nothing (will use term_id). | |
| ;order :Default is ASC. Can use DESC. | |
| ;hide_empty :Default is true. Will not return empty terms, which means terms whose count is 0 according to the given taxonomy. | |
| ;exclude :Default is an empty string. A comma- or space-delimited string of term ids to exclude from the return array. If 'include' is non-empty, 'exclude' is ignored. | |
| ;include :Default is an empty string. A comma- or space-delimited string of term ids to include in the return array. | |
| ;number :The maximum number of terms to return. Default is empty. | |
| ;offset :The number by which to offset the terms query. | |
| ;fields :Default is 'all', which returns an array of term objects. If 'fields' is 'ids' or 'names', returns an array of integers or strings, respectively. | |
| ;slug :Returns terms whose "slug" matches this value. Default is empty string. | |
| ;hierarchical :Whether to include terms that have non-empty descendants (even if 'hide_empty' is set to true). | |
| ;search :Returned terms' names will contain the value of 'search', case-insensitive. Default is an empty string. | |
| ;name__like :Returned terms' names will contain the value of 'name__like', case-sensitive. Default is empty string. | |
| ;description__like :Returned terms' descriptions will contain the value of 'description__like', case-insensitive. Default is empty string. | |
| ;pad_counts :If set to true will include the quantity of a term's children in the quantity of each term's "count" object variable. | |
| ;get :If set to 'all' instead of its default empty string, returns terms regardless of ancestry or whether the terms are empty. | |
| ;child_of :When used, should be set to the integer of a term ID. Its default is 0. If set to a non-zero value, all returned terms will be descendants of that term according to the given taxonomy. Hence 'child_of' is set to 0 if more than one taxonomy is passed in $taxonomies, because multiple taxonomies make term ancestry ambiguous. | |
| ;parent :When used, should be set to the integer of a term ID. Its default is the empty string, which has a different meaning from the integer 0. If set to an integer value, all returned terms will have as an immediate ancestor the term whose ID is specified by that integer according to the given taxonomy. The 'parent' argument is different from 'child_of' in that a term X is considered a 'parent' of term Y only if term X is the father of term Y, not its grandfather or great-grandfather, etc. | |
| == Returns == | |
| Returns either an array of objects or an empty array. Each returned object has the following properties: | |
| ;term_id : (''string'') | |
| ;name : (''string'') | |
| ;slug : (''string'') | |
| ;term_group : (''string'') | |
| ;term_taxonomy_id : (''string'') | |
| ;taxonomy : (''string'') | |
| ;description : (''string'') | |
| ;parent : (''string'') | |
| ;count : (''string'') | |
| == Example == | |
| Displays a list of tags with links to each one and a specific class for each tag: | |
| <pre> | |
| $tags = get_tags(); | |
| $html = '<div class="post_tags">'; | |
| foreach ( $tags as $tag ) { | |
| $tag_link = get_tag_link( $tag->term_id ); | |
| $html .= "<a href='{$tag_link}' title='{$tag->name} Tag' class='{$tag->slug}'>"; | |
| $html .= "{$tag->name}</a>"; | |
| } | |
| $html .= '</div>'; | |
| echo $html; | |
| </pre> | |
| == Source File == | |
| <tt>get_tags()</tt> is located in {{Trac|wp-includes/category.php}}. | |
| == Related == | |
| {{Tag Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| {{copyedit}}</p> | |
| </d:entry> | |
| <d:entry id="get_cat_name" d:title="get cat name"> | |
| <d:index d:value="get cat name"/> | |
| <h1>get cat name</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_cat_name}} | |
| {{it|Riferimento funzioni/get_cat_name}} | |
| }} | |
| == Description == | |
| Retrieve the name of a category from its ID. | |
| == Usage == | |
| %%%<?php get_cat_name( $cat_id ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$cat_id|integer|Category ID}} | |
| == Return Values == | |
| ; (string) : Category name | |
| == Examples == | |
| <pre><?php echo get_cat_name(4);?></pre> | |
| returns the name for the category with the id '4'. | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>get_cat_name()</tt> is located in {{Trac|wp-includes/category.php}}. | |
| == Related == | |
| {{Category Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_tag" d:title="get tag"> | |
| <d:index d:value="get tag"/> | |
| <h1>get tag</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get tag}} | |
| {{it|Riferimento funzioni/get tag}} | |
| {{ja|関数リファレンス/get tag}} | |
| }} | |
| == Description == | |
| Retrieve post tag by tag ID or tag object. | |
| If you pass the <tt>$tag</tt> parameter an object, which is assumed to be the tag row object retrieved the database. It will cache the tag data. | |
| If you pass <tt>$tag</tt> an integer of the tag ID, then that tag will be retrieved from the database, if it isn't already cached, and pass it back. | |
| If you look at [[Function_Reference/get_term|<tt>get_term()</tt>]], then both types will be passed through several filters and finally sanitized based on the <tt>$filter</tt> parameter value. | |
| == Usage == | |
| %%%<?php &get_tag( $tag, $output, $filter ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$tag|integer&#124;object|}} | |
| {{Parameter|$output|string|Constant OBJECT, ARRAY_A, or ARRAY_N|optional|OBJECT}} | |
| {{Parameter|$filter|string|Default is raw or no WordPress defined filter will applied.|optional|'raw'}} | |
| == Return Values == | |
| ; (object&#124;array) : Return type based on <tt>$output</tt> value. | |
| == Examples == | |
| == Notes == | |
| * Uses: [[Function_Reference/get_term|get_term()]] Used to get the tag data from the taxonomy. | |
| == Change Log == | |
| Since: [[Version 2.3|2.3.0]] | |
| == Source File == | |
| <tt>&get_tag()</tt> is located in {{Trac|wp-includes/category.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_taxonomy_hierarchical" d:title="is taxonomy hierarchical"> | |
| <d:index d:value="is taxonomy hierarchical"/> | |
| <h1>is taxonomy hierarchical</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/is_taxonomy_hierarchical}} | |
| {{it|Riferimento_funzioni/is_taxonomy_hierarchical}} | |
| {{ja|関数リファレンス/is_taxonomy_hierarchical}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if the taxonomy object is hierarchical. This is a boolean function uses a global, meaning it returns either TRUE or FALSE (A false return value might also mean that the taxonomy does not exist). | |
| checks to make sure that the taxonomy is an object first. Then gets the object, and finally returns the hierarchical value in the object. | |
| ==Usage== | |
| %%%<?php is_taxonomy_hierarchical( $taxonomy ) ?>%%% | |
| ==Parameters== | |
| {{Parameter|$taxonomy|string|Name of taxonomy object}} | |
| ==Return Values== | |
| ; (boolean) : Whether the taxonomy is hierarchical | |
| ==Examples== | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| ==Notes== | |
| * See Also: [[WordPress_Taxonomy|WordPress Taxonomy]]. | |
| * Uses: [[Function_Reference/taxonomy_exists|<tt>taxonomy_exists()</tt>]] Checks whether taxonomy exists. | |
| * Uses: [[Function_Reference/get_taxonomy|<tt>get_taxonomy()</tt>]] Used to get the taxonomy object. | |
| ==Change Log== | |
| Since: 2.3.0 | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_taxonomy_hierarchical()</tt> is located in {{Trac|wp-includes/taxonomy.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_term_by" d:title="get term by"> | |
| <d:index d:value="get term by"/> | |
| <h1>get term by</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get term by}} | |
| {{ja|関数リファレンス/get term by}} | |
| }} | |
| == Description == | |
| Get all <tt>Term</tt> data from database by <tt>Term</tt> field and data. | |
| Warning: <tt>$value</tt> is not HTML-escaped for the '<tt>name</tt>' <tt>$field</tt>. You must do it yourself, if required. | |
| The default <tt>$field</tt> is '<tt>id</tt>', therefore it is possible to also use null for field, but not recommended that you do so. | |
| If <tt>$value</tt> does not exist, the return value will be false. If <tt>$taxonomy</tt> exists and <tt>$field</tt> and <tt>$value</tt> combinations exist, the Term will be returned. | |
| == Usage == | |
| %%%<?php get_term_by( $field, $value, $taxonomy, $output, $filter ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$field|string|Either '<tt>id</tt>', '<tt>slug</tt>', '<tt>name</tt>', or '<tt>term_taxonomy_id</tt>'|required|'id'}} | |
| {{Parameter|$value|string&#124;integer|Search for this term value}} | |
| {{Parameter|$taxonomy|string|Taxonomy Name <tt>category</tt>, <tt>post_tag</tt>, <tt>link_category</tt> or something custom}} | |
| {{Parameter|$output|string|Constant OBJECT, ARRAY_A, or ARRAY_N|optional|OBJECT}} | |
| {{Parameter|$filter|string|default is raw or no WordPress defined filter will applied.|optional|'raw'}} | |
| == Return Values == | |
| ; (mixed) : Term Row (object or array) from database. Will return false if <tt>$taxonomy</tt> does not exist or <tt>$term</tt> was not found. Othewise returns object (by default) or array of fields depending on <tt>$output</tt> parameter. | |
| The fields returned are: | |
| * <tt>term_id (See warning below)</tt> | |
| * <tt>name</tt> | |
| * <tt>slug</tt> | |
| * <tt>term_group</tt> | |
| * <tt>term_taxonomy_id</tt> | |
| * <tt>taxonomy</tt> | |
| * <tt>description</tt> | |
| * <tt>parent</tt> | |
| * <tt>count</tt> | |
| '''Warning: string vs integer confusion!''' Field values, including <tt>term_id</tt> are returned in string format. Before further use, typecast numeric values to actual integers, otherwise WordPress will mix up term_ids and slugs which happen to have only numeric characters! | |
| == Examples == | |
| Taxonomy_name is the name of taxonomy, not the term_name and is required; the id (term_id) is the ID of the term, not post_id;... | |
| Remember:<br /> | |
| &darr; Taxonomy type (e.g. post_tag)<br /> | |
| Terms in this taxonomy:<br /> | |
| &rarr; news<br /> | |
| &rarr; webdev<br /> | |
| &rarr; ... | |
| Examples to get terms by name and taxonomy ''type'' (taxonomy_name as category, post_tag or custom taxonomy). | |
| <pre> | |
| // Get term by name ''news'' in Categories taxonomy. | |
| get_term_by('name', 'news', 'category') | |
| // Get term by name ''news'' in Tags taxonomy. | |
| get_term_by('name', 'news', 'post_tag') | |
| // Get term by name ''news'' in Custom taxonomy. | |
| get_term_by('name', 'news', 'my_custom_taxonomy') | |
| </pre> | |
| By id (term_id, not post_id): | |
| <pre> | |
| // Get term by id (''term_id'') in Categories taxonomy. | |
| get_term_by('id', 12, 'category') | |
| ... | |
| </pre> | |
| === Wrong example in this page history === | |
| Warning: the example below '''is wrong''' (see in this page history): | |
| <pre>get_term_by('id', (int)$post->ID, 'taxonomy_name'); // return null</pre> | |
| This example try to get a term with ID (term_id) as post_id and in the taxonomy ''taxonomy_name''. This taxonomy not exists and the term_id is wrong. | |
| This is the correct version of this example: | |
| <pre> | |
| // get_term_by('id', category_id, 'category') | |
| $postCategories = get_the_category($post->ID); | |
| foreach ( $postCategories as $postCategory ) { | |
| $myCategories[] = get_term_by('id', $postCategory->cat_ID, 'category'); | |
| } | |
| // OR: | |
| $myCategory = get_term_by('id', $postCategories[0]->cat_ID, 'category'); | |
| </pre> | |
| == Notes == | |
| * Warning: <tt>$value</tt> is not escaped for '<tt>name</tt>' <tt>$field</tt>. You must do it yourself, if required. | |
| * See [[Function_Reference/sanitize_term_field|<tt>sanitize_term_field()</tt>]] The <tt>$context</tt> param lists the available values for '<tt>get_term_by</tt>' <tt>$filter</tt> param. | |
| * Uses: [[Function_Reference/sanitize_term|<tt>sanitize_term()</tt>]] Cleanses the term based on <tt>$filter</tt> context before returning. | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| == Change Log == | |
| Since: 2.3.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_term_by()</tt> is located in {{Trac|wp-includes/taxonomy.php}}. | |
| == Related == | |
| {{Term Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="is_term" d:title="is term"> | |
| <d:index d:value="is term"/> | |
| <h1>is term</h1> | |
| <p>{{Deprecated}} | |
| == Description == | |
| Check if <tt>Term</tt> exists. | |
| Returns the index of a defined term, or <tt>0</tt> (<tt>false</tt>) if the term doesn't exist. | |
| == Replace With == | |
| [[Function Reference/term_exists|term_exists]] for check that term exists or [[Function Reference/is_tax|is_tax]] with optional $term argument for check that you are in term archive. | |
| == Usage == | |
| %%%<?php is_term( $term, $taxonomy ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$term|integer&#124;string|The term to check}} | |
| {{Parameter|$taxonomy|string|The taxonomy name to use|optional|&#39;&#39;}} | |
| == Return Values == | |
| ; (mixed) : Get the term id or <tt>Term Object</tt>, if exists. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses global: (<tt>object</tt>) <tt>$term</tt> | |
| == Change Log == | |
| * Since: [[Version 2.3|2.3]] | |
| * Deprecated: [[Version 3.0|3.0]] | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>is_term()</tt> is located in {{Trac|wp-includes/taxonomy.php}}. | |
| == Related == | |
| {{Conditional Tags}} | |
| {{Term Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Conditional Tags]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_object_terms" d:title="wp get object terms"> | |
| <d:index d:value="wp get object terms"/> | |
| <h1>wp get object terms</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp get object terms}} | |
| {{ja|関数リファレンス/wp get object terms}} | |
| }} | |
| == Description == | |
| Retrieves the terms associated with the given object(s), in the supplied taxonomies. | |
| == Usage == | |
| %%%<?php wp_get_object_terms( $object_ids, $taxonomies, $args ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$object_ids|string&#124;array|The id's of objects to retrieve terms from.}} | |
| {{Parameter|$taxonomies|string&#124;array|The [[Taxonomies|taxonomies]] to retrieve terms from. For example: 'category', 'post_tag', 'taxonomy slug'}} | |
| {{Parameter|$args|array&#124;string|Change what is returned|optional|array}} | |
| === Default Arguments === | |
| $args = array('orderby' => 'name', 'order' => 'ASC', 'fields' => 'all'); | |
| === Argument Options === | |
| The following information has to do the <tt>$args</tt> parameter and for what can be contained in the string or array of that parameter, if it exists. | |
| ; order : (''string'') | |
| :* <tt>ASC</tt> - Default | |
| :* <tt>DESC</tt> | |
| ; orderby : (''string'') | |
| :* <tt>name</tt> - Default | |
| :* <tt>count</tt> | |
| :* <tt>slug</tt> | |
| :* <tt>term_group</tt> | |
| :* <tt>term_order</tt> | |
| :* <tt>term_id</tt> | |
| :* <tt>none</tt> | |
| ; fields : (''string'') | |
| :* <tt>all</tt> - Default : all matching terms objects will be returned. | |
| :* <tt>ids</tt> : terms ids will be returned | |
| :* <tt>names</tt> : terms names will be returned | |
| :* <tt>slugs</tt> : terms slugs will be returned | |
| :* <tt>all_with_object_id</tt> : all matching terms objects will be returned. | |
| :* <tt>tt_ids</tt> : terms taxonomies ids will be returned | |
| '''NOTE''': Arguments are passed in the format used by [[Function_Reference/wp_parse_args|wp_parse_args()]]. e.g. | |
| == Return Values == | |
| ; (array&#124;WP_Error) : Array of requested term objects or empty array if no terms found. WP_Error if <tt>$taxonomy</tt> does not exist. See [[Function_Reference/is_wp_error|is_wp_error()]] for more information. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| Return a list of all 'product' taxonomy terms which are applied to <tt>$post</tt>: | |
| <pre>$product_terms = wp_get_object_terms($post->ID, 'product'); | |
| if(!empty($product_terms)){ | |
| if(!is_wp_error( $product_terms )){ | |
| echo '<ul>'; | |
| foreach($product_terms as $term){ | |
| echo '<li><a href="'.get_term_link($term->slug, 'product').'">'.$term->name.'</a></li>'; | |
| } | |
| echo '</ul>'; | |
| } | |
| }</pre> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * May return [[Function_Reference/WP_Error|<tt>WP_Error</tt>]] object. | |
| == Change Log == | |
| Since: 2.3.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_get_object_terms()</tt> is located in {{Trac|wp-includes/taxonomy.php}}. | |
| == Related == | |
| {{Term Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="do_feed" d:title="do feed"> | |
| <d:index d:value="do feed"/> | |
| <h1>do feed</h1> | |
| <p>== Description == | |
| Loads the feed template from the use of an action hook. | |
| If the feed action does not have a hook, then the function will die with a message telling the visitor that the feed is not valid. | |
| It is better to only have one hook for each feed. | |
| == Usage == | |
| %%%<?php do_feed() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_query_var|get_query_var()]] to get '<tt>feed</tt>' from [[Class_Reference/WP_Query|<tt>$wp_query</tt>]]. | |
| * Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] Calls '<tt>do_feed_$feed</tt>' hook, if a hook exists for the feed where <tt>$feed</tt> is the '<tt>feed</tt>' property from [[Class_Reference/WP_Query|<tt>$wp_query</tt>]]. | |
| * Uses global: (<tt>object</tt>) [[Class_Reference/WP_Query|<tt>$wp_query</tt>]] Used to tell if the use a comment feed. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>do_feed()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="do_feed_rdf" d:title="do feed rdf"> | |
| <d:index d:value="do feed rdf"/> | |
| <h1>do feed rdf</h1> | |
| <p>== Description == | |
| Load the [[wikipedia:Resource_Description_Framework|RDF]] [[wikipedia:Rss|RSS]] 0.91 Feed template. | |
| == Usage == | |
| %%%<?php do_feed_rdf() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/load_template|<tt>load_template()</tt>]] to load feed template. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>do_feed_rdf()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="do_feed_rss" d:title="do feed rss"> | |
| <d:index d:value="do feed rss"/> | |
| <h1>do feed rss</h1> | |
| <p>== Description == | |
| Load the [[wikipedia:Resource_Description_Framework|RDF]] [[wikipedia:Rss|RSS]] 1.0 Feed template. | |
| == Usage == | |
| %%%<?php do_feed_rss() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/load_template|<tt>load_template()</tt>]] to load feed template. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>do_feed_rss()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="do_feed_rss2" d:title="do feed rss2"> | |
| <d:index d:value="do feed rss2"/> | |
| <h1>do feed rss2</h1> | |
| <p>== Description == | |
| Load either the RSS2 comment feed or the RSS2 posts feed. | |
| == Usage == | |
| %%%<?php do_feed_rss2( $for_comments ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$for_comments|boolean|<tt>true</tt> for the comment feed, <tt>false</tt> for normal feed.}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/load_template|<tt>load_template()</tt>]] to load feed template. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>do_feed_rss2()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="do_feed_atom" d:title="do feed atom"> | |
| <d:index d:value="do feed atom"/> | |
| <h1>do feed atom</h1> | |
| <p>== Description == | |
| Load either [[wikipedia:Atom_(standard)|Atom]] comment feed or [[wikipedia:Atom_(standard)|Atom]] posts feed. | |
| == Usage == | |
| %%%<?php do_feed_atom( $for_comments ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$for_comments|boolean|<tt>true</tt> for the comment feed, <tt>false</tt> for normal feed.}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/load_template|<tt>load_template()</tt>]] to load feed templates. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>do_feed_atom()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_bloginfo_rss" d:title="get bloginfo rss"> | |
| <d:index d:value="get bloginfo rss"/> | |
| <h1>get bloginfo rss</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_bloginfo_rss}} | |
| {{ja|テンプレートタグ/get_bloginfo_rss}} | |
| }} | |
| == Description == | |
| [[wikipedia:Rss|RSS]] container for the bloginfo function. | |
| You can retrieve anything that you can using the [[Function Reference/get_bloginfo|<tt>get_bloginfo()</tt>]] function. Everything will be stripped of tags and characters converted, when the values are retrieved for use in the feeds. | |
| == Usage == | |
| %%%<?php get_bloginfo_rss( $show ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$show|string|Informational detail about your blog. Valid values:|optional|&#39;&#39;}} | |
| :* <tt>'name'</tt> - Weblog title; set in General Options. (Default) | |
| :* <tt>'description'</tt> - Tagline for your blog; set in General Options. | |
| :* <tt>'url'</tt> - [[Glossary#URI and URL|URL]] for your blog's web site address. | |
| :* <tt>'rdf_url'</tt> - URL for [[Glossary#RDF|RDF]]/RSS 1.0 feed. | |
| :* <tt>'rss_url'</tt> - URL for [[Glossary#RSS|RSS]] 0.92 feed. | |
| :* <tt>'rss2_url'</tt> - URL for RSS 2.0 feed. | |
| :* <tt>'atom_url'</tt> - URL for [[Glossary#Atom|Atom]] feed. | |
| :* <tt>'comments_rss2_url'</tt> - URL for comments RSS 2.0 feed. | |
| :* <tt>'pingback_url'</tt> - URL for [[Glossary#PingBack|Pingback]] (XML-RPC file). | |
| :* <tt>'admin_email'</tt> - Administrator's email address; set in General Options. | |
| :* <tt>'charset'</tt> - Character encoding for your blog; set in Reading Options. | |
| :* <tt>'version'</tt> - Version of WordPress your blog uses. | |
| : '''The following work in WordPress version 1.5 or after:''' | |
| :* <tt>'html_type'</tt> - "Content-type" for your blog. | |
| :* <tt>'wpurl'</tt> - URL for WordPress installation. | |
| :* <tt>'template_url'</tt> - URL for template in use. | |
| :* <tt>'template_directory'</tt> - URL for template's directory. | |
| :* <tt>'stylesheet_url'</tt> - URL for primary [[Glossary#CSS|CSS]] file. | |
| :* <tt>'stylesheet_directory'</tt> - URL for stylesheet directory. | |
| == Return Values == | |
| ; (string) : | |
| == Examples == | |
| === RSS2 URL === | |
| Assigns the URL of your blog's RSS2 feed to the variable $rss2_url. | |
| <?php $rss2_url = get_bloginfo_rss('rss2_url'); ?> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>get_bloginfo_rss</tt>' hook with two parameters. | |
| == Change Log == | |
| Since: 1.5.1 | |
| == Source File == | |
| <tt>get_bloginfo_rss()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="bloginfo_rss" d:title="bloginfo rss"> | |
| <d:index d:value="bloginfo rss"/> | |
| <h1>bloginfo rss</h1> | |
| <p>== Description == | |
| Display [[wikipedia:Rss|RSS]] container for the bloginfo function. | |
| You can retrieve anything that you can using the [[Function Reference/get_bloginfo|<tt>get_bloginfo()</tt>]] function. Everything will be stripped of tags and characters converted, when the values are retrieved for use in the feeds. | |
| == Usage == | |
| %%%<?php bloginfo_rss( $show ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$show|string|See [[Function Reference/get_bloginfo|<tt>get_bloginfo()</tt>]] for possible values.|optional|&#39;&#39;}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * See [[Function Reference/get_bloginfo|<tt>get_bloginfo()</tt>]] For the list of possible values to display. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>bloginfo_rss</tt>' hook with two parameters. | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>bloginfo_rss()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_the_title_rss" d:title="get the title rss"> | |
| <d:index d:value="get the title rss"/> | |
| <h1>get the title rss</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_the_title_rss}} | |
| {{it|Riferimento funzioni/get_the_title_rss}} | |
| }} | |
| == Description == | |
| Retrieve the current post title for the feed. | |
| == Usage == | |
| %%%<?php get_the_title_rss() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Current post title. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>the_title_rss</tt>' on the post title. | |
| * Uses: [[Function_Reference/get_the_title|get_the_title()]] to get the post title. | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <tt>get_the_title_rss()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="the_title_rss" d:title="the title rss"> | |
| <d:index d:value="the title rss"/> | |
| <h1>the title rss</h1> | |
| <p>== Description == | |
| Display the post title in the feed. | |
| == Usage == | |
| %%%<?php the_title_rss() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_the_title_rss|<tt>get_the_title_rss()</tt>]] Used to retrieve current post title. | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>the_title_rss()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="the_content_rss" d:title="the content rss"> | |
| <d:index d:value="the content rss"/> | |
| <h1>the content rss</h1> | |
| <p>{{Deprecated|new_function=the_content_feed}} | |
| == Description == | |
| Display the post content for the feed. | |
| For encoding the html or the <tt>$encode_html</tt> parameter, there are three possible values. '<tt>0</tt>' will make urls footnotes and use [[Function_Reference/make_url_footnote|<tt>make_url_footnote()</tt>]]. '<tt>1</tt>' will encode special characters and automatically display all of the content. The value of '<tt>2</tt>' will strip all HTML tags from the content. | |
| Also note that you cannot set the amount of words and not set the html encoding. If that is the case, then the html encoding will default to <tt>2</tt>, which will strip all HTML tags. | |
| To restrict the amount of words of the content, you can use the cut parameter. If the content is less than the amount, then there won't be any dots added to the end. If there is content left over, then dots will be added and the rest of the content will be removed. | |
| == Usage == | |
| %%%<?php the_content_rss( $more_link_text, $stripteaser, $more_file, $cut, $encode_html ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$more_link_text|string|Text to display when more content is available but not displayed.|optional|'more...'}} | |
| {{Parameter|$stripteaser|integer&#124;boolean|Default is 0.|optional|0}} | |
| {{Parameter|$more_file|string|Optional.|optional|&#39;&#39;}} | |
| {{Parameter|$cut|integer|Amount of words to keep for the content.|optional|0}} | |
| {{Parameter|$encode_html|integer|How to encode the content.|optional|0}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * See [[Function_Reference/get_the_content|<tt>get_the_content()</tt>]] For the <tt>$more_link_text</tt>, <tt>$stripteaser</tt>, and <tt>$more_file</tt> parameters. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>the_content_rss</tt>' on the content before processing. | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>the_content_rss()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="the_excerpt_rss" d:title="the excerpt rss"> | |
| <d:index d:value="the excerpt rss"/> | |
| <h1>the excerpt rss</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get pages}} | |
| {{ja|Function Reference/the excerpt rss}} | |
| }} | |
| == Description == | |
| Display the post excerpt for the feed. | |
| == Usage == | |
| %%%<?php the_excerpt_rss() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| To create a custom feed that takes a GET parameter on a URL (e.g. http://www.example.com/?feed=myfeed&type=excerpt), place something like the following in your particular feed file to send an excerpt (<code>the_excerpt_rss()</code>) instead of the full content (<code>the_content()</code>): | |
| <pre> | |
| <?php | |
| if isset($_GET['type'])) { $typewanted = $_GET['type']; } | |
| if ($typewantd=='excerpt') { | |
| // Wrap the Excerpt in a span tag for CSS styling | |
| echo '<span class="excerpt">'; | |
| the_excerpt_rss(); | |
| echo '</span>'; | |
| } else { | |
| // Otherwise they want the full content so wrap it in another span | |
| echo '<span class="content">'; | |
| the_content(); | |
| echo '</span>'; | |
| } | |
| ?> | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>the_excerpt_rss</tt>' hook on the excerpt. | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>the_excerpt_rss()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| [[Function_Reference/wp_trim_excerpt|wp_trim_excerpt()]]<br/> | |
| [[Function_Reference/the_content|the_content()]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Feeds]]</p> | |
| </d:entry> | |
| <d:entry id="comment_link" d:title="comment link"> | |
| <d:index d:value="comment link"/> | |
| <h1>comment link</h1> | |
| <p>== Description == | |
| Display the full, anchored URL to a single comment. This function must be used within the comments loop. | |
| If you want to link to all of the comments for an entry, use the function [[Function_Reference/comments_link | comments_link()]] instead. | |
| == Usage == | |
| %%%<?php comment_link() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| Create an anchored permalink to a single comment: | |
| <a href="<?php comment_link(); ?>">Permalink to this comment</a> | |
| The code shown above will result (depending on your permalink settings) in something like this: | |
| <a href="http://example.com/2009/07/15/example-post/comment-page-1/#comment-3">Permalink to this comment</a> | |
| == Notes == | |
| * Echos the return value of [[Function_Reference/get_comment_link|<tt>get_comment_link()</tt>]]. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>comment_link()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_comment_link" d:title="get comment link"> | |
| <d:index d:value="get comment link"/> | |
| <h1>get comment link</h1> | |
| <p>== Description == | |
| Retrieve the link to a given comment. | |
| == Usage == | |
| %%%<?php get_comment_link( $comment, $args ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$comment|object&#124;string&#124;integer|Comment to retrieve.|optional|null}} | |
| {{Parameter|$args|mixed|Optional arguments (see [[Function_Reference/get_comment_link#Default_Arguments|Default Arguments]].)|optional|array (see [[Function_Reference/get_comment_link#Default_Arguments|Default Arguments]])}} | |
| == Return Values == | |
| ; (string) : The permalink to the current comment | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Default Arguments == | |
| The following default arguments are used unless found in the optional <tt>$args</tt> argument: | |
| ;page : The zero-based index for the page where the comment should appear. Defaults to <tt>0</tt>. '''Note''': for backward compatibility the entire <tt>$args</tt> argument is treated as an integer and used for this argument if it is not found to be an array. | |
| ;type : The type of comment (not used directly). Defaults to <tt>'all'</tt>. | |
| ;per_page : Number of comments per page. Defaults to <tt>0</tt>. | |
| ;max_depth : Maximum depth to be considered for comments, when threaded (not used directly). Defaults to <tt><nowiki>''</nowiki></tt> | |
| == Filters == | |
| * <tt>get_comment_link</tt> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_comment|<tt>get_comment()</tt>]] to retrieve <tt>$comment</tt>. | |
| * Uses global: (<tt>unknown</tt>) <tt>$wp_rewrite</tt> | |
| * Uses global: (<tt>unknown</tt>) <tt>$in_comment_loop</tt> | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_comment_link()</tt> is located in {{Trac|wp-includes/comment-template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_comment_author_rss" d:title="get comment author rss"> | |
| <d:index d:value="get comment author rss"/> | |
| <h1>get comment author rss</h1> | |
| <p>== Description == | |
| Retrieve the current comment author for use in the feeds. | |
| == Usage == | |
| %%%<?php get_comment_author_rss() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : Comment Author | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>comment_author_rss</tt>' hook on comment author. | |
| * Uses: [[Function_Reference/get_comment_author|<tt>get_comment_author()</tt>]] | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <tt>get_comment_author_rss()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="comment_author_rss" d:title="comment author rss"> | |
| <d:index d:value="comment author rss"/> | |
| <h1>comment author rss</h1> | |
| <p>== Description == | |
| Display the current comment author in the feed. | |
| == Usage == | |
| %%%<?php comment_author_rss() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Echos the return from [[Function_Reference/get_comment_author_rss|<tt>get_comment_author_rss()</tt>]]. | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>comment_author_rss()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="comment_text_rss" d:title="comment text rss"> | |
| <d:index d:value="comment text rss"/> | |
| <h1>comment text rss</h1> | |
| <p>== Description == | |
| Display the current comment content for use in the feeds. | |
| == Usage == | |
| %%%<?php comment_text_rss() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>comment_text_rss</tt>' filter on comment content. | |
| * Uses: [[Function_Reference/get_comment_text|<tt>get_comment_text()</tt>]] | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>comment_text_rss()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_post_comments_feed_link" d:title="get post comments feed link"> | |
| <d:index d:value="get post comments feed link"/> | |
| <h1>get post comments feed link</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_post_comments_feed_link}} | |
| {{it|Riferimento funzioni/get_post_comments_feed_link}} | |
| }} | |
| == Description == | |
| Retrieve the permalink for the post comments feed. | |
| == Usage == | |
| %%%<?php get_post_comments_feed_link( $post_id, $feed ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$post_id|integer|Post ID.|optional|&#39;&#39;}} | |
| {{Parameter|$feed|string|Feed type.|optional|&#39;&#39;}} | |
| == Return Values == | |
| ; (string) : | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>integer</tt>) <tt>$id</tt> | |
| == Change Log == | |
| Since: 2.2.0 | |
| == Source File == | |
| <tt>get_post_comments_feed_link()</tt> is located in {{Trac|wp-includes/link-template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_the_category_rss" d:title="get the category rss"> | |
| <d:index d:value="get the category rss"/> | |
| <h1>get the category rss</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get_the_category_rss}} | |
| {{it|Riferimento funzioni/get_the_category_rss}} | |
| }} | |
| == Description == | |
| Retrieve all of the post categories, formatted for use in feeds. | |
| All of the categories for the current post in the feed loop, will be retrieved and have feed markup added, so that they can easily be added to the RSS2, Atom, or RSS1 and RSS0.91 RDF feeds. | |
| == Usage == | |
| %%%<?php get_the_category_rss( $type ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$type|string|default is '<tt>rss</tt>'. Either '<tt>rss</tt>', '<tt>atom</tt>', or '<tt>rdf</tt>'.|optional|'rss'}} | |
| == Return Values == | |
| ; (string) : All of the post categories for displaying in the feed. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>get_the_category_rss()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="the_category_rss" d:title="the category rss"> | |
| <d:index d:value="the category rss"/> | |
| <h1>the category rss</h1> | |
| <p>== Description == | |
| Display the post categories in the feed. | |
| == Usage == | |
| %%%<?php the_category_rss( $type ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$type|string|Either '<tt>rss</tt>', '<tt>atom</tt>', or '<tt>rdf</tt>'.|optional|'rss'}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * See [[Function_Reference/get_the_category_rss|<tt>get_the_category_rss()</tt>]] for better explanation. | |
| * Echos the return from [[Function_Reference/get_the_category_rss|<tt>get_the_category_rss()</tt>]]. | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>the_category_rss()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| {{Category Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="rss_enclosure" d:title="rss enclosure"> | |
| <d:index d:value="rss enclosure"/> | |
| <h1>rss enclosure</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/rss_enclosure}} | |
| {{ja|テンプレートタグ/rss_enclosure}} | |
| }} | |
| == Description == | |
| Display the rss enclosure for the current post. | |
| Uses the global <tt>$post</tt> to check whether the post requires a password and if the user has the password for the post. If not then it will return before displaying. | |
| Also uses the function [[Function_Reference/get_post_custom|<tt>get_post_custom()</tt>]] to get the post's '<tt>enclosure</tt>' metadata field and parses the value to display the enclosure(s). The enclosure(s) consist of enclosure HTML tag(s) with a URI and other attributes. | |
| == Usage == | |
| %%%<?php rss_enclosure() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>rss_enclosure</tt>' hook on rss enclosure. | |
| * Uses: [[Function_Reference/get_post_custom|<tt>get_post_custom()</tt>]] To get the current post enclosure metadata. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>rss_enclosure()</tt> is located in {{Trac|wp-includes/feed.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_search_feed_link" d:title="get search feed link"> | |
| <d:index d:value="get search feed link"/> | |
| <h1>get search feed link</h1> | |
| <p>== Description == | |
| Retrieve the permalink for the feed of the search results. | |
| == Usage == | |
| %%%<?php echo get_search_feed_link( $search_query, $feed ) ?>%%% | |
| If you don't echo the function you're simply going to get a permalink to the page with no RSS feed for the search results. | |
| == Parameters == | |
| {{Parameter|$search_query|string|URL search query.|optional|&#39;&#39;}} | |
| {{Parameter|$feed|string|Feed type.|optional|&#39;&#39;}} | |
| == Return Values == | |
| ; (string) : Returns a url after the '<tt>search_feed_link</tt>' filters have been applied. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_search_query|<tt>get_search_query()</tt>]] if no query supplied. | |
| == Change Log == | |
| Since: 2.5.0 | |
| == Source File == | |
| <tt>get_search_feed_link()</tt> is located in {{Trac|wp-includes/link-template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_search_comments_feed_link" d:title="get search comments feed link"> | |
| <d:index d:value="get search comments feed link"/> | |
| <h1>get search comments feed link</h1> | |
| <p>== Description == | |
| Retrieve the permalink for the comments feed of the search results. | |
| == Usage == | |
| %%%<?php get_search_comments_feed_link( $search_query, $feed ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$search_query|string|Url search query.|optional|&#39;&#39;}} | |
| {{Parameter|$feed|string|Feed type.|optional|&#39;&#39;}} | |
| == Return Values == | |
| ; (string) : | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/get_search_query|<tt>get_search_query()</tt>]] if no query supplied. | |
| == Change Log == | |
| Since: 2.5.0 | |
| == Source File == | |
| <tt>get_search_comments_feed_link()</tt> is located in {{Trac|wp-includes/link-template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="clean_pre" d:title="clean pre"> | |
| <d:index d:value="clean pre"/> | |
| <h1>clean pre</h1> | |
| <p>== Description == | |
| Accepts matches <tt>array</tt> from [http://us.php.net/manual/en/function.preg-replace-callback.php preg_replace_callback] in [[Function_Reference/wpautop|<tt>wpautop()</tt>]] or a string. | |
| Ensures that the contents of a <nowiki><pre>...</pre></nowiki> HTML block are not converted into paragraphs or line-breaks. | |
| == Usage == | |
| %%%<?php clean_pre( $matches ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$matches|array&#124;string|The array or string}} | |
| == Return Values == | |
| ; (string) : The pre block without paragraph/line-break conversion. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Note: If $matches is an <tt>array</tt> the array values are concatenated into a string. | |
| == Change Log == | |
| Since: 1.2.0 | |
| == Source File == | |
| <tt>clean_pre()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="seems_utf8" d:title="seems utf8"> | |
| <d:index d:value="seems utf8"/> | |
| <h1>seems utf8</h1> | |
| <p>== Description == | |
| Checks to see if a string is utf8 encoded. | |
| == Usage == | |
| %%%<?php seems_utf8( $str ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$str|string|The string to be checked}} | |
| == Return Values == | |
| ; (boolean) : True if <tt>$str</tt> fits a UTF-8 model, false otherwise. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.2.1 | |
| == Source File == | |
| <tt>seems_utf8()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_specialchars" d:title="wp specialchars"> | |
| <d:index d:value="wp specialchars"/> | |
| <h1>wp specialchars</h1> | |
| <p>== Description == | |
| '''This function is deprecated as of WordPress 2.8.0. Please use [[Function Reference/esc_html|esc_html]] instead.''' | |
| Converts a number of special characters into their HTML entities. | |
| Differs from [http://us.php.net/manual/en/function.htmlspecialchars.php <tt>htmlspecialchars</tt>] as existing HTML entities will not be encoded. Specifically changes: <tt>&amp;</tt> to <tt>&amp;#038;</tt>, <tt>&lt;</tt> to <tt>&amp;lt;</tt> and <tt>&gt;</tt> to <tt>&amp;gt;</tt>. | |
| <tt>$quotes</tt> can be set to '<tt>single</tt>' to encode <tt>'</tt> to <tt>&amp;#039;</tt>, '<tt>double</tt>' to encode <tt>"</tt> to <tt>&amp;quot;</tt>, or '<tt>1</tt>' to do both. Default is <tt>0</tt> where no quotes are encoded. | |
| == Usage == | |
| %%%<?php wp_specialchars( $text, $quotes ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$text|string|The text which is to be encoded.}} | |
| {{Parameter|$quotes|mixed|Converts single quotes if set to '<tt>single</tt>', double if set to '<tt>double</tt>' or both if otherwise set.|optional|0}} | |
| == Return Values == | |
| ; (string) : The encoded text with HTML entities. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * [http://us.php.net/manual/en/function.htmlspecialchars.php <tt>htmlspecialchars</tt>] (noted in the description) is a PHP built-in function. | |
| == Change Log == | |
| Since: 1.2.2 | |
| == Source File == | |
| <tt>wp_specialchars()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="utf8_uri_encode" d:title="utf8 uri encode"> | |
| <d:index d:value="utf8 uri encode"/> | |
| <h1>utf8 uri encode</h1> | |
| <p>== Description == | |
| Only alphanumerics and some special characters may be used in a URL (or URI, more on that difference elsewhere). This function will convert other characters to their Unicode values. | |
| == Usage == | |
| %%%<?php utf8_uri_encode( $utf8_string, $length ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$utf8_string|string|}} | |
| {{Parameter|$length|integer|Max length of the string|optional|0}} | |
| == Return Values == | |
| ; (string) : String with Unicode encoded for URI. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>utf8_uri_encode()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="is_sticky" d:title="is sticky"> | |
| <d:index d:value="is sticky"/> | |
| <h1>is sticky</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/is_sticky}} | |
| {{ja|関数リファレンス/is_sticky}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|Conditional Tag]] checks if the current post is a [[Sticky_Posts | Sticky Post ]] meaning the "Stick this post to the front page" check box has been checked for the post. This is a boolean function, meaning it returns either TRUE or FALSE. | |
| ==Usage== | |
| %%%<?php is_sticky($post_ID); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$post_ID|string|The post ID|optional}} | |
| ==Return Values== | |
| ; <tt>(boolean)</tt> : True on success, false on failure. | |
| ==Examples== | |
| is_sticky(); | |
| // When any Sticky Post page is being displayed. | |
| is_sticky('17'); | |
| // When Sticky Post 17 (ID) is being displayed. | |
| ==Notes== | |
| ==Change Log== | |
| Since: [[Version 2.7|2.7.0]] | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_sticky()</tt> is located in {{Trac|wp-includes/post.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="is_singular" d:title="is singular"> | |
| <d:index d:value="is singular"/> | |
| <h1>is singular</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/is_singular}} | |
| {{tr|Fonksiyon_Listesi/is_singular}} | |
| {{ja|関数リファレンス/is_singular}} | |
| }} | |
| ==Description== | |
| This [[Conditional Tags|conditional tag]] checks if a singular post is being displayed, which is the case when one of the following returns ''true'': <tt>[[Function Reference/is single|is_single()]]</tt>, <tt>[[Function Reference/is page|is_page()]]</tt> or <tt>[[Function Reference/is attachment|is_attachment()]]</tt>. If the <tt>$post_types</tt> parameter is specified, the function will additionally check if the [[Glossary#Query|query]] is for one of the post types specified. | |
| ==Usage== | |
| %%%<?php is_singular( $post_types ); ?>%%% | |
| ==Parameters== | |
| {{Parameter|$post_types|string/array|Post type or types to check in current query.|optional}} | |
| ==Return Values== | |
| {{Return||boolean|''True'' on success, ''false'' on failure}}. | |
| ==Examples== | |
| ===Different Sidebar Ads in Singular Page=== | |
| <?php | |
| if ( is_singular() ) { | |
| // show adv. #1 | |
| } else { | |
| // show adv. #2 | |
| } | |
| ?> | |
| ===Default Post Type=== | |
| True when viewing a regular [[Post Types|post]]. | |
| is_singular('post'); | |
| ===Custom Post Types=== | |
| When any of the following return true: <tt>is_single()</tt>, <tt>is_page()</tt> or <tt>is_attachment()</tt>. | |
| is_singular(); | |
| True when viewing a post of the [[Post Types|Custom Post Type]] book. | |
| is_singular('book'); | |
| True when viewing a post of the [[Post Types|Custom Post Type]] newspaper or book. | |
| is_singular(array( 'newspaper', 'book' )); | |
| ==Notes== | |
| ==Change Log== | |
| * Since: [[Version 1.5|1.5.0]] | |
| * [[Version 3.0|3.0.0]]: <tt>$post_types</tt> parameter was added. | |
| ==Source File== | |
| <!-- Need links to current source code files --> | |
| <tt>is_singular()</tt> is located in {{Trac|wp-includes/query.php}}. | |
| ==Related== | |
| {{Conditional Tags}} | |
| {{Tag Footer}} | |
| [[Category:Conditional Tags]] | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="remove_accents" d:title="remove accents"> | |
| <d:index d:value="remove accents"/> | |
| <h1>remove accents</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/remove accents}} | |
| {{ja|Function Reference/remove accents}} | |
| }} | |
| == Description == | |
| Converts all accent characters to [[wikipedia:ASCII|ASCII]] characters. | |
| If there are no accent characters, then the string given is just returned. | |
| == Usage == | |
| %%%<?php remove_accents( $string ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|Text that might have accent characters}} | |
| == Return Values == | |
| ; (string) : Filtered string with replaced "nice" characters. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| <pre> | |
| <?php | |
| $text = "Hoy será un gran día"; | |
| echo remove_accents ( $text ); | |
| ?> | |
| </pre> | |
| Echo result: Hoy sera un gran dia | |
| == Notes == | |
| == Change Log == | |
| Since: 1.2.1 | |
| == Source File == | |
| <tt>remove_accents()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="sanitize_file_name" d:title="sanitize file name"> | |
| <d:index d:value="sanitize file name"/> | |
| <h1>sanitize file name</h1> | |
| <p>== Description == | |
| Sanitizes a filename replacing whitespace with dashes | |
| Removes special characters that are illegal in filenames on certain operating systems and special characters requiring special escaping to manipulate at the command line. Replaces spaces and consecutive dashes with a single dash. Trim period, dash and underscore from beginning and end of filename. | |
| The special characters are passed through the [[Plugin API/Filter Reference/sanitize_file_name_chars|sanitize_file_name_chars]] filter before removing them from the file name, allowing plugins to change which characters are considered invalid. After <code>sanitize_file_name()</code> has done its work, it passes the sanitized file name through the [[Plugin API/Filter Reference/sanitize_file_name|sanitize_file_name]] filter. | |
| == Usage == | |
| %%%<?php sanitize_file_name( $name ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$name|string|The file name}} | |
| == Return Values == | |
| ; (string) : Sanitized file name | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: [[Version 2.1|2.1]] | |
| == Source File == | |
| <code>sanitize_file_name()</code> is located in {{Trac|wp-includes/formatting.php}} | |
| == Related == | |
| === Functions === | |
| {{sanitize functions|sanitize_file_name()}} | |
| === Filters === | |
| {{sanitize filters|sanitize_file_name}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="sanitize_user" d:title="sanitize user"> | |
| <d:index d:value="sanitize user"/> | |
| <h1>sanitize user</h1> | |
| <p>== Description == | |
| Sanitize username stripping out unsafe characters. | |
| If <tt>$strict</tt> is true, only alphanumeric characters plus these: <tt>_</tt>, space, <tt>.</tt>, <tt>-</tt>, <tt>*</tt>, and <tt>@</tt> are returned. | |
| Removes tags, octets, entities, and if strict is enabled, will remove all non-[[wikipedia:ASCII|ASCII]] characters. After sanitizing, it passes the username, raw username (the username in the parameter), and the strict parameter as parameters for the [[Plugin API/Filter Reference/sanitize_user|sanitize_user]] filter. | |
| == Usage == | |
| %%%<?php sanitize_user( $username, $strict ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$username|string|The username to be sanitized.}} | |
| {{Parameter|$strict|boolean|If set limits <tt>$username</tt> to specific characters.|optional|false}} | |
| == Return Values == | |
| ; (string) : The sanitized username, after passing through filters. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>sanitize_user</tt>' hook on username, raw username, and <tt>$strict</tt> parameter. | |
| == Change Log == | |
| * Since: [[Version 2.0|2.0.0]] | |
| * Originally defined in {{Trac|wp-includes/functions-formatting.php|tags/2.0|268}} | |
| * <code>$strict</code> parameter and <tt>sanitize_user</tt> filter added in [[Version 2.0.1|2.0.1]] | |
| * File renamed to {{Trac|wp-includes/formatting.php|tags/2.1|316}} in [[Version 2.1|2.1]] | |
| == Source File == | |
| <code>sanitize_user()</code> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| === Functions === | |
| {{sanitize functions|sanitize_user()}} | |
| === Filters === | |
| {{sanitize filters|sanitize_user}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="sanitize_title_with_dashes" d:title="sanitize title with dashes"> | |
| <d:index d:value="sanitize title with dashes"/> | |
| <h1>sanitize title with dashes</h1> | |
| <p>== Description == | |
| Sanitizes title, replacing whitespace with dashes. | |
| Limits the output to alphanumeric characters, underscore (<tt>_</tt>) and dash (<tt>-</tt>). Whitespace becomes a dash. | |
| Note that <b>it does not replace special accented characters</b> (see plugins such as [https://github.com/toscho/Germanix-WordPress-Plugin] to fix that). | |
| == Usage == | |
| %%%<?php sanitize_title_with_dashes( $title, $unused, $context = 'display' ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$title|string|The title to be sanitized.}} | |
| {{Parameter|$unused|string|Used to be the <tt>$raw_title</tt>, but is now unused.|optional}} | |
| {{Parameter|$context|string|The context for the sanitation. When set to <tt>'save'</tt>, additional entities are converted to hyphens or stripped entirely.|optional|'display'}} | |
| == Return Values == | |
| ; (string) : The sanitized title. | |
| == Examples == | |
| ===Default usage=== | |
| <pre> | |
| <?php | |
| echo sanitize_title_with_dashes("I'm in LOVE with WordPress!!!1"); | |
| // this will print: im-in-love-with-wordpress1 | |
| ?> | |
| </pre> | |
| == Notes == | |
| Does not apply the <tt>[[Plugin API/Filter Reference/sanitize_title|sanitize_title]]</tt> filter to the title. | |
| == Change Log == | |
| Since: 1.2.0 | |
| == Source File == | |
| <code>sanitize_title_with_dashes()</code> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| === Functions === | |
| {{sanitize functions| sanitize_title_with_dashes()}} | |
| === Filters === | |
| {{sanitize filters}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="convert_chars" d:title="convert chars"> | |
| <d:index d:value="convert chars"/> | |
| <h1>convert chars</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/convert_chars}} | |
| {{it|Riferimento funzioni/convert_chars}} | |
| }} | |
| == Description == | |
| Converts a number of characters from a string. | |
| Metadata tags <nowiki><title></nowiki> and <nowiki><category></nowiki> are removed, <nowiki><br></nowiki> and <nowiki><hr></nowiki> are converted into correct [[wikipedia:XHTML|XHTML]] and [[wikipedia:Unicode|Unicode]] characters are converted to the valid range. | |
| == Usage == | |
| %%%<?php convert_chars( $content, $deprecated ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$content|string|String of characters to be converted.}} | |
| {{Parameter|$deprecated|string|Not used.|optional|&#39;&#39;}} | |
| == Return Values == | |
| ; (string) : Converted string. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>convert_chars()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="balanceTags" d:title="balanceTags"> | |
| <d:index d:value="balanceTags"/> | |
| <h1>balanceTags</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/balanceTags}} | |
| {{it|Riferimento funzioni/balanceTags}} | |
| }} | |
| == Description == | |
| Will balance the tags if forced to or the option is set to balance tags. | |
| The option '<tt>use_balanceTags</tt>' is used for whether the tags will be balanced. Either the <tt>$force</tt> parameter or '<tt>use_balanceTags</tt>' option need to be true before the tags will be balanced. | |
| == Usage == | |
| %%%<?php balanceTags( $text, $force ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$text|string|Text to be balanced}} | |
| {{Parameter|$force|boolean|Forces balancing, ignoring the value of the option.|optional|false}} | |
| == Return Values == | |
| ; (string) : Balanced text | |
| == Examples == | |
| === Unclosed LI tags === | |
| <pre> | |
| <?php | |
| $html = '<ul> | |
| <li>this | |
| <li>is | |
| <li>a | |
| <li>list | |
| </ul>'; | |
| echo balanceTags($html, true); | |
| ?> | |
| </pre> | |
| Will output this HTML: | |
| <pre> | |
| <ul> | |
| <li>this | |
| </li><li>is | |
| </li><li>a | |
| </li><li>list | |
| </li></ul> | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>balanceTags()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="format_to_edit" d:title="format to edit"> | |
| <d:index d:value="format to edit"/> | |
| <h1>format to edit</h1> | |
| <p>== Description == | |
| Acts on text which is about to be edited. | |
| Unless <tt>$richedit</tt> is set, it is simply a holder for the '<tt>format_to_edit</tt>' filter. If <tt>$richedit</tt> is set true [http://us3.php.net/manual/en/function.htmlspecialchars.php <tt>htmlspecialchars</tt>] will be run on the content, converting special characters to [[wikipedia:HTML|HTML]] entities. | |
| == Usage == | |
| %%%<?php format_to_edit( $content, $richedit ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$content|string|The text about to be edited.}} | |
| {{Parameter|$richedit|boolean|Whether or not the <tt>$content</tt> should pass through [http://us3.php.net/manual/en/function.htmlspecialchars.php <tt>htmlspecialchars</tt>].|optional|false}} | |
| == Return Values == | |
| ; (string) : The text after the filter (and possibly [http://us3.php.net/manual/en/function.htmlspecialchars.php <tt>htmlspecialchars</tt>].) has been run. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>format_to_edit()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="zeroise" d:title="zeroise"> | |
| <d:index d:value="zeroise"/> | |
| <h1>zeroise</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/zeroise}} | |
| {{it|Riferimento funzioni/zeroise}} | |
| }} | |
| == Description == | |
| Add leading zeros when necessary. | |
| If you set the threshold to '<tt>4</tt>' and the number is '<tt>10</tt>', then you will get back '<tt>0010</tt>'. If you set the threshold to '<tt>4</tt>' and the number is '<tt>5000</tt>', then you will get back '<tt>5000</tt>'. | |
| Uses [http://www.php.net/manual/en/function.sprintf.php sprintf] to append the amount of zeros based on the <tt>$threshold</tt> parameter and the size of the number. If the number is large enough, then no zeros will be appended. | |
| == Usage == | |
| %%%<?php zeroise( $number, $threshold ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$number|mixed|Number to append zeros to if not greater than threshold.}} | |
| {{Parameter|$threshold|integer|Digit places number needs to be to not have zeros added.}} | |
| == Return Values == | |
| ; (string) : Adds leading zeros to number if needed. | |
| == Examples == | |
| ===Leading Zeros on Number of Comments=== | |
| This example allows you to add leading zeros to the number of comments (used within the loop). In the particular example shown below, the threshold is set to 2, so single digit numbers will have a zero added, and numbers in the tens and higher will not. For example, 1 will be displayed as 01. | |
| <pre> | |
| <?php | |
| $comno = get_comments_number(); | |
| echo zeroise($comno, 2); | |
| ?> | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>zeroise()</tt> is located in {{Trac|wp-includes/formatting.php|tags/3.4|1289}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="backslashit" d:title="backslashit"> | |
| <d:index d:value="backslashit"/> | |
| <h1>backslashit</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/backslashit}} | |
| {{it|Riferimento funzioni/backslashit}} | |
| {{ja|Function Reference/backslashit}} | |
| }} | |
| == Description == | |
| Adds backslashes before letters and before a number at the start of a string. | |
| == Usage == | |
| %%%<?php backslashit( $string ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|Value to which backslashes will be added.}} | |
| == Return Values == | |
| ; (string) : String with backslashes inserted. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * This: '<tt>\</tt>' is a backslash. | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>backslashit()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="trailingslashit" d:title="trailingslashit"> | |
| <d:index d:value="trailingslashit"/> | |
| <h1>trailingslashit</h1> | |
| <p>== Description == | |
| Appends a trailing slash. | |
| Will remove trailing slash if it exists already before adding a trailing slash. This prevents double slashing a string or path. | |
| The primary use of this is for paths and thus should be used for paths. It is not restricted to paths and offers no specific path support. | |
| == Usage == | |
| %%%<?php trailingslashit( $string ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|What to add the trailing slash to.}} | |
| == Return Values == | |
| ; (string) : String with trailing slash added. | |
| == Examples == | |
| <pre> | |
| <?php | |
| $path = trailingslashit( '/home/julien/bin/dotfiles' ); | |
| ?> | |
| </pre> | |
| $path will now contain: %%%/home/julien/bin/dotfiles/%%% | |
| (Notice the trailing slash) | |
| == Notes == | |
| * Uses: [[Function_Reference/untrailingslashit|<tt>untrailingslashit()</tt>]] Unslashes string if it was slashed already. | |
| * This: '<tt>/</tt>' is a slash. | |
| == Change Log == | |
| Since: 1.2.0 | |
| == Source File == | |
| <tt>trailingslashit()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| [[Function_Reference/untrailingslashit|<tt>untrailingslashit()</tt>]] | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="untrailingslashit" d:title="untrailingslashit"> | |
| <d:index d:value="untrailingslashit"/> | |
| <h1>untrailingslashit</h1> | |
| <p>== Description == | |
| Removes trailing slash if it exists. | |
| The primary use of this is for paths and thus should be used for paths. It is not restricted to paths and offers no specific path support. | |
| == Usage == | |
| %%%<?php untrailingslashit( $string ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|What to remove the trailing slash from.}} | |
| == Return Values == | |
| ; (string) : String without the trailing slash. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * This: '<tt>/</tt>' is a slash. | |
| == Change Log == | |
| Since: 2.2.0 | |
| == Source File == | |
| <tt>untrailingslashit()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| [[Function_Reference/trailingslashit|<tt>trailingslashit()</tt>]] | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="addslashes_gpc" d:title="addslashes gpc"> | |
| <d:index d:value="addslashes gpc"/> | |
| <h1>addslashes gpc</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/addslashes_gpc}} | |
| {{it|Riferimento funzioni/addslashes_gpc}} | |
| }} | |
| == Description == | |
| Adds slashes to escape strings. | |
| Slashes will first be removed if [http://php.net/manual/en/info.configuration.php#ini.magic-quotes-gpc magic-quotes-gpc] is set, see [http://php.net/manual/en/security.magicquotes.php magic_quotes] for more details. | |
| == Usage == | |
| %%%<?php addslashes_gpc( $gpc ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$gpc|string|The string returned from HTTP request data.}} | |
| == Return Values == | |
| ; (string) : Returns a string escaped with slashes. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * In this context, this: '<tt>\</tt>' is a slash. | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>addslashes_gpc()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="antispambot" d:title="antispambot"> | |
| <d:index d:value="antispambot"/> | |
| <h1>antispambot</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/antispambot}} | |
| {{it|Riferimento funzioni/antispambot}} | |
| {{pt-br|Referência de Função/antispambot}} | |
| }} | |
| == Description == | |
| Converts email addresses characters to [[wikipedia:HTML_entities|HTML entities]] to block spam bots. | |
| == Usage == | |
| %%%<?php antispambot( $emailaddy, $hex_encoding ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$emailaddy|string|Email address.}} | |
| {{Parameter|$hex_encoding|integer|0 or 1. Use 0 to only allow decimal encoding (&amp;#123;) and 1 to also allow hex encoding (&amp;x7B;).|optional|0}} | |
| == Return Values == | |
| ; (string) : Converted email address. | |
| == Examples == | |
| <pre> | |
| /** | |
| * Hide email from Spam Bots using a shortcode. | |
| * | |
| * @param array $atts Shortcode attributes. Not used. | |
| * @param string $content The shortcode content. Should be an email address. | |
| * | |
| * @return string The obfuscated email address. | |
| */ | |
| function wpcodex_hide_email_shortcode( $atts , $content = null ) { | |
| if ( ! is_email( $content ) ) { | |
| return; | |
| } | |
| return '<a href="mailto:' . antispambot( $content ) . '">' . antispambot( $content ) . '</a>'; | |
| } | |
| add_shortcode( 'email', 'wpcodex_hide_email_shortcode' ); | |
| </pre> | |
| To use this in your WordPress Content area all you have to do it wrap it in a short code. | |
| <pre> | |
| [email]john.doe@mysite.com[/email] | |
| </pre> | |
| You can also use this in a plain text widget if you add this filter to your function file as well. | |
| <pre> | |
| add_filter( 'widget_text', 'shortcode_unautop' ); | |
| add_filter( 'widget_text', 'do_shortcode' ); | |
| </pre> | |
| === Default Usage === | |
| <pre> | |
| <?php | |
| echo antispambot( 'john.doe@mysite.com' ); | |
| ?> | |
| </pre> | |
| This will output the email like this in the HTML: | |
| <pre> | |
| &amp;#106;&amp;#111;h&amp;#110;&amp;#46;&amp;#100;&amp;#111;&amp;#101;&amp;#64;mysit&amp;#101;.&amp;#99;&amp;#111;&amp;#109; | |
| </pre> | |
| But it will appear as a normal email address to anyone using a web browser: | |
| <pre> | |
| john.doe@mysite.com | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>antispambot()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="make_clickable" d:title="make clickable"> | |
| <d:index d:value="make clickable"/> | |
| <h1>make clickable</h1> | |
| <p>== Description == | |
| Convert plain text [[wikipedia:URI|URI]] to [[wikipedia:HTML|HTML]] links. | |
| Converts URI, www, FTP, and email addresses. Finishes by fixing links within links. | |
| == Usage == | |
| %%%<?php make_clickable( $ret ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$ret|string|Content to convert URIs.}} | |
| == Return Values == | |
| ; (string) : Content with converted URIs. | |
| == Examples == | |
| ===Display all URLs in clickable links=== | |
| <pre> | |
| <?php | |
| $string = "This is a long text that contains some links like http://www.wordpress.org and http://www.wordpress.com ."; | |
| echo make_clickable($string); | |
| ?> | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>make_clickable()</tt> is located in | |
| {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_rel_nofollow" d:title="wp rel nofollow"> | |
| <d:index d:value="wp rel nofollow"/> | |
| <h1>wp rel nofollow</h1> | |
| <p>== Description == | |
| Adds<tt> rel="nofollow"</tt> string to all [[wikipedia:HTML_entities|HTML entities]] <tt>A</tt> elements in content and escapes the content using <tt>esc_sql()</tt>. | |
| Note: this is not appropriate for escaping HTML for output: this function is for adding <tt>nofollow</tt> to content being added to the database. | |
| == Usage == | |
| %%%<?php wp_rel_nofollow( $text ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$text|string|Content that may contain HTML <tt>A</tt> elements.}} | |
| == Return Values == | |
| ; (string) : Converted content, escaped using [[Function Reference/esc_sql|<tt>esc_sql()</tt>]] | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] to escape text. | |
| == Change Log == | |
| * Since: 1.5.0 | |
| == Source File == | |
| <tt>wp_rel_nofollow()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="convert_smilies" d:title="convert smilies"> | |
| <d:index d:value="convert smilies"/> | |
| <h1>convert smilies</h1> | |
| <p>== Description == | |
| Convert text equivalent of smilies to images. | |
| Will only convert smilies if the option '<tt>use_smilies</tt>' is <tt>true</tt> and the globals used in the function aren't empty. | |
| == Usage == | |
| %%%<?php convert_smilies( $text ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$text|string|Content to convert smilies from text.}} | |
| == Return Values == | |
| ; (string) : Converted content with text smilies replaced with images. | |
| == Examples == | |
| <pre> | |
| echo convert_smilies("This smiley is going to show as an image... :) "); | |
| </pre> | |
| == Notes == | |
| * Uses: <tt>$wp_smiliessearch</tt>, <tt>$wp_smiliesreplace</tt> Smiley replacement arrays. | |
| * Uses global: (<tt>array</tt>) <tt>$wp_smiliessearch</tt> | |
| * Uses global: (<tt>array</tt>) <tt>$wp_smiliesreplace</tt> | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>convert_smilies()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| * [[Using_Smilies]] | |
| * [[Glossary#Smileys|Glossary: Smileys]] | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_iso_descrambler" d:title="wp iso descrambler"> | |
| <d:index d:value="wp iso descrambler"/> | |
| <h1>wp iso descrambler</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_iso_descrambler}} | |
| {{it|Riferimento funzioni/wp_iso_descrambler}} | |
| }} | |
| == Description == | |
| Converts an email subject to [[wikipedia:ASCII|ASCII]]. | |
| == Usage == | |
| %%%<?php wp_iso_descrambler( $string ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|Subject line}} | |
| == Return Values == | |
| ; (string) : Converted string to ASCII | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * "iso" seems to refer to the iso-8859-1 character set. | |
| * There is a somewhat related [https://core.trac.wordpress.org/ticket/6788 discussion on WordPress trac] about Swedish encoding. | |
| == Change Log == | |
| Since: [[Version_1.2 | 1.2.0]] | |
| == Source File == | |
| <tt>wp_iso_descrambler()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="popuplinks" d:title="popuplinks"> | |
| <d:index d:value="popuplinks"/> | |
| <h1>popuplinks</h1> | |
| <p>== Description == | |
| Adds <tt> target='_blank' and rel='external'</tt> to all HTML <tt>Anchor</tt> tags to open links in new windows. | |
| Comment text in popup windows should be filtered through this. Right now it's a moderately dumb function, ideally it would detect whether a target or rel attribute was already there and adjust its actions accordingly. | |
| == Usage == | |
| %%%<?php popuplinks( $text ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$text|string|Content to replace links to open in a new window.}} | |
| == Return Values == | |
| ; (string) : Content that has filtered links. | |
| == Examples == | |
| === Default usage=== | |
| <pre> | |
| <?php | |
| echo popuplinks('Please visit <a href="http://www.wordpress.com">WordPress.com</a>.'); | |
| ?> | |
| </pre> | |
| Will output: | |
| <pre> | |
| Please visit <a href="http://www.wordpress.com" target='_blank' rel='external'>WordPress.com</a> | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>popuplinks()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="sanitize_email" d:title="sanitize email"> | |
| <d:index d:value="sanitize email"/> | |
| <h1>sanitize email</h1> | |
| <p>== Description == | |
| Strips out all characters that are not allowable in an email address. | |
| After <code>sanitize_email()</code> has done its work, it passes the sanitized e-mail address through the [[Plugin API/Filter Reference/sanitize_email|sanitize_email]] filter. | |
| == Usage == | |
| %%%<?php sanitize_email( $email ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$email|string|Email address to filter.}} | |
| == Return Values == | |
| ; (string) : Filtered email address. | |
| == Examples == | |
| <pre> | |
| <?php | |
| $sanitized_email = sanitize_email(' admin@example.com! '); | |
| echo $sanitized_email; // will output: 'admin@example.com' | |
| ?> | |
| </pre> | |
| == Notes == | |
| * This function uses a smaller allowable character set than the set defined by [http://tools.ietf.org/html/rfc5322 RFC 5322]. Some legal email addresses may be changed. | |
| * Allowed character regular expression: <code>/[^a-z0-9+_.@-]/i</code>. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <code>sanitize_email()</code> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| === Functions === | |
| {{sanitize functions|sanitize_email()}} | |
| === Filters === | |
| {{sanitize filters|sanitize_email}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="ent2ncr" d:title="ent2ncr"> | |
| <d:index d:value="ent2ncr"/> | |
| <h1>ent2ncr</h1> | |
| <p>== Description == | |
| Converts named entities into numbered entities. | |
| == Usage == | |
| %%%<?php ent2ncr( $text ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$text|string|The text within which entities will be converted.}} | |
| == Return Values == | |
| ; (string) : Text with converted entities. | |
| == Examples == | |
| <pre> | |
| <?php | |
| echo ent2ncr("C&amp;rsquo;est la f&amp;ecirc;te!"); | |
| // this will output: C&amp;#8217;est la f&amp;#234;te! | |
| ?> | |
| </pre> | |
| And you will see: | |
| <pre> | |
| C'est la fête! | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.5.1 | |
| == Source File == | |
| <tt>ent2ncr()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_richedit_pre" d:title="wp richedit pre"> | |
| <d:index d:value="wp richedit pre"/> | |
| <h1>wp richedit pre</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_richedit_pre}} | |
| {{it|Riferimento funzioni/wp_richedit_pre}} | |
| }} | |
| == Description == | |
| Formats text for the rich text editor. | |
| The filter '<tt>richedit_pre</tt>' is applied here. If <tt>$text</tt> is empty the filter will be applied to an empty string. | |
| == Usage == | |
| %%%<?php wp_richedit_pre( $text ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$text|string|The text to be formatted.}} | |
| == Return Values == | |
| ; (string) : The formatted text after filter is applied. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <tt>wp_richedit_pre()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="clean_url" d:title="clean url"> | |
| <d:index d:value="clean url"/> | |
| <h1>clean url</h1> | |
| <p>{{Deprecated}} | |
| Use [[Function_Reference/esc_url|esc_url()]] instead. Usage is described [[Data_Validation#URLs|here]]. | |
| == Description == | |
| Checks and cleans a URL. | |
| A number of characters are removed from the URL. If the URL is for displaying (the default behaviour) ampersands (<tt>&</tt>) are also replaced. The '<tt>clean_url</tt>' filter is applied to the returned cleaned URL. | |
| == Usage == | |
| %%%<?php clean_url( $url, $protocols, $context ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$url|string|The URL to be cleaned.}} | |
| {{Parameter|$protocols|array|An array of acceptable protocols. Defaults to '<tt>http</tt>', '<tt>https</tt>', '<tt>ftp</tt>', '<tt>ftps</tt>', '<tt>mailto</tt>', '<tt>news</tt>', '<tt>irc</tt>', '<tt>gopher</tt>', '<tt>nntp</tt>', '<tt>feed</tt>', '<tt>telnet</tt>' if not set.|optional|null}} | |
| {{Parameter|$context|string|How the URL will be used. Default is '<tt>display</tt>'.|optional|'display'}} | |
| == Return Values == | |
| ; (string) : The cleaned <tt>$url</tt> after the '<tt>cleaned_url</tt>' filter is applied. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/wp_kses_bad_protocol|<tt>wp_kses_bad_protocol()</tt>]] to only permit protocols in the URL set via <tt>$protocols</tt> or the common ones set in the function. | |
| == Changelog == | |
| * Deprecated: [[Version 3.0|3.0.0]] use [[Function_Reference/esc_url|esc_url()]] | |
| * Since: 1.2.0 | |
| == Source File == | |
| <tt>clean_url()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| * [[Data Validation]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="htmlentities2" d:title="htmlentities2"> | |
| <d:index d:value="htmlentities2"/> | |
| <h1>htmlentities2</h1> | |
| <p>== Description == | |
| Convert entities, while preserving already-encoded entities. | |
| == Usage == | |
| %%%<?php htmlentities2( $myHTML ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$myHTML|string|The text to be converted.}} | |
| == Return Values == | |
| ; (string) : Converted text. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * See Also: [http://www.php.net/htmlentities Borrowed from the PHP Manual user notes.] | |
| == Change Log == | |
| Since: 1.2.2 | |
| == Source File == | |
| <tt>htmlentities2()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="js_escape" d:title="js escape"> | |
| <d:index d:value="js escape"/> | |
| <h1>js escape</h1> | |
| <p>{{Deprecated}} | |
| == Description == | |
| Escape single quotes. Convert double quotes. Fix line endings. | |
| The filter '<tt>js_escape</tt>' is also applied here. | |
| <tt>js_escape</tt> has been deprecated since 2.8. Use <tt>[[Data_Validation#JavaScript|esc_js]]</tt> instead. | |
| == Usage == | |
| %%%<?php js_escape( $text ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$text|string|The text to be escaped.}} | |
| == Return Values == | |
| ; (string) : Escaped text. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/wp_specialchars|<tt>wp_specialchars()</tt>]] for double quote conversion. | |
| == Change Log == | |
| Since: 2.0.4 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>js_escape()</tt> is located in <tt>wp-includes/formatting.php</tt>. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_make_link_relative" d:title="wp make link relative"> | |
| <d:index d:value="wp make link relative"/> | |
| <h1>wp make link relative</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_make_link_relative}} | |
| {{it|Riferimento funzioni/wp_make_link_relative}} | |
| }} | |
| == Description == | |
| Convert full URL paths to relative paths. | |
| Removes the http or https protocols and the domain. Keeps the path '/' at the beginning, so it isn't a true relative link, but from the web root base. | |
| == Usage == | |
| %%%<?php wp_make_link_relative( $link ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$link|string|Full URL path.}} | |
| == Return Values == | |
| ; (string) : Absolute path. | |
| == Examples == | |
| ===Default usage=== | |
| <pre> | |
| <?php | |
| echo wp_make_link_relative('http://localhost/wp_test/sample-page/'); | |
| ?> | |
| </pre> | |
| This should output the following URL: | |
| <pre> | |
| /wp_test/sample-page/ | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>wp_make_link_relative()</tt> is located in {{Trac|wp-includes/formatting.php|tags/3.4|2695}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="add_magic_quotes" d:title="add magic quotes"> | |
| <d:index d:value="add magic quotes"/> | |
| <h1>add magic quotes</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/add_magic_quotes}} | |
| {{it|Riferimento funzioni/add_magic_quotes}} | |
| }} | |
| == Description == | |
| Walks an array while sanitizing the contents. | |
| == Usage == | |
| %%%<?php add_magic_quotes( $array ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$array|array|Array to walk while sanitizing contents.}} | |
| == Return Values == | |
| {{it:Return||array|Sanitized <tt>$array</tt>.}} | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] to sanitize values | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>add_magic_quotes()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_hook" d:title="wp kses hook"> | |
| <d:index d:value="wp kses hook"/> | |
| <h1>wp kses hook</h1> | |
| <p>== Description == | |
| You add any [http://sourceforge.net/projects/kses <tt>kses</tt>] hooks here. | |
| There is currently only one [http://sourceforge.net/projects/kses <tt>kses</tt>] WordPress hook and it is called here. All parameters are passed to the hooks and expected to recieve a string. | |
| == Usage == | |
| %%%<?php wp_kses_hook( $string, $allowed_html, $allowed_protocols ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|Content to filter through [http://sourceforge.net/projects/kses <tt>kses</tt>]}} | |
| {{Parameter|$allowed_html|array|List of allowed HTML elements}} | |
| {{Parameter|$allowed_protocols|array|Allowed protocol in links}} | |
| == Return Values == | |
| ; (string) : Filtered content through '<tt>pre_kses</tt>' hook | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_hook()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_split" d:title="wp kses split"> | |
| <d:index d:value="wp kses split"/> | |
| <h1>wp kses split</h1> | |
| <p>== Description == | |
| Searches for HTML tags, no matter how malformed. | |
| It also matches stray ">" characters. | |
| == Usage == | |
| %%%<?php wp_kses_split( $string, $allowed_html, $allowed_protocols ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|Content to filter}} | |
| {{Parameter|$allowed_html|array|Allowed HTML elements}} | |
| {{Parameter|$allowed_protocols|array|Allowed protocols to keep}} | |
| == Return Values == | |
| ; (string) : Content with fixed HTML tags | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/wp_kses_split2|<tt>wp_kses_split2()</tt>]] as a callback to do much of the work. | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_split()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_split2" d:title="wp kses split2"> | |
| <d:index d:value="wp kses split2"/> | |
| <h1>wp kses split2</h1> | |
| <p>== Description == | |
| Callback for [[Function_Reference/wp_kses_split|<tt>wp_kses_split()</tt>]] for fixing malformed HTML tags. | |
| This function does a lot of work. It rejects some very malformed things like <tt><nowiki><:::></nowiki></tt>. It returns an empty string, if the element isn't allowed (look ma, no <tt>strip_tags()</tt>!). Otherwise it splits the tag into an element and an attribute list. | |
| After the tag is split into an element and an attribute list, it is run through another filter which will remove illegal attributes and once that is completed, will be returned. | |
| == Usage == | |
| %%%<?php wp_kses_split2( $string, $allowed_html, $allowed_protocols ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|Content to filter}} | |
| {{Parameter|$allowed_html|array|Allowed HTML elements}} | |
| {{Parameter|$allowed_protocols|array|Allowed protocols to keep}} | |
| == Return Values == | |
| ; (string) : Fixed HTML element | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * <strong>This is a private function. It should not be called directly. It is listed in the Codex for completeness.</strong> | |
| * Uses: [[Function_Reference/wp_kses_attr|<tt>wp_kses_attr()</tt>]] | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_split2()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_attr" d:title="wp kses attr"> | |
| <d:index d:value="wp kses attr"/> | |
| <h1>wp kses attr</h1> | |
| <p>== Description == | |
| Removes all attributes, if none are allowed for this element. | |
| If some are allowed it calls [[Function_Reference/wp_kses_hair|<tt>wp_kses_hair()</tt>]] to split them further, and then it builds up new [[wikipedia:HTML|HTML]] code from the data that [[Function_Reference/wp_kses_hair|<tt>wp_kses_hair()</tt>]] returns. It also removes '<tt>&lt;</tt>' and '<tt>&gt;</tt>' characters, if there are any left. One more thing it does is to check if the tag has a closing XHTML slash, and if it does, it puts one in the returned code as well. | |
| == Usage == | |
| %%%<?php wp_kses_attr( $element, $attr, $allowed_html, $allowed_protocols ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$element|string|[[wikipedia:HTML|HTML]] element/tag}} | |
| {{Parameter|$attr|string|[[wikipedia:HTML|HTML]] attributes from HTML element to closing HTML element tag}} | |
| {{Parameter|$allowed_html|array|Allowed [[wikipedia:HTML|HTML]] elements}} | |
| {{Parameter|$allowed_protocols|array|Allowed protocols to keep}} | |
| == Return Values == | |
| ; (string) : Sanitized [[wikipedia:HTML|HTML]] element | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_attr()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_hair" d:title="wp kses hair"> | |
| <d:index d:value="wp kses hair"/> | |
| <h1>wp kses hair</h1> | |
| <p>== Description == | |
| Builds an attribute list from string containing attributes. | |
| This function does a lot of work. It parses an attribute list into an array with attribute data, and tries to do the right thing even if it gets weird input. It will add quotes around attribute values that don't have any quotes or apostrophes around them, to make it easier to produce [[wikipedia:HTML|HTML]] code that will conform to W3C's HTML specification. It will also remove bad URL protocols from attribute values. It also reduces duplicate attributes by using the attribute defined first (foo='<tt>bar</tt>' foo='<tt>baz</tt>' will result in foo='<tt>bar</tt>'). | |
| == Usage == | |
| %%%<?php wp_kses_hair( $attr, $allowed_protocols ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$attr|string|Attribute list from [[wikipedia:HTML|HTML]] element to closing HTML element tag}} | |
| {{Parameter|$allowed_protocols|array|Allowed protocols to keep}} | |
| == Return Values == | |
| ; (array) : List of attributes after parsing | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_hair()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_check_attr_val" d:title="wp kses check attr val"> | |
| <d:index d:value="wp kses check attr val"/> | |
| <h1>wp kses check attr val</h1> | |
| <p>== Description == | |
| Performs different checks for attribute values. | |
| The currently implemented checks are '<tt>maxlen</tt>', '<tt>minlen</tt>', '<tt>maxval</tt>', '<tt>minval</tt>' and '<tt>valueless</tt>' with even more checks to come soon. | |
| == Usage == | |
| %%%<?php wp_kses_check_attr_val( $value, $vless, $checkname, $checkvalue ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$value|string|Attribute value}} | |
| {{Parameter|$vless|string|Whether the value is valueless or not. Use '<tt>y</tt>' or '<tt>n</tt>'}} | |
| {{Parameter|$checkname|string|What <tt>$checkvalue</tt> is checking for.}} | |
| {{Parameter|$checkvalue|mixed|What constraint the value should pass}} | |
| == Return Values == | |
| ; (boolean) : Whether check passes (true) or not (false) | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_check_attr_val()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_bad_protocol" d:title="wp kses bad protocol"> | |
| <d:index d:value="wp kses bad protocol"/> | |
| <h1>wp kses bad protocol</h1> | |
| <p>== Description == | |
| Sanitize string from bad protocols. | |
| This function removes all non-allowed protocols from the beginning of <tt>$string</tt>. It ignores whitespace and the case of the letters, and it does understand [[wikipedia:HTML|HTML]] entities. It does its work in a while loop, so it won't be fooled by a string like '<tt>javascript:javascript:alert(57)</tt>'. | |
| == Usage == | |
| %%%<?php wp_kses_bad_protocol( $string, $allowed_protocols ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|Content to filter bad protocols from}} | |
| {{Parameter|$allowed_protocols|array|Allowed protocols to keep}} | |
| == Return Values == | |
| ; (string) : Filtered content | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_bad_protocol()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_no_null" d:title="wp kses no null"> | |
| <d:index d:value="wp kses no null"/> | |
| <h1>wp kses no null</h1> | |
| <p>== Description == | |
| Removes any NULL characters in <tt>$string</tt>. | |
| == Usage == | |
| %%%<?php wp_kses_no_null( $string ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|}} | |
| == Return Values == | |
| ; (string) : | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_no_null()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_stripslashes" d:title="wp kses stripslashes"> | |
| <d:index d:value="wp kses stripslashes"/> | |
| <h1>wp kses stripslashes</h1> | |
| <p>== Description == | |
| Strips slashes from in front of quotes. | |
| This function changes the character sequence <tt>\"</tt> to just <tt>"</tt>. It leaves all other slashes alone. It's really weird, but the quoting from preg_replace(//e) seems to require this. | |
| == Usage == | |
| %%%<?php wp_kses_stripslashes( $string ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|String to strip slashes}} | |
| == Return Values == | |
| ; (string) : Fixed strings with quoted slashes | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_stripslashes()</tt> is located in <tt>{{Trac|wp-includes/kses.php}}</tt>. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_array_lc" d:title="wp kses array lc"> | |
| <d:index d:value="wp kses array lc"/> | |
| <h1>wp kses array lc</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_kses_array_lc}} | |
| {{it|Riferimento funzioni/wp_kses_array_lc}} | |
| }} | |
| == Description == | |
| Goes through an array and changes the keys to all lower case. | |
| == Usage == | |
| %%%<?php wp_kses_array_lc( $inarray ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$inarray|array|Unfiltered array}} | |
| == Return Values == | |
| ; (array) : Fixed array with all lowercase keys | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * This function expects a multi-dimensional array for input. | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_array_lc()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_js_entities" d:title="wp kses js entities"> | |
| <d:index d:value="wp kses js entities"/> | |
| <h1>wp kses js entities</h1> | |
| <p>== Description == | |
| Removes the [[wikipedia:HTML|HTML]] JavaScript entities found in early versions of Netscape 4. | |
| == Usage == | |
| %%%<?php wp_kses_js_entities( $string ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|}} | |
| == Return Values == | |
| ; (string) : | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_js_entities()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_html_error" d:title="wp kses html error"> | |
| <d:index d:value="wp kses html error"/> | |
| <h1>wp kses html error</h1> | |
| <p>== Description == | |
| Handles parsing errors in [[Function_Reference/wp_kses_hair|<tt>wp_kses_hair()</tt>]]. | |
| The general plan is to remove everything to and including some whitespace, but it deals with quotes and apostrophes as well. | |
| == Usage == | |
| %%%<?php wp_kses_html_error( $string ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|}} | |
| == Return Values == | |
| ; (string) : | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_html_error()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_bad_protocol_once" d:title="wp kses bad protocol once"> | |
| <d:index d:value="wp kses bad protocol once"/> | |
| <h1>wp kses bad protocol once</h1> | |
| <p>== Description == | |
| Sanitizes content from bad protocols and other characters. | |
| This function searches for URL protocols at the beginning of <tt>$string</tt>, while handling whitespace and [[wikipedia:HTML|HTML]] entities. | |
| == Usage == | |
| %%%<?php wp_kses_bad_protocol_once( $string, $allowed_protocols ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|Content to check for bad protocols}} | |
| {{Parameter|$allowed_protocols|string|Allowed protocols}} | |
| == Return Values == | |
| ; (string) : Sanitized content | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_bad_protocol_once()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_bad_protocol_once2" d:title="wp kses bad protocol once2"> | |
| <d:index d:value="wp kses bad protocol once2"/> | |
| <h1>wp kses bad protocol once2</h1> | |
| <p>== Description == | |
| Callback for [[Function_Reference/wp_kses_bad_protocol_once|<tt>wp_kses_bad_protocol_once()</tt>]] regular expression. | |
| This function processes URL protocols, checks to see if they're in the white-list or not, and returns different data depending on the answer. | |
| == Usage == | |
| %%%<?php wp_kses_bad_protocol_once2( $matches, $allowed_protocols ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$matches|$string|URI scheme to check against the whitelist}} | |
| {{Parameter|$allowed_protocols|$string|Allowed protocols}} | |
| == Return Values == | |
| {{Return||string|Sanitized content}} | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * <strong>This is a private function. It should not be called directly. It is listed in the Codex for completeness.</strong> | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_bad_protocol_once2()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_normalize_entities" d:title="wp kses normalize entities"> | |
| <d:index d:value="wp kses normalize entities"/> | |
| <h1>wp kses normalize entities</h1> | |
| <p>== Description == | |
| Converts and fixes [[wikipedia:HTML_entities|HTML entities]]. | |
| This function normalizes HTML entities. It will convert 'AT&T' to the correct 'AT&amp;amp;T', '&amp;#00058;' to '&amp;#58;', '&amp;#XYZZY;' to '&amp;amp;#XYZZY;' and so on. | |
| == Usage == | |
| %%%<?php wp_kses_normalize_entities( $string ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|Content to normalize entities}} | |
| == Return Values == | |
| ; (string) : Content with normalized entities | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_normalize_entities()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_normalize_entities2" d:title="wp kses normalize entities2"> | |
| <d:index d:value="wp kses normalize entities2"/> | |
| <h1>wp kses normalize entities2</h1> | |
| <p>== Description == | |
| Callback for [[Function_Reference/wp_kses_normalize_entities|<tt>wp_kses_normalize_entities()</tt>]] regular expression. | |
| This function helps [[Function_Reference/wp_kses_normalize_entities|<tt>wp_kses_normalize_entities()</tt>]] to only accept 16 bit values and nothing more for <tt>&#number;</tt> entities. | |
| == Usage == | |
| %%%<?php wp_kses_normalize_entities2( $matches ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$matches|array|[http://www.php.net/manual/en/function.preg-replace-callback.php <tt>preg_replace_callback()</tt>] matches array}} | |
| == Return Values == | |
| ; (string) : Correctly encoded entity | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * <strong>This is a private function. It should not be called directly. It is listed in the Codex for completeness.</strong> | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_normalize_entities2()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_decode_entities" d:title="wp kses decode entities"> | |
| <d:index d:value="wp kses decode entities"/> | |
| <h1>wp kses decode entities</h1> | |
| <p>== Description == | |
| Convert all entities to their character counterparts. | |
| This function decodes numeric [[wikipedia:HTML_entities|HTML entities]] (like <tt>&amp;#65;</tt> and <tt>&amp;#x41;</tt>). It doesn't do anything with other entities like <tt>&amp;auml;</tt>, but we don't need them in the URL protocol whitelisting system anyway. | |
| == Usage == | |
| %%%<?php wp_kses_decode_entities( $string ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$string|string|Content to change entities}} | |
| == Return Values == | |
| ; (string) : Content after decoded entities | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_decode_entities()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_filter_kses" d:title="wp filter kses"> | |
| <d:index d:value="wp filter kses"/> | |
| <h1>wp filter kses</h1> | |
| <p>== Description == | |
| Sanitize content with allowed [[wikipedia:HTML|HTML]] [http://sourceforge.net/projects/kses Kses] rules. | |
| <tt>wp_filter_kses</tt> should generally be preferred over <tt>wp_kses_data</tt> because <tt>wp_magic_quotes</tt> escapes <tt>$_GET</tt>, <tt>$_POST</tt>, <tt>$_COOKIE</tt>, <tt>$_SERVER</tt>, and <tt>$_REQUEST</tt> fairly early in the hook system, shortly after 'plugins_loaded' but earlier then 'init' or 'wp_loaded'. | |
| == Usage == | |
| %%%<?php wp_filter_kses( $data ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$data|string|Content to filter}} | |
| == Return Values == | |
| ; (string) : Filtered content | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>unknown</tt>) <tt>$allowedtags</tt> | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_filter_kses()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_filter_post_kses" d:title="wp filter post kses"> | |
| <d:index d:value="wp filter post kses"/> | |
| <h1>wp filter post kses</h1> | |
| <p>== Description == | |
| Sanitize content for allowed [[wikipedia:HTML|HTML]] tags for post content. | |
| Post content refers to the page contents of the '<tt>post</tt>' type and not <tt>$_POST</tt> data from forms. | |
| KSES seems to stand for "kses strips evil scripts!". | |
| == Usage == | |
| %%%<?php wp_filter_post_kses( $data ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$data|string|Post content to filter}} | |
| == Return Values == | |
| ; (string) : Filtered post content with allowed [[wikipedia:HTML|HTML]] tags and attributes intact. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>unknown</tt>) <tt>$allowedposttags</tt> | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>wp_filter_post_kses()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_filter_nohtml_kses" d:title="wp filter nohtml kses"> | |
| <d:index d:value="wp filter nohtml kses"/> | |
| <h1>wp filter nohtml kses</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_filter_nohtml_kses}} | |
| {{it|Riferimento funzioni/wp_filter_nohtml_kses}} | |
| }} | |
| == Description == | |
| Strips all of the [[wikipedia:HTML|HTML]] in the content. | |
| == Usage == | |
| %%%<?php wp_filter_nohtml_kses( $data ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$data|string|Content to strip all [[wikipedia:HTML|HTML]] from}} | |
| == Return Values == | |
| ; (string) : Filtered content without any [[wikipedia:HTML|HTML]] | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>wp_filter_nohtml_kses()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_term_children" d:title="get term children"> | |
| <d:index d:value="get term children"/> | |
| <h1>get term children</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/get term children}} | |
| {{ja|関数リファレンス/get term children}} | |
| }} | |
| == Description == | |
| Merge all term children into a single array. | |
| This recursive function will merge all of the children of <tt>$term</tt> into the same array. Only useful for taxonomies which are hierarchical. | |
| Will return an empty array if <tt>$term</tt> does not exist in <tt>$taxonomy</tt>. | |
| == Usage == | |
| %%%<?php get_term_children( $term, $taxonomy ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$term|string|ID of Term to get children}} | |
| {{Parameter|$taxonomy|string|Taxonomy Name}} | |
| == Return Values == | |
| ; (array&#124;WP_Error) : Array of Term IDs. WP_Error returned if <tt>$taxonomy</tt> does not exist | |
| == Examples == | |
| === A Basic Example === | |
| Used to get an array of children taxonomies and write them out with links in an unordered list. | |
| <pre><nowiki><?php | |
| $term_id = 10; | |
| $taxonomy_name = 'products'; | |
| $termchildren = get_term_children( $term_id, $taxonomy_name ); | |
| echo '<ul>'; | |
| foreach ( $termchildren as $child ) { | |
| $term = get_term_by( 'id', $child, $taxonomy_name ); | |
| echo '<li><a href="' . get_term_link( $child, $taxonomy_name ) . '">' . $term->name . '</a></li>'; | |
| } | |
| echo '</ul>'; | |
| ?> </nowiki></pre> | |
| This would return something like. | |
| <pre><nowiki><ul> | |
| <li><a href="link_to_term_page">Term 1</a></li> | |
| <li><a href="link_to_term_page">Term 2</a></li> | |
| </ul></nowiki></pre> | |
| == Notes == | |
| * Uses: [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| * Uses: [[Function_Reference/_get_term_hierarchy|<tt>_get_term_hierarchy()</tt>]] | |
| * Uses: get_term_children Used to get the children of both <tt>$taxonomy</tt> and the parent <tt>$term</tt> | |
| == Change Log == | |
| Since: 2.3.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_term_children()</tt> is located in {{Trac|wp-includes/taxonomy.php}}. | |
| == Related == | |
| {{Term Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="previous_comments_link" d:title="previous comments link"> | |
| <d:index d:value="previous comments link"/> | |
| <h1>previous comments link</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/previous_comments_link}} | |
| {{it|Riferimento funzioni/previous_comments_link}} | |
| }} | |
| == Description == | |
| Display the previous comments page link. | |
| == Usage == | |
| %%%<?php previous_comments_link( $label ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$label|string|Label for comments link text.|optional|&#39;&#39;}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 2.7.0 | |
| == Source File == | |
| <tt>previous_comments_link()</tt> is located in {{Trac|wp-includes/link-template.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="format_to_post" d:title="format to post"> | |
| <d:index d:value="format to post"/> | |
| <h1>format to post</h1> | |
| <p>{{Deprecated}} | |
| == Description == | |
| Holder for the '<tt>format_to_post</tt>' filter. Deprecated in [[Version_3.9|3.9.0]]. Use [[Class_Reference/wpdb|wpdb::prepare()]] instead. | |
| == Usage == | |
| %%%<?php format_to_post( $content ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$content|string|The text to pass through the filter.}} | |
| == Return Values == | |
| ; (string) : Text returned from the '<tt>format_to_post</tt>' filter. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| * Since: [[Version_0.71|0.71]] | |
| * Deprecated: [[Version_3.9|3.9.0]] | |
| == Source File == | |
| <tt>format_to_post()</tt> is located in {{Trac|wp-includes/formatting.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_kses_version" d:title="wp kses version"> | |
| <d:index d:value="wp kses version"/> | |
| <h1>wp kses version</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/wp_kses_version}} | |
| {{it|Riferimento funzioni/wp_kses_version}} | |
| }} | |
| == Description == | |
| This function returns the [http://sourceforge.net/projects/kses <tt>kses</tt>] version number. | |
| == Usage == | |
| %%%<?php wp_kses_version() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : [http://sourceforge.net/projects/kses <tt>KSES</tt>] Version Number | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <tt>wp_kses_version()</tt> is located in {{Trac|wp-includes/kses.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="maybe_serialize" d:title="maybe serialize"> | |
| <d:index d:value="maybe serialize"/> | |
| <h1>maybe serialize</h1> | |
| <p>== Description == | |
| [http://php.net/manual/en/function.serialize.php Serialize] data, if needed. | |
| == Usage == | |
| %%%<?php maybe_serialize( $data ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$data|mixed|Data that might be serialized.}} | |
| == Return Values == | |
| ; (mixed) : A scalar data | |
| == Examples == | |
| <pre> | |
| <?php | |
| // Strings are returned untouched. | |
| $data = 'Hello World!'; | |
| echo maybe_serialize( $data ); | |
| // Hello World! | |
| // Integers, floats and boolean values are also returned untouched. | |
| $data = 55; | |
| echo maybe_serialize( $data ); | |
| // 55 | |
| $data = 4.560 | |
| echo maybe_serialize( $data ); | |
| // 4.560 | |
| $data = true; | |
| $data = maybe_serialize( $data ); | |
| // $data = true; | |
| $data = null; | |
| $data = maybe_serialize( $data ); | |
| // $data = null | |
| // An array or object will be returned as a serialized string. | |
| $data = array( 1 => 'Hello World!', 'foo' => 'bar' ); | |
| echo maybe_serialize( $data ); | |
| // a:2:{i:1;s:12:"Hello World!";s:3:"foo";s:3:"bar";} | |
| // A serialized string will be serialized again. | |
| $data = 'a:2:{i:1;s:12:"Hello World!";s:3:"foo";s:3:"bar";}'; | |
| echo maybe_serialize( $data ); | |
| // s:50:"a:2:{i:1;s:12:"Hello World!";s:3:"foo";s:3:"bar";}"; | |
| ?> | |
| </pre> | |
| == Notes == | |
| * Data might need to be <i>serialized</i> to allow it to be successfully stored and retrieved from a database in a form that PHP can understand. | |
| * Confusingly, strings that contain already serialized values are serialized again, resulting in a nested serialization. Other strings are unmodified. | |
| A possible solution to prevent nested serialization is to check if a variable is serialized using %%%<?php if(!is_serialized( $data )) { $data = maybe_serialize($data); } ?>%%% | |
| More info at [[Function_Reference/is_serialized | is_serialized()]]. | |
| == Change Log == | |
| Since: 2.0.5 | |
| == Source File == | |
| <tt>maybe_serialize()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="maybe_unserialize" d:title="maybe unserialize"> | |
| <d:index d:value="maybe unserialize"/> | |
| <h1>maybe unserialize</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/maybe_unserialize}} | |
| {{it|Riferimento funzioni/maybe_unserialize}} | |
| }} | |
| == Description == | |
| Unserialize value only if it was serialized. | |
| == Usage == | |
| %%%<?php maybe_unserialize( $original ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$original|string|Maybe unserialized original, if is needed.}} | |
| == Return Values == | |
| {{Return||mixed|Unserialized data can be any type.}} | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Data might need to be <i>serialized</i> to allow it to be successfully stored and retrieved from a database in a form that PHP can understand. | |
| == Change Log == | |
| Since: 2.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>maybe_unserialize()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="is_serialized" d:title="is serialized"> | |
| <d:index d:value="is serialized"/> | |
| <h1>is serialized</h1> | |
| <p>== Description == | |
| Check value to find if it was serialized. | |
| If <tt>$data</tt> is not a string, then returned value will always be false. Serialized data is always a string. | |
| == Usage == | |
| %%%<?php is_serialized( $data ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$data|mixed|Value to check to see if was serialized.}} | |
| == Return Values == | |
| ; (boolean) : False if not serialized and true if it was. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Data might need to be <i>serialized</i> to allow it to be successfully stored and retrieved from a database in a form that PHP can understand. | |
| == Change Log == | |
| Since: 2.0.5 | |
| == Source File == | |
| <tt>is_serialized()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Conditional Tags]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="is_serialized_string" d:title="is serialized string"> | |
| <d:index d:value="is serialized string"/> | |
| <h1>is serialized string</h1> | |
| <p>== Description == | |
| Check whether serialized data is of string type. | |
| == Usage == | |
| %%%<?php is_serialized_string( $data ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$data|mixed|Serialized data}} | |
| == Return Values == | |
| ; (boolean) : False if not a serialized string, true if it is. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Data might need to be <i>serialized</i> to allow it to be successfully stored and retrieved from a database in a form that PHP can understand. | |
| == Change Log == | |
| Since: 2.0.5 | |
| == Source File == | |
| <tt>is_serialized_string()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:Conditional Tags]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_alloptions" d:title="get alloptions"> | |
| <d:index d:value="get alloptions"/> | |
| <h1>get alloptions</h1> | |
| <p>{{Deprecated}} | |
| Deprecated since WordPress 3.0, use [[Function_Reference/wp_load_alloptions| wp_load_alloptions()]] instead. | |
| == Description == | |
| Retrieve all autoload options or all options, if no autoloaded ones exist. | |
| This is different from [[Function_Reference/wp_load_alloptions|<tt>wp_load_alloptions()</tt>]] in that this function does not cache its results and will retrieve all options from the database every time it is called. | |
| == Usage == | |
| %%%<?php get_alloptions() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (array) : List of all options. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>pre_option_$optionname</tt>' hook with option value as parameter. | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>all_options</tt>' on options list. | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] | |
| == Change Log == | |
| Since: 1.0.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>get_alloptions()</tt> is located in <tt>wp-includes/functions.php</tt>. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="get_user_option" d:title="get user option"> | |
| <d:index d:value="get user option"/> | |
| <h1>get user option</h1> | |
| <p>== Description == | |
| Retrieve user option that can be either per Site or per Network. | |
| If the user ID is not given, then the current user will be used instead. The filter for the result will also pass the original option name and finally the user data object as the third parameter. | |
| The function will first check for the site-specific user metadata, then the network-wide user metadata. The option can either be modified or set by a plugin. | |
| == Usage == | |
| %%%<?php get_user_option( $option, $user ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$option|string|User option name.}} | |
| {{Parameter|$user|integer|User ID. If not given, the current user will be used.|optional|0}} | |
| {{Parameter|$deprecated|string|This parameter is no longer used. Setting it will generate a deprecated argument notice.|optional|Empty string}} | |
| == Return Values == | |
| ; (mixed) : Option value on success, false on failure | |
| == Examples == | |
| <pre> | |
| <?php | |
| $bar = get_user_option( 'show_admin_bar_front', get_current_user_id() ); | |
| if ( $bar == 'true' ) { | |
| echo 'The admin bar is enabled'; | |
| } else { | |
| echo 'The admin bar is disabled'; | |
| } | |
| ?> | |
| </pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls <tt>'get_user_option_$option'</tt> hook with result, option parameter, and user data object. | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] WordPress database object for queries. | |
| == Change Log == | |
| * [[Version_3.0|3.0.0]] - The <tt>$check_blog_options</tt> parameter was deprecated, and the function no longer checks the options table if the option isn't found in <tt>[[Database_Description#Table:_wp_usermeta | wp_usermeta]]</tt>. See [https://core.trac.wordpress.org/ticket/11615 #11615]. | |
| * Since: [[Version_2.0|2.0.0]] | |
| == Source File == | |
| <tt>get_user_option()</tt> is located in {{Trac|wp-includes/user.php}}. | |
| == Related == | |
| {{User_Meta_Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="update_user_option" d:title="update user option"> | |
| <d:index d:value="update user option"/> | |
| <h1>update user option</h1> | |
| <p>== Description == | |
| Update a user option that can be either per Site or per Network. | |
| User options are just like user metadata except that they have support for blog-specific options when using multisite. If the <tt>$global</tt> parameter is <tt>false</tt>, which it is by default, it will prepend the WordPress table prefix to the option name. | |
| == Usage == | |
| %%%<?php update_user_option( $user_id, $option_name, $newvalue, $global ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$user_id|integer|User ID}} | |
| {{Parameter|$option_name|string|User option name.}} | |
| {{Parameter|$newvalue|mixed|User option value.}} | |
| {{Parameter|$global|boolean|Whether option name is blog specific or not.|optional|false}} | |
| == Return Values == | |
| ; (boolean) : Whether the update was successful | |
| == Examples == | |
| Hide the admin bar for a user on the front end of the site: | |
| <pre> | |
| update_user_option( $user_id, 'show_admin_bar_front', false ); | |
| </pre> | |
| When multisite is installed, the <tt>$global</tt> parameter can be used to set the user option for the whole network, instead of just the current site: | |
| <pre> | |
| update_user_option( $user_id, 'show_admin_bar_front', false, true ); | |
| </pre> | |
| == Notes == | |
| * Uses global: (<tt>object</tt>) [[Class Reference/wpdb|<tt>$wpdb</tt>]] WordPress database object for queries. | |
| == Change Log == | |
| * Since: [[Version 2.0|2.0]] | |
| == Source File == | |
| <tt>update_user_option()</tt> is located in {{Trac|wp-includes/user.php}}. | |
| == Related == | |
| {{User_Meta_Tags}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="xmlrpc_getposttitle" d:title="xmlrpc getposttitle"> | |
| <d:index d:value="xmlrpc getposttitle"/> | |
| <h1>xmlrpc getposttitle</h1> | |
| <p>== Description == | |
| Retrieve post title from [[XML-RPC_Support|XMLRPC]] XML. | |
| If the title element is not part of the XML, then the default post title from the <tt>$post_default_title</tt> will be used instead. | |
| == Usage == | |
| %%%<?php xmlrpc_getposttitle( $content ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$content|string|[[XML-RPC_Support|XMLRPC]] XML Request content}} | |
| == Return Values == | |
| ; (string) : Post title | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>string</tt>) <tt>$post_default_title</tt> | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>xmlrpc_getposttitle()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="xmlrpc_getpostcategory" d:title="xmlrpc getpostcategory"> | |
| <d:index d:value="xmlrpc getpostcategory"/> | |
| <h1>xmlrpc getpostcategory</h1> | |
| <p>== Description == | |
| Retrieve the post category or categories from [[XML-RPC_Support|XMLRPC]] XML. | |
| If the category element is not found, then the default post category will be used. The return type then would be what <tt>$post_default_category</tt>. If the category is found, then it will always be an array. | |
| == Usage == | |
| %%%<?php xmlrpc_getpostcategory( $content ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$content|string|[[XML-RPC_Support|XMLRPC]] XML Request content}} | |
| == Return Values == | |
| ; (string&#124;array) : List of categories or category name. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>unknown</tt>) <tt>$post_default_category</tt> | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>xmlrpc_getpostcategory()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="xmlrpc_removepostdata" d:title="xmlrpc removepostdata"> | |
| <d:index d:value="xmlrpc removepostdata"/> | |
| <h1>xmlrpc removepostdata</h1> | |
| <p>== Description == | |
| [[XML-RPC_Support|XMLRPC]] XML content without title and category elements. | |
| == Usage == | |
| %%%<?php xmlrpc_removepostdata( $content ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$content|string|[[XML-RPC_Support|XMLRPC]] XML Request content}} | |
| == Return Values == | |
| ; (string) : [[XML-RPC_Support|XMLRPC]] XML Request content without title and category elements. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| == Change Log == | |
| Since: 0.71 | |
| == Source File == | |
| <tt>xmlrpc_removepostdata()</tt> is located in {{Trac|wp-includes/functions.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="user_pass_ok" d:title="user pass ok"> | |
| <d:index d:value="user pass ok"/> | |
| <h1>user pass ok</h1> | |
| <p>{{Deprecated}} | |
| == Description == | |
| '''As of WordPress [[Version_3.5|3.5]] this function has been deprecated in favor of [[Function Reference/wp_authenticate|wp_authenticate()]]''' | |
| Check that the user login name and password is correct. | |
| == Usage == | |
| %%%<?php user_pass_ok( $user_login, $user_pass ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$user_login|string|User name.}} | |
| {{Parameter|$user_pass|string|User password.}} | |
| == Return Values == | |
| ; (boolean) : <tt>False</tt> if does not authenticate, <tt>true</tt> if username and password authenticates. | |
| == Examples == | |
| <pre> | |
| <?php | |
| $user_login = 'admin'; | |
| $user_pass = 'mypass'; | |
| if ( !user_pass_ok( $user_login, $user_pass ) ) { | |
| echo "Sorry, you are not allowed to do this."; | |
| exit; | |
| } | |
| ?> | |
| </pre> | |
| == Notes == | |
| == Change Log == | |
| * Deprecated: [[Version 3.5|3.5.0]] | |
| * Since: 0.71 | |
| == Source File == | |
| <tt>user_pass_ok()</tt> is located in {{Trac|wp-includes/user.php}}. | |
| == Related == | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="get_locale" d:title="get locale"> | |
| <d:index d:value="get locale"/> | |
| <h1>get locale</h1> | |
| <p>== Description == | |
| Gets the current locale. | |
| If the locale is set, then it will filter the locale in the '<tt>locale</tt>' filter hook and return the value. | |
| If the locale is not set already, then the WPLANG constant is used if it is defined. Then it is filtered through the '<tt>locale</tt>' filter hook and the value for the locale global set and the locale is returned. | |
| The process to get the locale should only be done once but the locale will always be filtered using the '<tt>locale</tt>' hook. | |
| == Usage == | |
| %%%<?php get_locale() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (string) : The locale of the blog or from the '<tt>locale</tt>' hook. | |
| == Examples == | |
| This sets the monetary locale and if empty, sets as en_US | |
| <pre>setlocale(LC_MONETARY, get_locale()); | |
| $my_local_settings = localeconv(); | |
| if ($my_local_settings['int_curr_symbol'] == "") setlocale(LC_MONETARY, 'en_US');</pre> | |
| This shows the value of setlocale: | |
| <pre>setlocale(LC_MONETARY, get_locale()); | |
| print_r($my_local_settings);</pre> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>locale</tt>' hook on locale value. | |
| * Uses: <tt>$locale</tt> Gets the locale stored in the global. | |
| * Uses global: (<tt>unknown</tt>) <tt>$locale</tt> | |
| * <i>l10n</i> is an abbreviation for <i>localization</i>. | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <tt>get_locale()</tt> is located in {{Trac|wp-includes/l10n.php}}. | |
| == Related == | |
| {{Localization}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="_2" d:title=" 2"> | |
| <d:index d:value=" 2"/> | |
| <h1> 2</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/_2}} | |
| {{ja|関数リファレンス/_2}} | |
| {{ru|Справочник_по_функциям/_2}} | |
| }} | |
| {{Message|background=#FCECAD|text=This page is named incorrectly due to a limitation of Mediawiki page naming. The function name is <tt>__()</tt> not <tt>_2()</tt>.}} | |
| == Description == | |
| Retrieves the translated string from the [[Function_Reference/translate|<tt>translate()</tt>]]. | |
| == Usage == | |
| %%%<?php $translated_text = __( $text, $domain ); ?>%%% | |
| == Parameters == | |
| {{Parameter|$text|string|Text to translate}} | |
| {{Parameter|$domain|string|Domain to retrieve the translated text|optional|'default'}} | |
| == Return Values == | |
| ; (string) : Translated text | |
| == Examples == | |
| Make a string inside your plugin or theme translatable: | |
| <pre> | |
| $translated = __( 'Hello World!', 'mytextdomain' ); | |
| </pre> | |
| <tt>'mytextdomain'</tt> needs to be a unique text domain used throughout your plugin/theme. This should always be directly passed as a sting literal as shown above, ''not'' a string assigned to a variable or constant. E.g., this is incorrect: | |
| <pre> | |
| $text_domain = 'mytextdomain'; | |
| $string = 'Hello World!'; | |
| $translated = __( $string, $text_domain ); | |
| </pre> | |
| This ''seems'' to work, but it will interfere in automatic parsing of your plugin/theme's files for translation. See these for more information: | |
| * [http://ottopress.com/2012/internationalization-youre-probably-doing-it-wrong/ Internationalization: You're probably doing it wrong - Otto on WordPress] | |
| * [http://markjaquith.wordpress.com/2011/10/06/translating-wordpress-plugins-and-themes-dont-get-clever/ Translating WordPress Plugins and Themes - Mark Jaquith] | |
| == Notes == | |
| * See [[Function_Reference/_2|<tt>__()</tt>]] An alias of [[Function_Reference/translate|<tt>translate()</tt>]] | |
| * <i>l10n</i> is an abbreviation for <i>localization</i>. | |
| * The function name is two underscores in a row. In some fonts it looks like one long underscore. (Who says programmers don't have a sense of humor.) | |
| == Change Log == | |
| * Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>__()</tt> is located in {{Trac|wp-includes/l10n.php}}. | |
| == Related == | |
| {{L10n}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="_e" d:title=" e"> | |
| <d:index d:value=" e"/> | |
| <h1> e</h1> | |
| <p>{{Languages| | |
| {{en|Function_Reference/_e}} | |
| {{ru|Справочник_по_функциям/_e}} | |
| }} | |
| == Description == | |
| Displays the returned translated text from [[Function_Reference/translate|<tt>translate()</tt>]]. | |
| == Usage == | |
| %%%<?php _e( $text, $domain ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$text|string|Text to translate}} | |
| {{Parameter|$domain|string|Domain to retrieve the translated text|optional|'default'}} | |
| == Return Values == | |
| ; (void) : This function does not return a value. | |
| == Examples == | |
| Display some translated text: | |
| <?php _e( 'Some text to translate and display.', 'textdomain' ); ?> | |
| == Notes == | |
| * Echos returned [[Function_Reference/translate|<tt>translate()</tt>]] string. | |
| * <i>l10n</i> is an abbreviation for <i>localization</i>. | |
| == Change Log == | |
| * Since: [[Version 1.2|1.2.0]] | |
| == Source File == | |
| <tt>_e()</tt> is located in {{Trac|wp-includes/l10n.php}}. | |
| == Related == | |
| {{L10n}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="_2ngettext" d:title=" 2ngettext"> | |
| <d:index d:value=" 2ngettext"/> | |
| <h1> 2ngettext</h1> | |
| <p>{{Message|background=#FCECAD|text=This page is named incorrectly due to a limitation of Mediawiki page naming. The function name is __ngettext not _2ngettext.}} | |
| {{Deprecated|new_function=_n|version=2.8}} | |
| == Description == | |
| Retrieve the plural or single form based on the amount. | |
| If the domain is not set in the <tt>$l10n</tt> list, then a comparsion will be made and either <tt>$plural</tt> or <tt>$single</tt> parameters returned. | |
| If the domain does exist, then the parameters <tt>$single</tt>, <tt>$plural</tt>, and <tt>$number</tt> will first be passed to the domain's ngettext method. Then it will be passed to the '<tt>ngettext</tt>' filter hook along with the same parameters. The expected type will be a string. | |
| == Usage == | |
| %%%<?php __ngettext( $single, $plural, $number, $domain ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$single|string|The text that will be used if <tt>$number</tt> is 1}} | |
| {{Parameter|$plural|string|The text that will be used if <tt>$number</tt> is not 1}} | |
| {{Parameter|$number|integer|The number to compare against to use either <tt>$single</tt> or <tt>$plural</tt>}} | |
| {{Parameter|$domain|string|The domain identifier the text should be retrieved in|optional|'default'}} | |
| == Return Values == | |
| ; (string) : Either <tt>$single</tt> or <tt>$plural</tt> translated text | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses: [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] Calls '<tt>ngettext</tt>' hook on domains text returned, along with <tt>$single</tt>, <tt>$plural</tt>, and <tt>$number</tt> parameters. Expected to return string. | |
| * Uses global: (<tt>array</tt>) <tt>$l10n</tt> Gets list of domain translated string (gettext_reader) objects. | |
| * <i>l10n</i> is an abbreviation for <i>localization</i>. | |
| * This function name has two leading underscores in a row. In some fonts it looks like one long underscore. | |
| == Change Log == | |
| * Since: 1.2.0 | |
| * Deprecated: 2.8.0 | |
| == Source File == | |
| <tt>__ngettext()</tt> was located in {{Trac|wp-includes/l10n.php}}. As of [[Version 2.8]] it was moved to {{Trac|wp-includes/deprecated.php}}. | |
| == Related == | |
| {{L10n}} | |
| {{Tag Footer}} | |
| [[Category:Functions]]</p> | |
| </d:entry> | |
| <d:entry id="load_textdomain" d:title="load textdomain"> | |
| <d:index d:value="load textdomain"/> | |
| <h1>load textdomain</h1> | |
| <p>== Description == | |
| Loads MO file into the list of domains. | |
| If the domain already exists, the inclusion will fail. If the MO file is not readable, the inclusion will fail. | |
| On success, the MO file will be placed in the <tt>$l10n</tt> global by <tt>$domain</tt> and will be an <tt>gettext_reader</tt> object. | |
| == Usage == | |
| %%%<?php load_textdomain( $domain, $mofile ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$domain|string|Unique identifier for retrieving translated strings}} | |
| {{Parameter|$mofile|string|Path to the .mo file}} | |
| == Return Values == | |
| {{Return||boolean| First, will return '''true''' and exit if call to <tt>apply_filters('override_load_textdomain')</tt> returns '''true'''. If .mo file is not readable or the import fails - returns '''false'''. Otherwise returns '''true'''. }} | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Uses global: (<tt>array</tt>) <tt>$l10n</tt>. Gets list of domain translated string objects. | |
| * <i>l10n</i> is an abbreviation for <i>localization</i>. There are 10 characters between the initial 'l' and the terminal 'n' | |
| == Change Log == | |
| Since: 1.5.0 | |
| == Source File == | |
| <!-- Need links to current source code files --> | |
| <tt>load_textdomain()</tt> is located in {{Trac|wp-includes/l10n.php}}. | |
| == Related == | |
| {{Localization}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="load_plugin_textdomain" d:title="load plugin textdomain"> | |
| <d:index d:value="load plugin textdomain"/> | |
| <h1>load plugin textdomain</h1> | |
| <p>{{Languages| | |
| {{en|Function Reference/load_plugin_textdomain}} | |
| {{it|Riferimento funzioni/load_plugin_textdomain}} | |
| }} | |
| == Description == | |
| Loads the plugin's translated strings. | |
| If the path is not given then it will be the root of the plugin directory. The .mo file should be named based on the domain followed by a dash, and then the locale exactly. The locale is the language code and/or country code you defined in the constant WPLANG in the file wp-config.php. For example, the locale for German is 'de_DE', and the locale for Danish is 'da_DK'. If your plugin's text domain is "my-plugin" the Danish .mo and.po files should be named "my-plugin-da_DK.mo" and "my-plugin-da_DK.po" Call this function in your plugin as early as the <tt>plugins_loaded</tt> [[Plugin_API#Actions|action]]. | |
| If you call <tt>load_plugin_textdomain</tt> multiple times for the same domain, the translations will be merged. If both sets have the same string, the translation from the original value will be taken. | |
| == Usage == | |
| %%%<?php load_plugin_textdomain( $domain, $abs_rel_path, $plugin_rel_path ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$domain|string|Unique identifier for retrieving translated strings.}} | |
| {{Parameter|$abs_rel_path|string|Relative path to <tt>ABSPATH</tt> of a folder, where the .mo file resides. '''Deprecated''', but still functional until 2.7|optional|false}} | |
| {{Parameter|$plugin_rel_path|string|Relative path to <tt>WP_PLUGIN_DIR</tt>, <b>with a trailing slash</b>. This is the preferred argument to use. It takes precendence over <tt>$abs_rel_path</tt>|optional|false}} | |
| == Return Values == | |
| ; boolean : Returns true if the override_load_textdomain filter returns true or the language file wes loaded successfully. Returns false, if the language file could not be loaded (it is not readable or the mo file reader can not understand it). | |
| == Examples == | |
| This example assumes that it is placed in the main plugin file, or at least a file in the plugin root. If it's not, you'll need to adjust the [https://codex.wordpress.org/Function_Reference/plugin_dir_path plugin_dir_path()] call accordingly. | |
| <pre>add_action( 'plugins_loaded', 'myplugin_load_textdomain' ); | |
| /** | |
| * Load plugin textdomain. | |
| * | |
| * @since 1.0.0 | |
| */ | |
| function myplugin_load_textdomain() { | |
| load_plugin_textdomain( 'my-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/langs/' ); | |
| } | |
| </pre> | |
| == Notes == | |
| * <i>l10n</i> is an abbreviation for <i>localization</i>. | |
| * <i>l10n</i> is derived from the 10 letters between the "l" and the "n" of <i>localization</i>. | |
| == Change Log == | |
| * Since: [[Version 1.5|1.5.0]] | |
| * [[Version 2.7|2.7.0]]: '<tt>$abs_rel_path</tt>' parameter was deprecated. | |
| == Source File == | |
| <tt>load_plugin_textdomain()</tt> is located in {{Trac|wp-includes/l10n.php}}. | |
| == Resources == | |
| * [http://geertdedeckere.be/article/loading-wordpress-language-files-the-right-way Loading WordPress language files the right way] | |
| * [http://ottopress.com/2013/language-packs-101-prepwork/ Language packs 101 prepwork] | |
| * [http://premium.wpmudev.org/blog/localize-a-wordpress-plugin-and-make-it-translation-ready/ Localize a WordPress plugin and make it translation ready] | |
| == Related == | |
| {{Localization}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="load_theme_textdomain" d:title="load theme textdomain"> | |
| <d:index d:value="load theme textdomain"/> | |
| <h1>load theme textdomain</h1> | |
| <p>== Description == | |
| Loads the theme's translated strings. | |
| If the current locale exists as a .mo file in the theme's root directory, it will be included in the translated strings by the <tt>$domain</tt>. | |
| The .mo files must be <strong>named based on the locale exactly</strong>, <code>sv_SE.mo</code> for example. | |
| == Usage == | |
| %%%<?php load_theme_textdomain( $domain, $path ) ?>%%% | |
| == Parameters == | |
| {{Parameter|$domain|string|Unique identifier for retrieving translated strings.}} | |
| {{Parameter|$path|unknown|The directory where the .mo file can be found (without the trailing slash).|optional|false}} | |
| == Return Values == | |
| ; (bool) : This function return TRUE as textdomain well loaded, FALSE on failure. | |
| == Examples == | |
| === 1st example=== | |
| The load_theme_textdomain() function should generally be called from within the [[Plugin_API/Action_Reference/after_setup_theme|after_setup_theme]] action hook. | |
| <pre> | |
| add_action('after_setup_theme', 'my_theme_setup'); | |
| function my_theme_setup(){ | |
| load_theme_textdomain('my_theme', get_template_directory() . '/languages'); | |
| } | |
| </pre> | |
| The <code>.mo</code> files must use language-only filenames, like <code>languages/de_DE.mo</code> in your theme directory. | |
| Unlike plugin language files, a name like <code>my_theme-de_DE.mo</code> will NOT work. Although plugin language files allow you to specify the text-domain in the filename, this will NOT work with themes. Language files for themes should include the language shortcut ONLY. | |
| === 2nd example=== | |
| you can use this example if you wish to switch theme language using a variable passed within the URL, for example to load the <em>Tamazikht</em> language, your URL would look like; <code>www.example.com/?l=tz_MA</code>, this will search for a <code>.mo</code> file with name <code>tz_MA.mo</code> in the language directory inside your theme. | |
| <pre> | |
| // CHANGE LOCAL LANGUAGE | |
| // must be called before load_theme_textdomain() | |
| add_filter( 'locale', 'my_theme_localized' ); | |
| function my_theme_localized( $locale ) | |
| { | |
| if ( isset( $_GET['l'] ) ) | |
| { | |
| return esc_attr( $_GET['l'] ); | |
| } | |
| return $locale; | |
| } | |
| </pre> | |
| <pre> | |
| // SET THEME LANGUAGES DIRECTORY | |
| // Theme translations can be filed in the my_theme/languages/ directory | |
| // Wordpress translations can be filed in the wp-content/languages/ directory | |
| load_theme_textdomain( 'my_theme_textdomain', get_template_directory().'/languages' ); | |
| </pre> | |
| == Notes == | |
| Internationalization and localization (other correct spellings are internationalisation and localisation) are means of adapting computer software to different languages. | |
| * <i>l10n</i> is an abbreviation for <i>localization</i>. | |
| * <i>i18n</i> 18 stands for the number of letters between the first i and last n in <i>internationalization</i>. | |
| == Change Log == | |
| * Since: [[Version 1.5|1.5.0]] | |
| == Source File == | |
| <tt>load_theme_textdomain()</tt> is located in {{Trac|wp-includes/l10n.php}}. | |
| == External Resources == | |
| * [http://generatewp.com/theme-support/ WordPress Theme Support Generator] | |
| == Related == | |
| {{Localization}} | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="spawn_cron" d:title="spawn cron"> | |
| <d:index d:value="spawn cron"/> | |
| <h1>spawn cron</h1> | |
| <p>== Description == | |
| Send request to run cron through HTTP request that doesn't halt page loading. Will not run more than once every 60 seconds. | |
| == Usage == | |
| %%%<?php spawn_cron( $local_time ); ?>%%% | |
| == Parameters == | |
| == Return Values == | |
| ; (null) : Cron could not be spawned, because it is not needed to run. | |
| == Examples == | |
| <!-- Need creative examples. Feel free to link to external examples. --> | |
| == Notes == | |
| * Cron is named after a unix program which runs unattended scheduled tasks. | |
| == Change Log == | |
| Since: 2.1.0 | |
| == Source File == | |
| <tt>spawn_cron()</tt> is located in {{Trac|wp-includes/cron.php}}. | |
| == Related == | |
| <!-- | |
| To Do: | |
| Need to find related functions. | |
| Need to create groups of functions and create templates to add them to a page quickly. | |
| Some functions may be related to many groups of functions. | |
| --> | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:WP-Cron Functions]] | |
| [[Category:New_page_created]]</p> | |
| </d:entry> | |
| <d:entry id="wp_cron" d:title="wp cron"> | |
| <d:index d:value="wp cron"/> | |
| <h1>wp cron</h1> | |
| <p>== Description == | |
| Run scheduled callbacks or spawn cron for all scheduled events. | |
| == Usage == | |
| %%%<?php wp_cron() ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| ; (null) : When cron doesn't need to run.. | |
| == Examples == | |
| <pre> | |
| if ( ! wp_next_scheduled( 'my_task_hook' ) ) { | |
| wp_schedule_event( time(), 'hourly', 'my_task_hook' ); | |
| } | |
| add_action( 'my_task_hook', 'my_task_function' ); | |
| function my_task_function() { | |
| wp_mail( 'your@email.com', 'Automatic email', 'Automatic scheduled email from WordPress.'); | |
| } | |
| </pre> | |
| == Notes == | |
| * Cron is named after a unix program which runs unattended scheduled tasks. | |
| == Change Log == | |
| * Since: [[Version 2.1|2.1.0]] | |
| == Source File == | |
| <tt>wp_cron()</tt> is located in {{Trac|wp-includes/cron.php}}. | |
| == Related == | |
| * [[Function_Reference/wp_schedule_event|wp_schedule_event]] | |
| {{Tag Footer}} | |
| [[Category:Functions]] | |
| [[Category:WP-Cron Functions]]</p> | |
| </d:entry> | |
| <d:entry id="wp_get_schedules" d:title="wp get schedules"> | |
| <d:index d:value="wp get schedules"/> | |
| <h1>wp get schedules</h1> | |
| <p>== Description == | |
| Retrieve supported and filtered Cron recurrences. | |
| The supported recurrences are '<tt>hourly</tt>', '<tt>twicedaily</tt>', and '<tt>daily</tt>'. A plugin may add more by hooking into the '<tt>cron_schedules</tt>' filter. The filter accepts an array of arrays. The outer array has a key that is the name of the schedule or for example '<tt>weekly</tt>'. The value is an array with two keys, one is '<tt>interval</tt>' and the other is '<tt>display</tt>'. | |
| The '<tt>interval</tt>' is a number in seconds of when the cron job should run. So for '<tt>hourly</tt>', the time is <tt>3600</tt> or <tt>60*60</tt>. For weekly, the value would be <tt>60*60*24*7</tt> or <tt>604800</tt>. The value of '<tt>interval</tt>' would then be <tt>604800</tt>. | |
| == Usage == | |
| %%%<?php wp_get_schedules(); ?>%%% | |
| == Parameters == | |
| None. | |
| == Return Values == | |
| Array | |
| ( | |
| [hourly] => Array | |
| ( | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment