Table of Contents for
WordPress Plugin Development Cookbook - Second Edition

Version ebook / Retour

Cover image for bash Cookbook, 2nd Edition WordPress Plugin Development Cookbook - Second Edition by Yannick Lefebvre Published by Packt Publishing, 2017
  1. WordPress Plugin Development Cookbook
  2. Title Page
  3. Second Edition
  4. Copyright
  5. WordPress Plugin Development Cookbook
  6. Second Edition
  7. Credits
  8. About the Author
  9. About the Reviewers
  10. www.PacktPub.com
  11. Why subscribe?
  12. Customer Feedback
  13. Dedication
  14. Table of Contents
  15. Preface
  16. What this book covers
  17. What you need for this book
  18. Who this book is for
  19. Conventions
  20. Reader feedback
  21. Customer support
  22. Downloading the example code
  23. Errata
  24. Piracy
  25. Questions
  26. Preparing a Local Development Environment
  27. Introduction
  28. Installing a web server on your computer
  29. How to do it...
  30. How it works...
  31. There's more...
  32. Creating a remote web development environment
  33. See also
  34. Downloading and configuring a local WordPress installation
  35. Getting ready
  36. How to do it...
  37. How it works...
  38. Creating a local Subversion repository
  39. How to do it...
  40. How it works...
  41. There's more...
  42. Manual repository creation
  43. Other version control systems
  44. See also
  45. Importing initial files to a local Subversion repository
  46. Getting ready
  47. How to do it...
  48. How it works...
  49. See also
  50. Checking out files from a Subversion repository
  51. Getting ready
  52. How to do it...
  53. How it works...
  54. There's more...
  55. Subversion file statuses
  56. See also
  57. Committing changes to a Subversion repository
  58. Getting ready
  59. How to do it...
  60. How it works...
  61. There's more...
  62. Viewing the differences in modified files
  63. Updating files to latest repository version
  64. Reverting uncommitted file changes
  65. Viewing file history
  66. Installing a dedicated code editor/text editor
  67. Getting ready
  68. How to do it...
  69. How it works...
  70. Plugin Framework Basics
  71. Introduction
  72. Creating a plugin file and header
  73. Getting ready
  74. How to do it...
  75. How it works...
  76. See also
  77. Adding output content to page headers using plugin actions
  78. How to do it...
  79. How it works...
  80. There's more...
  81. Action hooks online listings
  82. Searching for hooks in the WordPress source code
  83. See also
  84. Using WordPress path utility functions to load external files and images
  85. How to do it...
  86. How it works...
  87. There's more...
  88. See also
  89. Modifying the site generator meta tag using plugin filters
  90. How to do it...
  91. How it works...
  92. There's more...
  93. preg_replace function
  94. Filter hooks online listings and the apply_filters function
  95. See also
  96. Adding text after each item's content using plugin filters
  97. How to do it...
  98. How it works...
  99. There's more...
  100. get_the_title and get_permalink functions
  101. See also
  102. Inserting link statistics tracking code in page body using plugin filters
  103. Getting ready
  104. How to do it...
  105. How it works...
  106. See also
  107. Troubleshooting coding errors and printing variable content
  108. How to do it...
  109. How it works...
  110. There's more...
  111. Built-in WordPress debugging features
  112. See also
  113. Creating a new simple shortcode
  114. How to do it...
  115. How it works...
  116. See also
  117. Creating a new shortcode with parameters
  118. How to do it...
  119. How it works...
  120. See also
  121. Creating a new enclosing shortcode
  122. How to do it...
  123. How it works...
  124. See also
  125. Loading a style sheet to format plugin output
  126. Getting ready
  127. How to do it...
  128. How it works...
  129. See also
  130. Writing plugins using object-oriented PHP
  131. Getting ready
  132. How to do it...
  133. How it works...
  134. See also
  135. User Settings and Administration Pages
  136. Introduction
  137. Creating default user settings on plugin initialization
  138. How to do it...
  139. How it works...
  140. There's more...
  141. Deactivation function
  142. See also
  143. Storing user settings using arrays
  144. Getting ready
  145. How to do it...
  146. How it works...
  147. See also
  148. Removing plugin data on deletion
  149. Getting ready
  150. How to do it...
  151. How it works...
  152. See also
  153. Creating an administration page menu item in the settings menu
  154. Getting ready
  155. How to do it...
  156. How it works...
  157. There's more...
  158. Settings hook priority to determine menu order
  159. See also
  160. Creating a multi-level administration menu
  161. How to do it...
  162. How it works...
  163. See also
  164. Adding menu items leading to external pages
  165. Getting ready
  166. How to do it...
  167. How it works...
  168. See also
  169. Hiding items which users should not access from the default menu
  170. How to do it...
  171. How it works...
  172. Rendering the admin page contents using HTML
  173. Getting ready
  174. How to do it...
  175. How it works...
  176. There's more...
  177. wp_nonce_field
  178. See also
  179. Processing and storing plugin configuration data
  180. Getting ready
  181. How to do it...
  182. How it works...
  183. See also
  184. Displaying a confirmation message when options are saved
  185. Getting ready
  186. How to do it...
  187. How it works...
  188. See also
  189. Adding custom help pages
  190. Getting ready
  191. How to do it...
  192. How it works...
  193. See also
  194. Rendering the admin page contents using the Settings API
  195. How to do it...
  196. How it works...
  197. There's more...
  198. Rendering a drop-down list settings field
  199. Rendering a text area settings field
  200. See also
  201. Accessing user settings from action and filter hooks
  202. Getting ready
  203. How to do it...
  204. How it works...
  205. See also
  206. Formatting admin pages using meta boxes
  207. Getting ready
  208. How to do it...
  209. How it works...
  210. See also
  211. Splitting admin code from the main plugin file to optimize site performance
  212. Getting ready
  213. How to do it...
  214. How it works...
  215. See also
  216. Storing style sheet data in user settings
  217. Getting ready
  218. How to do it...
  219. How it works...
  220. See also
  221. Managing multiple sets of user settings from a single admin page
  222. Getting ready
  223. How to do it...
  224. How it works...
  225. See also
  226. Creating network-level admin pages
  227. Getting ready
  228. How to do it...
  229. How it works...
  230. See also
  231. The Power of Custom Post Types
  232. Introduction
  233. Creating a custom post type
  234. Getting ready
  235. How to do it...
  236. How it works...
  237. There's more...
  238. Changing the custom post type permalinks slug
  239. Adding a new section to the custom post type editor
  240. Getting ready
  241. How to do it...
  242. How it works...
  243. See also
  244. Displaying single custom post type items using a custom layout
  245. Getting ready
  246. How to do it...
  247. How it works...
  248. See also
  249. Displaying custom post type data in shortcodes
  250. Getting ready
  251. How to do it...
  252. How it works...
  253. There's more...
  254. do_shortcode function
  255. Adding custom categories for custom post types
  256. Getting ready
  257. How to do it...
  258. How it works...
  259. See also
  260. Adding custom fields to categories
  261. Getting ready
  262. How to do it...
  263. How it works...
  264. See also
  265. Hiding the category editor from the custom post type editor
  266. Getting ready
  267. How to do it...
  268. How it works...
  269. See also
  270. Displaying additional columns in the custom post list page
  271. Getting ready
  272. How to do it...
  273. How it works...
  274. See also
  275. Adding filters for custom categories to the custom post list page
  276. Getting ready
  277. How to do it...
  278. How it works...
  279. See also
  280. Adding Quick Edit fields for custom categories
  281. Getting ready
  282. How to do it...
  283. How it works...
  284. Updating page title to include custom post data using plugin filters
  285. Getting ready
  286. How to do it...
  287. How it works...
  288. Customizing Post and Page Editors
  289. Introduction
  290. Capturing and displaying information using custom meta boxes
  291. Getting ready
  292. How to do it...
  293. How it works...
  294. There's more...
  295. Adding a new meta box to all post types (including custom ones)
  296. Displaying custom post data using filter functions
  297. Getting ready
  298. How to do it...
  299. How it works...
  300. See also
  301. Hiding the Custom Field section in the post editor
  302. Getting ready
  303. How to do it...
  304. How it works...
  305. Extending the post editor to allow users to upload files directly
  306. Getting ready
  307. How to do it...
  308. How it works...
  309. See also
  310. Accepting User Content Submissions
  311. Introduction
  312. Creating a client-side content submission form
  313. Getting ready
  314. How to do it...
  315. How it works...
  316. See also
  317. Saving user-submitted content in custom post types
  318. Getting ready
  319. How to do it...
  320. How it works...
  321. There's more...
  322. Moderating user-submitted content
  323. See also
  324. Sending email notifications upon new submissions
  325. Getting ready
  326. How to do it...
  327. How it works...
  328. See also
  329. Implementing a CAPTCHA on user forms using an online service
  330. Getting ready
  331. How to do it...
  332. How it works...
  333. See also
  334. Using a local library to implement a CAPTCHA on user forms
  335. Getting ready
  336. How to do it...
  337. How it works...
  338. See also
  339. Customizing User Data
  340. Introduction
  341. Adding custom fields to the user editor
  342. Getting ready
  343. How to do it...
  344. How it works...
  345. See also
  346. Processing and storing user custom data
  347. Getting ready
  348. How to do it...
  349. How it works...
  350. See also
  351. Displaying new user data in user list page
  352. Getting ready
  353. How to do it...
  354. How it works...
  355. See also
  356. Using custom user data in containing shortcode
  357. Getting ready
  358. How to do it...
  359. How it works...
  360. See also
  361. Creating Custom MySQL Database Tables
  362. Introduction
  363. Creating new database tables
  364. Getting ready
  365. How to do it...
  366. How it works...
  367. There's more...
  368. Using phpMyAdmin to simplify code creation
  369. Create tables in network installation
  370. Deleting custom tables on plugin removal
  371. Getting ready
  372. How to do it...
  373. How it works...
  374. See also
  375. Updating custom table structure on plugin upgrade
  376. Getting ready
  377. How to do it...
  378. How it works...
  379. See also
  380. Displaying custom table data on an admin page
  381. Getting ready
  382. How to do it...
  383. How it works...
  384. See also
  385. Inserting and updating records in custom tables
  386. Getting ready
  387. How to do it...
  388. How it works...
  389. See also
  390. Deleting records from custom tables
  391. Getting ready
  392. How to do it...
  393. How it works...
  394. See also
  395. Displaying custom database table data in shortcodes
  396. Getting ready
  397. How to do it...
  398. How it works...
  399. See also
  400. Implementing a search function to retrieve custom table data
  401. Getting ready
  402. How to do it...
  403. How it works...
  404. See also
  405. Importing data from a user file into custom tables
  406. Getting ready
  407. How to do it...
  408. How it works...
  409. See also
  410. Leveraging JavaScript, jQuery, and AJAX Scripts
  411. Introduction
  412. Safely loading jQuery onto WordPress web pages
  413. Getting ready
  414. How to do it...
  415. How it works...
  416. There's more...
  417. jQuery noconflict mode
  418. Displaying a pop-up dialog using the built-in ThickBox plugin
  419. Getting ready
  420. How to do it...
  421. How it works...
  422. There's more...
  423. Removing the dialog close button
  424. Displaying pop-up dialogs on select pages
  425. Controlling pop-up dialog display using shortcodes
  426. Getting ready
  427. How to do it...
  428. How it works...
  429. See also
  430. Displaying a calendar day selector using the Datepicker plugin
  431. Getting ready
  432. How to do it...
  433. How it works...
  434. Adding tooltips to admin page form fields using the TipTip plugin
  435. Getting ready
  436. How to do it...
  437. How it works...
  438. See also
  439. Using AJAX to dynamically update partial page contents
  440. Getting ready
  441. How to do it...
  442. How it works...
  443. See also
  444. Adding New Widgets to the WordPress Library
  445. Introduction
  446. Creating a new widget in WordPress
  447. Getting ready
  448. How to do it...
  449. How it works...
  450. There's more...
  451. Plugins extending other plugins
  452. See also
  453. Displaying configuration options
  454. Getting ready
  455. How to do it...
  456. How it works...
  457. See also
  458. Validating configuration options
  459. Getting ready
  460. How to do it...
  461. How it works...
  462. See also
  463. Implementing the widget display function
  464. Getting ready
  465. How to do it...
  466. How it works...
  467. See also
  468. Adding a custom dashboard widget
  469. Getting ready
  470. How to do it...
  471. How it works...
  472. See also
  473. Adding a custom widget to the network dashboard
  474. Getting ready
  475. How to do it...
  476. How it works...
  477. See also
  478. Enabling Plugin Internationalization
  479. Introduction
  480. Changing the WordPress language configuration
  481. Getting ready
  482. How to do it...
  483. How it works...
  484. Adapting default user settings for translation
  485. Getting ready
  486. How to do it...
  487. How it works...
  488. See also
  489. Making admin page code ready for translation
  490. Getting ready
  491. How to do it...
  492. How it works...
  493. See also
  494. Modifying shortcode output for translation
  495. Getting ready
  496. How to do it...
  497. How it works...
  498. See also
  499. Translating text strings using Poedit
  500. Getting ready
  501. How to do it...
  502. How it works...
  503. There's more...
  504. Translation template file
  505. See also
  506. Loading a language file in the plugin initialization
  507. Getting ready
  508. How to do it...
  509. How it works...
  510. There's more...
  511. Updating a translation file
  512. Advanced translation functions
  513. Localizing JavaScript files
  514. See also
  515. Distributing Your Plugin on wordpress.org
  516. Introduction
  517. Creating a README file for your plugin
  518. Getting ready
  519. How to do it...
  520. How it works...
  521. There's more...
  522. Releasing specific plugin versions using tags
  523. Applying for your plugin to be hosted on WordPress.org
  524. How to do it...
  525. How it works...
  526. See also
  527. Uploading your plugin using Subversion
  528. Getting ready
  529. How to do it...
  530. How it works...
  531. There's more...
  532. Checking out plugins to your development installation
  533. See also
  534. Providing plugin banner and thumbnail images
  535. Getting ready
  536. How to do it...
  537. How it works...
  538. See also

Introduction

Building on its history of openness and ease of use, WordPress reached new heights in customization when it introduced custom post types.

Custom post types are new categories of items that are created by using the WordPress API and that appear in the WordPress administration interface as complete new sections, next to the default Posts and Pages sections. These custom items can be used to store any type of information, including events, bug reports, recipes, movie reviews, and many more.

When using custom post types to implement this kind of functionality, developers are able to take advantage of WordPress internal content editing capabilities, including its powerful text editor and user-friendly media uploader. Custom post types also simplify data management for developers, since all of the information related to these new entries is stored in the site database using the existing table structures. Finally, custom post types can leverage the established theme and template system to display the information that site administrators store in these new content types.

If you have ever taken a peek at the MySQL database behind a WordPress site, you know that posts, pages, attachments, revisions, and navigation menu items share the same tables. In essence, all of these data elements are custom post types, with some of them using the standard text editor, while others, such as the navigation menus, have a custom management interface. Each of these types of items also has a different mechanism to be displayed on a site.

Using custom post types opens up endless possibilities to tailor the functionality of a WordPress installation and provide a custom solution to end users without needing to invest a large amount of time re-inventing the wheel. This chapter covers all facets of creating custom post types through the creation of a Book Review system, including the creation of new types of elements, displaying the newly stored information on the website, and customizing the environment to create an editor with unique capabilities.